Skip to main content
POST
/
v2.01
/
{ClientId}
/
transfers
{
    "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"
}

{
    "ScaContext": "USER_PRESENT",
    "Id": "xfer_c_01JRSHQFG2337DBQ4NS8XPYCK7",
    "CreationDate": 1744614179,
    "DebitedWalletId": "wlt_m_01JRJM7ASZN7YP4MBDVBT0HZF1",
    "CreditedWalletId": "wlt_m_01JRHSTW2NP4MDB45WQMDNS23C",
    "AuthorId": "user_m_01JRJM5RR5NYQDN0S6QWJJDRMR",
    "CreditedUserId": "user_m_01JRHSS3B18H86QA0C467RVK07",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 3001
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 3001
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "Type": "TRANSFER",
    "Nature": "REGULAR",
    "Status": "CREATED",
    "Tag": "Created using Mangopay API Postman Collection",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "PendingUserAction": {
        "RedirectUrl": "https://sca.sandbox.mangopay.com/?token=sca_0196331bc1247e3fa33be6f9c797abd7"
    }
}
Caution - ScaContext default value changingOn 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 endpointWhen 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.

​
Body parameters

​
ScaContext
string
Possible values: USER_PRESENT, USER_NOT_PRESENTThe 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)
​
AuthorId
string
required
The unique identifier of the user at the source of the transaction.
​
DebitedFunds
object
required
Information about the debited funds.
​
Fees
object
required
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
​
CreditedWalletId
string
required
The unique identifier of the credited wallet.
​
DebitedWalletId
string
required
The unique identifier of the debited wallet.
​
Tag
string
Max. length: 255 charactersCustom data that you can add to this object.

​
Responses

​
ScaContext
string
Possible values: USER_PRESENT, USER_NOT_PRESENTThe 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)
​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
Tag
string
Max. length: 255 charactersCustom data that you can add to this object.
​
DebitedFunds
object
Information about the debited funds.
​
CreditedFunds
object
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
​
Fees
object
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
​
Status
string
Returned values: CREATED, SUCCEEDED, FAILEDThe status of the transaction.
​
ResultCode
string
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
​
ResultMessage
string
The explanation of the result code.
​
ExecutionDate
Unix timestamp
The date and time at which the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.
​
Type
string
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUTThe type of the transaction.
​
Nature
string
Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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.
​
DebitedWalletId
string
The unique identifier of the debited wallet.
​
CreditedWalletId
string
The unique identifier of the credited wallet.
​
PendingUserAction
object
Object containing the link needed for SCA redirection if triggered by the API call (otherwise returned null).
{
    "Message": "Error: multi-currency usage is not authorized",
    "Type": "currency_incompatibility",
    "Id": "0c23333c-a0ef-468a-8d33-7bd7ced6e7d4#1661495038",
    "Date": 1661495039.0,
    "errors": {
        "currency": "The Debited Wallet's currency EUR and the Credited Wallet's currency GBP must be the same"
    }
}  

{
    "Message": "Author should be the Debited wallet owner",
    "Type": "param_error",
    "Id": "3cc18d56-5aab-4271-87aa-7baee84a78a0",
    "Date": 1756456857.0,
    "errors": null
}

{
    "ScaContext": "USER_PRESENT",
    "Id": "xfer_c_01JRSHQFG2337DBQ4NS8XPYCK7",
    "CreationDate": 1744614179,
    "DebitedWalletId": "wlt_m_01JRJM7ASZN7YP4MBDVBT0HZF1",
    "CreditedWalletId": "wlt_m_01JRHSTW2NP4MDB45WQMDNS23C",
    "AuthorId": "user_m_01JRJM5RR5NYQDN0S6QWJJDRMR",
    "CreditedUserId": "user_m_01JRHSS3B18H86QA0C467RVK07",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 3001
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 3001
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "Type": "TRANSFER",
    "Nature": "REGULAR",
    "Status": "CREATED",
    "Tag": "Created using Mangopay API Postman Collection",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "PendingUserAction": {
        "RedirectUrl": "https://sca.sandbox.mangopay.com/?token=sca_0196331bc1247e3fa33be6f9c797abd7"
    }
}

{
    "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"
}