1. Create Refund Recipient
POST {{host}}/v1/refund-accounts
Sometimes we may need to refund the transfer's funds - see the transfer status here for cases when this may happen.
A refund recipient is a person or institution where we will refund transfer funds to. This is not a mandatory step if your bank is using a fast local payment network as we can usually infer the refund recipient from the bank transaction that funded the transfer.
But if your bank is using a slow domestic payment network and a prefunded
model, we may try to refund before we receive the funds in our bank transactions. In these instances, we require banks to inform us what are the details where to refund transfers. In order to do this we have current API
This API is identical to the regular recipient account creation. The refund recipient account id returned here is needed when creating transfers in step 3 as the field sourceAccount.
The format of the request payload for refund recipient creation will be different depending on the currency your bank will send transfers from. The above example is for GBP only. We can provide the correct format for your bank upon request.
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
"{\n \"id\": 14076196,\n \"business\": null,\n \"profile\": \u003cyour profile id\u003e,\n \"accountHolderName\": \"Ann Johnson\",\n \"currency\": \"GBP\",\n \"country\": \"GB\",\n \"type\": \"sort_code\",\n \"details\": {\n \"address\": null,\n \"email\": null,\n \"legalType\": \"PRIVATE\",\n \"accountNumber\": \"28821822\",\n \"sortCode\": \"231470\",\n \"abartn\": null,\n \"accountType\": null,\n \"bankgiroNumber\": null,\n \"ifscCode\": null,\n \"bsbCode\": null,\n \"institutionNumber\": null,\n \"transitNumber\": null,\n \"phoneNumber\": null,\n \"bankCode\": null,\n \"russiaRegion\": null,\n \"routingNumber\": null,\n \"branchCode\": null,\n \"cpf\": null,\n \"cardNumber\": null,\n \"idType\": null,\n \"idNumber\": null,\n \"idCountryIso3\": null,\n \"idValidFrom\": null,\n \"idValidTo\": null,\n \"clabe\": null,\n \"swiftCode\": null,\n \"dateOfBirth\": null,\n \"clearingNumber\": null,\n \"bankName\": null,\n \"branchName\": null,\n \"businessNumber\": null,\n \"province\": null,\n \"city\": null,\n \"rut\": null,\n \"token\": null,\n \"cnpj\": null,\n \"payinReference\": null,\n \"pspReference\": null,\n \"orderId\": null,\n \"idDocumentType\": null,\n \"idDocumentNumber\": null,\n \"targetProfile\": null,\n \"targetUserId\": null,\n \"taxId\": null,\n \"job\": null,\n \"nationality\": null,\n \"interacAccount\": null,\n \"bban\": null,\n \"town\": null,\n \"postCode\": null,\n \"IBAN\": null,\n \"iban\": null,\n \"BIC\": null,\n \"bic\": null\n },\n \"user\": \u003cyour user id\u003e,\n \"active\": true,\n \"ownedByCustomer\": false\n}"