Skip to Navigation | Skip to Content


EFT Payments

EFT Payments are used to execute electronic debits or credits against bank accounts around the world. There are differences in the timing and data required to initiate the payment, depending on the country and clearing systems.

All RAVEN EFT payments follow a similar pattern:

  1. The payment is sent to RAVEN and some basic validation is performed. The payment will then have a status of InProgress or Invalid, in which case a reason will be provided.
  2. RAVEN will submit ‘InProgress’ payments to the bank for processing, at which point the status will be listed as ‘Submitted’. Submission usually happens daily, though there are some exceptions.
  3. Some clearing systems are able to indicate when a payment has cleared and in these instances the payment will be marked as such.
  4. Many clearing systems have a mechanism that allows payments to be returned for a certain time period after they were submitted. In this case the payment will be marked as Returned and a reason will be provided.

Request and Response Fields

The fields that make up a generic EFT payment are described in the following table.The column ‘Req’ indicates if the field forms part of the request to RAVEN or part of the response from RAVEN. Except as noted, RAVEN will echo all request fields in the response. The column Op indicates if a field is mandatory, optional or conditional.

Field Names Type Max. Size Req/Rsp O/C/M Remarks
PRN N 6 Req M The 6 digit payment routing number assigned to you.
PymtType* T 25 Req M Credit and debit from the customer’s perspective. See the country specific sections for more detail.
Amount N 10 Req M Value supplied in base units of currency, with no decimal. E.g. $150.00 is 15000
AccountAmount N 10 Req O Payment amount in the currency of the account associated with the Payment Routing Number. The value of the payment is determined when the payment is processed, based on the exchange rate in effect at that time. If this value is present and is NOT zero, then the Amount field MUST be zero.Value is supplied in base unit of currency, with no decimal. E.g. $150.00 is 15000
Currency* A 3 Req M The three character ISO currency code.
CustomerCountry* A 2 Req O The two character ISO country code of the country where the  bank account is held.
BankNumber*† N * Req * BankNumber: remove any punctuation, preserve leading zeros.
AccountNumber*† N * Req * The number of the customer’s account that is to be debited or credited.  Remove any punctuation, preserve leading zeros.
AccountType* T * Req * Type of account, e.g. savings, chequing etc.
IBAN*† AN+(s) 35 Req * The IBAN (International Bank Account Number) as printed on most customer statements. The exact size and format varies from country to country.  It is constructed by pre-pending the full domestic account information with the country code and the IBAN check digit.
BIC*† AN 12 Req * The BIC (Bank Identification Code) also know as the SWIFT Code, of the bank branch at which the customers account is held.
FullBankAccountNumber*† AN+(s) * Req * *
TaxNumber* Text * Req * Account holder’s tax number.
InstructionReference* AN * Req * Reference number of the payment instruction to the bank that authorizes the debit.
AccountName*† T * Req * The customers name exactly as the customer has supplied when setting up their bank account.
AddressLine1 to Addressline3* T 35 each Req * Account holder’s address.  Up to 3 lines of address information may be provided.
City* T * Req *
PostalCode* T * Req *
Description* T * Req O If present, will be ignored.
Reference T 30 Req C Information the merchant supplies to identifying the payment or customer. Will be echoed on reports.In the case of batch files this field is recommended but optional, in all other cases (RAPI, Virtual Terminal) this field is mandatory and must be unique in the file.
Reference2-10 T 30 Req O Additional 9 reference fields containing information the merchant may supply at their discretion identifying the payment or customer. Will be echoed on reports.
Comment T 1000 Req O Information the merchant may supply at their discretion. Will be echoed on reports.
Status* T 50 Rsp M One of the following status codes.

  • InProgress – payment received and will be processed.
  • Submitted – payment has been submitted to clearing system.
  • Cleared – payment has cleared (not universally supported)
  • Voided – the payment has been voided and will not be processed.
  • Invalid:<field> – some field in the request is invalid
  • Rejected:<reason> – the payment while valid has been rejected for some other reason.
  • ConfigError:<error> – due to a RAVEN configuration error the payment could not be processed.
  • UnexpectedResponse:<value> – bank returned an unexpected error condition.
  • Invalid:TestChannel – payment was submitted to a test channel and the test was successful. If the channel was live the payment would be InProgress.
