Skip to main content
POST
finance.cash-redemption.create

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
redemptionId
string
required

Your unique redemption record ID.

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

Recipient name, sent to the account.

Required string length: 1 - 100
phone
string
required

Recipient phone number, sent once.

Required string length: 1 - 12
Pattern: ^[0-9]{10,12}$
expiresOn
string<date>
required

Calendar date, YYYY-MM-DD.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
notifyRecipient
boolean
required

Send the redemption link to the recipient by phone and email.

email
string<email>

Recipient email, sent once.

Maximum string length: 200
Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Response

The result

redemptionId
string
required

Your cash-redemption record ID.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
handoffUrl
string<uri>
required

Short-lived platform link for the recipient to redeem the payout.

status
enum<string>
required

Account-reported redemption state.

Available options:
active,
redeemed,
expired,
canceled,
pending,
unknown