Import Batch Transfers

Import Batch Transfers

The Import Batch Transfers service is used to create one batch in a single request, which may contain multiple transfer orders.

Only one batch can be imported in one request.

A maximum of 1000 transfer orders can be sent in a batch.

For a batch transfer, the common debit account is sent at the top level of the request in the debitAccount field, while individual transfers are sent in the transferOrders array.


Endpoint

POST /bab/v1/transfers/batch


Request Parameters

FieldTypeRequiredDescription
batchNamestringBatch name
debitAccountobject / AccountIdentificationCommon debit account
transferOrdersarray / TransferOrderList of transfers included in the batch
The array must not be empty
batchTransferExternalIdstring / integerExternal transfer ID assigned by the client system
validateReceiverIdentifierstringReceiver identifier validation parameter

TransferOrder object

FieldTypeRequiredDescription
transferTypestringTransfer type
documentNumberintegerDocument number
positionintegerOrder position in the batch
amountobject / MoneyAmount and currency
descriptionstringDepends on typeTransfer purpose
additionalDescriptionstringAdditional description
creditAccountobject / AccountIdentificationDepends on typeBeneficiary account
beneficiaryNamestringDepends on typeBeneficiary name
beneficiaryTaxCodestringBeneficiary identification / tax code
beneficiaryBankCodestringDepends on typeBeneficiary bank code
beneficiaryBankNamestringBeneficiary bank name
beneficiaryAddressstringDepends on typeBeneficiary address for a foreign currency transfer to another bank
chargeDetailsstringDepends on typeCharge details for a foreign currency transfer to another bank
taxpayerCodestringDepends on typeTaxpayer code for a treasury transfer
taxpayerNamestringDepends on typeTaxpayer name for a treasury transfer
treasuryCodestringDepends on typeTreasury code

AccountIdentification object

FieldTypeRequiredDescription
accountNumberstringAccount number / IBAN
accountCurrencyCodestringAccount currency ISO code

Money object

FieldTypeRequiredDescription
amountnumberAmount. Must be greater than 0
currencystringCurrency ISO code

Transfer Types

TransferTypeDescription
TransferToOwnAccountTransfer between own accounts
TransferWithinBankTransfer to another account within TBC Bank
TransferToOtherBankNationalCurrencyTransfer to another bank in national currency
TransferToOtherBankForeignCurrencyTransfer to another bank in foreign currency
TreasuryTransferTreasury transfer
TreasuryTransfer instead of 3rd personTreasury transfer on behalf of a third person

Response Parameters

FieldTypeDescription
batchTransferIdintegerInternal ID of the batch transfer created in the bank's system

Rules

RuleDescription
debitAccount is requiredThe common debit account of the batch must be filled
transferOrders is requiredThe array must be filled and must not be empty
Maximum 1000 ordersA maximum of 1000 transfer orders can be sent in one batch
position logicIf position is provided for one order, it must be provided for all orders
Account formatDebit / Credit account numbers must be in the appropriate format
Currency formataccountCurrencyCode must be in the appropriate ISO format
business rule validationFields and currency restrictions are validated according to the relevant rules based on transfer type

Request / Response Examples

{
 “batchTrasnferExternalId”: “123456”,
  "batchName": "Test Batch",
  "debitAccount": {
    "accountNumber": "GE61TB7625533660958000",
    "accountCurrencyCode": "GEL"
  },
  "transferOrders": [
    {
      "transferType": "TransferWithinBank",
      "documentNumber": 1,
      "position": 1,
      "amount": {
        "amount": 1,
        "currency": "GEL"
      },
      "description": "transfer within bank",
      "additionalDescription": "string",
      "beneficiaryName": "Test Beneficiary 1",
      "creditAccount": {
        "accountNumber": "GE44TB0600051509630000",
        "accountCurrencyCode": "GEL"
      }
    },
    {
      "transferType": "TransferToOwnAccount",
      "documentNumber": 2,
      "position": 2,
      "amount": {
        "amount": 2,
        "currency": "GEL"
      },
      "description": "transfer to own account",
      "additionalDescription": "string",
      "creditAccount": {
        "accountNumber": "GE41TB7849963286076000",
        "accountCurrencyCode": "GEL"
      }
    },
    {
      "transferType": "TransferToOtherBankNationalCurrency",
      "documentNumber": 3,
      "position": 3,
      "amount": {
        "amount": 30,
        "currency": "GEL"
      },
      "description": "transfer to other bank",
      "additionalDescription": "string",
      "beneficiaryName": "Other Bank Beneficiary",
      "beneficiaryTaxCode": "123456789",
      "beneficiaryBankCode": "TB",
      "beneficiaryBankName": "TBC Bank",
      "creditAccount": {
        "accountNumber": "GE90BG0000000589021000",
        "accountCurrencyCode": "GEL"
      }
    }
  ]
}
{
  "batchTransferId": 184729
}