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
|
|||
|
close
DescriptionName of the account holder
Depends on:Required for Create and Update token calls for ACH (730).
|
|||
|
close
DescriptionBank account number
Depends on:Required for Direct Debit UK (705) and ACH (730) payments, except when a token has been included in the request that includes this value.
Required for Create and Update token calls. |
|||
|
close
DescriptionBank code
Depends on:Required for Direct Debit UK (705) and ACH (730) payments, except when a token has been included in the request that includes this value.
Required for Create and Update token calls for ACH (730). |
|||
|
close
DescriptionName of the bank
|
|||
|
close
DescriptionBranch code
|
|||
|
close
DescriptionBank check digit
|
|||
|
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
|
|||
|
close
DescriptionName in which the account is held.
Depends on:Required for the creation of a Payout
Required for Create and Update token calls. |
|||
|
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.
Depends on:Required for the creation of a Payout
Required for Create and Update token. Required for payments with product 9000 (AfterPay Installments) in Austria (AT) and Germany (DE). Required for Create mandate and Create payment with mandate calls |
|||
| Property | Type | Required | Details |
Request example
SDK: Ruby
Default scenario
This scenario you will probably use the most
-
bank_account_bban = Domain::BankAccountBban.new bank_account_bban.account_number = '0532013000' bank_account_bban.bank_code = '37040044' bank_account_bban.country_code = 'DE' body = Domain::BankDetailsRequest.new body.bank_account_bban = bank_account_bban 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
|
|||
|
close
DescriptionName of the account holder
Depends on:Required for Create and Update token calls for ACH (730).
|
|||
|
close
DescriptionBank account number
Depends on:Required for Direct Debit UK (705) and ACH (730) payments, except when a token has been included in the request that includes this value.
Required for Create and Update token calls. |
|||
|
close
DescriptionBank code
Depends on:Required for Direct Debit UK (705) and ACH (730) payments, except when a token has been included in the request that includes this value.
Required for Create and Update token calls for ACH (730). |
|||
|
close
DescriptionName of the bank
|
|||
|
close
DescriptionBranch code
|
|||
|
close
DescriptionBank check digit
|
|||
|
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
|
|||
|
close
DescriptionName in which the account is held.
Depends on:Required for the creation of a Payout
Required for Create and Update token calls. |
|||
|
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.
Depends on:Required for the creation of a Payout
Required for Create and Update token. Required for payments with product 9000 (AfterPay Installments) in Austria (AT) and Germany (DE). Required for Create mandate and Create payment with mandate calls |
|||
| object | no | read close | |
|
close
DescriptionBank name, matching the bank code of the request
|
|||
|
close
DescriptionReformatted account number according to local clearing rules
|
|||
|
close
DescriptionReformatted bank code according to local clearing rules
|
|||
|
close
DescriptionReformatted branch code according to local clearing rules
|
|||
| object | 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.
|
|||
|
close
DescriptionSWIFT category
|
|||
|
close
DescriptionClearing House Interbank Payments System (CHIPS) UID
CHIPS is one half of the primary US network of large-value domestic and international payments. |
|||
|
close
DescriptionSWIFT extra information
|
|||
|
close
DescriptionInstitution PO Box country
|
|||
|
close
DescriptionInstitution PO Box location
|
|||
|
close
DescriptionInstitution PO Box number
|
|||
|
close
DescriptionInstitution PO Box ZIP
|
|||
|
close
DescriptionPayment routing BIC
|
|||
|
close
DescriptionSWIFT services
|
|||
| Property | Type | Required | Details |
Response example
SDK: Ruby
Default scenario
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
|
|||
|
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
|
close
DescriptionError code
|
|||
|
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
|
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
|
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
|
|||
|
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:
|
|||
|
close
DescriptionID of the request that can be used for debugging purposes
|
|||
| Property | Type | Required | Details |
Response example
SDK: Ruby
Default scenario
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" } ] }