Skip to main content
POST
finance.transfer.fund

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-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
profileId
string
required

Id of a record in your connected account.

Required string length: 1 - 16
Pattern: ^[1-9][0-9]{0,15}$
transferId
string
required

Id of a record in your connected account.

Required string length: 1 - 16
Pattern: ^[1-9][0-9]{0,15}$
maxDebit
number
required

Approved maximum total debit, including all quoted fees.

Required range: x <= 1000000000000
maxFee
number
required

Approved maximum total financial fee.

Required range: 0 <= x <= 1000000000000
currency
string
required

Approved debit and fee currency.

Required string length: 1 - 3
Pattern: ^[A-Z]{3}$
balanceId
string

Explicit balance to debit in the same profile.

Required string length: 1 - 16
Pattern: ^[1-9][0-9]{0,15}$
fundingMethod
enum<string>
default:balance

Funding route; trusted settlement requires an account entitlement.

Available options:
balance,
trusted_pre_fund,
trusted_pre_fund_bulk
partnerReference
string

Settlement reference for trusted funding only.

Required string length: 1 - 100

Response

The result

status
enum<string>
required

Accepted funding state; rejected payments are errors.

Available options:
created,
completed
funded
boolean
required

True only when funding completed.