Final capture

Capture the final part of funds from an initial authorisation and mark it as fully captured.

Fully capture a transaction

POST

/v1/transactions/{systemTransactionId}/modifications

Request example

Use the following request to fully capture an authorised transaction.

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

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. This can't be more than the original transaction value.
`operation` string required	The type of modification that you want to make. Set this to `FinalCapture`. Possible values: `Capture` `FinalCapture` `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. The state will also be updated to Captured. You'll also receive a Transaction (Card Captured) webhook notification.

{
  "state": "Captured",
  "stateData": {},
  "merchantTransactionDate": "2025-03-27T10:10:28.302Z",
  "merchantTransactionId": "66e9b08f-6609-43f7-be87-6fcff16c6168",
  "systemTransactionId": "196d03e8-9f66-48d7-bde3-764447951afb",
  "fundingData": {
    "cardScheme": "MasterCard",                   		     
    "primaryAccountNumber": "526600******0075",
    "expiryMonth": "12",
    "expiryYear": "2031",
    "gatewayTokenId": "5fbd77ce-02c1-40ed-94bc-1016660b7512",
    "providerResponse": {
      "provider": "pxpfinancial",
      "merchantAdvice": {}
    },
    "processorTransactionId": "3494f819-4bc6-4129-b3b1-01430b317336"
  }
}

Final capture

Fully capture a transaction

Request example

Response example

Was this helpful?