Skip to main content
POST
Create a payout

Authorizations

Authorization
string
header
required

Your API key: sk_test_… (sandbox) or sk_live_… (production).

Body

application/json
to
object
required
externalReference
string
required
Required string length: 1 - 100
from
object
narration
string
Maximum string length: 500
metadata
object

Response

Idempotent replay — this externalReference was already used, the original payout is returned.

payout
object
required