Skip to main content
POST
finance.transfer.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
transferId
string

Your transfer record ID.

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

Original call key, to reconcile after an unclear outcome.

Required string length: 1 - 200
accountId
string

Connected sub-account; omit to use your own account.

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

Response

The result

transferId
string
required

Your transfer record ID, for follow-up calls.

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

Confirmed outcome; pending means processing has not finished.

Available options:
pending,
succeeded,
failed,
reversed,
canceled,
unknown
amount
object
required

Principal transferred in minor units.

beneficiaryId
string

Your saved beneficiary record ID.

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

Amount taken from your account, in minor units, when it differs.

beneficiaryReceives
object

Amount the recipient receives after fees, in minor units.

note
string

Reference shown to the recipient.

Required string length: 1 - 200
transferDate
string<date>

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])))$
transferMethod
enum<string>

Local bank network or international transfer.

Available options:
local,
swift
fundingStatus
string

State of the funds, when reported.

Required string length: 1 - 50
failureCategory
enum<string>

Neutral failure category.

Available options:
funding,
destination,
processing
createdAt
string<date-time>

Date and time with timezone, ISO 8601.

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)))$
updatedAt
string<date-time>

Date and time with timezone, ISO 8601.

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)))$