Apply for inbound external payment channel (RTGS, EFT)

POST /trans/applyExternalPaymentChannelInbound

This API is for BaaS clients to submit a collection request for their externally transferred funds via RTGS, EFT or SWIFT to allow crediting their accounts in Choice Bank

Fields
Type
Description
Required?

accountId

String

The account number that is to be credited

Mandatory

choiceReceivingBank

String

The bank code of the external operational bank they used to send funds to. Please refer to API - Query Operational Bank Account Listarrow-up-right

Mandatory

choiceReceivingAccount

String

Bank account number of the external operational bank that Choice utilises to receive funds

Mandatory

paymentChannel

String

The payment channel that the customer chooses to transfer the money to Choice's bank account.RTGSEFT

Mandatory

payerBankCode

String

bank code of transfer bank. Please refer to "Bank Code" column of the Choice Bank Code Listarrow-up-right.NB: where this parameter is specified, the payerBankName parameter ought not to be supplied

Conditional

payerBankName

String

The name of the counterparty bankNB: where this parameter is specified, the payerBankCode parameter ought not to be supplied

Conditional

payerAccount

String

The account number of the counterparty (Sender)

Mandatory

payerName

String

The name of the counterparty (Sender)

Optional

transactionDate

String

Date of the transfer. Format: Unix timestamp

Mandatory

transferReferenceNumber

String

The reference number of the transfer that was generated by the sending bank

Optional

transactionNarrative

String

Transaction narrations if there's any

Optional

supportDocument

File

Contracts, source of funds or other supporting documents that the Bank may need to reference later.The file is expected to be coded in Base64 representation

Mandatory

documentType

String

Specify the file type of the support documentPDFImageIf this is not given, by default the type is PDF

Optional

amount

String

The amount of the transfer (also the amount that the account has to be credited with)

Mandatory

Response

{
  "applicationId": "", 
}

Last updated