Create a Transfer

POST

/v2.01/:ClientId/transfers

POST

/v2.01/:ClientId/transfers

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/transfers \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "ScaContext": "USER_PRESENT",
>     "AuthorId": "user_m_01JRJM5RR5NYQDN0S6QWJJDRMR",
>     "DebitedFunds": {
>       "Currency": "EUR",
>       "Amount": 3001
>     },
>     "Fees": {
>       "Currency": "EUR",
>       "Amount": 0
>     },
>     "DebitedWalletId": "wlt_m_01JRJM7ASZN7YP4MBDVBT0HZF1",
>     "CreditedWalletId": "wlt_m_01JRHSTW2NP4MDB45WQMDNS23C",
>     "Tag": "Created using Mangopay API Postman Collection"
>   }
> }'

1 {
2   "ScaContext": "USER_PRESENT",
3   "Id": "xfer_c_01JRSHQFG2337DBQ4NS8XPYCK7",
4   "Tag": "Created using Mangopay API Postman Collection",
5   "DebitedFunds": {
6     "Currency": "EUR",
7     "Amount": 3001
8   },
9   "CreditedFunds": {
10     "Currency": "EUR",
11     "Amount": 3001
12   },
13   "Fees": {
14     "Currency": "EUR",
15     "Amount": 0
16   },
17   "Status": "CREATED",
18   "ResultCode": null,
19   "ResultMessage": null,
20   "ExecutionDate": null,
21   "Type": "TRANSFER",
22   "Nature": "REGULAR",
23   "DebitedWalletId": "wlt_m_01JRJM7ASZN7YP4MBDVBT0HZF1",
24   "CreditedWalletId": "wlt_m_01JRHSTW2NP4MDB45WQMDNS23C",
25   "PendingUserAction": {
26     "RedirectUrl": "https://sca.sandbox.mangopay.com/?token=sca_0196331bc1247e3fa33be6f9c797abd7"
27   },
28   "CreationDate": 1744614179,
29   "AuthorId": "user_m_01JRJM5RR5NYQDN0S6QWJJDRMR",
30   "CreditedUserId": "user_m_01JRHSS3B18H86QA0C467RVK07"
31 }

Caution - ScaContext default value changing

On this endpoint, the default value for ScaContext is changing to USER_PRESENT on Dec 15, 2025 (Dec 1 in Sandbox).

From this date, if the PendingUserAction.RedirectUrl value is returned, then you need to redirect the user to perform SCA.

With approval from Mangopay, your platform may be able to use the USER_NOT_PRESENT value provided you also have a legal proxy in place with the user and the user’s consent to initiate transfers on their behalf (read more about proxy management).

Note – SCA may be triggered by this endpoint

When a user with UserCategory OWNER initiates a transfer to another OWNER they are required to authenticate the transfer with SCA, unless Mangopay applies a low-amount or low-risk exemption to the transfer (or unless your platform is using a proxy and user consent).

To let the user complete the SCA session on the Mangopay-hosted webpage, your platform needs to retrieve the returned PendingUserAction.RedirectUrl, add an encoded returnUrl query parameter, and redirect the user. Read more about how to redirect them in the SCA session guide.

In Sandbox, you can bypass SCA by including the word accept in the Email value of the Natural User or the LegalRepresentative.Email value of the Legal User – for example accept@example.com or john.doe+accept@example.com.

Create a Transfer

