Capture Transaction

Prev Next
Post
/v1/transactions/{transactionId}/capture

When you’re ready to request payments for your customer’s order, you can submit a POST request to the capture endpoint. Flex Pay provides the flexibility to either fully or partially capture the transaction – this may be useful when you are only requesting payments for a portion of the order at this moment, while the remaining amount will be requested at a later date.

To fully capture a transaction, simply submit a capture request with an amount in the request equal to the remaining_amount. To partially capture a transaction, submit a capture request with an amount less than the remaining_amount.

Security
HTTP
Type bearer
Header parameters
Idempotency-Key
stringRequired

Idempotency key to prevent duplicate requests.

Path parameters
transactionId
string (uuid) Required
Body parameters
object
amount
number (decimal)

Amount voided, captured, or refunded. Optional. If left blank, uses the full remaining amount.

Minimum0
currency
string

ISO 4217 currency code for this transaction. Required if amount is provided.

merchant_reference_id
string

Optional field for merchants to enter their own reference ID to aid in reconciliation.

Responses
200

Successful response

Expand All
object
id
string (uuid)

The unique transaction_id generated when an authorization is submitted for an order.

original_amount
number (decimal)

The original amount the transaction was authorized for.

remaining_amount
number (decimal)

The remaining amount that can be captured.

captured_amount
number (decimal)

The cumulative amount that has been successfully captured.

refunded_amount
number (decimal)

The cumulative amount that has been successfully refunded.

authorization_expiration
string (date-time)

Once a transaction is authorized, the merchant has a limited number of days to capture on the remaining amount. RFC3339 format.

order_id
string (uuid)

The Flex Pay order that the transaction is authorized for.

created
string (date-time)

Timestamp of when this transaction was first authorized. RFC3339 format.

currency
string

ISO 4217 currency code for the amount fields.

merchant_reference_id
string

Optional field for merchants to enter their own reference ID to aid in reconciliation.

status
string

The current status of the transaction.

Valid values[ "AUTHORIZED", "AUTHORIZED_FAILED", "AUTHORIZATION_EXPIRED", "CAPTURED", "PARTIALLY_CAPTURED", "REFUNDED", "PARTIALLY_REFUNDED", "VOIDED" ]
events
Array of object (TransactionEventAto)

A list of transaction events. See TransactionEventAto object.

object
id
string (uuid)

The unique event_id generated for the transaction event.

amount
number (decimal)

The amount corresponding to the transaction event.

currency
string

ISO 4217 currency code for the amount field.

created
string (date-time)

Timestamp of when this transaction event took place. RFC3339 format.

merchant_reference_id
string

Optional field for merchants to enter their own reference ID to aid in reconciliation.

type
string

The type of action that this event represents.

Valid values[ "AUTHORIZATION", "VOID", "CAPTURE", "REFUND" ]
400

response for errors

object
codeName
string

The name of the error codes.

Valid values[ "INSUFFICIENT_FUNDS", "OVER_CAPTURE_ERROR", "OVER_REFUND_ERROR", "OVER_VOID_ERROR", "NO_AMOUNT_LEFT", "LINE_EXPIRED_ERROR", "AUTH_EXPIRED_ERROR", "CURRENCY_MISMATCH_ERROR", "TRANSACTION_NOT_FOUND", "INCORRECT_ORDER_ID", "INVALID_INPUT", "NOT_READABLE_INPUT", "IDEMPOTENCY_KEY_ALREADY_USED", "MISSING_IDEMPOTENCY_KEY", "UNEXPECTED_ERROR" ]
message
string
401

Unauthorized (you don't have access)

403

Forbidden(you don't have the permission to perform this operation)

404

response for errors

object
codeName
string

The name of the error codes.

Valid values[ "INSUFFICIENT_FUNDS", "OVER_CAPTURE_ERROR", "OVER_REFUND_ERROR", "OVER_VOID_ERROR", "NO_AMOUNT_LEFT", "LINE_EXPIRED_ERROR", "AUTH_EXPIRED_ERROR", "CURRENCY_MISMATCH_ERROR", "TRANSACTION_NOT_FOUND", "INCORRECT_ORDER_ID", "INVALID_INPUT", "NOT_READABLE_INPUT", "IDEMPOTENCY_KEY_ALREADY_USED", "MISSING_IDEMPOTENCY_KEY", "UNEXPECTED_ERROR" ]
message
string
500

response for errors

object
codeName
string

The name of the error codes.

Valid values[ "INSUFFICIENT_FUNDS", "OVER_CAPTURE_ERROR", "OVER_REFUND_ERROR", "OVER_VOID_ERROR", "NO_AMOUNT_LEFT", "LINE_EXPIRED_ERROR", "AUTH_EXPIRED_ERROR", "CURRENCY_MISMATCH_ERROR", "TRANSACTION_NOT_FOUND", "INCORRECT_ORDER_ID", "INVALID_INPUT", "NOT_READABLE_INPUT", "IDEMPOTENCY_KEY_ALREADY_USED", "MISSING_IDEMPOTENCY_KEY", "UNEXPECTED_ERROR" ]
message
string