Skip to main content
POST
payments.transfer-request.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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

The ref returned by payments.transfer-request.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

status
enum<string>
required

paid means the provider's signed notification matched this request; unknown arrivals never change it. expired is past expiresAt with no money received. partially_paid means some money arrived that does not yet cover the amount.

Available options:
awaiting_payment,
partially_paid,
paid,
expired,
cancelled
amount
integer
required

Amount the buyer is asked to pay, in the currency's minor unit (cents for USD).

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

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

amountReceived
integer

Money received so far, in minor units. Absent while none has arrived.

Required range: -9007199254740991 <= x <= 9007199254740991
paidAt
string

When the payment completed, ISO 8601. Only once paid.

expiresAt
string

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