Ecommerce

Capture a transaction

Allows you to capture an auth only transaction. To do this, you must complete the following steps:

  1. Run an auth only transaction using the Run card transaction endpoint (by setting the isAuthOnly parameter to true).
  2. Retrieve the id from the response. This is the Nexio Payment ID.
  3. Include that id in the body of your request to this endpoint.

If you do not know the paymentId or amount to use, make a call with the View transactions endpoint with the query filter of transactionStatus=11 and plugin= to get an array of possible transactions.

<!-- theme: warning -->

⚠️ Try It

To use the Try It feature for this endpoint, you can use the credentials for your Sandbox API user.<br/><br/>You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right. username: docs@nexiopay.com password: JZdzoXpdDeH6VA<br/><br/>Include the ID as indicated above for an <<glossary:auth only>> transaction.

<div style="display:none;">

Request parameters

  • id
  • data
  • data.amount

Response parameters

  • amount
  • authCode
  • currency
  • data
  • data.amount
  • data.currency
  • data.settlementCurrency
  • gatewayResponse
  • gatewayResponse.gatewayName
  • gatewayResponse.refNumber
  • id
  • merchantId
  • message
  • transactionDate
  • transactionStatus
  • transactionType
</div>
post/pay/v3/capture

Request body

idId required— unresolved $ref

Response

Success

idId — unresolved $ref
merchantIdMerchantId — unresolved $ref
authCodestring

Represents a successfully authorized payment request. Not all gateways or connections return a value for authCode, so Nexio recommends against using this for reconciliation or bookkeeping.

transactionTypestring

The transaction type. This value is cached in the one-time-use token.

transactionDatestring

The transaction date and time, formatted as an ISO-8601 date expressed in UTC.

transactionStatusTransactionStatus — unresolved $ref
gatewayResponseGatewayResponse — unresolved $ref
messageMessage — unresolved $ref
currencystring

The three-character ISO code for the currency used in the transaction.

amountnumber

The amount to be captured.

Changes

No recorded changes to this endpoint across all 1 revision of this API.