TrackingNumber N 9 Rsp M RAVEN will return a unique tracking number for each payment processed.

* These fields depend on the specific country or clearing system. These fields are described in the country specific sections as applicable. If they are not described in the country specific section of the documentation, they are not applicable and should not be provided.

† These fields will be copied into recurring payments from their template, as described in the section on recurring payments.

Country Specific Documentation

Australian EFT Payments

Field Names Type Max. Size Req /Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • aueft_credit
  • aueft_debit
Currency A 3 Req M AUD
BankNumber N 6 Req M BankNumber remove any punctuation, preserve leading zeros.
AccountNumber N 9 Req M The number of the customer’s account that is to be debited or credited.  Remove any punctuation, preserve leading zeros.
AccountName T 27 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
Description T 15 Req O If present, will be ignored.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

Austrian EFT Payments

Field Names Type Max. Size Req /Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • ateft_credit
  • ateft_debit
Currency A 3 Req M EUR
BankNumber N 5 Req M BankNumber remove any punctuation, preserve leading zeros.
AccountNumber N 11 Req M The number of the customer’s account that is to be debited or credited.  As printed on customer’s cheque less any punctuation. Will be 4 to 11 digits.
AccountName T 35 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
City T 35 Req O
Description T 140 Req O If present, this text may be displayed to the individual receiving the debit or credit. It will not affect processing. Use the shortest possible value. All values will be converted to uppercase.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

Belgian EFT Payments

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • beeft_credit
  • beeft_debit
Currency A 3 Req M EUR
FullBankAccountNumber N+(s) 22 Req M This is the full Belgian domestic account number as printed on the bottom of a consumer’s check. It is a string of 12 digits, excluding spaces. It consists of the bank code, account number and check digits.   It is typically printed as follows: 123 1234567 12

Spaces to separate the fields may be present.

AccountName T 35 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
InstructionReference T 12 Req C A reference number that identifies the payer. Must be as printed on the mandate signed by the payer. Only required for debits.
Description T 140 Req O If present, this text may be displayed to the individual receiving the debit or credit. It will not affect processing. Use the shortest possible value. All values will be converted to uppercase.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

Brazilian EFT Payments

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • breft_credit
  • breft_debit
Currency A 3 Req M BRL
BankNumber N 8 Req M Composed of two 4 digit elements: the bank number and the branch number.
AccountNumber N 20 Req M The number of the customer’s account that is to be debited or credited.  Remove any punctuation, preserve leading zeros.
AccountName T 27 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
AccountTaxNumber T 14 Req M The account holder’s Brazilian tax number (known as the CPF for private individuals, CNPJ for corporations).
Description T 15 Req O If present, will be ignored.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

Canadian EFT Payments

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • caeft_credit
  • caeft_debit
Currency A 3 Req M CAD
BankNumber N 9 Req M Full 8 digit bank number composed of the branch transit number followed by the institution number. This is as printed on a Canadian check, less any punctuation. For example, if a check has :94000-004: printed on it this should be supplied as 94000004.
AccountNumber N 12 Req M The number of the customer’s account that is to be debited or credited.  Remove any punctuation, preserve leading zeros.
AccountName T 27 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
Description T 20 Req O If present, will be ignored.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

Dutch EFT Payments

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PaymentType T 25 Req M Credit and debit from the account holder’s perspective:

  • nleft_credit
  • nleft_debit
