Bizum
Create a Bizum PayIn
POST
There are two Bizum flows, depending on the payload sent to this endpoint:
- Phone – If
Phoneis sent, theReturnURLis ignored andRedirectURLis not returned because no redirection is necessary: the user receives a push notification from the Bizum app asking them to authenticate. In Sandbox, theRedirectURLis returned in all cases, because it is the only way to complete the transaction (see testing). - Redirect – If
Phoneis not sent, thenReturnURLis required and you must redirect the user to theRedirectURLin 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
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.
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.
The unique identifier of the user at the source of the transaction.
Information about the debited funds.
Information about the fees.
The unique identifier of the credited wallet.
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.
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.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.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
200
200
Max length: 128 characters (see data formats for details)The unique identifier of the object.
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.
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.
The date and time at which the object was created.
The unique identifier of the user at the source of the transaction.
Information about the debited funds.
Information about the credited funds (
CreditedFunds = DebitedFunds - Fees).Information about the fees.
Returned values:
CREATED, SUCCEEDED, FAILEDThe status of the transaction.The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
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.Returned values:
PAYIN, TRANSFER, CONVERSION, PAYOUTThe type of the transaction.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.
The unique identifier of the credited wallet.
Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.
Returned values:
BIZUMThe type of pay-in.Returned values:
WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.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.Max. length: 255 charactersThe URL to which the user is returned after the payment, whether the transaction is successful or not.
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.
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.
400 - Phone number format error
400 - Phone number format error