Skip to main content
POST
Pay out at an accepted quote

Authorizations

X-API-Key
string
header
required

On the example server, any key that starts with rpk_mock_, e.g. rpk_mock_yourname. Never your real key.

Body

application/json
transaction_id
string
required

string, 1–100 of A–Z a–z 0–9 . _ : -. Required. Your id for this payout, and its idempotency key.

type
enum<string>
required

qr | bank_transfer. Required. Where the money goes; send the object of the same name, and only that one.

Available options:
qr,
bank_transfer
quote_id
enum<string>
required

uuid. Required. The id of the firm quote the end user accepted, for the amount the destination receives, before it expires.

Available options:
uuid
qr
object
bank_transfer
object
description
string

string, ≤ 200. Sent with the payment when the QR carries no description of its own.

Response

Paid · Not paid — QR for another amount

id
string
type
string
status
string
transaction_id
string
resolution_id
string | null
quote
object | null
source
object | null
target
object
qr
object
error
object | null
completed_at
string | null
created_at
string