Overview
User management
- Users
- User regulatory status
- User e-money
User verification
- IDV sessions
- 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
- Pay by bank
- Virtual IBAN
- Direct debits
- Web direct debits
APM pay-ins
- Apple Pay
- Bancontact
- Bizum
- 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
- Recipients
- Bank accounts
- Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Echo
- Intents
- Settlements
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
Copy
Ask AI
{
"Amount": 20000,
"Currency": "EUR",
"PlatformFeesAmount": 0,
"ExternalData": {
"ExternalProcessingDate": 1752057185,
"ExternalProviderReference": "auth-stripe-633781e6-bb10-4484-8a29-ff6da7d7464a",
"ExternalMerchantReference": "order-420bbe60-7f62-4e53-9d64-7cb5188c507f",
"ExternalProviderName": "Stripe",
"ExternalProviderPaymentMethod": "MASTERCARD"
},
"Buyer": {
"Id": "user_m_01JZB09HSDZRVN60QH1006TK6E"
},
"LineItems": [
{
"Seller": {
"AuthorId": "user_m_01JZJ42M48CGJ19F2FS5WWKBNH",
"WalletId": "wlt_m_01JZ5STM3FDSC5G1WWVS4ZCZFJ",
"FeesAmount": 0
},
"Sku": "example-item-123",
"Name": "Example item name",
"Description": "Example item description",
"Quantity": 2,
"UnitAmount": 6000,
"TaxAmount": 0,
"DiscountAmount": 2000,
"Category": "Example category",
"ShippingAddress": {
"AddressLine1": "2226 Balistreri Roads",
"AddressLine2": null,
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
}
},
{
"Seller": {
"AuthorId": "user_m_01JZAXD3C31Y543SRKNCVK3V5N",
"WalletId": "wlt_m_01JZ8DKE83Y06860JZRKAM259V",
"FeesAmount": 0
},
"Sku": "example-item-456",
"Name": "Example item name",
"Description": "Example item description",
"Quantity": 1,
"UnitAmount": 10000,
"TaxAmount": 0,
"DiscountAmount": 0,
"Category": "Example category",
"ShippingAddress": {
"AddressLine1": "771 Koch Mews",
"AddressLine2": null,
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
}
}
]
}
Copy
Ask AI
{
"Id": "int_0197eebf-21fd-73c7-85ef-8193b4cf427d",
"Amount": 20000,
"AvailableAmountToSplit": 0,
"Currency": "EUR",
"PlatformFeesAmount": 0,
"Status": "AUTHORIZED",
"NextActions": "CAPTURED, PARTIALLY_CAPTURED, CANCELED",
"ExternalData": {
"ExternalProcessingDate": 1752057185,
"ExternalProviderReference": "auth-stripe-633781e6-bb10-4484-8a29-ff6da7d7464a",
"ExternalMerchantReference": "order-420bbe60-7f62-4e53-9d64-7cb5188c507f",
"ExternalProviderName": "Stripe",
"ExternalProviderPaymentMethod": "MASTERCARD"
},
"Buyer": {
"Id": "user_m_01JZB09HSDZRVN60QH1006TK6E"
},
"LineItems": [
{
"Seller": {
"AuthorId": "user_m_01JZJ42M48CGJ19F2FS5WWKBNH",
"WalletId": "wlt_m_01JZ5STM3FDSC5G1WWVS4ZCZFJ",
"FeesAmount": 0
},
"Id": "int_li_0197eebf-21fd-73c7-85ef-8193b4cf427e",
"Sku": "example-item-123",
"Name": "Example item name",
"Description": "Example item description",
"Quantity": 2,
"UnitAmount": 6000,
"TaxAmount": 0,
"DiscountAmount": 2000,
"Category": "Example category",
"ShippingAddress": {
"AddressLine1": "2226 Balistreri Roads",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"CapturedAmount": 0,
"RefundedAmount": 0,
"DisputedAmount": 0,
"SplitAmount": 0,
"TotalLineItemAmount": 10000
},
{
"Seller": {
"AuthorId": "user_m_01JZAXD3C31Y543SRKNCVK3V5N",
"WalletId": "wlt_m_01JZ8DKE83Y06860JZRKAM259V",
"FeesAmount": 0
},
"Id": "int_li_0197eebf-21fd-73c7-85ef-8193b4cf427f",
"Sku": "example-item-456",
"Name": "Example item name",
"Description": "Example item description",
"Quantity": 1,
"UnitAmount": 10000,
"TaxAmount": 0,
"DiscountAmount": 0,
"Category": "Example category",
"ShippingAddress": {
"AddressLine1": "771 Koch Mews",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"CapturedAmount": 0,
"RefundedAmount": 0,
"DisputedAmount": 0,
"SplitAmount": 0,
"TotalLineItemAmount": 10000
}
],
"CreationDate": 1752057192,
"ExecutionDate": 1752057192
}
Intents
Create an Intent
Declare a transaction authorization processed by a third-party PSP
POST
/
v3.0
/
{ClientId}
/
payins
/
intents
Copy
Ask AI
{
"Amount": 20000,
"Currency": "EUR",
"PlatformFeesAmount": 0,
"ExternalData": {
"ExternalProcessingDate": 1752057185,
"ExternalProviderReference": "auth-stripe-633781e6-bb10-4484-8a29-ff6da7d7464a",
"ExternalMerchantReference": "order-420bbe60-7f62-4e53-9d64-7cb5188c507f",
"ExternalProviderName": "Stripe",
"ExternalProviderPaymentMethod": "MASTERCARD"
},
"Buyer": {
"Id": "user_m_01JZB09HSDZRVN60QH1006TK6E"
},
"LineItems": [
{
"Seller": {
"AuthorId": "user_m_01JZJ42M48CGJ19F2FS5WWKBNH",
"WalletId": "wlt_m_01JZ5STM3FDSC5G1WWVS4ZCZFJ",
"FeesAmount": 0
},
"Sku": "example-item-123",
"Name": "Example item name",
"Description": "Example item description",
"Quantity": 2,
"UnitAmount": 6000,
"TaxAmount": 0,
"DiscountAmount": 2000,
"Category": "Example category",
"ShippingAddress": {
"AddressLine1": "2226 Balistreri Roads",
"AddressLine2": null,
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
}
},
{
"Seller": {
"AuthorId": "user_m_01JZAXD3C31Y543SRKNCVK3V5N",
"WalletId": "wlt_m_01JZ8DKE83Y06860JZRKAM259V",
"FeesAmount": 0
},
"Sku": "example-item-456",
"Name": "Example item name",
"Description": "Example item description",
"Quantity": 1,
"UnitAmount": 10000,
"TaxAmount": 0,
"DiscountAmount": 0,
"Category": "Example category",
"ShippingAddress": {
"AddressLine1": "771 Koch Mews",
"AddressLine2": null,
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
}
}
]
}
Copy
Ask AI
{
"Id": "int_0197eebf-21fd-73c7-85ef-8193b4cf427d",
"Amount": 20000,
"AvailableAmountToSplit": 0,
"Currency": "EUR",
"PlatformFeesAmount": 0,
"Status": "AUTHORIZED",
"NextActions": "CAPTURED, PARTIALLY_CAPTURED, CANCELED",
"ExternalData": {
"ExternalProcessingDate": 1752057185,
"ExternalProviderReference": "auth-stripe-633781e6-bb10-4484-8a29-ff6da7d7464a",
"ExternalMerchantReference": "order-420bbe60-7f62-4e53-9d64-7cb5188c507f",
"ExternalProviderName": "Stripe",
"ExternalProviderPaymentMethod": "MASTERCARD"
},
"Buyer": {
"Id": "user_m_01JZB09HSDZRVN60QH1006TK6E"
},
"LineItems": [
{
"Seller": {
"AuthorId": "user_m_01JZJ42M48CGJ19F2FS5WWKBNH",
"WalletId": "wlt_m_01JZ5STM3FDSC5G1WWVS4ZCZFJ",
"FeesAmount": 0
},
"Id": "int_li_0197eebf-21fd-73c7-85ef-8193b4cf427e",
"Sku": "example-item-123",
"Name": "Example item name",
"Description": "Example item description",
"Quantity": 2,
"UnitAmount": 6000,
"TaxAmount": 0,
"DiscountAmount": 2000,
"Category": "Example category",
"ShippingAddress": {
"AddressLine1": "2226 Balistreri Roads",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"CapturedAmount": 0,
"RefundedAmount": 0,
"DisputedAmount": 0,
"SplitAmount": 0,
"TotalLineItemAmount": 10000
},
{
"Seller": {
"AuthorId": "user_m_01JZAXD3C31Y543SRKNCVK3V5N",
"WalletId": "wlt_m_01JZ8DKE83Y06860JZRKAM259V",
"FeesAmount": 0
},
"Id": "int_li_0197eebf-21fd-73c7-85ef-8193b4cf427f",
"Sku": "example-item-456",
"Name": "Example item name",
"Description": "Example item description",
"Quantity": 1,
"UnitAmount": 10000,
"TaxAmount": 0,
"DiscountAmount": 0,
"Category": "Example category",
"ShippingAddress": {
"AddressLine1": "771 Koch Mews",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"CapturedAmount": 0,
"RefundedAmount": 0,
"DisputedAmount": 0,
"SplitAmount": 0,
"TotalLineItemAmount": 10000
}
],
"CreationDate": 1752057192,
"ExecutionDate": 1752057192
}
Body parameters
The full amount authorized in the Intent, which must equal the sum of the total amounts of all
LineItems.The currency of the intent.
The amount of fees to be diverted to the platform’s Fees Wallet when the Intent is split. This value can be overridden when the Split is created.The
PlatformFees value must the sum of all line item Seller.FeesAmount values.Information about the transaction authorization processed by the third-party PSP.
Show child attributes
Show child attributes
The date at which the transaction authorization was created.
The unique identifier of the transaction at the provider level.
The unique identifier of the transaction at the merchant level.
The supported third-party PSP processing the transaction.
One of the supported payment methods used to process the transaction.
Information about the buyer.
Show child attributes
Show child attributes
If it exists, the unique identifier of the Mangopay user making the payment via the third-party PSP. Must be a valid Mangopay
UserId.Information about the items purchased in the transaction.The sum of all line item amounts must equal the Intent
Amount value. The total for each line items is calculated as ((UnitAmount x Quantity) - DiscountAmount), which is shown in the TotalLineItemAmount returned. The TaxAmount is indicative and included in the UnitAmount.The sum of all line item Seller.FeesAmount values must equal the Intent PlatformFees value.Show child attributes
Show child attributes
Information about the seller of the line item.
Show child attributes
Show child attributes
The unique identifier of the seller of the line item.Required if
WalletId not sent.The unique identifier of the wallet to credit the seller’s funds.Required if
AuthorId not sent.The amount of fees that will be diverted to the platform’s Fees Wallet when the Intent is split. This value can be overridden when the Split is created.
The future date when the funds are to be automatically transferred to the seller’s wallet.
The stock keeping unit (SKU) or other unique identifier of the item.
The name of the item.
The description of the item.
The number of units in the line item.
The cost of each unit, including
TaxAmount and excluding DiscountAmount.The amount of the
UnitAmount which is tax.The amount of discount applied to the item.
The category of the item, as defined by the platform.
Information about the shipping address.
Responses
200 - Response parameters
200 - Response parameters
The unique identifier of the intent.
The full amount authorized in the Intent, which must equal the sum of the total amounts of all
LineItems.The remaining amount of the Intent that can be split and transferred to the sellers’ wallets.
The currency of the intent.
The amount of fees to be diverted to the platform’s Fees Wallet when the Intent is split. This value can be overridden when the Split is created.The
PlatformFees value must the sum of all line item Seller.FeesAmount values.The status of the Intent:
AUTHORIZED– The IntentAmountwas authorized for acquisition by the PSP.PARTIALLY_CAPTURED– Part of the IntentAmountwas captured and is expected in a Settlement.CAPTURED– The full IntentAmountwas captured and is expected in a Settlement.CANCELED– Some or all of theAmountwas canceled.REFUNDED– Some or all of theAmountwas refunded.REFUND_REVERSED– The refund could not be completed and the funds were returned to the platform.DISPUTED– A dispute occurred on some or all of theAmount.DEFENDED– The disputed funds were returned to the platform temporarily until the dispute is resolved.DISPUTED_WON– The dispute was resolved in favor of the platform.DISPUTED_LOST– The dispute was resolved against the platform: funds permanently withdrawn to the buyer.
The possible next actions on the intent.
Information about the transaction authorization processed by the third-party PSP.
Show child attributes
Show child attributes
The date at which the transaction authorization was created.
The unique identifier of the transaction at the provider level.
The unique identifier of the transaction at the merchant level.
The supported third-party PSP processing the transaction.
One of the supported payment methods used to process the transaction.
Information about the buyer.
Show child attributes
Show child attributes
If it exists, the unique identifier of the Mangopay user making the payment via the third-party PSP. Must be a valid Mangopay
UserId.Information about the items purchased in the transaction.The sum of all line item amounts must equal the Intent
Amount value. The total for each line items is calculated as ((UnitAmount x Quantity) - DiscountAmount), which is shown in the TotalLineItemAmount returned. The TaxAmount is indicative and included in the UnitAmount.The sum of all line item Seller.FeesAmount values must equal the Intent PlatformFees value.Show child attributes
Show child attributes
Information about the seller of the line item.
Show child attributes
Show child attributes
The unique identifier of the seller of the line item.Required if
WalletId not sent.The unique identifier of the wallet to credit the seller’s funds.Required if
AuthorId not sent.The amount of fees that will be diverted to the platform’s Fees Wallet when the Intent is split. This value can be overridden when the Split is created.
The future date when the funds are to be automatically transferred to the seller’s wallet.
The unique identifier of the line item in Mangopay’s ecosystem.
The stock keeping unit (SKU) or other unique identifier of the item.
The name of the item.
The description of the item.
The number of units in the line item.
The cost of each unit, including
TaxAmount and excluding DiscountAmount.The amount of the
UnitAmount which is tax.The amount of discount applied to the line item.
The category of the item, as defined by the platform.
Information about the shipping address.
The total amount of the line item calculated as ((
UnitAmount x Quantity) - DiscountAmount).The item total
CANCELED amount.The item total
CAPTURED amountThe item total
REFUNDED amountThe item total
DISPUTED amount.The item total
COMPLETED amount.The date and time at which the Intent was created.
The date and time at which the Intent moved to
AUTHORIZED.400 - Intent Amount must equal sum of line items'
400 - Intent Amount must equal sum of line items'
Copy
Ask AI
{
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Id": "21d7dbc4-beea-4ad2-9f2a-471d683c25b5",
"Date": 1752053748,
"Type": "param_error",
"Errors": {
"Amount": "The total intent amount does not match the sum of the declared LineItem amounts"
}
}
Copy
Ask AI
{
"Id": "int_0197eebf-21fd-73c7-85ef-8193b4cf427d",
"Amount": 20000,
"AvailableAmountToSplit": 0,
"Currency": "EUR",
"PlatformFeesAmount": 0,
"Status": "AUTHORIZED",
"NextActions": "CAPTURED, PARTIALLY_CAPTURED, CANCELED",
"ExternalData": {
"ExternalProcessingDate": 1752057185,
"ExternalProviderReference": "auth-stripe-633781e6-bb10-4484-8a29-ff6da7d7464a",
"ExternalMerchantReference": "order-420bbe60-7f62-4e53-9d64-7cb5188c507f",
"ExternalProviderName": "Stripe",
"ExternalProviderPaymentMethod": "MASTERCARD"
},
"Buyer": {
"Id": "user_m_01JZB09HSDZRVN60QH1006TK6E"
},
"LineItems": [
{
"Seller": {
"AuthorId": "user_m_01JZJ42M48CGJ19F2FS5WWKBNH",
"WalletId": "wlt_m_01JZ5STM3FDSC5G1WWVS4ZCZFJ",
"FeesAmount": 0
},
"Id": "int_li_0197eebf-21fd-73c7-85ef-8193b4cf427e",
"Sku": "example-item-123",
"Name": "Example item name",
"Description": "Example item description",
"Quantity": 2,
"UnitAmount": 6000,
"TaxAmount": 0,
"DiscountAmount": 2000,
"Category": "Example category",
"ShippingAddress": {
"AddressLine1": "2226 Balistreri Roads",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"CapturedAmount": 0,
"RefundedAmount": 0,
"DisputedAmount": 0,
"SplitAmount": 0,
"TotalLineItemAmount": 10000
},
{
"Seller": {
"AuthorId": "user_m_01JZAXD3C31Y543SRKNCVK3V5N",
"WalletId": "wlt_m_01JZ8DKE83Y06860JZRKAM259V",
"FeesAmount": 0
},
"Id": "int_li_0197eebf-21fd-73c7-85ef-8193b4cf427f",
"Sku": "example-item-456",
"Name": "Example item name",
"Description": "Example item description",
"Quantity": 1,
"UnitAmount": 10000,
"TaxAmount": 0,
"DiscountAmount": 0,
"Category": "Example category",
"ShippingAddress": {
"AddressLine1": "771 Koch Mews",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"CapturedAmount": 0,
"RefundedAmount": 0,
"DisputedAmount": 0,
"SplitAmount": 0,
"TotalLineItemAmount": 10000
}
],
"CreationDate": 1752057192,
"ExecutionDate": 1752057192
}
Copy
Ask AI
{
"Amount": 20000,
"Currency": "EUR",
"PlatformFeesAmount": 0,
"ExternalData": {
"ExternalProcessingDate": 1752057185,
"ExternalProviderReference": "auth-stripe-633781e6-bb10-4484-8a29-ff6da7d7464a",
"ExternalMerchantReference": "order-420bbe60-7f62-4e53-9d64-7cb5188c507f",
"ExternalProviderName": "Stripe",
"ExternalProviderPaymentMethod": "MASTERCARD"
},
"Buyer": {
"Id": "user_m_01JZB09HSDZRVN60QH1006TK6E"
},
"LineItems": [
{
"Seller": {
"AuthorId": "user_m_01JZJ42M48CGJ19F2FS5WWKBNH",
"WalletId": "wlt_m_01JZ5STM3FDSC5G1WWVS4ZCZFJ",
"FeesAmount": 0
},
"Sku": "example-item-123",
"Name": "Example item name",
"Description": "Example item description",
"Quantity": 2,
"UnitAmount": 6000,
"TaxAmount": 0,
"DiscountAmount": 2000,
"Category": "Example category",
"ShippingAddress": {
"AddressLine1": "2226 Balistreri Roads",
"AddressLine2": null,
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
}
},
{
"Seller": {
"AuthorId": "user_m_01JZAXD3C31Y543SRKNCVK3V5N",
"WalletId": "wlt_m_01JZ8DKE83Y06860JZRKAM259V",
"FeesAmount": 0
},
"Sku": "example-item-456",
"Name": "Example item name",
"Description": "Example item description",
"Quantity": 1,
"UnitAmount": 10000,
"TaxAmount": 0,
"DiscountAmount": 0,
"Category": "Example category",
"ShippingAddress": {
"AddressLine1": "771 Koch Mews",
"AddressLine2": null,
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
}
}
]
}
Was this page helpful?
Assistant
Responses are generated using AI and may contain mistakes.