EchoIntents

The Intent object

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.

UnfundedAmount
integer

The amount needing to be settled to the Platform’s technical wallet before the Intent Splits can be executed.

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, as declared by the platform through Intent Captures, Refunds (and reversals), or Disputes (and decisions). Where partial actions occur, the top-level Intent Status may differ from the Status of Intent LineItems.

Intent Status values:

  • AUTHORIZED – The Intent Amount was authorized for acquisition by the PSP and can be captured or canceled.
  • PARTIALLY_CAPTURED – Part of the Intent Amount from one or more LineItems was captured. The other parts are either still available for capture or cancel.
  • CAPTURED – All of the Intent Amount was captured. Part of it may have been subsequently refunded or disputed.
  • CANCELLED – All of the Intent Amount was canceled.
  • REFUNDED – All of the CapturedAmount of all LineItems was refunded.
  • REFUND_REVERSED – The refund could not be completed and the funds were returned to the platform.
  • DISPUTED – All of the CapturedAmount of all LineItems was disputed.
  • DEFENDED – The dispute is being defended by the platform.
  • DISPUTED_WON – The dispute was resolved in favor of the platform.
  • DISPUTED_LOST – The dispute was resolved against the platform.
NextActions
string

The possible next actions on the intent.

ExternalData
object

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

ExternalProcessingDate
Unix timestamp

The date at which the transaction authorization was created.

ExternalProviderReference
string

The unique identifier of the transaction at the provider level.

ExternalMerchantReference
string

The unique identifier of the transaction at the merchant level.

ExternalProviderName
string

The supported third-party PSP processing the transaction.

Note: The uppercase value is expected. The API returns the sentence-case value.

ExternalProviderPaymentMethod
string

One of the supported payment methods used to process the transaction.

Buyer
object

Information about the buyer.

Id
string

If it exists, the unique identifier of the Mangopay user making the payment via the third-party PSP. Must be a valid Mangopay UserId.

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.

Seller
object

Information about the seller of the line item.

AuthorId
string

The unique identifier of the seller of the line item.

Required if WalletId not sent.

WalletId
string

The unique identifier of the wallet to credit the seller’s funds.

Required if AuthorId not sent.

FeesAmount
integer

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.

TransferDate
Unix timestamp

The future date when the funds are to be automatically transferred to the seller’s wallet.

Id
string

The unique identifier of the line item in Mangopay’s ecosystem.

Sku
string

The stock keeping unit (SKU) or other unique identifier of the item.

Name
string

The name of the item.

Description
string

The description of the item.

Quantity
integer

The number of units in the line item.

UnitAmount
integer

The cost of each unit, including TaxAmount and excluding DiscountAmount.

TaxAmount
integer

The amount of the UnitAmount which is tax.

DiscountAmount
integer

The amount of discount applied to the line item.

Category
string

The category of the item, as defined by the platform.

ShippingAddress
object

Information about the shipping address.

AddressLine1
string

The first line of the address.

AddressLine2
string

The second line of the address.

City
string

The city of the address

Region
string

The region of the address.

PostalCode
string

The postal code of the address

Country
string

The country of the address

CapturedAmount
integer

The item total CAPTURED amount

RefundedAmount
integer

The item total REFUNDED amount

DisputedAmount
integer

The item total DISPUTED amount.

SplitAmount
integer

The item total COMPLETED amount.

CancelledAmount
integer

The item total CANCELLED amount.

TotalLineItemAmount
integer

The total amount of the line item calculated as ((UnitAmount x Quantity) - DiscountAmount).

UnfundedSellerAmount
integer

The amount needing to be settled to the Platform’s technical wallet before the Intent Splits can be executed for this seller.

SplitOriginWalletId
string

The unique identifier of the wallet from which the split will be debited.

This parameter is required for Intents where ExternalProviderName is Mangopay. If it is not defined in the Intent it must be defined at Split creation.

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.

Id
string

The unique identifier of the Capture.

Amount
integer

The amount of the Capture.

Status
string

The status of the Intent Capture:

  • CAPTURED – The funds have been acquired by the third-party PSP and are expected on the technical wallet.
  • SETTLED_NOT_PAID – The transaction was included in a settlement file successfully uploaded by the platform using the POST Create a Settlement endpoint.
  • PAID – The funds were received on the platform’s technical wallet.
