Capture an auth-only APM transaction

In situations where an APM transaction has been run as auth only, you need to capture that transaction at a later time. For the steps to run that auth-only transaction, see Run an auth only transaction.

You can capture a transaction using either the API or the Nexio Dashboard.

Dashboard

To capture an auth-only APM transaction through the Nexio Dashboard, complete the following steps:

1. Go to the Nexio Dashboard and log in.
2. In the top left of the contents pane, select the merchant account or accounts that you want to capture the APM transaction for.
3. Go to the Transactions feature.
4. Filter the resulting list of transactions as needed. For example, set the Method to "APM" and the Status to "AUTHONLY" to get auth-only transactions for all alternative payment methods.
5. Click the transaction you want in order to open it.
6. Click Capture.
7. In the Capture Transaction dialog, complete the capture amount.

   📘

   Note

   Some payment methods support capturing the full amount, partial amount, or even an amount greater than the auth-only amount. Some also support multiple captures. To determine the capabilities, check the integration guide for the specific payment method.

8. Click Capture .
   The system attempts to capture that transaction.
9. Repeat steps 3-8 as needed.

API

To capture an auth-only APM transaction through the Nexio API, complete the following steps:

1. Make sure you know the payment ID of the auth-only transaction.
   This value is returned as id in the original auth-only transaction.
   If you do not know the paymentId or amount to use, make a call with the View transactions endpoint with the query filters of transactionStatus=11 and plugin= to get an array of possible transactions with the IDs (returned as plugin.originalId).
2. Send a request to the Capture an APM transaction endpoint.
   You need to include the paymentId for the auth-only transaction and the amount to capture.

   📘

   Note

   Some payment methods support capturing the full amount, partial amount, or even an amount greater than the auth-only amount. Some also support multiple captures. To determine the capabilities, check the integration guide for the specific payment method.

   Example Request

   curl -X POST https://api.nexiopaysandbox.com/apm/v3/capture \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/json' \
     -H 'Authorization: Basic [Base64_encoded_login]'
     -d '{
     "data": {
       "amount": 4.00
     },
     "id": "[payment_id]"
   }'
   

   A successful request returns a message of success, along with other transaction information:
   Example 200 Response

   {
     "id": "[payment_id]",
     "merchantId": "000999",
     "transactionDate": "2024-12-12T23:13:12.149Z",
     "transactionStatus": "settled",
     "amount": 1.76,
     "transactionType": "sale",
     "currency": "USD",
     "gatewayResponse": {
       "gatewayName": "klarnaPayments",
       "message": "success"
     },
     "data": {
       "amount": 1.76,
       "currency": "USD",
       "settlementCurrency": "USD"
     },
     "message": "success"
   }
   

3. Repeat steps 1-2 for each APM transaction you want to capture.