Referência da API

List payment intents

Scope: payments:read

Responses: 200 400 401 403 404 409 422 429

Create a payment intent

Scope: payments:write

Responses: 201 400 401 403 404 409 422 429

Retrieve a payment intent

Scope: payments:read

Responses: 200 400 401 403 404 409 422 429

Cancel an intent

Cancels an intent that holds no money at a provider. While the authorization is UNKNOWN (processing) the cancellation is recorded and a late approval is reversed automatically; the intent reports `canceled` once the reversal is confirmed. Authorized or captured transactions must be voided or refunded instead (409 invalid_state).

Scope: payments:write

Responses: 200 400 401 403 404 409 422 429

Confirm an intent with a payment method

Creates a transaction and runs authorisation synchronously. The response carries the transaction in its resulting state: captured/authorized, declined, failed, requires_action (complete the 3DS challenge) or processing (UNKNOWN: poll or wait for the webhook).

Scope: payments:write

Responses: 200 400 401 403 404 409 422 429

Quote the cardholder surcharge for a payment method

Returns the surcharge the cardholder would pay with this card on the intent's terminal, or zero with the gate reason. Display it before the pay button and confirm with `surcharge_disclosure` carrying the same amount and text version; a changed quote refuses the confirm with `surcharge_quote_stale`. A read: nothing is persisted.

Scope: payments:read

Responses: 200 400 401 403 404 409 422 429

List transactions

Scope: payments:read

Responses: 200 400 401 403 404 409 422 429

Retrieve a transaction

Scope: payments:read

Responses: 200 400 401 403 404 409 422 429

State transition history

Scope: payments:read

Responses: 200 400 401 403 404 409 422 429

Routing decisions (why each attempt went to its provider)

Scope: payments:read

Responses: 200 400 401 403 404 409 422 429

Pricing snapshot, fee bookings and ledger journals of a transaction

What the transaction was priced with at its first routing decision (FX quote, markup, provider amount, fee estimate) and what was booked on each capture and refund. Immutable: later schedule changes never alter it.

Scope: payments:read

Responses: 200 400 401 403 404 409 422 429

Capture an authorisation (full or partial)

Scope: payments:write

Responses: 200 400 401 403 404 409 422 429

Void an open authorisation

Scope: payments:write

Responses: 200 400 401 403 404 409 422 429

Refund a captured transaction (full or partial)

Scope: refunds:write

Responses: 200 400 401 403 404 409 422 429

Retrieve a refund

Scope: payments:read

Responses: 200 400 401 403 404 409 422 429

Create a customer reference

Scope: customers:write

Responses: 201 400 401 403 404 409 422 429

Tokenize a card (hosted fields)

Authenticated with a publishable key (`ExelPay-Publishable-Key` header) from an allowed browser origin. Returns a token and the payment method registered for the account; the number is encrypted in the Vault and never returned. Test publishable keys accept published test cards only.

Scope: tokens:write

Responses: 201 400 401 403 404 409 422 429

Create and confirm a payment with a card number (raw-PAN channel)

Server-to-server payment with the card in the request body. Available only on terminals whose raw-PAN channel ExelPay has enabled (merchants using it are in PCI DSS SAQ D scope, ADR-0014). The Vault tokenizes the card and the platform runs the same pipeline as `POST /v1/payment_intents` + `confirm`; the response carries the transaction plus the token to reuse. A retry with the same Idempotency-Key reuses the minted token and replays the answer.

Scope: payments:write

Responses: 201 400 401 403 404 409 422 429

Sandbox tokenizer (published test cards only)

Available to test-environment credentials only. Rejects any number that is not a provider-published test card; the number is never stored or echoed.

Scope: payments:write

Responses: 201 400 401 403 404 409 422 429

Complete the Simulator 3DS challenge

Scope: payments:write

Responses: 200 400 401 403 404 409 422 429

Chargebacks and disputes of a transaction

Scope: payments:read

Responses: 200 400 401 403 404 409 422 429

Retrieve a chargeback stage with its dispute

Scope: payments:read

Responses: 200 400 401 403 404 409 422 429

Accept liability for a chargeback

Closes the dispute as CLOSED_ACCEPTED; the debit already posted stays. Only RECEIVED chargebacks can be accepted.

Scope: disputes:write

Responses: 200 400 401 403 404 409 422 429

Submit evidence references for a chargeback

Records the merchant's representment before `due_at` (stage becomes REPRESENTED). Evidence is a list of document references (object-storage keys, ids, URLs); never upload documents or cardholder data here. Until a connector exposes dispute submission the representment is recorded for manual submission.

Scope: disputes:write

Responses: 200 400 401 403 404 409 422 429

Event log of the account (newest first; `after` pages forward from an event id)

Scope: webhooks:read

Responses: 200 400 401 403 404 409 422 429

Retrieve an event with its delivery attempts

Scope: webhooks:read

Responses: 200 400 401 403 404 409 422 429