Cashier API · 2026-08-30

Create checkouts, execute payouts, and run payroll through 45 documented operations.

Create hosted payments or send a direct Mobile Money approval request without a checkout page, inspect consolidated balances, execute payouts, run payroll, and consume signed lifecycle events. Test credentials simulate the same state changes without contacting an external financial network.

Read the integration guide

Production base URLOpenAPI 3.1

https://api.xrpay.it

Authentication: Bearer credential
Amounts: Minor units or decimal strings
Format: JSON over HTTPS

Download OpenAPI 3.1 JSON ↗

01Inspect capabilities

Read the payment methods and settlement destinations available to the authenticated business.

02Create a payment intent

Receive a hosted URL, or use direct Mobile Money to send an approval request to the customer's phone.

03Verify the webhook

Use the signed event to update the order in your system without polling.

Request and response schemas

45 documented API operations

45 shown

POST/api/v1/payment-intents

Payment intents

Create a payment intent

Bearer authentication

Send a secret API key or an XRPay Connect access token in the Authorization header.

XRPay Connect scopecheckout.write

A connected access token must include this merchant-approved scope. Secret API keys remain subject to their own account permissions.

Parameters

Idempotency-Keyheaderrequired

Stable key for one logical operation. Reusing a key with different parameters returns HTTP 409.

string

JSON body

amount_minorrequired

Fiat amount in the currency's smallest unit.

integer

currencyrequired

Accepted request value.

string

external_order_idrequired

Accepted request value.

string

order_number

Accepted request value.

string

customer_email

Accepted request value.

string

location_id

Accepted request value.

string

terminal_id

Accepted request value.

string

operator_id

Accepted request value.

string

integration_type

Accepted request value.

pos | ecommerce | invoice | payment_link | api

payment_method_types

Optional allow-list enforced by both the hosted checkout UI and server actions.

collection_mode

Use direct with mobile_money to send the approval prompt to the customer's phone without creating a hosted checkout page.

hosted | direct

payment_method_data

Required only for direct Mobile Money collection. The full phone number is used for submission but is never returned.

object

settlement_currency

Accepted request value.

XRP | RLUSD

metadata

Accepted request value.

object

line_items

Accepted request value.

object[]

success_url

Accepted request value.

string

cancel_url

Accepted request value.

string

expires_in

Relative expiry in seconds. Mutually exclusive with expires_at.

integer

expires_at

Absolute expiry at least 60 seconds and no more than 30 days ahead. Mutually exclusive with expires_in.

string

Responses

200

Idempotent replay

201

Created

400

401

409

429

Sandbox consoleTest credentials only

Test credential

Held in memory for this tab. Never stored.Idempotency-Key header · requiredJSON body

View cURL

curl --request POST 'https://api.xrpay.it/api/v1/payment-intents' \
  --header 'Authorization: Bearer sk_test_…' \
  --header 'Idempotency-Key: docs-request-001' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount_minor": 2500,
  "currency": "USD",
  "external_order_id": "order_1048",
  "integration_type": "payment_link",
  "payment_method_types": [
    "card",
    "mobile_money",
    "bank"
  ],
  "expires_in": 3600
}'