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

Sending profile id in your connected account.

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

Three-letter currency code.

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

Three-letter currency code.

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

Positive amount in currency units.

Required range: x <= 1000000000000
toAmount
number

Positive amount in currency units.

Required range: x <= 1000000000000
preferredFundingMethod
enum<string>

Preferred method of paying for a quote.

Available options:
bank_transfer,
balance,
card,
debit_card,
credit_card
beneficiaryId
string

Recipient id in the same connected profile.

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

Payout method; sender-pays international routing is an explicit option.

Available options:
bank_transfer,
balance,
swift,
swift_sender_pays,
alipay,
interac
transferNature
string

Explicit transfer nature used for tax calculations.

Required string length: 1 - 128
Pattern: ^[a-zA-Z0-9_./-]+$
pricingOverride
object

Explicit fee override; requires connected-account entitlement.

Response

The result

profileId
string
required

Id of a record in your connected account.

Required string length: 1 - 16
Pattern: ^[1-9][0-9]{0,15}$
quoteId
string<uuid>
required

Id of a transfer quote in your connected account.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
fromCurrency
string
required

Sending currency.

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

Receiving currency.

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

Sending amount, including quoted fees.

Required range: x <= 1000000000000
toAmount
number
required

Amount the recipient receives.

Required range: x <= 1000000000000
rate
number
required

Receiving currency units per sending currency unit.

Required range: x <= 1000000000000000
status
enum<string>
required

Quote state.

Available options:
pending,
accepted,
funded,
expired
createdAt
string<date-time>
required

Quote creation time, UTC.

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

Quote expiry, UTC.

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))$
payoutMethod
enum<string>
required

Payout method; sender-pays international routing is an explicit option.

Available options:
bank_transfer,
balance,
swift,
swift_sender_pays,
alipay,
interac
blocked
boolean
required

True when the quote contains a blocking notice.

paymentOptions
object[]
required

Available payment methods and their quoted financial fees.

Maximum array length: 30
rateExpiresAt
string<date-time>

Locked rate expiry, UTC.

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