Incremental authorisation

Increase the authorised amount of a transaction.

Increment an authorisation

POST

/v1/transactions/{systemTransactionId}/modifications

Request example

Use the following request to increment an authorisation.

{
  "merchant": "MERCHANT-1",
  "site": "SITE-1",
  "merchantTransactionId": "TRANSACTION-2",
  "merchantTransactionDate": "2025-01-27T08:51:02.826Z",
  "amounts": {
    "transaction": 29.99
  },
  "operation": "Incremental"
}

Parameter	Description
`merchant` string (≤ 20 characters) required	Your unique merchant identifier, as assigned by PXP.
`site` string (≤ 20 characters) required	Your unique site identifier, as assigned by PXP.
`merchantTransactionId` string (≤ 50 characters) required	The unique identifier for this transaction, as chosen by you.
`merchantTransactionDate` date-time required	The date and time when the initial transaction happened, in ISO 8601 format.
`amounts` object required	Details about the transaction amount.
`amounts.transaction` string required	The value of the transaction. For `Incremental` operations, this should be more than the original transaction value.
`operation` string required	The type of modification that you want to make. Set this to `Incremental`. Possible values: `Capture` `Refund` `Incremental` `Void`
`dccData` object	Details about the Dynamic Currency Conversion (DCC).
`dccData.rateSelectedIndicator` string (enum) required	Whether a DCC rate was selected for the transaction. Possible values: `NotSelected` `Selected` `NotAvailable` `CardNotEligible` `Error`
`dccData.amounts` object required	Details about the transaction amount in the local currency and the cardholder's currency.
`dccData.amounts.local` string required	Details about the transaction amount in the local currency.
`dccData.amounts.local.transaction` number required	The transaction amount in the local currency.
`dccData.amounts.local.currencyCode` string required	The currency code in ISO 4217 format.
`dccData.amounts.cardholder` object required	Details about the transaction amount in the cardholder's currency.
`dccData.amounts.cardholder.transaction` number required	The transaction amount in the cardholder's currency.
`dccData.amounts.cardholder.currencyCode` string required	The currency code in ISO 4217 format.
`dccData.exchangeRate` number required	The exchange rate used for the DCC.
`dccData.providerData` object required	Details about the DCC provider.
`dccData.providerData.provider` string required	The name of the DCC provider.
`dccData.providerData.referenceId` string required	The reference ID provided by the DCC provider. This is required if your provider is Elavon, otherwise it's ignored.
`dccData.providerData.merchantId` string required	The merchant ID assigned by the DCC provider. This is required if your provider is Elavon, otherwise it's ignored.
`dccData.providerData.terminalId` string required	The terminal ID assigned by the DCC provider. This is required if your provider is Elavon, otherwise it's ignored.
`dccData.providerData.markupTextIndicator` integer required	The mark-up text indicator for the DCC provider.
`dccData.markupRate` number or null	The mark-up rate.
`dccData.disclaimer` string or null	The disclaimer text.

Response example

If your request is successful, you'll receive a 200 request containing a new systemTransactionId. You'll also receive a Transaction (Card Authorised) webhook notification.

{
  "state": "Authorised",
  "stateData": {},
  "approvalCode": "754417",
  "merchantTransactionDate": "2025-03-27T10:49:00.662Z",
  "merchantTransactionId": "800e7596-0281-465c-8ce1-e9599485baee",
  "systemTransactionId": "ffd14e2b-b126-4c2e-a35f-c5d041556445",
  "fundingData": {
    "cardScheme": "MasterCard",
    "primaryAccountNumber": "526600******0075",
    "expiryMonth": "12",
    "expiryYear": "2031",
    "gatewayTokenId": "5fbd77ce-02c1-40ed-94bc-1016660b7512",
    "providerResponse": {
      "provider": "pxpfinancial",
      "code": "00",
      "merchantAdvice": {},
      "authorisedAmount": 29.99
    },
    "processorTransactionId": "38c0c7f4-a76a-4408-98f3-a8590064c5e2"
  }
}

Incremental authorisation

Increment an authorisation

Request example

Response example

Was this helpful?