On This Page

Authorizations with Hand-Keyed Data

Under certain circumstances, you might choose to manually enter (hand key) a customer's data to obtain an authorization.

Endpoint

Production:

POST https://nabgateway-api.nab.com.au/pts/v2/payments

Test:

POST https://nabgateway-api-test.nab.com.au/pts/v2/payments

Required Fields for Processing an Authorization with Hand-Keyed Data

IMPORTANT

When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

clientReferenceInformation.code
clientReferenceInformation.partner.thirdPartyCertificationNumber: National Australia Bank provides the value for this field.
clientReferenceInformation.transactionId
merchantInformation.transactionLocalDateTime
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
paymentInformation.card.expirationMonth
paymentInformation.card.expirationyear
paymentInformation.card.number
pointOfSaleInformation.cardPresent: Set the value to
true
.
pointOfSaleInformation.entryMode: Set the value to
keyed
.
pointOfSaleInformation.terminalCapability: Set the value to
1
,
2
,
3
,
4
, or
5
.
pointOfSaleInformation.terminalPinCapability
processingInformation.commerceIndicator: Set the value to
retail
.

REST Example: Processing an Authorization with Hand Keyed Data

Request

{    
    "clientReferenceInformation": {
        "code": "123456",
        "transactionId": "12233445679",
        "partner": {
            "thirdPartyCertificationNumber": "123456789012"
        }
    },
    "processingInformation": {
        "commerceIndicator": "retail",
        "authorizationOptions": {
            "ignoreAvsResult": "true",
            "ignoreCvResult": "true"
        }
    },
    "pointOfSaleInformation": {
        "entryMode": "keyed",
        "terminalCapability": "4",
        "terminalPinCapability": "6"
    },
    "paymentInformation": {
        "card": {
            "number": "4111111111111111",
            "securityCode": "123",
            "expirationMonth": "12",
            "expirationYear": "2031",
            "type": "001"
        }
    },
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "9604.00",
            "currency": "USD"
        },
        "billTo": {
            "postalCode": "94538"
        }
    }
    "merchantInformation": { 
        "transactionLocalDateTime": "20230724085022" 
    }
}

Response to a Successful Request

A successful response returns

status=AUTHORIZED

{
    "_links": {
        "void": {
            "method": "POST",
            "href": "/pts/v2/payments/6080032225246314603005/voids"
        },
        "self": {
            "method": "GET",
            "href": "/pts/v2/payments/6080032225246314603005"
        }
    },
    "clientReferenceInformation": {
        "code": "123456"
    },
    "id": "6080032225246314603005",
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "9604.00",
            "authorizedAmount": "9604.00",
            "currency": "USD"
        }
    },
    "paymentAccountInformation": {
        "card": {
            "type": "001"
        }
    },
    "paymentInformation": {
        "accountFeatures": {
            "category": "A",
            "group": "0"
        },
        "tokenizedCard": {
            "type": "001"
        }
    },
    "processorInformation": {
        "systemTraceAuditNumber": "173156",
        "approvalCode": "831000",
        "cardVerification": {
            "resultCodeRaw": "M",
            "resultCode": "M"
        },
        "networkTransactionId": "016153570198200",
        "transactionId": "016153570198200",
        "responseCode": "00",
        "avs": {
             "code": "Z",
             "codeRaw": "Z"
        }
    },
    "reconciliationId": "6080032225246314603005",
    "status": "AUTHORIZED",
    "submitTimeUtc": "2020-12-15T03:33:42Z"
    }