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

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
bankAccountBban	object	no	read close
close Description Object that holds the Basic Bank Account Number (BBAN) data SDK Object type BankAccountBban
accountHolderName	string (30)	depends	read close
close Description Name of the account holder Depends on: Required for Create and Update token calls for ACH (730).
accountNumber	string	depends	read close
close Description Bank 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.
bankCode	string	depends	read close
close Description Bank 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).
bankName	string (40)	no	read close
close Description Name of the bank
branchCode	string	no	read close
close Description Branch code
checkDigit	string	no	read close
close Description Bank check digit
countryCode	string (2)	no	read close
close Description ISO 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.
bankAccountIban	object	no	read close
close Description Object that holds the International Bank Account Number (IBAN) data SDK Object type BankAccountIban
accountHolderName	string (30)	depends	read close
close Description Name in which the account is held. Depends on: Required for the creation of a Payout Required for Create and Update token calls.
iban	string (50)	depends	read close
close Description The 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

Request example

SDK: Java

This scenario you will probably use the most

BankAccountBban bankAccountBban = new BankAccountBban();
bankAccountBban.setAccountNumber("0532013000");
bankAccountBban.setBankCode("37040044");
bankAccountBban.setCountryCode("DE");

BankDetailsRequest body = new BankDetailsRequest();
body.setBankAccountBban(bankAccountBban);

BankDetailsResponse response = client.v1().merchant("merchantId").services().bankaccount(body);

BankAccountIban bankAccountIban = new BankAccountIban();
bankAccountIban.setIban("******************");

BankDetailsRequest body = new BankDetailsRequest();
body.setBankAccountIban(bankAccountIban);

BankDetailsResponse 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.

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
bankAccountBban	object	no	read close
close Description Object that holds the Basic Bank Account Number (BBAN) data SDK Object type BankAccountBban
accountHolderName	string (30)	depends	read close
close Description Name of the account holder Depends on: Required for Create and Update token calls for ACH (730).
accountNumber	string	depends	read close
close Description Bank 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.
bankCode	string	depends	read close
close Description Bank 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).
bankName	string (40)	no	read close
close Description Name of the bank
branchCode	string	no	read close
close Description Branch code
checkDigit	string	no	read close
close Description Bank check digit
countryCode	string (2)	no	read close
close Description ISO 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.
bankAccountIban	object	no	read close
close Description Object that holds the International Bank Account Number (IBAN) data SDK Object type BankAccountIban
accountHolderName	string (30)	depends	read close
close Description Name in which the account is held. Depends on: Required for the creation of a Payout Required for Create and Update token calls.
iban	string (50)	depends	read close
close Description The 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
bankData	object	no	read close
close Description Object that holds the reformatted bank account data SDK Object type BankData
newBankName	string	no	read close
close Description Bank name, matching the bank code of the request
reformattedAccountNumber	string	no	read close
close Description Reformatted account number according to local clearing rules
reformattedBankCode	string	no	read close
close Description Reformatted bank code according to local clearing rules
reformattedBranchCode	string	no	read close
close Description Reformatted branch code according to local clearing rules
swift	object	no	read close
close Description Object that holds all the SWIFT routing information SDK Object type Swift
bic	string	no	read close
close Description The 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 Description SWIFT category
chipsUID	string	no	read close
close Description Clearing 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 Description SWIFT extra information
poBoxCountry	string	no	read close
close Description Institution PO Box country
poBoxLocation	string	no	read close
close Description Institution PO Box location
poBoxNumber	string	no	read close
close Description Institution PO Box number
poBoxZip	string	no	read close
close Description Institution PO Box ZIP
routingBic	string	no	read close
close Description Payment routing BIC
services	string	no	read close
close Description SWIFT services

Response example

SDK: Java

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

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
errorId	string	yes	read close
close Description Unique reference, for debugging purposes, of this error response
errors	array of object	yes	read close
close Description List of one or more errors
items	object	no	read close
close Description Contains detailed information on one single error. SDK Object type APIError
category	string	no	read close
close Description Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values: CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform. PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform. IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
code	string	yes	read close
close Description Error code
httpStatusCode	integer	no	read close
close Description HTTP status code for this error that can be used to determine the type of error
id	string	no	read close
close Description ID of the error. This is a short human-readable message that briefly describes the error.
message	string	no	read close
close Description Human-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 Description Returned 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: a.b selects the value of property b of root property a, a[1] selects the first element of the array in root property a, a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
requestId	string	no	read close
close Description ID of the request that can be used for debugging purposes

Response example

SDK: Java

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"
        }
    ]
}

Convert bankaccount

Services

Request

PayloadBankDetailsRequest

Description

Description

Depends on:

Description

Depends on:

Description

Depends on:

Description

Description

Description

Description

Description

Description

Depends on:

Description

Depends on:

Request example

Responses

Response 200 - OKBankDetailsResponse

Description

Description

Depends on:

Description

Depends on:

Description

Depends on:

Description

Description

Description

Description

Description

Description

Depends on:

Description

Depends on:

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Response example

Response 400 - Bad requestErrorResponse

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Response example