Skip to main content
POST
payments.payout.send

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
recipient
object
required

Destination for this payout; contact information is sent only to deliver it.

amount
object
required

Amount to transfer from your account in minor units.

note
string

Optional message sent to the recipient.

Required string length: 1 - 1000

Response

The result

status
enum<string>
required

Recipient transfer state; pending is not completion.

Available options:
pending,
completed,
failed,
unclaimed,
returned,
on_hold,
blocked,
refunded,
reversed
payoutId
string

Payout item in your account; available once the service assigns it.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
batchId
string

Payout batch in your account, for reconciliation when the item is still pending.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
amount
object

Transferred amount in minor units.

processedAt
string

When the item was processed, ISO 8601 UTC.