Using the order_id from the checkout flow, an authorization is the first step using the Transaction API. Once an authorization is submitted against an Order, a new Transaction is created. In most use cases, you will only have one transaction for each order when you authorize for the entire order amount.
When the transaction is successfully authorized, you will receive a unique transaction id in the response. You can also refer to the Transaction and Transaction Event object dictionary for the definition of the API responses.
Authorization expiration: once a transaction is authorized, you will have up to 7 days to submit capture requests to request payments from Flex Pay. After the expiration, no new captures may be placed on this transaction, and the remaining amount is automatically voided. This expiration timestamp is provided in the authorization_expiration field in the Transaction object for your reference.
Idempotency key to prevent duplicate requests.
The order_id received from Flex Pay during the checkout flow.
The amount you’re authorizing for this transaction. If left blank, authorize the remaining approved amount.
The currency in which you’re authorizing the transaction for. This should be the same as the checkout currency. In ISO 4217 format. Required if amount is provided.
Optional field for merchants to enter their own reference ID to aid in reconciliation.
Successful response
The unique transaction_id generated when an authorization is submitted for an order.
The original amount the transaction was authorized for.
The remaining amount that can be captured.
The cumulative amount that has been successfully captured.
The cumulative amount that has been successfully refunded.
Once a transaction is authorized, the merchant has a limited number of days to capture on the remaining amount. RFC3339 format.
The Flex Pay order that the transaction is authorized for.
Timestamp of when this transaction was first authorized. RFC3339 format.
ISO 4217 currency code for the amount fields.
Optional field for merchants to enter their own reference ID to aid in reconciliation.
The current status of the transaction.
A list of transaction events. See TransactionEventAto object.
The unique event_id generated for the transaction event.
The amount corresponding to the transaction event.
ISO 4217 currency code for the amount field.
Timestamp of when this transaction event took place. RFC3339 format.
Optional field for merchants to enter their own reference ID to aid in reconciliation.
The type of action that this event represents.
response for errors
The name of the error codes.
Unauthorized (you don't have access)
Forbidden(you don't have the permission to perform this operation)
response for errors
The name of the error codes.