Bulk Payments

❗️

Most of the banks don't accept bulk payments containing only one payment instruction.

First, let's know what's possible for this bank account.

By calling https://api.mybanx.io/bankaccounts/:bankAccountId/bulkpayment/info.
Where :bankAccountId is the Id of your bank account in the list sent back from https://api.mybanx.io/v1/companies/bankaccounts

You will receive the following data structure which allows you to understand the behaviour of the connector related to the bankAccountId provided.

{
    "bankName": "CBC", // Name of the bank
    "countryId": "BE", // Country ISO Code 2 of the bank
    "connectorId": 30, // ID of the connector in Exthand's system
    "currencies": "EUR", // Comma separated currencies supported
    "sepaInstantSupported": true,  // Is Instant payment supported.
    "sepaSpecificPaymentDate": true,  // Is a specific date of execution supported
    "minimalAmount": 1  // Minimal amount (decimal format) of a payment
}

Initial Call with Payments Batch.

https://api.mybanx.io/v1/bankaccounts/:bankAccountId/bulkpayment

Where :bankAccountId is the Id of your bank account in the list sent back from https://api.mybanx.io/v1/companies/bankaccounts

{  
  "redirectURL": "https://mybanx.io/bulkPayment/finalized",  
  "senderEmail": "your-email-registered-on-mybanx.io",  
  "isInstant": true,  
  "bulkPayments": [  
    {  
      "counterpartyIBAN": "LT883250026566XXXX",  
      "amount": "2.00",  
      "counterpartName": "Company Name",  
      "currency": "EUR",  
      "remittanceStructuredRef": "",  
      "remittanceUnstructured": "TEST BULK 20240101",  
      "end2EndId": "2024062803"  
    },  
    {  
      "counterpartyIBAN": "LT883250026YYYYY",  
      "amount": "3.00",  
      "counterpartName": "Other Company Name",  
      "currency": "EUR",  
      "remittanceStructuredRef": "",  
      "remittanceUnstructured": "TEST BULK 20240102",  
      "end2EndId": "2024062804"  // This IS should be flowing from your system to the system of the counterpart and be back in your related statement.
    }  
  ],  
  "additionalProperties": {}  
}

Response (200)

{
    "id": "954d35f5-f6f9-42f5-31c0-08dc97734eXX",
    "url": "https://www.mybanx.io/payment/api/954d35f5-f6f9-42f5-31c0-08dc97734eXX/start"
}

Sends back the ID of the payment created and a link to start the flow and connect to the bank to validate the bulk.

Most of the time, bulk is a 2 steps process on the bank side:

1. Sending and signing the bulk
2. Connecting yourselves in the bank app and validating the bulk for execution.

Final Redirect

Once the process on the bank side has been executed, the user will be redirected to the URL you provided in the Initial Call ( "redirectURL": "https://mybanx.io/payment/finalized" )

For testing purpose, you can use this URL:

https://www.mybanx.io/bulkPayment/finalized