API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

OrderTransactionKind enum

Version unstable

The different kinds of order transactions.

Values

  • AUTHORIZATION

    An amount reserved against the cardholder's funding source. Money does not change hands until the authorization is captured.

  • CAPTURE

    A transfer of the money that was reserved during the authorization stage.

  • CHANGE

    Money returned to the customer when they have paid too much.

  • EMV_AUTHORIZATION

    An authorization for a payment taken with an EMV credit card reader.

  • REFUND

    A partial or full return of captured funds to the cardholder. A refund can happen only after a capture is processed.

  • SALE

    An authorization and capture performed together in a single step.

  • SUGGESTED_REFUND

    A suggested refund transaction that can be used to create a refund.

  • VOID

    A cancellation of a pending authorization or capture.

Types that return OrderTransactionKind

Version 2021-07 (Release candidate)

The different kinds of order transactions.

Values

  • AUTHORIZATION

    An amount reserved against the cardholder's funding source. Money does not change hands until the authorization is captured.

  • CAPTURE

    A transfer of the money that was reserved during the authorization stage.

  • CHANGE

    Money returned to the customer when they have paid too much.

  • EMV_AUTHORIZATION

    An authorization for a payment taken with an EMV credit card reader.

  • REFUND

    A partial or full return of captured funds to the cardholder. A refund can happen only after a capture is processed.

  • SALE

    An authorization and capture performed together in a single step.

  • SUGGESTED_REFUND

    A suggested refund transaction that can be used to create a refund.

  • VOID

    A cancellation of a pending authorization or capture.

Types that return OrderTransactionKind

Version 2021-04 (Latest)

The different kinds of order transactions.

Values

  • AUTHORIZATION

    An amount reserved against the cardholder's funding source. Money does not change hands until the authorization is captured.

  • CAPTURE

    A transfer of the money that was reserved during the authorization stage.

  • CHANGE

    Money returned to the customer when they have paid too much.

  • EMV_AUTHORIZATION

    An authorization for a payment taken with an EMV credit card reader.

  • REFUND

    A partial or full return of captured funds to the cardholder. A refund can happen only after a capture is processed.

  • SALE

    An authorization and capture performed together in a single step.

  • SUGGESTED_REFUND

    A suggested refund transaction that can be used to create a refund.

  • VOID

    A cancellation of a pending authorization or capture.

Types that return OrderTransactionKind

Version 2021-01

The different kinds of order transactions.

Values

  • AUTHORIZATION

    An amount reserved against the cardholder's funding source. Money does not change hands until the authorization is captured.

  • CAPTURE

    A transfer of the money that was reserved during the authorization stage.

  • CHANGE

    Money returned to the customer when they have paid too much.

  • EMV_AUTHORIZATION

    An authorization for a payment taken with an EMV credit card reader.

  • REFUND

    A partial or full return of captured funds to the cardholder. A refund can happen only after a capture is processed.

  • SALE

    An authorization and capture performed together in a single step.

  • SUGGESTED_REFUND

    A suggested refund transaction that can be used to create a refund.

  • VOID

    A cancellation of a pending authorization or capture.

Types that return OrderTransactionKind

Version 2020-10

The different kinds of order transactions.

Values

  • AUTHORIZATION

    An amount reserved against the cardholder's funding source. Money does not change hands until the authorization is captured.

  • CAPTURE

    A transfer of the money that was reserved during the authorization stage.

  • CHANGE

    Money returned to the customer when they have paid too much.

  • EMV_AUTHORIZATION

    An authorization for a payment taken with an EMV credit card reader.

  • REFUND

    A partial or full return of captured funds to the cardholder. A refund can happen only after a capture is processed.

  • SALE

    An authorization and capture performed together in a single step.

  • SUGGESTED_REFUND

    A suggested refund transaction that can be used to create a refund.

  • VOID

    A cancellation of a pending authorization or capture.

Types that return OrderTransactionKind

Version 2020-07

The different kinds of order transactions.

