Convert bankaccount
POST https://{domainname}/v1/{merchantId}/services/convert/bankaccount
Services
Under services you find several calls that can be used to support your payment flow:
- Test your connection to us
- Convert an amount from one currency to another
- Convert between different bank account notations
- Retrieve the card type and country where the card was issued based on the IIN of the card
- Retrieve the ARN (Acquirer Reference Number), RRN (Retrieval Reference Number), Amount and Currency for a payment
Request
This API call can be used to convert bank account details between Basic Bank Account Number (BBAN) and International Bank Account Number (IBAN). This can be helpful if you still have data sources that have or provide you with BBAN data, but you need IBAN data to process transactions. You can convert traditional BBAN data into an IBAN and vice versa. If you supply both the BBAN and the IBAN data they will be compared.
PayloadBankDetailsRequest
|
Properties
|
|||
| Property | Type | Required | Details |
|---|---|---|---|
| object | no | read close | |
|
close
DescriptionObject that holds the Basic Bank Account Number (BBAN) data
|
|||
| accountHolderName | string (30) | depends | read close |
|
close
DescriptionName of the account holder
|
|||
| accountNumber | string | depends | read close |
|
close
DescriptionBank account number
|
|||
| bankCode | string | depends | read close |
|
close
DescriptionBank code
|
|||
| bankName | string (40) | no | read close |
|
close
DescriptionName of the bank
|
|||
| branchCode | string | no | read close |
|
close
DescriptionBranch code
|
|||
| checkDigit | string | no | read close |
|
close
DescriptionBank check digit
|
|||
| countryCode | string (2) | no | read close |
|
close
DescriptionISO 3166-1 alpha-2 country code of the country where the bank account is held
For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
|
|||
| object | no | read close | |
|
close
DescriptionObject that holds the International Bank Account Number (IBAN) data
|
|||
| accountHolderName | string (30) | depends | read close |
|
close
DescriptionName in which the account is held.
|
|||
| iban | string (50) | depends | read close |
|
close
DescriptionThe IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
|
|||
Request example
SDK: PHP
This scenario you will probably use the most
-
$bankAccountBban = new BankAccountBban(); $bankAccountBban->accountNumber = '0532013000'; $bankAccountBban->bankCode = '37040044'; $bankAccountBban->countryCode = 'DE'; $body = new BankDetailsRequest(); $body->bankAccountBban = $bankAccountBban; $response = $client->v1()->merchant('merchantId')->services()->bankaccount($body); -
$bankAccountIban = new BankAccountIban(); $bankAccountIban->iban = '******************'; $body = new BankDetailsRequest(); $body->bankAccountIban = $bankAccountIban; $response = $client->v1()->merchant('merchantId')->services()->bankaccount($body);
Responses
Please find below an overview of the possible responses.
Response 200 - OKBankDetailsResponse
When you get a 200 response a conversion has been made and the results are in the response.
|
Properties
|
|||
| Property | Type | Required | Details |
|---|---|---|---|
| object | no | read close | |
|
close
DescriptionObject that holds the Basic Bank Account Number (BBAN) data
|
|||
| accountHolderName | string (30) | depends | read close |
|
close
DescriptionName of the account holder
|
|||
| accountNumber | string | depends | read close |
|
close
DescriptionBank account number
|
|||
| bankCode | string | depends | read close |
|
close
DescriptionBank code
|
|||
| bankName | string (40) | no | read close |
|
close
DescriptionName of the bank
|
|||
| branchCode | string | no | read close |
|
close
DescriptionBranch code
|
|||
| checkDigit | string | no | read close |
|
close
DescriptionBank check digit
|
|||
| countryCode | string (2) | no | read close |
|
close
DescriptionISO 3166-1 alpha-2 country code of the country where the bank account is held
For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
|
|||
| object | no | read close | |
|
close
DescriptionObject that holds the International Bank Account Number (IBAN) data
|
|||
| accountHolderName | string (30) | depends | read close |
|
close
DescriptionName in which the account is held.
|
|||
| iban | string (50) | depends | read close |
|
close
DescriptionThe IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
|
|||
| object | no | read close | |
| newBankName | string | no | read close |
|
close
DescriptionBank name, matching the bank code of the request
|
|||
| reformattedAccountNumber | string | no | read close |
|
close
DescriptionReformatted account number according to local clearing rules
|
|||
| reformattedBankCode | string | no | read close |
|
close
DescriptionReformatted bank code according to local clearing rules
|
|||
| reformattedBranchCode | string | no | read close |
|
close
DescriptionReformatted branch code according to local clearing rules
|
|||
| object | no | read close | |
| bic | string | no | read close |
|
close
DescriptionThe BIC is the Business Identifier Code, also known as SWIFT or Bank Identifier code. It is a code with an internationally agreed format to Identify a specific bank or even branch. The BIC contains 8 or 11 positions: the first 4 contain the bank code, followed by the country code and location code.
|
|||
| category | string | no | read close |
|
close
DescriptionSWIFT category
|
|||
| chipsUID | string | no | read close |
|
close
DescriptionClearing House Interbank Payments System (CHIPS) UID
CHIPS is one half of the primary US network of large-value domestic and international payments. |
|||
| extraInfo | string | no | read close |
|
close
DescriptionSWIFT extra information
|
|||
| poBoxCountry | string | no | read close |
|
close
DescriptionInstitution PO Box country
|
|||
| poBoxLocation | string | no | read close |
|
close
DescriptionInstitution PO Box location
|
|||
| poBoxNumber | string | no | read close |
|
close
DescriptionInstitution PO Box number
|
|||
| poBoxZip | string | no | read close |
|
close
DescriptionInstitution PO Box ZIP
|
|||
| routingBic | string | no | read close |
|
close
DescriptionPayment routing BIC
|
|||
| services | string | no | read close |
|
close
DescriptionSWIFT services
|
|||
Response example
SDK: PHP
This scenario you will probably use the most
-
{ "bankAccountIban" : { "iban" : "DE89370400440532013000" }, "bankData" : { "reformattedAccountNumber" : "0532013000", "reformattedBankCode" : "37040044" }, "swift" : { "bic" : "COBADEFF370", "category" : "SUPE", "chipsUID" : "108246", "routingBic" : "COBADEFFXXX", "services" : "EBAERPFINTG+" } }
Response 400 - Bad requestErrorResponse
|
Properties
|
|||
| Property | Type | Required | Details |
|---|---|---|---|
| errorId | string | yes | read close |
|
close
DescriptionUnique reference, for debugging purposes, of this error response
|
|||
| array of object | yes | read close | |
|
close
DescriptionList of one or more errors
|
|||
| object | no | read close | |
| category | string | no | read close |
|
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
| code | string | yes | read close |
|
close
DescriptionError code
|
|||
| httpStatusCode | integer | no | read close |
|
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
| id | string | no | read close |
|
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
| message | string | no | read close |
|
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
| propertyName | string | no | read close |
|
close
DescriptionReturned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query. Some common examples:
|
|||
| requestId | string | no | read close |
|
close
DescriptionID of the request that can be used for debugging purposes
|
|||
Response example
SDK: PHP
This scenario you will probably use the most
-
{ "errorId" : "15eabcd5-30b3-479b-ae03-67bb351c07e6-00000092", "errors" : [ { "code" : "20000000", "propertyName" : "bankAccountBban.accountNumber", "message" : "PARAMETER_NOT_FOUND_IN_REQUEST" } ] }