--- title: "Create an Intent Refund" method: POST path: "/v3.0/{ClientId}/payins/intents/{IntentId}/refunds" tags: ["Intents"] --- # Create an Intent Refund `POST /v3.0/{ClientId}/payins/intents/{IntentId}/refunds` Declare the full or partial refund of a payment processed by a third-party PSP, represented by an Intent Refund. ## Path parameters - `ClientId` string, required - `IntentId` string, required ## Headers - `Authorization` string, required ## Request body - CreateAnIntentRefundRequest - `ExternalData` ExternalProcessingDateExternalProviderReferenceExternalMerchantReference2 — Information about the transaction authorization processed by the third-party PSP. - `ExternalProcessingDate` integer, required — The date at which the transaction authorization was created. - `ExternalProviderReference` string, required — The unique identifier of the transaction at the provider level. - `ExternalMerchantReference` string — The unique identifier of the transaction at the merchant level. - `ExternalProviderName` string, required — 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. - `Amount` integer — The amount of the Refund, required for a partial refund. The Refund `Amount` must equal the sum of the `Amount` values refunded for all line items. - `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. - `LineItems` CreateAnIntentRefundRequestLineItemsItems[] — Information about the amount refunded for each line item, required for a partial refund. - `Id` string, required — The unique identifier of the line item in Mangopay ecosystem. - `Amount` integer, required — The amount of the refund. The sum of the Refund's `LineItems.Amount` values must equal the `Amount` of the Refund. - `Tag` string — Max. length: 255 characters Custom data that you can add to this object. ## Response `200` Success - IntentRefundResponse - `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` IdTotalLineItemAmountCapturedAmount[] — Information about the line items included in the intent action. - `Id` string — The unique identifier of the line item in Mangopay's ecosystem. - `TotalLineItemAmount` integer — The total amount of the line item calculated as ((`UnitAmount` x `Quantity`) - `DiscountAmount`). - `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. - `UnfundedSellerAmount` integer — The amount needing to be settled to the Platform's technical wallet before the Intent Splits can be executed for this seller. - `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`. - `Refund` IdIntentRefund — Information about the Refund. - `Id` string — The unique identifier of the Refund. ## Changes - **2026-07-26** `795281070285` — 1 info - added the new optional request property `Tag` [Change history](https://skmtc.dev/mangopay/apis/api-reference/changes/v3.0/:ClientId/payins/intents/:IntentId/refunds/post.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/956211a94070/schema)