SchemaPayments

Capture payment

Use this method to capture a pre-authorization.

To capture a pre-authorization, you need its paymentId. Our gateway returned the paymentId in the response of the Create Payment method.

Note: If you don’t have the paymentId, use our List Payments method to search for the payment.

Depending on the amount you want to capture, complete the following:

  • Capture the full amount of the pre-authorization - Don’t send a value for the amount parameter in your request.
  • Capture less than the amount of the pre-authorization - Send a value for the amount parameter in your request.
  • Capture more than the amount of the pre-authorization - Adjust the pre-authorization before you capture it. For more information about adjusting a pre-authorization, go to Adjust Payment.

If your request is successful, our gateway takes the amount from the payment card.

Note: For more information about pre-authorizations and captures, go to Run a pre-authorization.

Path parameters

paymentIdstringRequired=10 characters
Unique identifier of the payment that the merchant wants to retrieve.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Idempotency-KeystringRequired

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request

This endpoint expects an object.
processingTerminalIdstringOptional>=4 characters<=50 characters
Unique identifier that our gateway assigned to the terminal.
operatorstringOptional>=0 characters<=50 characters
Operator who captured the payment.
amountlongOptional

Amount that the merchant wants to capture. The value is in the currency’s lowest denomination, for example, cents.
Note: If the merchant does not send an amount, we capture the total amount of the transaction.

breakdownobjectOptional
Object that contains information about the breakdown of the transaction.

Response

Successful request. We captured the payment.
paymentIdstring=10 characters
Unique identifier that our gateway assigned to the transaction.
processingTerminalIdstring>=4 characters<=50 characters
Unique identifier of the terminal that initiated the transaction.
orderobject
Object that contains information about the payment.
cardobject
Object that contains information about the card.
transactionResultobject
Object that contains information about the transaction response details.
operatorstring or null>=0 characters<=50 characters
Operator who initiated the request.
customerobject or null
Object that contains the customer's contact details and address information.
refundslist of objects or null
Array of refundSummary objects. Each object contains information about refunds linked to the transaction.
supportedOperationslist of enums or null

Array of operations that you can perform on the transaction.

  • capture - Capture the payment.
  • refund - Refund the payment.
  • fullyReverse - Fully reverse the transaction.
  • partiallyReverse - Partially reverse the payment.
  • incrementAuthorization - Increase the amount of the authorization.
  • adjustTip - Adjust the tip post-payment.
  • addSignature - Add a signature to the payment.
  • setAsReady - Set the transaction’s status to ready.
  • setAsPending - Set the transaction’s status to pending.
  • setAsDeclined - Set the transaction’s status to declined.
customFieldslist of objects or null
Array of customField objects.

Errors