Initiating a payout
This is an integration guide for the Payer Payout API - and the integration flow for initiating single, recurring or unscheduled payouts. We've made it possible to initiate payouts for bank accounts token with only one API.
Integration Guide
The following flow describes the necessary steps to Initiate Payouts
Step 1 - Business Bank Account - Store bank account
For customer bank accounts, the first step is to store the bank account. You only need to do this once for each account.
curl --request POST \ --url https://b2b.payer.se/api/v1/bankaccounts \ --data '{ "accountHolderCountry": "SE", "accountHolderName": "Example Business", "accountHolderType": "LIMITED_COMPANY", "accountNumber": "GB33BUKB20201555555555", "accountNumberType": "iban", "bic": "TEST234", "countryCode": "SE", "currencyCode": "SEK", "name": "My business account"}'The response contains a bankAccountReference that you need to store and use for subsequent payouts.
Step 2. Initiate bank payout requests
Use the bankAccountReferenceas the toBankAccountReference in order to initiate a payout
curl --request POST \ --url https://b2b.payer.se/api/v2/payments/payouts \ --data '{ "amount": 1000, "countryCode": "SE", "currencyCode": "SEK", "debtorName": "Text on bank statement for api-user", "dueDate": "2020-09-01", "externalReference": "External unique id which can be used to reference the created payout", "externalReferenceType": "The type of the externalReference", "toBankAccountReference": "41e2e7a1-cc7e-4742-9260-f2b6c8084698"}'The response contains a transactionMessage that will be visible on the receiving bank account.
That's it! We take care of the rest. Simple, right?
It's possible to create many payouts at the same time, set a future date for when the payout is to be initiated and use your own bank accounts for the services.
Payouts for Marketplaces and Three-party business models
Our Payout API can also be used together with the B2B Invoicing solutions for marketplace setups, in order to distribute the funds to multiple parties involved in the process. Contacts us for more information.