<Warning icon="fa-regular fa-triangle-exclamation"> **Caution - ScaContext default value changing** On this endpoint, the default value for `ScaContext` is changing to `USER_PRESENT` on **Dec 15, 2025** (Dec 1 in Sandbox). From this date, if the `PendingUserAction.RedirectUrl` value is returned, then you need to redirect the user to perform SCA. With approval from Mangopay, your platform may be able to use the `USER_NOT_PRESENT` value provided you also have a legal proxy in place with the user and the user's consent to initiate transfers on their behalf (read more about [proxy management](/guides/sca/proxy-management)). </Warning> <Note icon="fa-regular fa-circle-info"> **Note – SCA may be triggered by this endpoint** When a user with `UserCategory` `OWNER` initiates a transfer to another `OWNER` they are required to [authenticate the transfer with SCA](/guides/sca/transfers), unless Mangopay applies a [low-amount or low-risk exemption](/guides/sca#exemptions-available-to-mangopay) to the transfer (or unless your platform is using a [proxy and user consent](/guides/sca/proxy-management)). To let the user complete the SCA session on the Mangopay-hosted webpage, your platform needs to retrieve the returned `PendingUserAction.RedirectUrl`, add an encoded `returnUrl` query parameter, and redirect the user. Read more about how to redirect them in the [SCA session](/guides/sca/session) guide. In Sandbox, you can bypass SCA by including the word `accept` in the `Email` value of the [Natural User](/api-reference/users/natural-user-object-sca) or the `LegalRepresentative.Email` value of the [Legal User](/api-reference/users/legal-user-object-sca) – for example `accept@example.com` or `john.doe+accept@example.com`. </Note> Create a Transfer

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

Request

This endpoint expects an object.

AuthorIdstringRequired

The unique identifier of the user at the source of the transaction.

DebitedFundsobjectRequired

Information about the debited funds.

FeesobjectRequired

Information about the fees.

CreditedWalletIdstringRequired

The unique identifier of the credited wallet.

DebitedWalletIdstringRequired

The unique identifier of the debited wallet.

ScaContextstringOptional

Possible values: USER_PRESENT, USER_NOT_PRESENT

The SCA context of the request, which is required if the debited wallet owner’s UserCategory is OWNER:

USER_PRESENT – The user is taking the SCA-triggering action of initiating a transfer. The platform must redirect the user using the PendingUserAction.RedirectUrl returned so that the user can complete the SCA session (unless Mangopay applied an exemption for low-amount and low-risk transfers, so no redirection link was returned).
USER_NOT_PRESENT – The platform is taking the action under proxy from the user and the user has previously given consent to Mangopay (via the SCA hosted experience) to allow the action. If the user has not given (or has revoked) their consent, then USER_NOT_PRESENT returns a 403 error.

Read more about managing proxy and user consent →

Note: For existing platforms, the parameter is technically optional if the debited wallet owner’s UserCategory is OWNER, and the default value will become USER_PRESENT from Dec 15, 2025 (Dec 1 in Sandbox)

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

Response

Success

ScaContextstring

Possible values: USER_PRESENT, USER_NOT_PRESENT

The SCA context of the request, which is required if the debited wallet owner’s UserCategory is OWNER:

USER_PRESENT – The user is taking the SCA-triggering action of initiating a transfer. The platform must redirect the user using the PendingUserAction.RedirectUrl returned so that the user can complete the SCA session (unless Mangopay applied an exemption for low-amount and low-risk transfers, so no redirection link was returned).
USER_NOT_PRESENT – The platform is taking the action under proxy from the user and the user has previously given consent to Mangopay (via the SCA hosted experience) to allow the action. If the user has not given (or has revoked) their consent, then USER_NOT_PRESENT returns a 403 error.

Read more about managing proxy and user consent →

Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

DebitedFundsobject

Information about the debited funds.

CreditedFundsobject

Information about the credited funds (CreditedFunds = DebitedFunds - Fees).

Feesobject

Information about the fees.

Statusstring

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ResultCodestring

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessagestring

The explanation of the result code.

ExecutionDateinteger

Unix timestamp (UTC) of the date and time the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.

Typestring

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Naturestring

Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENT

The nature of the transaction, providing more information about the context in which the transaction occurred:

REGULAR – Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow.
REPUDIATION – Automatic withdrawal of funds from the platform’s repudiation wallet as part of the dispute process (when the user has requested a chargeback).
REFUND – Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay).
SETTLEMENT – Transfer made to the repudiation wallet by the platform to settle a lost dispute.

DebitedWalletIdstring

The unique identifier of the debited wallet.

CreditedWalletIdstring

The unique identifier of the credited wallet.

PendingUserActionobject

Object containing the RedirectUrl needed for SCA redirection if triggered by the API call (otherwise returned null).

Errors

400

Bad Request Error