CurrencyCode A 3 Req M EUR
AccountNumber N 10 Req M The number of the customer’s account that is to be debited or credited.  Remove any punctuation, preserve leading zeros.
AccountName T 35 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
City A 35 Req O The city in which the customer’s bank/post bank is located. Supplying this field, especially in the case of post bank accounts (< 7 digits), will substantially reduce the chances of a misdirected payment.
Description T 96 Req O If present, this text may be displayed to the individual receiving the debit or credit. It will not affect processing. Use the shortest possible value.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

EURO Standard Payments

EURO Standard Payments can be used to credit banks within countries in compliance with the standard payments directive. This includes: Austria, Belgium, Bulgaria, Switzerland, Cyprus, Czech Republic, Germany, Denmark, Estonia, Spain, Finland, France, United Kingdom, Gibraltar, Greece, Hungary, Republic Of Ireland, Iceland, Italy, Lithuania, Luxembourg, Latvia, Malta, Netherlands, Norway, Poland, Portugal, Romania, Sweden, Slovenia and Slovakia.

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • esp_credit
Currency A 3 Req M EUR
IBAN AN+(s) 35 Req M The IBAN (International Bank Account Number) as printed on most customer statements. The exact size and format varies from country to country.  It is constructed by pre-pending the full domestic account information with the country code and the IBAN check digit.
BIC AN 12 Req M The BIC (Bank Identification Code) also know as the SWIFT Code, of the bank branch at which the customers account is held.
AccountName T 35 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
Description T 20 Req O If present, this text may be displayed to the individual receiving the debit or credit. It will not affect processing. Use the shortest possible value. All characters will be converted to upper case prior to submission to the bank.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

French EFT Payments

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • freft_credit
  • freft_debit
Currency A 3 Req M EUR
FullBankAccountNumber AN+(s) 26 Req M This is the Relevé d’Identité Bancaire (RIB) as printed on the bottom of a consumer’s check. It is a string of 23 alpha numeric characters, excluding spaces. It consists of the bank code, branch code, account number and check digits.  It is typically printed as follows: 12345 12345 12345678901 12

Spaces to separate the fields may be present.

AccountName T 24 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
Description T 140 Req O If present this text may be displayed to the individual receiving the debit or credit. It will not affect processing. Use the shortest possible value. All characters will be converted to upper case prior to submission to the bank.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

German EFT Payments

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • deeft_credit
  • deeft_debit
Currency A 3 Req M EUR
BankNumber N 8 Req M BankNumber remove any punctuation, preserve leading zeros.
AccountNumber N 10 Req M The number of the customer’s account that is to be debited or credited.  Remove any punctuation, preserve leading zeros.
AccountName T 27 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
Description T 27 Req O If present, this text may be displayed to the individual receiving the debit or credit. It will not affect processing. Use the shortest possible value. All characters will be converted to upper case prior to submission to the bank.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

Hong Kong EFT Payments

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • hkeft_credit
  • hkeft_debit
CurrencyCode A 3 Req M EUR
BankNumber N 7 Req M BankNumber remove any punctuation, preserve leading zeros.
AccountNumber N 9 Req M The number of the customer’s account that is to be debited or credited.  Remove any punctuation, preserve leading zeros.
AccountName T 27 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
Description T 20 Req O If present, this text may be displayed to the individual receiving the debit or credit. It will not affect processing. Use the shortest possible value.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

Indian EFT Payments

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • ineft_credit
  • ineft_debit
Currency A 3 Req M INR
BankNumber N 20 Req M BankNumber remove any punctuation, preserve leading zeros.
AccountNumber N 20 Req M The number of the customer’s account that is to be debited or credited.  Remove any punctuation, preserve leading zeros.
AccountName T 35 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
Description T 50 Req O If present, this text may be displayed to the individual receiving the debit or credit. It will not affect processing. Use the shortest possible value. All characters will be converted to upper case prior to submission to the bank.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

Irish EFT Payments

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • ieeft_credit
  • ieeft_debit
