Place a Fund Reserve

POST

payment

authorization

curl -X POST https://api.therius.io/v1/payment/authorization \
  -H "Authorization: Bearer prv_production_your_key_here" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantCode": "MERCHANT_001",
    "orderCode": "ORDER-20240101-002",
    "amount": { "currency": "USD", "value": 9900, "exponent": 2 },
    "card": {
      "cardData": {
        "cardNumber": "4111111111111111",
        "cardholderName": "Ada Lovelace",
        "expiryMonth": "12",
        "expiryYear": "2030",
        "cvv": "123"
      }
    }
  }'

{
  "id": "9f8b2c1e-4d5a-6b7c-8d9e-0f1a2b3c4d5e",
  "status": "authorized",
  "paymentCode": "PC-1234567890",
  "orderCode": "ORDER-20240101-002",
  "merchantCode": "MERCHANT_001",
  "amount": { "currency": "USD", "value": 9900, "exponent": 2 },
  "card": {
    "cardData": { "brand": "visa", "cardNumber": "411111****1111", "type": "credit" },
    "networkTransactionId": "txn_def456"
  }
}

POST /payment/authorization reserves funds on the cardholder’s account without settling them. The authorization hold is typically valid for 7 days, though the exact window depends on the acquirer and card network. Call Capture to settle the funds when you’re ready to fulfill, or Cancel to release the hold if you can’t fulfill the order. See the Purchase reference for the full card/shopper/response field descriptions — the request and response shape are identical, only the outcome differs (a hold instead of a settled charge).

curl -X POST https://api.therius.io/v1/payment/authorization \
  -H "Authorization: Bearer prv_production_your_key_here" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantCode": "MERCHANT_001",
    "orderCode": "ORDER-20240101-002",
    "amount": { "currency": "USD", "value": 9900, "exponent": 2 },
    "card": {
      "cardData": {
        "cardNumber": "4111111111111111",
        "cardholderName": "Ada Lovelace",
        "expiryMonth": "12",
        "expiryYear": "2030",
        "cvv": "123"
      }
    }
  }'

{
  "id": "9f8b2c1e-4d5a-6b7c-8d9e-0f1a2b3c4d5e",
  "status": "authorized",
  "paymentCode": "PC-1234567890",
  "orderCode": "ORDER-20240101-002",
  "merchantCode": "MERCHANT_001",
  "amount": { "currency": "USD", "value": 9900, "exponent": 2 },
  "card": {
    "cardData": { "brand": "visa", "cardNumber": "411111****1111", "type": "credit" },
    "networkTransactionId": "txn_def456"
  }
}

Partial capture is supported. When you call Capture, you can pass an amount less than or equal to the authorized amount. For example, if you authorized

99.00 but only shipped

75.00 worth of goods, capture $75.00 and the remaining hold is released automatically.

Authorization holds expire — typically after 7 days, but this varies by acquirer and card network. If you don’t call Capture before expiry, the hold is released and you’ll need to re-authorize. Monitor hold age in your order management system.

Authorizations

Authorization

string

header

required

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

Headers

Idempotency-Key

string<uuid>

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

Body

application/json

merchantCode

string

required

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

orderCode

string

required

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

amount

object

required

Show child attributes

card

Raw card (PCI DSS) · object

Card input for one-off payments: exactly one instrument (cardData / nonceData / tokenData) plus optional stored-credential and installment modifiers.

Raw card (PCI DSS)
SDK nonce
Vault token

Show child attributes

apm

object

Alternative payment method data — use instead of card for APMs such as Pix, ACH or Boleto. Structure varies by method.

paymentMethod

string

Payment method code. Omit for card payments; for APMs pass the code, e.g. pix, ach, boleto.

shopper

object

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

Show child attributes

webhookUrl

string

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

connectionCode

string

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

ipAddress

string

Cardholder's IP address, passed to fraud scoring when available.

metadata

object

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

Show child attributes

Response

200 - application/json

Authorization result

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.

Example:

"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; cancelled - authorization voided; refunded - captured funds returned.

Available options:

captured,

authorized,

declined,

pending_3ds,

pending_action,

failed,

cancelled,

refunded

paymentCode

string

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

Example:

"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 gateway connection that processed the payment.

connectionName

string

Display name of the gateway connection that processed the payment.

amount

object

Show child attributes

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).

Show child attributes

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().

Show child attributes

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.

Show child attributes

curl -X POST https://api.therius.io/v1/payment/authorization \
  -H "Authorization: Bearer prv_production_your_key_here" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantCode": "MERCHANT_001",
    "orderCode": "ORDER-20240101-002",
    "amount": { "currency": "USD", "value": 9900, "exponent": 2 },
    "card": {
      "cardData": {
        "cardNumber": "4111111111111111",
        "cardholderName": "Ada Lovelace",
        "expiryMonth": "12",
        "expiryYear": "2030",
        "cvv": "123"
      }
    }
  }'

{
  "id": "9f8b2c1e-4d5a-6b7c-8d9e-0f1a2b3c4d5e",
  "status": "authorized",
  "paymentCode": "PC-1234567890",
  "orderCode": "ORDER-20240101-002",
  "merchantCode": "MERCHANT_001",
  "amount": { "currency": "USD", "value": 9900, "exponent": 2 },
  "card": {
    "cardData": { "brand": "visa", "cardNumber": "411111****1111", "type": "credit" },
    "networkTransactionId": "txn_def456"
  }
}

Payments

Tokenization

Subscriptions

Subscription Plans

SDK Session

Place a Fund Reserve

Authorizations

Headers

Body

Response