Skip to main content
POST
payments.transfer-request.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
amount
integer
required

What the buyer should pay, in the currency's minor unit (cents for USD).

Required range: 1 <= x <= 99999999
currency
string
required

Three-letter currency code, e.g. USD. Bank transfer availability varies by currency.

Required string length: 1 - 3
Pattern: ^[A-Za-z]{3}$
description
string
required

What the request is for. The buyer is not shown it; it labels the request for you.

Required string length: 1 - 500
customerEmail
string

The buyer's email, when you know it.

Required string length: 1 - 320
Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
expiresAt
string<date-time>

When the request stops being payable, ISO 8601 with a timezone.

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])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
bankCountry
string

Two-letter country of the bank account the buyer pays into, e.g. DE, FR or NL. Required for EUR, where several countries' accounts are offered; ignored otherwise.

Pattern: ^[A-Z]{2}$

Response

The result

status
string
required

Every request starts awaiting the buyer's transfer.

Allowed value: "awaiting_payment"
amount
integer
required

Amount the buyer is asked to pay, in the currency's minor unit.

Required range: -9007199254740991 <= x <= 9007199254740991
currency
string
required

Three-letter currency code, uppercase, e.g. USD.

ref
string

Reference to what this call created. Pass it as ref to payments.transfer-request.get or payments.transfer-request.cancel.

reference
string

The code the buyer must quote with their bank transfer.

bank
object

Where the buyer sends the money, exactly as the source issued it.

expiresAt
string

When the request stops being payable, ISO 8601, when one was set.