CurrencyCode A 3 Req M EUR
BankNumber N 6 Req M BankNumber remove any punctuation, preserve leading zeros.
AccountNumber N 8 Req M The number of the customer’s account that is to be debited or credited. Remove any punctuation, preserve leading zeros.
AccountName T 18 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
InstructionReference T 18 Req C IE EFT instruction reference number as printed on the original mandate signed by the customer. This only applies to debits.
Description T 20 Req O If present, will be ignored.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

Japanese EFT Payments

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • jpeft_credit
  • jpeft_debit
CurrencyCode A 3 Req M JPY
BankNumber N 7 Req M BankNumber remove any punctuation, preserve leading zeros.
BankName N 30 Req M Full name of beneficiary’s bank.
BankAddress N 30 Req M Full address of beneficiary’s bank.
AccountNumber N 9 Req M The number of the customer’s account that is to be debited or credited.  As printed on customer’s check, less any punctuation. Leading zeros should be preserved.
AccountTypeCode N 25 Req M One of two account types:

  • TOZA
  • FUTSUU
AccountName T 27 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
Description T 20 Req O If present, this text may be displayed to the individual receiving the debit or credit. It will not affect processing. Use the shortest possible value.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

Polish EFT Payments

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • pleft_credit
  • pleft_debit
Currency A 3 Req M EUR
FullBankAccountNumber AN+(s) 26 Req M This is the NRB (equivalent to the IBAN without country code). It is a string of 26 alpha numeric characters, excluding spaces. It consists of the bank-branch code, account number and check digits.   It is typically printed as follows:12 1234 5678 1234 5678 9012 3456Spaces to separate the fields may be present.
AccountName T 35 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
AddressLine1 to Addressline3 T 35 each Req M Account holder’s address. Up to 3 lines of address information may be provided.
InstructionReference T 20 Req C This is the Payment ID number quoted on the Payer’s Direct Debit Mandate. Only required for debits.
Description T 140 Req O If present, this text may be displayed to the individual receiving the debit or credit. It will not affect processing. Use the shortest possible value. All characters will be converted to upper case prior to submission to the bank.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

Russian EFT Payments

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • rueft_credit
  • rueft_debit
Currency A 3 Req M RUB
BankNumber N 20 Req M BankNumber remove any punctuation, preserve leading zeros.
AccountNumber N 20 Req M The number of the customer’s account that is to be debited or credited.  Remove any punctuation, preserve leading zeros.
AccountName T 35 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
Description T 50 Req O If present, this text may be displayed to the individual receiving the debit or credit. It will not affect processing. Use the shortest possible value. All characters will be converted to upper case prior to submission to the bank.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

Singapore EFT Payments

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • sgeft_credit
  • sgeft_debit
Currency A 3 Req M SGD
BankNumber N 7 Req M BankNumber remove any punctuation, preserve leading zeros.
AccountNumber N 10 Req M The number of the customer’s account that is to be debited or credited.  Remove any punctuation, preserve leading zeros.
AccountName T 27 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
Description T 20 Req O If present, this text may be displayed to the individual receiving the debit or credit. It will not affect processing. Use the shortest possible value.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

Spanish EFT Payments

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • eseft_credit
  • eseft_debit
Currency A 3 Req M EUR
FullBankAccountNumber N+(s) 22 Req M This is the “Código Cuenta Cliente”, or CCC for short, as printed on the bottom of a consumer’s check. It is a string of 20 digits, excluding spaces. It consists of the bank code, check digits and account number.  It is typically printed as follows:1234578 12 1234567890Spaces to separate the fields may be present.
AccountName T 24 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
InstructionReference T 12 Req M Reference number that identifies the payer. Must be as printed on the mandate. Only required for debits.
Description T 140 Req O If present, this text may be displayed to the individual receiving the debit or credit. It will not affect processing. Use the shortest possible value.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

Swiss EFT Payments

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • cheft_credit
  • cheft_debit
