IN PROGRESS
This site is under active development. The sandbox is coming soon.
This is an independent, unofficial personal learning project. It does not represent any bank, financial institution, or regulator.
Payments API
Create a payment instruction
Section titled “Create a payment instruction”POST /v1/paymentsIdempotency-Key: <uuid>Request body
Section titled “Request body”| Field | Type | Required | Description |
|---|---|---|---|
debtor_account_id |
string | Yes | Payer account |
creditor.name |
string | Yes | Payee name |
creditor.account_number |
string | Yes | Payee account number |
amount.currency |
string | Yes | ISO 4217 currency code |
amount.value |
string | Yes | Amount string with two decimal places |
remittance_information |
string | No | Remittance information, up to 140 characters |
Response
Section titled “Response”{ "payment_id": "pay_2b7d9f", "status": "PENDING", "created_at": "2026-10-26T08:30:00Z"}Query a payment instruction
Section titled “Query a payment instruction”GET /v1/payments/{payment_id}Cancel a payment instruction
Section titled “Cancel a payment instruction”DELETE /v1/payments/{payment_id}Only instructions in PENDING status can be cancelled. On success, the status becomes CANCELLED.