Try it
Pick an operation, paste a test secret key, and send. The request goes straight from your browser to the API — nothing passes through this site.
Request builder
A real call, in test mode, with your own key.
Kept in this page only. Never stored, never sent anywhere but the API.
POST https://secure.idealbox.org/v1/payment_intentsEndpoints
What is shipped, and what is specified but not yet built. The second list is here so you can plan against it, not integrate against it.
| Verb | Path | What it does | State |
|---|---|---|---|
| POST | /v1/payment_intents | Create a payment. Send an Idempotency-Key. | Idempotent |
| POST | /v1/payment_intents/:id/confirm | Route the payment to a provider and start it. | |
| GET | /v1/payment_intents/:id | Retrieve a payment and every charge attempted against it. | |
| GET | /v1/payment_intents | List payments, filtered, searched and paginated. | |
| POST | /v1/customers | Create a customer you can reuse across payments. | |
| GET | /v1/providers | Which methods will work for a corridor and amount. | |
| POST | /v1/payment_intents/:id/cancel | Cancel a payment while it is still non-terminal. | Not built |
| POST | /v1/payment_intents/:id/refunds | Refund a captured payment in full or in part. | Not built |
| POST | /v1/disbursements | Send money out to a third party. | Not built |
| GET | /v1/wallets/:id/balance | Read a wallet’s pending and available balances. | Not built |
| GET | /v1/balance/transactions | The balance statement, line by line. | Not built |
| POST | /v1/payouts | Withdraw to your own destination. | Not built |
| POST | /v1/payment-links | Create a one-time or reusable payment link. | Not built |
Status codes
The HTTP status and the stable code that arrives with it. Your request log in the dashboard records the same code, so a code you filter by is a code documented here.
| HTTP | error.code |
|---|---|
| 400 | invalid_request |
| 401 | unauthenticated |
| 403 | permission_denied |
| 404 | resource_missing |
| 409 | resource_conflict |
| 412 | idempotency_key_reused |
| 422 | unprocessable_entity |
| 429 | rate_limit_exceeded |
| 503 | processor_unavailable |
| 500 | api_error |
Machine-readable
OpenAPI 3.1, generated from the controller’s own decorators and served by the API itself. The Postman collection is generated from that document, and Insomnia imports the same file.