Captures

This section provides the information you need in order to capture an authorized transaction.

Supported Card Types

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.

REST Example: Capturing an Authorization

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
Request
{
    "clientReferenceInformation": {
        "code": "1662997399711"
    },
    "orderInformation": {
        "amountDetails": {
            "totalAmount": 100,
            "currency": "USD"
        }
    },
    "paymentAccountInformation": {
        "card": {
        	"number": "4111111111111111",
            "type": "001"
        }
    }
}
Response for a Successful Request
{
    "_links": {
        "authReversal": {
            "method": "POST",
            "href": "/pts/v2/payments/6629976031336699803954/reversals"
        },
        "self": {
            "method": "GET",
            "href": "/pts/v2/payments/6629976031336699803954"
        },
        "capture": {
            "method": "POST",
            "href": "/pts/v2/payments/6629976031336699803954/captures"
        }
    },
    "clientReferenceInformation": {
        "code": "1662997399711"
    },
    "id": "6629976031336699803954",
    "orderInformation": {
        "amountDetails": {
            "authorizedAmount": "100.00",
            "currency": "USD"
        }
    },
    "paymentAccountInformation": {
        "card": {
            "type": "001"
        }
    },
    "paymentInformation": {
        "tokenizedCard": {
            "type": "001"
        },
        "card": {
            "type": "001"
        }
    },
    "pointOfSaleInformation": {
        "terminalId": "111111"
    },
    "processorInformation": {
        "approvalCode": "888888",
        "networkTransactionId": "123456789619999",
        "transactionId": "123456789619999",
        "responseCode": "100",
        "avs": {
            "code": "1"
        }
    },
    "reconciliationId": "61117545B7TY1MP6",
    "status": "AUTHORIZED",
    "submitTimeUtc": "2022-09-12T15:46:43Z"
}
Captures

Required Fields for Capturing an Authorization

Use these required fields for capturing an authorization.
clientReferenceInformation.code
This field value maps from the original authorization, sale, or credit transaction.
clientReferenceInformation.partner.thirdPartyCertificationNumber
National Australia Bank
 provides the value for this field.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
Captures

REST Example: Capturing an Authorization

Request
{
    "clientReferenceInformation": {
        "code": "ABC123",
        "partner": {
            "thirdPartyCertificationNumber": "123456789012"
        }
    },
    "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"
}
Captures

Capturing an Authorization Using
REST
 APIs

  1. 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
    id
     is the authorization ID returned in the authorization response. 
    {
  "id": "6481692924466004003001"
}
    The URL with the
    id
     value is included in the authorization response:
    {
  "_links": {
    "capture": {
      "method": "POST",
      "href": "/pts/v2/payments/6481692924466004003001/captures"
    }
  }
  2. Check the response message to make sure that the request was successful. A 200-level HTTP response code indicates success.
    For information about response codes, see Transaction Response Codes.
Captures