Two-step flow: reserve funds with an authorisation, then capture (purchase), refund or cancel it.
Authorize funds
Asks the payer's bank to reserve an amount. Use it when you need to guarantee funds before completing the sale. The amount stays reserved until the expiry date set by the bank or until the related purchase is received, at which point the customer's balance is updated. Card and mobile (MULTICAIXA Express) payment methods are supported.
An Authorization resource is created whenever the customer's bank responds, whether the processor accepts or declines it. If communication fails, no resource is created and an error is returned.
path Parameters
posIdTerminal (point of sale) identifier.
Authorize funds › Request Body
amountAmount to authorise or charge.
currencyISO 4217 currency code.
merchantReferenceNumberUnique merchant reference for this order. Reusing it returns 400 REFERENCE_NUMBER.
Payment method data.
orderOriginOrigin of the order.
Authorize funds › Responses
Operation created. Use id to query the transaction.
idTransaction identifier.
Capture funds
Captures (charges) funds reserved by an authorisation, turning the reservation into a purchase. Also called purchase after authorisation.
amountcan be equal to or lower than the authorised amount, never higher.currencymust match the authorisation currency.- An authorisation can be captured once. To charge the remaining amount after a partial capture, use a partial authorisation.
- Declined, timed-out or cancelled authorisations cannot be captured.
An AuthorizedPayment resource is created whenever the customer's bank responds, whether the processor accepts or declines it. If communication fails, no resource is created and an error is returned.
path Parameters
posIdTerminal (point of sale) identifier.
authorizationIdAuthorisation identifier (id returned when the authorisation was created).
Capture funds › Request Body
amountAmount to capture. Equal to or lower than the authorised amount.
currencyMust match the authorisation currency.
Capture funds › Responses
Operation created. Use id to query the transaction.
idTransaction identifier.
Partial authorization
When you captured only part of an authorised amount, use a partial authorisation to charge the remaining value. It behaves like an authorisation, keeps the same merchant reference and has a single transaction id, but only covers the amount not yet charged.
So that you never store the customer's payment data, the request sends a payment token instead. GPO assigns the token automatically to the merchant reference of the original authorisation; read it from paymentToken.id with Get reference. Capture the new authorisation as usual.
path Parameters
posIdTerminal (point of sale) identifier.
Partial authorization › Request Body
amountRemaining amount to authorise.
currencymerchantReferenceNumberMerchant reference of the original authorisation.
orderOriginPartial authorization › Responses
Operation created. Use id to query the transaction.
idTransaction identifier.
Refund purchase
Refunds a purchase made after an authorisation. The refund can be equal to or lower than the purchase amount. Because it debits the merchant, the supervisor card associated with the terminal is required.
path Parameters
posIdTerminal (point of sale) identifier.
authorizationIdAuthorisation identifier (id returned when the authorisation was created).
paymentIdPurchase identifier (id returned when the purchase was created).
Refund purchase › Request Body
amountAmount to refund. Equal to or lower than the purchase amount.
supervisorCardSupervisor card associated with the terminal.
Refund purchase › Responses
Operation created. Use id to query the transaction.
idTransaction identifier.
Cancel authorization
Cancels an authorisation. A cancellation always releases the full authorised amount.
path Parameters
posIdTerminal (point of sale) identifier.
authorizationIdAuthorisation identifier (id returned when the authorisation was created).
Cancel authorization › Responses
Operation created. Use id to query the transaction.
idTransaction identifier.