On This Page

Capture

This section describes how to capture an authorized transaction.

All supported card types can process captures.

Endpoint

Production:

POST https://nabgateway-api.nab.com.au/pts/v2/payments/{id}
/captures

Test:

POST https://nabgateway-api-test.nab.com.au/pts/v2/payments/{id}
/captures

The

{id}

is the transaction ID returned in the authorization response.

Required Fields for Capturing an Authorization

clientReferenceInformation.code: This field value maps from the original authorization, sale, or credit transaction.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount

REST Example: Capturing an Authorization

Request

{
    "clientReferenceInformation": {
        "code": "ABC123"
    },
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "100.00",
            "currency": "EUR"
    }
}

Response to a Successful Request

{
    "_links": {
        "void": {
            "method": "POST",
            "href": "/pts/v2/captures/6662994431376681303954/voids"
        },
        "self": {
            "method": "GET",
            "href": "/pts/v2/captures/6662994431376681303954"
        }
    },
    "clientReferenceInformation": {
        "code": "1666299443215"
    },
    "id": "6662994431376681303954",
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "100.00",
            "currency": "EUR"
        }
    },
    "reconciliationId": "66535942B9CGT52U",
    "status": "PENDING",
    "submitTimeUtc": "2022-10-20T20:57:23Z"
}

Capturing an Authorization Using
REST
APIs

Pass the original authorization ID in the URL, and send the service request to:

ADDITIONAL INFORMATION

POST https://<url_prefix>/v2/payments/{id}/captures

Use one of these URL prefixes:

Test:

nabgateway-developer.nab.com.au

Production:

nabgateway-developer.nab.com.au

Where

is the authorization ID returned in the authorization response.

{
  "id": "6481692924466004003001"
}

The URL with the

value is included in the authorization response:

{
  "_links": {
    "capture": {
      "method": "POST",
      "href": "/pts/v2/payments/6481692924466004003001/captures"
    }
  }

Verify that the request was successful. A 200-level HTTP response code indicates success.

For information about response codes, see

Transaction Response Codes