LineItems
array (object)

Information about the line items in the Capture.

Id
string

The unique identifier of the line item.

Amount
integer

The amount of the line item.

CreationDate
Unix timestamp

The date and time at which the Capture was created.

ExecutionDate
Unix timestamp

The date at which the object was successfully moved to CAPTURED.

Refunds
array (object)

Information about the Refunds created against the Intent.

Id
string

The unique identifier of the Refund.

Amount
integer

The amount of the Refund.

Status
string

The status of the Intent Refund:

  • REFUNDED – The funds were subject to a refund are not expected on the technical wallet.
  • REFUND_REVERSED – The refund could not be completed: the funds were returned to the platform and are expected on the technical wallet.
LineItems
array (object)

Information about the line items in the Refund.

Id
string

The unique identifier of the line item.

Amount
integer

The amount of the line item.

CreationDate
Unix timestamp

The date and time at which the Refund was created.

ExecutionDate
Unix timestamp

The date at which the object was successfully moved to REFUNDED.

Disputes
array (object)

Information about the Disputes created against against the Intent.

Id
string

The unique identifier of the Dispute.

Amount
integer

The amount of the Dispute.

Status
string

The status of the Intent Dispute:

  • NEEDS_RESPONSE – The outcome of the dispute has not been declared by the platform.
  • DEFENDED – The dispute is being defended and the funds may have been returned to the platform temporarily, but they are not expected on the technical wallet.
  • DISPUTED_WON – The dispute was resolved in favor of the platform and the funds are expected on the technical wallet.
  • DISPUTED_LOST – The dispute was ruled against the platform and the funds were returned to the user.
LineItems
array (object)

Information about the line items in the Dispute.

Id
string

The unique identifier of the line item.

Amount
integer

The amount of the line item.

CreationDate
Unix timestamp

The date and time at which the Dispute was created.

ExecutionDate
Unix timestamp

The date at which the object was successfully moved to DISPUTED.

Splits
array (object)

Information about the Splits created against the Intent.

Id
string

The unique identifier of the Split.

Amount
integer

The amount of the Split.

Status
string

The status of the Split:

  • CREATED
  • PENDING_FUNDS_RECEPTION
  • AVAILABLE
  • PENDING
  • COMPLETED
  • REJECTED
  • FAILED
  • REVERSED
  • REFUND_SPLIT_PENDING
  • REFUND_SPLIT_REJECTED
  • REFUND_SPLIT_COMPLETED
LineItems
array (object)

Information about the line items in the Split.

Id
string

The unique identifier of the line item.

Amount
integer

The amount split for the line item.

CreationDate
Unix timestamp

The date and time at which the Split was created.

ExecutionDate
Unix timestamp

The date at which the object was successfully moved to CREATED.

SettlementIds
array (string)

The unique identifier of the Settlement(s) linked to this Intent, if successfully created by uploading a settlement file to POST Create a Settlement.