Currency A 3 Req M CHF
BankNumber N 7 Req C Swiss BC number. Not needed if IBAN is provided.
AccountNumber N 16 Req C The number of the customer’s account that is to be debited or credited.  As printed on customers check or direct debit mandate. Not needed if IBAN is provided.
IBAN AN+(s) 35 Req C The IBAN (International Bank Account Number) as printed on most customer statements. CH or LI IBANs only. Not needed if Bank and Account number are provided.
AccountName T 24 Req M Customer’s name exactly as supplied when setting up their bank account. Incorrect data may result in rejection by the processing bank.
City T 35 Req M Customer’s city exactly as supplied when setting up their bank account. Incorrect data may result in rejection by the processing bank.
PostalCode N 6 Req M Customer’s postal code exactly as supplied when setting up their bank account. Incorrect data may result in rejection by the processing bank.
Description T 140 Req O If present, this text may be displayed to the individual receiving the debit or credit. It will not affect processing.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

Turkish EFT Payments

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • treft_credit
  • treft_debit
Currency A 3 Req M TRY
BankNumber N 20 Req M BankNumber remove any punctuation, preserve leading zeros.
AccountNumber N 20 Req M The number of the customer’s account that is to be debited or credited.  Remove any punctuation, preserve leading zeros.
AccountName T 35 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
Description T 50 Req O If present, this text may be displayed to the individual receiving the debit or credit. It will not affect processing. Use the shortest possible value. All characters will be converted to upper case prior to submission to the bank.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

United Arab Emirates EFT Payments

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • uaeft_credit
  • uaeft_debit
Currency A 3 Req M UAE
BankNumber N 20 Req M BankNumber remove any punctuation, preserve leading zeros.
AccountNumber N 20 Req M The number of the customer’s account that is to be debited or credited.  Remove any punctuation, preserve leading zeros.
AccountName T 35 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
Description T 50 Req O If present, this text may be displayed to the individual receiving the debit or credit. It will not affect processing. Use the shortest possible value. All characters will be converted to upper case prior to submission to the bank.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

Ukrainian EFT Payments

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • uaeft_credit
  • uaeft_debit
Currency A 3 Req M UAH
BankNumber N 20 Req M BankNumber remove any punctuation, preserve leading zeros.
AccountNumber N 20 Req M The number of the customer’s account that is to be debited or credited.  Remove any punctuation, preserve leading zeros.
AccountName T 35 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
Description T 50 Req O If present, this text may be displayed to the individual receiving the debit or credit. It will not affect processing. Use the shortest possible value. All characters will be converted to upper case prior to submission to the bank.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

UK BACS Payments

BACS is the UK low value clearing system. Items are cleared in three days and no notification of clearing is provided. The BACS system allows for mandates to be lodged electronically, and will return an instruction reference that must be provided for any BACS debit payment. The full processing cycle is as follows:

  1. For each account you wish to debit you must send a setup instruction. This establishes your authority to debit the account and need only be sent once. It takes the form of a BACS payment with a type of “bacs_setup_debit” and an amount of zero. The instruction will be returned if the account information is wrong or if the customer declines to provide the requisite authorization. If this setup instruction is not returned after 5 working days you may begin submitting debits. Debits submitted before the waiting period has expired will be returned to you by RAVEN.
  2. To debit the account send a Request file containing EFT requests with a type of “bacs_debit” to RAVEN. These may be one time or reccurring payments depending on your contractual arrangement with the account holder.
  3. Once items have been submitted to the bank for processing you will receive a Result file.
  4. RAVEN will receive notice of items returned due to lack of funds or because authority has been revoked. These will be reported to you in a Return file. If a debit is returned for any reason other than lack of funds you must re-establish your authority to debit as discussed in step 1.
  5. If you choose to re-present items returned due to lack of funds you may do so for a period of one month from the date of the original request. In this case you should use a type of “bacs_rep_debit” you must also supply the tracking number of the original request. You may represent any number of times.
  6. Once your business relationship with the customer has ended you should indicate your intention to stop debiting by sending an EFT request with a type of “bacs_cancel_debit”
  7. In some cases a customer will cancel an instruction. If this happens, you will receive a file indicating which instruction has been cancelled. This file is formatted as a Result file.
Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • bacs_setup_debit
  • bacs_debit
  • bacs_rep_debit
  • bacs_cancel_debit
  • bacs_credit
