Payments
Create, retrieve, and list payments.
/v1/paymentsCreate a paymentCreates a payment with complete counterparty and remittance data. The payment is validated, screened by Sirius Core, and — if cleared — settled.
Body parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
corridor |
string | yes | Corridor identifier, e.g. CL-US |
amount |
object | yes | value (decimal string) and currency |
source.account |
string | yes | Funding account, oz_acct_ |
counterparty.name |
string | yes | Legal name of the beneficiary |
counterparty.account_identifier |
string | yes | Destination account identifier |
counterparty.country |
string | yes | ISO 3166-1 alpha-2 |
remittance.reference |
string | yes | Invoice or purchase-order reference |
quote |
string | yes | Persisted quote, oz_quote_ |
metadata |
object | no | Up to 20 key-value pairs, returned unchanged |
Returns a Payment object in status screening, with estimated_settlement for the corridor.
/v1/payments/{id}Retrieve a paymentReturns the current state of a payment, including its screening reference once decided.
/v1/paymentsList paymentsQuery parameters: status, corridor, created_after, created_before, limit, cursor.
json The Payment object
{
"id": "oz_pay_8f2c41",
"status": "settled",
"corridor": "CL-US",
"amount": { "value": "48500.00", "currency": "USD" },
"source": { "account": "oz_acct_9d21ff", "currency": "CLP" },
"counterparty": { "name": "Acme Trading LLC", "country": "US" },
"remittance": { "reference": "INV-2026-0847" },
"screening": "oz_scr_c91b02",
"quote": "oz_quote_5b8a12",
"estimated_settlement": { "typical": "PT5M", "upper": "PT4H" },
"created_at": "2026-07-06T14:02:11Z",
"settled_at": "2026-07-06T14:06:23Z"
}