Intent object example
{
    "Id": "int_01980d51-ee76-7841-a98f-009e98d2def2",
    "Amount": 20000,
    "AvailableAmountToSplit": 20000,
    "Currency": "EUR",
    "PlatformFeesAmount": 0,
    "Status": "CAPTURED",
    "NextActions": "REFUND, DISPUTE",
    "ExternalData": {
        "ExternalProcessingDate": 1752439988,
        "ExternalProviderReference": "auth-stripe-da46c083-ef83-438d-ae4f-d8d2cf0cbca0",
        "ExternalMerchantReference": "order-7f3234ad-f0c5-4a66-98ac-83e37cada65b",
        "ExternalProviderName": "Stripe",
        "ExternalProviderPaymentMethod": "MASTERCARD"
    },
    "Buyer": {
        "Id": "user_m_01JZB09HSDZRVN60QH1006TK6E"
    },
    "LineItems": [
        {
            "Seller": {
                "AuthorId": "user_m_01JZWV35ZQZF8T9BYQ3494N4R7",
                "WalletId": "wlt_m_01JZ5STM3FDSC5G1WWVS4ZCZFJ",
                "FeesAmount": 0
            },
            "Id": "int_li_01980d51-ee78-717a-93ef-9ebe5a7f070d",
            "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": "00920 Bahringer Fields",
                "City": "Paris",
                "Region": "Ile de France",
                "PostalCode": "75001",
                "Country": "FR"
            },
            "CapturedAmount": 10000,
            "RefundedAmount": 0,
            "DisputedAmount": 0,
            "SplitAmount": 0,
            "TotalLineItemAmount": 10000
        },
        {
            "Seller": {
                "AuthorId": "user_m_01JZT2D6QQMS45JDR213A3FWF8",
                "WalletId": "wlt_m_01JZ8DKE83Y06860JZRKAM259V",
                "FeesAmount": 0
            },
            "Id": "int_li_01980d51-ee78-717a-93ef-9ebe5a7f070e",
            "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": "5997 Miller Oval",
                "City": "Paris",
                "Region": "Ile de France",
                "PostalCode": "75001",
                "Country": "FR"
            },
            "CapturedAmount": 10000,
            "RefundedAmount": 0,
            "DisputedAmount": 0,
            "SplitAmount": 0,
            "TotalLineItemAmount": 10000
        }
    ],
    "Captures": [
        {
            "Id": "int_capture_01980d51-faba-764a-b95f-deba3a1128be",
            "Amount": 20000,
            "Status": "SETTLED_NOT_PAID",
            "LineItems": [
                {
                    "Id": "int_li_01980d51-ee78-717a-93ef-9ebe5a7f070d",
                    "Amount": 10000
                },
                {
                    "Id": "int_li_01980d51-ee78-717a-93ef-9ebe5a7f070e",
                    "Amount": 10000
                }
            ],
            "CreationDate": 1752570133,
            "ExecutionDate": 1752570982
        }
    ],
    "Refunds": [],
    "Disputes": [],
    "Splits": [],
    "CreationDate": 1752570130,
    "ExecutionDate": 1752570133,
    "SettlementId": "int_stlmnt_01980d5e-dea1-7828-b7ba-bf1772d6abf2"
}

The Intent object represents the declaration of a payment authorization made via a third-party PSP.

Read more about Mangopay Echo →

​
Attributes

​
Id
string

The unique identifier of the intent.

​
Amount
integer

The full amount authorized in the Intent, which must equal the sum of the total amounts of all LineItems.

​
AvailableAmountToSplit
integer

The remaining amount of the Intent that can be split and transferred to the sellers’ wallets.

​
Currency
integer

The currency of the intent.

​
PlatformFees
integer

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.

​
Status
string

The status of the Intent:

  • AUTHORIZED – The Intent Amount was authorized for acquisition by the PSP.
  • PARTIALLY_CAPTURED – Part of the Intent Amount was captured and is expected in a Settlement.
  • CAPTURED – The full Intent Amount was captured and is expected in a Settlement.
  • CANCELED – Some or all of the Amount was canceled.
  • REFUNDED – Some or all of the Amount was 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 the Amount.
  • 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.
​
NextActions
string

The possible next actions on the intent.

​
ExternalData
object

Information about the transaction authorization processed by the third-party PSP.

​
Buyer
object

Information about the buyer.

​
LineItems
array (object)

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.

​
CreationDate
string

The date and time at which the Intent was created.

​
ExecutionDate
Unix timestamp

The date and time at which the Intent moved to AUTHORIZED.

​
Captures
array (object)

Information about the amounts captured against the Intent.

​
Refunds
array (object)

Information about the amounts refunded against the intent

​
Disputes
array (object)

Information about the disputes created against against the intent

​
Splits
array (object)

Information about the amounts split against the intent

​
SettlementId
string

The unique identifier of the Settlement linked to this Intent, if one has been successfully created by uploading a settlement file to POST Create a Settlement.