Skip to main content
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",
    "DebitedFunds": {
      "Currency": "EUR",
        "Amount": 100
    },
    "CreditedFunds": {
      "Currency": "EUR",
        "Amount": 100
    },
    "Fees": {
      "Currency": "EUR",
        "Amount": 0
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01HYG6AM9V72R64QTBHJY705DF",
    "CreditedUserId": "user_m_01HYE3F4EYHAMD7CX5K0Z0A5NF",
    "PaymentType": "BIZUM",
    "ExecutionType": "WEB",
    "StatementDescriptor": "Example123",
    "Phone" : "+34700000000"
}
There are two Bizum flows, depending on the payload sent to this endpoint:
  • Phone – If Phone is sent, the ReturnURL is ignored and RedirectURL is not returned because no redirection is necessary: the user receives a push notification from the Bizum app asking them to authenticate. In Sandbox, the RedirectURL is returned in all cases, because it is the only way to complete the transaction (see testing).
  • 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 minutesThe 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 charactersCustom 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 spacesCustom 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 charactersThe 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: ^(\\+?34)?[6-9][0-9]{8}$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
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.
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.
​
CreationDate
Unix timestamp
The date and time at which the object was created.
​
AuthorId
string
The unique identifier of the user at the source of the transaction.
​
DebitedFunds
object
Information about the debited funds.
​
CreditedFunds
object
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
​
Fees
object
Information about the fees.
​
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.
​
CreditedWalletId
string
The unique identifier of the credited wallet.
​
CreditedUserId
string
Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.
​
PaymentType
string
Returned values: BIZUMThe type of pay-in.
​
ExecutionType
string
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.
​
Phone
string
Format: International E.164 standard (preceded by plus sign and country code, +34 in Spain); pattern: ^(\\+?34)?[6-9][0-9]{8}$The phone number of the end user to which the Bizum push notification is sent to authenticate the transaction.On Bizum, if the Phone parameter is sent, then RedirectURL is not returned and ReturnURL not required.
​
ReturnURL
string
Max. length: 255 charactersThe URL to which the user is returned after the payment, whether the transaction is successful or not.
​
RedirectURL
string
The URL to which to redirect the user to complete the payment.Caution: This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.
​
StatementDescriptor
string
Max. length: 10 characters; only alphanumeric and spacesCustom 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.
{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Id": "7b5f232e-1802-4367-ab67-1914a4038339",
    "Date": 1750326049,
    "Type": "param_error",
    "Errors": {
        "Phone": "The field must match the regular expression '^(\\+?34)?[6-9][0-9]{8}$'."
    }
}

{
    "Id": "payin_m_01HZ7HGSWAWWNS6NBTBPBZ6TNC",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1717166434,
    "AuthorId": "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,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01HYG6AM9V72R64QTBHJY705DF",
    "CreditedUserId": "user_m_01HYE3F4EYHAMD7CX5K0Z0A5NF",
    "PaymentType": "BIZUM",
    "ExecutionType": "WEB",
    "StatementDescriptor": "Example123",
    "Phone" : "+34700000000"
}

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