Currency A 3 Req M GBP
BankNumber N 6 Req M UK Sort code as printed on the customer’s check, less any punctuation.
AccountNumber N 8 Req M The number of the customer’s account that is to be debited or credited.  Remove any punctuation, preserve leading zeros.
AccountName T 18 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
InstructionReference T 12 Req C BACS core reference number as printed on the original mandate signed by the customer.
Description T 20 Req O Will be provided as the description of the payment.
Status T 50 Rsp M As described in general section. Items will be marked as cleared.

UK CHAPS Payments

CHAPS is the UK high value clearing system. Items are generally cleared in one day and notification of clearing is provided.

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • chaps_credit
Currency A 3 Req M GBP
BankNumber N 6 Req M UK Sort code as printed on the customer’s check, less any punctuation.
AccountNumber N 8 Req M The number of the customer’s account that is to be debited or credited.  Remove any punctuation, preserve leading zeros.
AccountName T 18 Req M The customer’s name exactly as the customer has supplied when setting up their bank account.
Description T 20 Req O Will be provided as the description of the payment.
Status T 50 Rsp M As described in general section. Cleared items will be marked as such.

US ACH Payments

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective:

  • usach_ppd_credit
  • usach_ppd_debit
  • usach_tel_debit
  • usach_web_debit
Currency A 3 Req M USD
BankNumber N 9 Req M 8 digit ABA number followed by a check digit. As printed on the customer’s check.
AccountNumber N 9 Req M The number of the customer’s account that is to be debited or credited.Leading zeros should be preserved. The space characters do NOT count when calculating the field length and will be removed prior to processing the payments.
AccountType T 25 Req O Type of account, e.g. savings or checking
AccountName T 22 Req O The customer’s name exactly as the customer has supplied when setting up their bank account.
Description T 16 Req O If present, this text may be displayed to the individual receiving the debit or credit. It will not affect processing. Use the shortest possible value. If not present the value of EFTPYMT will be used.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.

Wire Payments

Wire Payments can be used to credit banks world wide. Because field requirements vary widely depending on the country it is important to review the remarks.

Field Names Type Max. Size Req / Rsp O/C/M Remarks
PymtType T 25 Req M Credit and debit from the account holder’s perspective: wire_credit
Currency A 3 Req M The three character ISO currency code.
IBAN AN+(s) 35 Req O The IBAN (International Bank Account Number) as printed on most customer statements. The exact size and format varies from country to country.  It is constructed by pre-pending the full domestic account information with the country code and the IBAN check digit.

It is strongly advised that this be provided for countries that support IBAN (all of Europe).

BIC AN 12 Req M The BIC (Bank Identification Code) also known as the SWIFT Code, of the bank branch at which the customer’s account is held.
BankNumber AN C Domestic bank number. Required if IBAN is not provided. If a country does not support bank numbers supply 0000.
AccountNumber AN C Domestic bank number. Required if IBAN is not provided.
AccountName T 35 Req M The account name exactly as the customer has supplied when setting up the bank account.
CustomerCountry A 2 Req C The two character ISO country code of the country where the  bank account is held. Required if IBAN is not provided.
AddressLine1 T 35 Req C Bank address. Required if IBAN is not provided.
Description T 20 Req O If present, this text may be displayed to the individual receiving the debit or credit. It will not affect processing. Use the shortest possible value. All characters will be converted to upper case prior to submission to the bank.
Status T 50 Rsp M As described in general section except that items are not marked when cleared.