Alternative Payment Methods

Capture an APM transaction

Changed on

Captures a previously authorized (auth only) transaction run using an Alternative Payment Method (see the Create APM one-time-use token 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.

For more help with this endpoint, see the Capture an auth-only APM transaction tutorial in Guides.

<!-- 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 (that is connected with PayPal). 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 of the payment request and the amount of the transaction in your request.

<div style="display:none;">

Request parameters

  • id
  • data
  • data.amount

Response parameters

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

Request

  • Base URL
    https://api.nexiopaysandbox.com
  • URL
    https://api.nexiopaysandbox.com/apm/v3/capture
  • Auth
    HTTP basic

Request body

idId required(unresolved $ref)

Response

Success

Schema required(unresolved $ref)

Changes