Intent object example
1{
2    "Id": "int_0198f0f0-471f-7f1b-8f79-483ab735c6d9",
3    "Amount": 20000,
4    "AvailableAmountToSplit": 20000,
5    "UnfundedAmount": 0,
6    "Currency": "EUR",
7    "PlatformFeesAmount": 0,
8    "Status": "CAPTURED",
9    "NextActions": "REFUND, DISPUTE",
10    "ExternalData": {
11        "ExternalProcessingDate": 1754489100,
12        "ExternalProviderReference": "auth-stripe-76f0baab-3d89-47e4-85f6-417864588055",
13        "ExternalMerchantReference": "order-390ca7c3-9e5f-4814-bb6a-c5ef6fd74c47",
14        "ExternalProviderName": "Stripe",
15        "ExternalProviderPaymentMethod": "MASTERCARD"
16    },
17    "Buyer": {
18        "Id": "user_m_01K3QXQEA1N0SYR7CFH82WHYWZ"
19    },
20    "LineItems": [
21        {
22            "Seller": {
23                "AuthorId": "user_m_01JH2Z9GXCCHGFN65T5HDZG4GB",
24                "WalletId": "wlt_m_01K3K8GR95Q64RPM4F6F1E5FVB",
25                "FeesAmount": 0
26            },
27            "Id": "int_li_0198f0f0-4720-79d1-ad7f-7f34c5d7fb48",
28            "Sku": "example-item-123",
29            "Name": "Example item name",
30            "Description": "Example item description",
31            "Quantity": 2,
32            "UnitAmount": 6000,
33            "TaxAmount": 0,
34            "DiscountAmount": 2000,
35            "Category": "Example category",
36            "ShippingAddress": {
37                "AddressLine1": "550 Vincent Stream",
38                "City": "Paris",
39                "Region": "Ile de France",
40                "PostalCode": "75001",
41                "Country": "FR"
42            },
43            "CapturedAmount": 10000,
44            "RefundedAmount": 0,
45            "DisputedAmount": 0,
46            "SplitAmount": 0,
47            "CancelledAmount": 0,
48            "TotalLineItemAmount": 10000,
49            "UnfundedSellerAmount": 0
50        },
51        {
52            "Seller": {
53                "AuthorId": "user_m_01K3QXPKSXPXETQQX92M5TH66K",
54                "WalletId": "wlt_m_01K3NXMX4WXNSQPDJR0JQ4TKVD",
55                "FeesAmount": 0
56            },
57            "Id": "int_li_0198f0f0-4720-79d1-ad7f-7f34c5d7fb49",
58            "Sku": "example-item-456",
59            "Name": "Example item name",
60            "Description": "Example item description",
61            "Quantity": 1,
62            "UnitAmount": 10000,
63            "TaxAmount": 0,
64            "DiscountAmount": 0,
65            "Category": "Example category",
66            "ShippingAddress": {
67                "AddressLine1": "16586 Matt Points",
68                "City": "Paris",
69                "Region": "Ile de France",
70                "PostalCode": "75001",
71                "Country": "FR"
72            },
73            "CapturedAmount": 10000,
74            "RefundedAmount": 0,
75            "DisputedAmount": 0,
76            "SplitAmount": 0,
77            "CancelledAmount": 0,
78            "TotalLineItemAmount": 10000,
79            "UnfundedSellerAmount": 0
80        }
81    ],
82    "Captures": [
83        {
84            "Id": "int_capture_0198f0f0-54c9-7821-aa58-9ea99c19cac3",
85            "Amount": 20000,
86            "Status": "SETTLED_NOT_PAID",
87            "LineItems": [
88                {
89                    "Id": "int_li_0198f0f0-4720-79d1-ad7f-7f34c5d7fb48",
90                    "Amount": 10000
91                },
92                {
93                    "Id": "int_li_0198f0f0-4720-79d1-ad7f-7f34c5d7fb49",
94                    "Amount": 10000
95                }
96            ],
97            "CreationDate": 1756388938,
98            "ExecutionDate": 1756389033
99        }
100    ],
101    "Refunds": [],
102    "Disputes": [],
103    "Splits": [
104        {
105            "Id": "int_split_0198f124-ea93-786c-b7f1-40c465efacca",
106            "Amount": 5000,
107            "Status": "PENDING_FUNDS_RECEPTION",
108            "LineItems": [
109                {
110                    "Id": "int_li_0198f0f0-4720-79d1-ad7f-7f34c5d7fb48",
111                    "Amount": 5000
112                }
113            ],
114            "CreationDate": 1756392385,
115            "ExecutionDate": 1756392385
116        },
117        {
118            "Id": "int_split_0198f124-ea93-786c-b7f1-40c465efaccb",
119            "Amount": 5000,
120            "Status": "PENDING_FUNDS_RECEPTION",
121            "LineItems": [
122                {
123                    "Id": "int_li_0198f0f0-4720-79d1-ad7f-7f34c5d7fb49",
124                    "Amount": 5000
125                }
126            ],
127            "CreationDate": 1756392385,
128            "ExecutionDate": 1756392385
129        }
130    ],
131    "CreationDate": 1756388935,
132    "ExecutionDate": 1756388938,
133    "SettlementIds": [
134        "int_stlmnt_0198f0f1-b3ac-7635-baa3-0ab1dff2ea3a"
135    ]
136}