Skip to main content
POST
Create an outbound payment

Authorizations

Authorization
string
header
required

Merchant authentication token. Obtained via POST /api/v1/merchant/token/grant. Pass as: Authorization: Bearer

Body

application/json
payment_method_id
string<uuid>
required

Target payment method ID

amount
integer
required

Amount in smallest currency unit

Required range: x >= 1
currency
enum<string>
required

Currency code

Available options:
USD,
BRL
customer_id
string<uuid>
required

Customer ID

metadata
object

Custom metadata

Response

Payout initiated

msg
string
required

Human-readable message describing the result

data
object
required

Transaction object (field casing in response is lowercased for status, type, provider, currency)