POST
/
v2.01
/
{ClientId}
/
payins
/
payment-methods
/
bizum
{
    "AuthorId": "user_m_01HYE3F4EYHAMD7CX5K0Z0A5NF",
    "CreditedWalletId": "wlt_m_01HYG6AM9V72R64QTBHJY705DF",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 100
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "Phone": "+34700000000",
    "Tag" : "Created using the Mangopay API Postman collection",
    "StatementDescriptor" : "Example123"
}

{
    "Id": "payin_m_01HZ7HGSWAWWNS6NBTBPBZ6TNC",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1717166434,
    "AuthorId": "user_m_01HYE3F4EYHAMD7CX5K0Z0A5NF",
    "CreditedUserId": "user_m_01HYE3F4EYHAMD7CX5K0Z0A5NF",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 100
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 100
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Phone" : "+34700000000",
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01HYG6AM9V72R64QTBHJY705DF",
    "PaymentType": "BIZUM",
    "ExecutionType": "WEB",
    "StatementDescriptor": "Example123"
}

There are two Bizum flows, depending on the payload sent to this endpoint:

  • Phone – If Phone is sent, the ReturnURL is not required and RedirectURL is ignored because no redirection is necessary: the user receives a push notification from the Bizum app asking them to authenticate.
  • Redirect – If Phone is not sent, then ReturnURL is required and you must redirect the user to the RedirectURL in the response so they can enter their phone number themselves.

Note – Timeout after 5 minutes

The payment session lasts for 5 minutes for both the phone and redirect flows, at which point the pay-in fails automatically if no action has been taken by the user.

​
Body parameters

​
Tag
string

Max. length: 255 characters

Custom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.

​
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.

​
CreditedWalletId
string
required

The unique identifier of the credited wallet.

​
StatementDescriptor
string

Max. length: 10 characters; only alphanumeric and spaces

Custom description to appear on the user’s bank statement along with the platform name. Different banks may show more or less information. See the Customizing bank statement references article for details.

​
ReturnURL
string

Max. length: 255 characters

The URL to which the user is returned after the payment, whether the transaction is successful or not.

Required if Phone is not sent.

​
Phone
string

Format: International E.164 standard (preceded by plus sign and country code, +34 in Spain); pattern: ^\+[1-9][\d]{4,14}$

The phone number of the end user to which the Bizum push notification is sent to authenticate the transaction.

If the Phone parameter is sent, then RedirectURL is not returned and ReturnURL is ignored.

​
ProfilingAttemptReference
string

The unique reference generated for the profiling session, used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.

Note: Parameter not returned by the API. Profiling feature available on request – contact Mangopay via the Dashboard for more information.

​
Responses

{
    "Id": "payin_m_01HZ7HGSWAWWNS6NBTBPBZ6TNC",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1717166434,
    "AuthorId": "user_m_01HYE3F4EYHAMD7CX5K0Z0A5NF",
    "CreditedUserId": "user_m_01HYE3F4EYHAMD7CX5K0Z0A5NF",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 100
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 100
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Phone" : "+34700000000",
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01HYG6AM9V72R64QTBHJY705DF",
    "PaymentType": "BIZUM",
    "ExecutionType": "WEB",
    "StatementDescriptor": "Example123"
}

{
    "AuthorId": "user_m_01HYE3F4EYHAMD7CX5K0Z0A5NF",
    "CreditedWalletId": "wlt_m_01HYG6AM9V72R64QTBHJY705DF",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 100
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "Phone": "+34700000000",
    "Tag" : "Created using the Mangopay API Postman collection",
    "StatementDescriptor" : "Example123"
}