View an Intent

Retrieve the declaration of a transaction processed by a third-party PSP

GET /v3.0/{ClientId}/payins/intents/{IntentId}

REST

// GET has no body parameters

Authorized

{
    "Id": "int_019bfa4f-60ba-7842-89c0-382066c072f1",
    "Amount": 20000,
    "AvailableAmountToSplit": 0,
    "UnfundedAmount": 0,
    "Currency": "EUR",
    "PlatformFeesAmount": 0,
    "Status": "AUTHORIZED",
    "NextActions": "",
    "ExternalData": {
        "ExternalProcessingDate": 1769431064,
        "ExternalProviderReference": "auth-stripe-36e34fd5-512f-4fb6-b4c2-3084ba3cd947",
        "ExternalMerchantReference": "order-a790c539-9c63-4166-8595-7b78f06e9215",
        "ExternalProviderName": "Stripe",
        "ExternalProviderPaymentMethod": "MASTERCARD"
    },
    "Buyer": {
        "Id": "user_m_01KF3087EDXEAK8VPD9DTMZW8N"
    },
    "LineItems": [
        {
            "Seller": {
                "AuthorId": "user_m_01JH2Z9GXCCHGFN65T5HDZG4GB",
                "WalletId": "wlt_m_01KEYE9ZRT7E1Y8QQF7JKYXMXF",
                "FeesAmount": 0
            },
            "Id": "int_li_019bfa4f-60c5-7306-b993-bf38153edb6f",
            "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": "7765 Cameron Points",
                "City": "Paris",
                "Region": "Ile de France",
                "PostalCode": "75001",
                "Country": "FR"
            },
            "CapturedAmount": 0,
            "RefundedAmount": 0,
            "DisputedAmount": 0,
            "SplitAmount": 0,
            "CancelledAmount": 0,
            "TotalLineItemAmount": 10000,
            "UnfundedSellerAmount": 0
        },
        {
            "Seller": {
                "AuthorId": "user_m_01KF3GT68HDXZ4PX9R4XV4E11P",
                "WalletId": "wlt_m_01K3K8QFMNRKSNED3S3EN8EF2X",
                "FeesAmount": 0
            },
            "Id": "int_li_019bfa4f-60c5-7306-b993-bf38153edb70",
            "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": "181 Griffin Glens",
                "City": "Paris",
                "Region": "Ile de France",
                "PostalCode": "75001",
                "Country": "FR"
            },
            "CapturedAmount": 0,
            "RefundedAmount": 0,
            "DisputedAmount": 0,
            "SplitAmount": 0,
            "CancelledAmount": 0,
            "TotalLineItemAmount": 10000,
            "UnfundedSellerAmount": 0
        }
    ],
    "Captures": [],
    "Refunds": [],
    "Disputes": [],
    "Cancels": [],
    "Splits": [],
    "CreationDate": 1769431064,
    "ExecutionDate": 1769431064,
    "SettlementIds": []
}

Path parameters

IntentId · string · required

The unique identifier of the Intent.

Responses

200 - Response parameters

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.

Show child attributes

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.

Show child attributes

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.

Show child attributes

Seller · object

Information about the seller of the line item.

Show child attributes

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.

Show child attributes

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.

Captures · array (object)

Information about the amounts captured against the Intent.

Show child attributes

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.

Show child attributes

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.

Show child attributes

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.

Show child attributes

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.

Show child attributes

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.

Show child attributes

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.

Cancels · array (object)

Information about the amounts Canceled in the Intent.

Show child attributes

Id · string

The unique identifier of the Cancel.

Amount · integer

The amount of the Cancel.

Status · string

The status of the Intent Cancel:

• CANCELLED – The transaction authorized was canceled and its funds are not expected on the platform’s technical wallet.

LineItems · array (object)

Information about the line items in the Capture.

Show child attributes

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 Cancel was created.

ExecutionDate · Unix timestamp

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

Splits · array (object)

Information about the Splits created against the Intent.

Show child attributes

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.

Show child attributes

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.

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.

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.

Authorized

{
    "Id": "int_019bfa4f-60ba-7842-89c0-382066c072f1",
    "Amount": 20000,
    "AvailableAmountToSplit": 0,
    "UnfundedAmount": 0,
    "Currency": "EUR",
    "PlatformFeesAmount": 0,
    "Status": "AUTHORIZED",
    "NextActions": "",
    "ExternalData": {
        "ExternalProcessingDate": 1769431064,
        "ExternalProviderReference": "auth-stripe-36e34fd5-512f-4fb6-b4c2-3084ba3cd947",
        "ExternalMerchantReference": "order-a790c539-9c63-4166-8595-7b78f06e9215",
        "ExternalProviderName": "Stripe",
        "ExternalProviderPaymentMethod": "MASTERCARD"
    },
    "Buyer": {
        "Id": "user_m_01KF3087EDXEAK8VPD9DTMZW8N"
    },
    "LineItems": [
        {
            "Seller": {
                "AuthorId": "user_m_01JH2Z9GXCCHGFN65T5HDZG4GB",
                "WalletId": "wlt_m_01KEYE9ZRT7E1Y8QQF7JKYXMXF",
                "FeesAmount": 0
            },
            "Id": "int_li_019bfa4f-60c5-7306-b993-bf38153edb6f",
            "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": "7765 Cameron Points",
                "City": "Paris",
                "Region": "Ile de France",
                "PostalCode": "75001",
                "Country": "FR"
            },
            "CapturedAmount": 0,
            "RefundedAmount": 0,
            "DisputedAmount": 0,
            "SplitAmount": 0,
            "CancelledAmount": 0,
            "TotalLineItemAmount": 10000,
            "UnfundedSellerAmount": 0
        },
        {
            "Seller": {
                "AuthorId": "user_m_01KF3GT68HDXZ4PX9R4XV4E11P",
                "WalletId": "wlt_m_01K3K8QFMNRKSNED3S3EN8EF2X",
                "FeesAmount": 0
            },
            "Id": "int_li_019bfa4f-60c5-7306-b993-bf38153edb70",
            "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": "181 Griffin Glens",
                "City": "Paris",
                "Region": "Ile de France",
                "PostalCode": "75001",
                "Country": "FR"
            },
            "CapturedAmount": 0,
            "RefundedAmount": 0,
            "DisputedAmount": 0,
            "SplitAmount": 0,
            "CancelledAmount": 0,
            "TotalLineItemAmount": 10000,
            "UnfundedSellerAmount": 0
        }
    ],
    "Captures": [],
    "Refunds": [],
    "Disputes": [],
    "Cancels": [],
    "Splits": [],
    "CreationDate": 1769431064,
    "ExecutionDate": 1769431064,
    "SettlementIds": []
}

REST

// GET has no body parameters