On This Page

Merchant-Initiated Incremental Transaction with PAN

An incremental authorization is used to increase the total amount authorized for a payment if the initial authorization does not cover the total cost of goods and services. An incremental transaction is an additional amount to the original authorization. The final authorized total includes amounts for both the initial and the incremental authorizations. Incremental transactions are limited to certain merchant categories, such as rental, lodging, transit, amusement parks, restaurants, and bars.
To create an incremental transaction using the
Gateway Portal
, choose one of these options:
  • Account Top Up
  • No Show

Supported Card Types

These are the supported card types for processing credentialed transactions:
  • American Express
  • Mastercard
  • Visa

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 Merchant-Initiated Incremental Transactions

Use these required fields to process merchant-initiated incremental transactions.
issuerInformation.transactionInformation
Required only for token transactions with Discover or Diners Club. Set this field to the
processorInformation.transactionID
 field that was in the response message when you obtained the customer's credentials.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction. previousTransactionId
processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction. reason
Set the value to
5
.
Required only for Discover and Visa.
processingInformation. authorizationOptions.initiator. type
Set the value to
merchant
.
processorInformation.cardReferenceData
Required only for token transactions with Discover or Diners Club. Set this field to the
processorInformation.cardReferenceData
 field that was in the response message when you obtained the customer's credentials.

REST Example: Processing Merchant-Initiated Incremental Transactions

Request
{
    "orderInformation": {
		"billTo" : {
    		"country" : "US",
    		"lastName" : "Kim",
    		"address1" : "201 S. Division St.",
    		"postalCode" : "48104-2201",
    		"locality" : "Ann Arbor",
    		"administrativeArea" : "MI",
    		"firstName" : "Kyong-Jin",
            "phoneNumber": "5554327113",
    		"email" : ""
    	},
        "amountDetails": {
            "totalAmount": "120.00",
            "currency": "USD"
        }
    },
    "paymentInformation": {
        "card": {
            "expirationYear": "2031",
            "number": "4111xxxxxxxxxxxx",
            "expirationMonth": "12"
        }
    },
    "processingInformation": {
        "authorizationOptions": {
            "initiator": {
        	"type": "merchant",
            	"merchantInitiatedTransaction": {
            		"originalAuthorizedAmount": "100",
                            // Required for Discover
            		"previousTransactionId": "123456789619999",
            		"reason": "5"
            	}
            }
        }
    }
}
Response to a Successful Request
{
    "_links": {
        "authReversal": {
            "method": "POST",
            "href": "/pts/v2/payments/6533225006556860003002/reversals"
        },
        "self": {
            "method": "GET",
            "href": "/pts/v2/payments/6533225006556860003002"
        },
        "capture": {
            "method": "POST",
            "href": "/pts/v2/payments/6533225006556860003002/captures"
        }
    },
    "clientReferenceInformation": {
        "code": "1653322500637"
    },
    "id": "6533225006556860003002",
    "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": "X",
            "codeRaw": "I1"
        }
    },
    "reconciliationId": "64143477A3AJ4P2Z",
    "status": "AUTHORIZED",
    "submitTimeUtc": "2022-05-23T16:15:00Z"
}