Values

  • AUTHORIZATION

    An amount reserved against the cardholder's funding source. Money does not change hands until the authorization is captured.

  • CAPTURE

    A transfer of the money that was reserved during the authorization stage.

  • CHANGE

    Money returned to the customer when they have paid too much.

  • EMV_AUTHORIZATION

    An authorization for a payment taken with an EMV credit card reader.

  • REFUND

    A partial or full return of captured funds to the cardholder. A refund can happen only after a capture is processed.

  • SALE

    An authorization and capture performed together in a single step.

  • SUGGESTED_REFUND

    A suggested refund transaction that can be used to create a refund.

  • VOID

    A cancellation of a pending authorization or capture.

Types that return OrderTransactionKind

Version 2020-04

The different kinds of order transactions.

Values

  • AUTHORIZATION

    An amount reserved against the cardholder's funding source. Money does not change hands until the authorization is captured.

  • CAPTURE

    A transfer of the money that was reserved during the authorization stage.

  • CHANGE

    Money returned to the customer when they have paid too much.

  • EMV_AUTHORIZATION

    An authorization for a payment taken with an EMV credit card reader.

  • REFUND

    A partial or full return of captured funds to the cardholder. A refund can happen only after a capture is processed.

  • SALE

    An authorization and capture performed together in a single step.

  • SUGGESTED_REFUND

    A suggested refund transaction that can be used to create a refund.

  • VOID

    A cancellation of a pending authorization or capture.

Types that return OrderTransactionKind

Version 2020-01 (Unsupported)

The different kinds of order transactions.

Values

  • AUTHORIZATION

    An amount reserved against the cardholder's funding source. Money does not change hands until the authorization is captured.

  • CAPTURE

    A transfer of the money that was reserved during the authorization stage.

  • CHANGE

    Money returned to the customer when they have paid too much.

  • EMV_AUTHORIZATION

    An authorization for a payment taken with an EMV credit card reader.

  • REFUND

    A partial or full return of captured funds to the cardholder. A refund can happen only after a capture is processed.

  • SALE

    An authorization and capture performed together in a single step.

  • SUGGESTED_REFUND

    A suggested refund transaction that can be used to create a refund.

  • VOID

    A cancellation of a pending authorization or capture.

Types that return OrderTransactionKind

Version 2019-10 (Unsupported)

The different kinds of order transactions.

Values

  • AUTHORIZATION

    An amount reserved against the cardholder's funding source. Money does not change hands until the authorization is captured.

  • CAPTURE

    A transfer of the money that was reserved during the authorization stage.

  • CHANGE

    Money returned to the customer when they have paid too much.

  • EMV_AUTHORIZATION

    An authorization for a payment taken with an EMV credit card reader.

  • REFUND

    A partial or full return of captured funds to the cardholder. A refund can happen only after a capture is processed.

  • SALE

    An authorization and capture performed together in a single step.

  • SUGGESTED_REFUND

    A suggested refund transaction that can be used to create a refund.

  • VOID

    A cancellation of a pending authorization or capture.

Types that return OrderTransactionKind

Version 2019-07 (Unsupported)

The different kinds of order transactions.

Values

  • AUTHORIZATION

    An amount reserved against the cardholder's funding source. Money does not change hands until the authorization is captured.

  • CAPTURE

    A transfer of the money that was reserved during the authorization stage.

  • CHANGE

    Money returned to the customer when they have paid too much.

  • EMV_AUTHORIZATION

    An authorization for a payment taken with an EMV credit card reader.

  • REFUND

    A partial or full return of captured funds to the cardholder. A refund can happen only after a capture is processed.

  • SALE

    An authorization and capture performed together in a single step.

  • SUGGESTED_REFUND

    A suggested refund transaction that can be used to create a refund.

  • VOID

    A cancellation of a pending authorization or capture.

Types that return OrderTransactionKind

Version 2019-04 (Unsupported)

The different kinds of order transactions.

Values

  • AUTHORIZATION

    An amount reserved against the cardholder's funding source. Money does not change hands until the authorization is captured.

  • CAPTURE

    A transfer of the money that was reserved during the authorization stage.

  • CHANGE

    Money returned to the customer when they have paid too much.

  • EMV_AUTHORIZATION

    An authorization for a payment taken with an EMV credit card reader.

  • REFUND

    A partial or full return of captured funds to the cardholder. A refund can happen only after a capture is processed.

  • SALE

    An authorization and capture performed together in a single step.

  • SUGGESTED_REFUND

    A suggested refund transaction that can be used to create a refund.

  • VOID

    A cancellation of a pending authorization or capture.

Types that return OrderTransactionKind