--- title: "View an Intent" method: GET path: "/v3.0/{ClientId}/payins/intents/{IntentId}" tags: ["Intents"] --- # View an Intent `GET /v3.0/{ClientId}/payins/intents/{IntentId}` Retrieve the declaration of a transaction processed by a third-party PSP ## Path parameters - `ClientId` string, required - `IntentId` string, required ## Headers - `Authorization` string, required ## Response `200` Success - ViewAnIntentResponse - `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` string — The currency of the intent. - `PlatformFeesAmount` 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 `PlatformFeesAmount` 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` ExternalProcessingDateExternalProviderReferenceExternalMerchantReference — Information about the transaction authorization processed by the third-party PSP. - `ExternalProcessingDate` integer — 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](/api-reference/echo/supported-providers) processing the transaction. **Note:** The uppercase value is expected. The API returns the sentence-case value. - `ExternalProviderPaymentMethod` string — One of the [supported payment methods](/api-reference/echo/supported-payment-methods) used to process the transaction. - `Buyer` BuyerId — 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` LineItemsIntent[] — Information about the items purchased in the transaction. A maximum of 100 line items can be created per Intent. 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 `PlatformFeesAmount` value. - `Seller` AuthorIdWalletIdFeesAmount — 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` integer — 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` LineItemsIntentShippingAddress — 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 — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) 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` ViewAnIntentResponseCapturesItems[] — 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](/api-reference/settlements/create-settlement) endpoint. - `PAID` – The funds were received on the platform's technical wallet. - `LineItems` ViewAnIntentResponseCapturesItemsLineItemsItems[] — 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` integer — Unix timestamp (UTC) of the date and time the Capture was created. - `ExecutionDate` integer — The date at which the object was successfully moved to `CAPTURED`. - `Tag` string — Max. length: 255 characters Custom data that you can add to this object. - `Refunds` ViewAnIntentResponseRefundsItems[] — 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` ViewAnIntentResponseRefundsItemsLineItemsItems[] — 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` integer — Unix timestamp (UTC) of the date and time the Refund was created. - `ExecutionDate` integer — The date at which the object was successfully moved to `REFUNDED`. - `Tag` string — Max. length: 255 characters Custom data that you can add to this object. - `Disputes` ViewAnIntentResponseDisputesItems[] — 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` ViewAnIntentResponseDisputesItemsLineItemsItems[] — 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` integer — Unix timestamp (UTC) of the date and time the Dispute was created. - `ExecutionDate` integer — The date at which the object was successfully moved to `DISPUTED`. - `Tag` string — Max. length: 255 characters Custom data that you can add to this object. - `Cancels` ViewAnIntentResponseCancelsItems[] — Information about the amounts Canceled in the Intent. - `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` ViewAnIntentResponseCancelsItemsLineItemsItems[] — 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` integer — Unix timestamp (UTC) of the date and time the Cancel was created. - `ExecutionDate` integer — The date at which the object was successfully moved to `CANCELLED`. - `Splits` ViewAnIntentResponseSplitsItems[] — 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` – The Split was successfully declared via the API but it is not yet confirmed whether the funds for the parent Intent are available. - `PENDING_FUNDS_RECEPTION` – The Split is linked to an Intent that has been reconciled with a settlement file. The system is waiting for the funds to be confirmed in the technical wallet. - `AVAILABLE` – The funds for the parent Intent have been received and confirmed. The Split is ready to be executed. - `PENDING` – The Split execution has been initiated and is being processed. - `COMPLETED` – The transfer was successful and the funds have been moved to the seller's wallet. - `REJECTED` – The Split execution failed immediately due to a synchronous error (e.g. invalid wallet ID). The platform can retry execution or reverse the Split. - `FAILED` – The Split execution was initiated but the transfer failed due to an asynchronous error (e.g. insufficient funds in the source wallet). A new Split must be created to retry. - `REVERSED` – The Split was canceled by the platform while in `AVAILABLE` or `REJECTED` status. - `REFUND_SPLIT_PENDING` – A refund has been declared on the parent Intent and the refund of this Split is pending. - `REFUND_SPLIT_REJECTED` – The refund of this Split was rejected. - `REFUND_SPLIT_COMPLETED` – The refund of this Split was completed successfully. - `LineItems` ViewAnIntentResponseSplitsItemsLineItemsItems[] — Information about the line items in the Split. - `Id` string — The unique identifier of the line item. - `Amount` integer — The amount of the line item. - `CreationDate` integer — Unix timestamp (UTC) of the date and time the Split was created. - `ExecutionDate` integer — The date at which the Split status became `COMPLETED`. - `CreationDate` integer — Unix timestamp (UTC) of the date and time the object was created. - `ExecutionDate` integer — Unix timestamp (UTC) of the date and time the Intent moved to `AUTHORIZED`. - `Tag` string — Max. length: 255 characters Custom data that you can add to this object. - `SettlementIds` 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](/api-reference/settlements/create-settlement). ## Changes - **2026-07-26** `795281070285` — 4 info - added the optional property `Captures/items/Tag` to the response with the `200` status - added the optional property `Disputes/items/Tag` to the response with the `200` status - added the optional property `Refunds/items/Tag` to the response with the `200` status - added the optional property `Tag` to the response with the `200` status [Change history](https://skmtc.dev/mangopay/apis/api-reference/changes/v3.0/:ClientId/payins/intents/:IntentId/get.md) --- [API](https://skmtc.dev/mangopay/apis/api-reference.md) · [All operations](https://skmtc.dev/mangopay/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mangopay/api-reference/revisions/fafbd0c69654/schema)