Fields

accountHolder : String

Get the account holder name of the client's bank account.
bankName : String

Get the name of the client's bank.
bic : String

Get the BIC/SWIFT code for the client's bank account.
iban : String

Get the IBAN of the client's bank account.
paymentReference : BankTransferReference

Get the payment reference the customer should use to transfer monies.

The possible errors that can be raised are:

  • KT-CT-3820: Received both ledger ID and number.
  • KT-CT-3821: Received neither ledger ID nor ledger number.
  • KT-CT-3923: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.
Arguments
accountNumber : String! required

Customer's account number.
ledgerId : ID

Customer's ledger ID for which the payment reference should be generated.
Deprecation
The 'ledgerId' field is deprecated.

Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A'

- Marked as deprecated on 2024-10-22.
- Scheduled for removal on or after 2025-06-25.
ledgerNumber : String

Customer's ledger number for which the payment reference should be generated.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "accountHolder": "bit-present-large-write-rest", "bankName": "strong-red-movie-to-story", "bic": "fact-church-have-minute-best", "iban": "generation-offer-analysis-spring-prepare", "paymentReference": BankTransferReference }