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

Your batch record ID.

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

Response

The result

batchId
string
required

Your batch record ID.

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
items
object[]
required

Transfers with your own IDs, for follow-up calls.

Maximum array length: 1000