Single Payments
First, let's know what's possible for this bank account.
By calling https://api.mybanx.io/bankaccounts/:bankAccountId/payment/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 behavior 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 for Single Payment
https://api.mybanx.io/v1/bankaccounts/:bankAccountId/payment
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/payment/finalized",
"senderEmail": "your-email-registered-on-mybanx.io",
"counterpartyIBAN": "BE71732039083XXX",
"amount": "2.00",
"counterpartName": "Company Name",
"currency": "EUR",
"remittanceStructuredRef": "",
"remittanceUnstructured": "20240628-02",
"dateExecution": "2024-06-28",
"end2EndId": "2024062802", // 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 payment.
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 put this URL in your initial request, redirectURL property:
Updated about 2 months ago