Saltar para o conteúdo principal
POST
POST /payment/purchase autoriza e captura fundos em uma única ida e volta. Use quando você pode cumprir o pedido de imediato — bens digitais, assinaturas SaaS ou varejo com estoque. Para bens físicos que são enviados depois, considere Authorize + Capture para reter fundos até o cumprimento sem liquidar antes da hora. A forma completa da requisição e da resposta — cada campo de card/shopper/amount, os valores de status e o detalhe de refusalCode/actionRequired/token — está documentada nos painéis de parâmetros e resposta acima (gerados a partir da especificação da API).
O id da resposta é o UUID de pagamento do Therius — guarde-o, é o identificador para uma chamada posterior a Refund ou Cancel or Refund. paymentCode (p. ex. "PC-1234567890") é uma referência separada para conciliação, suporte e Inquiry — não é aceito para reembolso/cancelamento.

Exemplos

Cobrar um cartão

Resposta recusada
amount.value está sempre em unidades menores. 1999 = $19.99 para USD (exponent 2). 5000 = ¥5000 para JPY (exponent 0). Use sempre o campo exponent para determinar a posição decimal.
Se status for "pending_3ds", redirecione o titular do cartão para actionRequired.url para concluir o desafio 3D Secure. Assim que ele terminar, chame POST /payment/resume com o sessionId da resposta pending_3ds para continuar. Se você usa o SDK JS do Therius, chame sdk.handleAction(result.actionRequired) — ele trata o redirecionamento e o resume automaticamente.

Autorizações

Authorization
string
header
obrigatório

Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).

Cabeçalhos

Idempotency-Key
string<uuid>

A UUID you generate per operation. Required in production. Retrying with the same key returns the original response.

Corpo

application/json
merchantCode
string
obrigatório

Your merchant account identifier. Validated against the Bearer key's merchant; required if the key maps to more than one merchant account.

orderCode
string
obrigatório

Your internal order reference. Must be unique per merchant — use it to correlate Therius payments with your own records.

amount
object
obrigatório
paymentMethod
object
obrigatório

The payment instrument/method to charge. Always required.

Exemplo:
shopper
object

Shopper information. Required when tokenizing a card (card.<instrument>.tokenize: true).

webhookUrl
string

Per-payment webhook URL override (HTTPS only). Therius posts the final payment status here when it changes asynchronously.

connectionId
string

Pin this payment to a specific connection by its opaque id (as returned by POST /payment/bank-options). Takes precedence over connectionCode. Omit to use your routing rules.

connectionCode
string

Pin this payment to a specific gateway connection. Omit to use your routing rules.

ipAddress
string

Cardholder's IP address, used for fraud scoring and by some providers. If you omit it, Therius uses the address of the connecting client, which is your server when you call from a backend, so send the shopper's real IP in that case.

metadata
object

Arbitrary string key/value pairs, echoed back in webhook payloads.

lineItems
object[]

Shared, request-level line items (description, quantity, line total). On a card payment they also supply the Level 3 breakdown when commercialData is sent. Used by BNPL providers for credit scoring and generic across every Adyen bank-redirect method, not method-specific -- a sibling of paymentMethod, never nested inside it.

billingAddress
object

Shared, request-level billing address used by APM methods that need one (e.g. Boleto, Efecty).

deliveryAddress
object

Shared, request-level delivery address used by BNPL providers for fraud scoring.

commercialData
object

Opt in to Level 2/3 card data (customer reference, tax, freight, ship-to and, with lineItems that carry unitAmount, the per-line breakdown). Card payments only. See the Level 2 and 3 card data guide.

Resposta

200 - application/json

Payment processed

id
string<uuid>

The Therius payment id. Returned by POST /payment/authorization and POST /payment/purchase; use it as the {id} path segment for capture, refund, cancel and cancel_or_refund.

Exemplo:

"9f8b2c1e-4d5a-6b7c-8d9e-0f1a2b3c4d5e"

status
enum<string>

captured - funds settled; authorized - funds reserved, call capture to settle; declined - issuer declined, see refusalCode; pending_3ds - a 3DS challenge is required, see actionRequired; pending_action - an external action (redirect, voucher) is required, see actionRequired; failed - processing error unrelated to the issuer; canceled - authorization voided; refunded - captured funds returned.

Opções disponíveis:
captured,
authorized,
declined,
pending_3ds,
pending_action,
failed,
canceled,
refunded
paymentCode
string

Therius receipt ID, for reconciliation, support and Inquiry. NOT the handle for capture/refund/cancel — use id for that.

Exemplo:

"PC-1234567890"

orderCode
string

Your orderCode, echoed back.

merchantCode
string

Your merchantCode, echoed back.

autorizationCode
string

Issuer authorization code on an approved payment. The field name is misspelled on the wire (no h) - this is intentional and stable.

paymentMethod
string

Payment method used, e.g. card, pix, ach.

connectionCode
string

Code of the connection that processed the payment. Omitted for payfac merchants.

connectionName
string

Display name of the gateway connection that processed the payment.

amount
object
card
object

Card details from the response: masked PAN, brand, type, and the network transaction/reference IDs to cite on future MIT charges.

apm
object

Alternative-payment-method details (redirect URL, QR code, barcode) when paymentMethod is an APM.

token
object

Present when the card was tokenized (tokenize: true).

actionRequired
object

Present when status is pending_3ds or pending_action. Describes what the cardholder must do next — with the Therius JS SDK, pass the whole object to sdk.handleAction().

refusalCode
object

Present when status is declined. See the Declined Payments concept page for the full code table and how to react to each recoveryAction. For alternative payment methods reasonCode is an APM_* code.