On This Page
Validating and Authorizing a Transaction
The Validation service can be combined with the Authorization service so that when a
customer's authentication is validated, the transaction is automatically submitted for
authorization.
Fields Specific to a Visa Secure Transaction
These API fields are required specifically for this use case.
- processingInformation.commerceIndicator
- Set this field tovbvfor a successful authentication (EMV3-D Securevalue of05),vbv_attemptedif authentication was attempted but did not succeed (EMV 3-D Secure value of06), orvbv_failureif authentication failed (EMV3-D Securevalue of07).
- consumerAuthenticationInformation.cavv
- This field is required when payer authentication is successful.
Card-Specific Requirements
Some payment cards require information to be collected during a transaction.
- consumerAuthenticationInformation. defaultCard
- consumerAuthenticationInformation.mcc
- consumerAuthenticationInformation. productCode
- This field is required for American Express SafeKey (US) when the product code isAIRfor an airline purchase.
- merchantInformation. merchantDescriptor.name
- This field is required for Visa Secure travel.
- orderInformation.shipTo.address1
- This field is required only for American Express SafeKey (US).
- orderInformation.shipTo.address2
- This field is required only for American Express SafeKey (US).
Country-Specific Requirements
These fields are required for transactions in specific countries.
- consumerAuthenticationInformation. merchantScore
- This field is required for transactions processed in France.
- orderinformation.billTo.locality
- This field is required for transactions in the US and Canada.
- orderInformation.billTo.postalCode
- This field is required when theorderInformation.billTo.countryfield value isUSorCA.
- orderInformation.billTo.administrativeArea
- This field is required for transactions in the US and Canada.
Endpoint
Production:
POST
https://nabgateway-api.nab.com.au
/pts/v2/paymentsTest:
POST
https://nabgateway-api-test.nab.com.au
/pts/v2/paymentsRequired Fields for Processing an Authorization Using Visa Secure
- clientReferenceInformation.code
- consumerAuthenticationInformation.cavv
- This field is required when payer authentication is successful. Otherwise, this field is optional.
- consumerAuthenticationInformation.xid
- orderInformation.amountDetails.currency
- orderInformation.amountDetails.totalAmount
- orderInformation.billTo.address1
- orderInformation.billTo.administrativeArea
- orderInformation.billTo.country
- orderInformation.billTo.email
- orderInformation.billTo.firstName
- orderInformation.billTo.lastName
- orderInformation.billTo.locality
- orderInformation.billTo.postalCode
- paymentInformation.card.expirationMonth
- paymentInformation.card.expirationYear
- paymentInformation.card.number
- paymentInformation.card.type
- processingInformation.commerceIndicator
- Set this field to one of these values:
- vbv: Successful authentication (EMV3-D Securevalue of05).
- vbv_attempted: Authentication was attempted (EMV3-D Securevalue of06).
- vbv_failure: orinternet: Authentication failed or was not attempted (EMV3-D Securevalue of07).
REST Example: Validating and Authorizing a Transaction
Request
{ "clientReferenceInformation": { "code": "test" }, "processingInformation": { "capture": "true", "authorizationOptions": { "ignoreAvsResult": "true" }, "actionList": [ "VALIDATE_CONSUMER_AUTHENTICATION" ] }, "paymentInformation": { "card": { "expirationYear": "2031", "number": "4XXXXXXXXXXX25X3", "securityCode": "123", "expirationMonth": "12", "type": "001" } }, "orderInformation": { "amountDetails": { "totalAmount": "100.00", "currency": "GBP" }, "billTo": { "firstName": "John", "lastName": "Smith", "address1": "201 S. Division St._1", "address2": "Suite 500", "locality": "Foster City", "administrativeArea": "CA", "postalCode": "94404", "country": "US", "email": "[email protected]", "phoneNumber": "6504327113" } }, "consumerAuthenticationInformation": { "authenticationTransactionId": "2b4eAa4K3H778X34Ciy0" } }
Response to a Successful Request
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/payments/7478305945626990404807/voids" }, "self": { "method": "GET", "href": "/pts/v2/payments/7478305945626990404807" } }, "clientReferenceInformation": { "code": "test" }, "consumerAuthenticationInformation": { "indicator": "vbv", "eciRaw": "05", "authenticationResult": "0", "strongAuthentication": { "OutageExemptionIndicator": "0" }, "authenticationStatusMsg": "Success", "eci": "05", "token": "Axj//wSTlWZX08jkcOTHAAIU3YMmzhgzcN2ie/LXsgSgKe/LXsgS50OnEFBWGTSTL0Yua1eAwHScqzK+nkcjhyY4wDi0", "cavv": "AAIBBYNoEwAAACcKhAJkdQAAAAA=", "paresStatus": "Y", "xid": "AAIBBYNoEwAAACcKhAJkdQAAAAA=", "directoryServerTransactionId": "fa628ed8-ad77-4723-b28f-91952eaca8fe", "threeDSServerTransactionId": "71399671-8456-4c97-b056-e127622a5e26", "specificationVersion": "2.2.0", "acsTransactionId": "5f9fb589-08cc-4952-866d-30939868f411" }, "id": "7478305945626990404807", "orderInformation": { "amountDetails": { "totalAmount": "100.00", "authorizedAmount": "100.00", "currency": "GBP" } }, "paymentAccountInformation": { "card": { "brandName": "VISA", "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "bin": "400000", "type": "VISA" } }, "pointOfSaleInformation": { "terminalId": "12345678" }, "processorInformation": { "paymentAccountReferenceNumber": "V0010013018036776997406844475", "merchantNumber": "12345678", "approvalCode": "100", "cardVerification": { "resultCodeRaw": "3", "resultCode": "2" }, "merchantAdvice": { "code": "00", "codeRaw": "0" }, "networkTransactionId": "123456789012345", "transactionId": "123456789012345", "responseCode": "0", "avs": { "code": "U", "codeRaw": "00" } }, "reconciliationId": "7026803874", "status": "AUTHORIZED", "submitTimeUtc": "2025-05-21T12:29:54Z" }