Bulk payment
Feature activation
To enable this feature on your app, please contact us.
Bulk payment flow
The bulk payment goes through different steps that are described below :
- Creation of the payment request - POST Create a payment request
- User has a Bridge loading page
- The user is redirected on the bank for authentication
- The user select the account on the bank interface
- An SCA is requested via a device attached to the account
- Redirecting the user to the
successful_callback_url
Create a bulk payment
In order to initiate a bulk payment you will need to provide the necessary details in the body of the endpoint POST Create a payment request.
Example of the body for a bulk payment :
{
"successful_callback_url": "https://bridgeapi.io",
"transactions": [
{
"currency": "EUR",
"label": "label test 1",
"amount": 1000,
"beneficiary": {
"name": "Company name" ,
"iban": "FR0912739000302281214822O48"
},
"client_reference": "ABCDE_FG-HI_12345",
"end_to_end_id": "E2E_TEST-123"
},
{
"currency": "EUR",
"label": "label test 2",
"amount": 2000,
"beneficiary": {
"name": "Company name" ,
"iban": "FR2012739000407524676274Z96"
},
"client_reference": "ABCDE_FG-HI_12345",
"end_to_end_id": "E2E_TEST-123"
},
{
"currency": "EUR",
"label": "label test 3",
"amount": 3000,
"beneficiary": {
"name": "Company name" ,
"iban": "FR2714508000403277953994H75"
},
"client_reference": "ABCDE_FG-HI_12345",
"end_to_end_id": "E2E_TEST-123"
}
],
"user": {
"first_name": "John",
"last_name": "Smith",
"external_reference": "AEF142536-890"
},
"bank_id": 421
}
Once you confirmed a payment in the bank interface, if everything went well, you will be redirect to the success callback url you set up in the v2/payment-requests call.
Get bulk payment status
In order to retrieve the status of a bulk payment transaction you will need to make an API call on this endpoint GET a single payment request.
The payment request and the payment transactions will have a status. Regarding the status of a payment request these are the different status :
Please refer to this page for all the different status
and if the payment is in RJCT to the status_reason
.
For bulk payment you might have another status for payment request that is PART
which is a final status
. In this case, please check the transactions statuses because it means some of them might be successful and some might be rejected.
Qonto specification
Qonto has a specific flow on bulk payment :
- Creation of the payment request - POST Create a payment request
- User has a Bridge loading page
- The user is redirected on the bank for authentication
- The user is redirected to Bridge to select the account
- Bridge page waiting for confirmation of the SCA that is requested via a device attached to the Qonto account
- Redirection of the user to the
successful_callback_url
Querying the status of a payment request via a GET simply retrieves the current status stored within the system. It does not initiate any actions that could refresh or update the status in real-time.
Updated 5 months ago