Overview
User management
- Users
- User regulatory status
- User e-money
User verification
- User data format
- KYC documents
- UBO declarations
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
- Bank wires
- Virtual IBAN
- Direct debits
- Web direct debits
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- Satispay
- Swish
- TWINT
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
- Bank accounts
- Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
View a Quote
Responses
The unique identifier of the object.
The date and time at which the object was created.
The date and time at which the quote expires and can no longer be used.
Returned values: ACTIVE
, EXPIRED
The status of the quote:
ACTIVE
– The quote can be used to execute a quoted conversion.EXPIRED
– The quote can’t be used because theExpirationDate
is passed.
Information about the debited funds.
Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the debited funds (the sell currency).
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260
whereas JPY 12 would be represented as just 12
).
During a conversion, (DebitedFunds.Amount
- Fees
) * MarketRate
= CreditedFunds.Amount
.
Information about the credited funds.
Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the credited funds (the buy currency).
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260
whereas JPY 12 would be represented as just 12
).
During a conversion, CreditedFunds.Amount
= (DebitedFunds.Amount
- Fees
) * MarketRate
.
Information about the conversion rate used during the transaction.
Max. 7 decimal places
The rate including Mangopay’s markup, indicative of the rate invoiced during the billing cycle: ClientRate
= MarketRate
* (1 - markup).
The ClientRate
fluctuates in line with the MarketRate
.
Max. 7 decimal places
The rate used to convert funds during a conversion: (DebitedFunds.Amount
- Fees
) * MarketRate
= CreditedFunds.Amount
.
The market rate fluctuates in line with FX market dynamics and is common to all platforms for the currency pair.
Max. length: 255 characters
Custom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.
The unique identifier of the object.
The date and time at which the object was created.
The date and time at which the quote expires and can no longer be used.
Returned values: ACTIVE
, EXPIRED
The status of the quote:
ACTIVE
– The quote can be used to execute a quoted conversion.EXPIRED
– The quote can’t be used because theExpirationDate
is passed.
Information about the debited funds.
Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the debited funds (the sell currency).
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260
whereas JPY 12 would be represented as just 12
).
During a conversion, (DebitedFunds.Amount
- Fees
) * MarketRate
= CreditedFunds.Amount
.
Information about the credited funds.
Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the credited funds (the buy currency).
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260
whereas JPY 12 would be represented as just 12
).
During a conversion, CreditedFunds.Amount
= (DebitedFunds.Amount
- Fees
) * MarketRate
.
Information about the conversion rate used during the transaction.
Max. 7 decimal places
The rate including Mangopay’s markup, indicative of the rate invoiced during the billing cycle: ClientRate
= MarketRate
* (1 - markup).
The ClientRate
fluctuates in line with the MarketRate
.
Max. 7 decimal places
The rate used to convert funds during a conversion: (DebitedFunds.Amount
- Fees
) * MarketRate
= CreditedFunds.Amount
.
The market rate fluctuates in line with FX market dynamics and is common to all platforms for the currency pair.
Max. length: 255 characters
Custom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.
Was this page helpful?