Skip to main content
POST
finance.fx.conversion.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
accountId
string

Optional connected sub-account ID; omit to use your own account.

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

ID of a record in your connected account.

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

Original call key for reconciliation after an unclear outcome.

Required string length: 1 - 200

Response

The result

conversionId
string
required

ID of a record in your connected account.

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

Three-letter currency code.

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

Three-letter currency code.

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

Amount bought, in minor units.

sellAmount
object
required

Amount sold, in minor units.

executionRate
string
required

Decimal amount in major units, as text.

Pattern: ^-?(?:0|[1-9][0-9]*)(?:\.[0-9]+)?$
ratePair
string
required

Currency pair in rate direction.

Required string length: 1 - 20
Pattern: ^[A-Z]{6}$
conversionDate
string<date>
required

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

Conversion state: pending until settled, succeeded once settled, failed when funding is overdue; unknown for an unrecognized state.

Available options:
pending,
succeeded,
failed,
canceled,
unknown
quoteId
string

ID of a record in your connected account.

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

Neutral funding state, when known.

Required string length: 1 - 50
fundingSourceId
string

ID of a record in your connected account.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9_-]+$
createdAt
string<date-time>

Date and time in ISO 8601 format.

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 in ISO 8601 format.

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

Date and time in ISO 8601 format.

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