API reference

In your integration, paths are relative to the base URL:

Environment	Base URL
Sandbox	`https://api.staging.rampapay.com/v1`
Production	`https://api.rampapay.com/v1`

Every request carries your key in X-API-Key — see Authentication. Each endpoint lists the scope it needs.

Try it

Try it on each endpoint sends the request to the example server, https://examples.staging.rampapay.com/v1. It answers like the API, with sample data: nothing real moves and no merchant is paid.

Key: any key that starts with rpk_mock_, for example rpk_mock_yourname. Never enter your real key. Each rpk_mock_ key gets its own example wallet, starting at 1,000 USDT, so ids from one answer work in the next request.
Outcomes: the example server picks how a payment ends from the QR’s content. Use these in POST /payouts/qr/resolve and POST /payouts, with the amount you quoted:

`content`	What you get
`MOCK:CLOSED:100.00`	A fixed-amount QR for Bs 100.00 — paid, `completed`
`MOCK:OPEN`	An open-amount QR — paid the quote’s amount, `completed`
`MOCK:PENDING:100.00`	The network answers late — `processing`, then `completed`
`MOCK:FAIL:100.00`	The network refuses the payment — `failed`
`MOCK:NOFUNDS:100.00`	No liquidity on our side — `cancelled`, `INSUFFICIENT_FUNDS`
`MOCK:CLOSED:300.00` after quoting Bs 100.00	A QR for another amount than the quote — `cancelled`, `QUOTE_AMOUNT_MISMATCH`
`MOCK:INVALID`	An unreadable QR — `422 QR_REFUSED` on resolve, `rejected` on payout

The example server is for reading the API, not for testing your integration. Build against the sandbox base URL with your sandbox key, as in the quick start.

Overview

Accounts

Wallet

Payouts

Webhooks

Try it

​Try it

Try it