AppZone API Documentation
  • Overview
    • Welcome
    • Getting Started
    • Enterprise User Oauth
  • Account
    • Account API
      • Create Account
      • Account Enquiry
      • Freeze Account
      • Unfreeze Account
      • Check Freeze Status
      • Place Lien on Account
      • Remove Lien on Account
      • Check Lien Status
      • Activate Post-No-Debit on Account
      • Deactivate Post-No-Debit on Account
      • Check Post-No-Debit Status
      • Retrieve BVN Details
      • Create Customer and Account
      • Update Account Tier2
      • Get Bank One Balance Enquiry
      • Generate Account Statement
      • Get Active Savings Accounts by CustomerID
      • Search Transactions
      • Get Transactions
  • Customer
    • Customer API
      • Create Customer
      • Update Customer
      • Get Customer by Account Number
  • Loans
    • Loan API
      • Get Loans By Customer Id
      • Get Loan Repayment Schedule
      • Loan Creation Application 2
      • Get Loan Account Balance 2
  • Account Officer
  • Standing Order
    • Standing Order API
      • Standing Order Creation Application2
      • Get Standing Orders By Debit Account Number
      • Cancel Standing Order
  • Fixed Deposit
    • Fixed Deposits API
      • Create Fixed Deposit Account
      • Get Fixed Deposit Account By Account Number
      • Get Fixed Deposit Account By Liquidation Account
      • Get Fixed Deposit Account By Phone Number
  • Transfers
    • Transfer API
      • Name Enquiry
      • Intra Bank (Local) Fund Transfer
      • Intra Bank Transfer
  • Cards
    • Cards API
      • Retrieve Institution Configurations
      • Card Request
      • Get Customer Cards
      • Hotlist Customer Card
      • Check Card Generation Status
      • Link Card to Customer Account
      • Freeze Cards
      • Unfreeze Cards
      • Add Transaction Limit to Customer Card
      • View Transaction Limit on Customer Card
      • Update Transaction Limit on Customer Card
      • Disable channel for customer card
      • Get Card Delivery Options
      • Re-Enable Channel for Customer Card
  • Overdraft
    • Overdraft API
      • Create Overdraft
      • Get Overdraft Interests
      • Get Overdraft Fees
  • Transactions
    • Transactions API
      • Transaction Status Confirmation
      • Credit Customer Account
      • Debit Customer Account
      • Reversals
  • Bills Payment
    • Bills Payment API
      • Get Commercial Bank
      • Get Billers
      • Get Billers Category
      • Get Payment Items
      • Initiate Bills Payment Transaction
  • Messaging
    • Save Bulk SMS
    • Save Email
Powered by GitBook
On this page
  1. Transfers
  2. Transfer API

Intra Bank Transfer

This processes a transfer between two customer accounts from one institution to the other.

To process a transfer between two customer accounts from different institutions you make a post request by passing Amount, AppzoneAccount, Token ,PayerAccountNumber and some other required payload in the request body. Below is an example of how to make a successful post request to inter bank transfer endpoint.

// Live URL 
http://api.mybankone.com/thirdpartyapiservice/apiservice/
Transfer/InterbankTransfer

POST https://staging.mybankone.com/thirdpartyapiservice/apiservice/Transfer/ InterbankTransfer

Request Body

Name
Type
Description

Amount*

String

Amount to be transferred in Kobo

AppzoneAccount

String

Appzone’s account number for Appzone share of fees

Token*

String

Authentication Key for the request

PayerAccountNumber*

String

Account number of sender or paye

Payer*

String

Payer’s account name

RecieversBankCode*

String

Commercial bank sort code that can be gotten from Bills Payment GetCommercialBank method response

ReceiverAccountNumber*

String

Account number of the receiver/beneficiary

ReceiverName*

String

Beneficiary’s name

ReceiverPhoneNumber*

String

Beneficiary’s phone number

ReceiverAccountType*

String

Beneficiary’s account type

ReceiverKYC *

String

Beneficiary’s Know Your Customer value

ReceiverBVN*

String

Beneficiary’s Bank Verification Number

TransactionReference*

String

Unique reference for transaction (maximum of 12 characters)

Narration

String

Transaction Narration (maximum of 100 characters)

NIPSessionID

String

Unique value gotten from Name Enquiry used to process transaction

{
    "Status": "Successful",
 "StatusDescription": null,
 "ReferenceID": 0,
 "UniqueIdentifier": 
"020067152410012328260000000000000000000000",
 "IsSuccessFul": true,
 "ResponseMessage": null,
 "ResponseCode": "00",
 "Reference": "VSGWTWY2097",
 "SessionID": null,
 "RequestStatus": true,
 "ResponseDescription": null,
 "ResponseStatus": "Successful"
}

Important things to note about Inter bank transaction processing response

Transaction Processing Response

Possible Status

A transaction status can any of the following: Pending, Failed, Successful, Reversed, SuccessfulButFeeNotTaken

  • If status Successful and Response Code 00 indicates that the transfer succeeded

  • If status is Pending. A TSQ is required to determine the status of the transaction

  • If response code 91,06. A TSQ is required to determine the status of the transaction

  • Failed: If Status is Failed and response code is not one of the pending codes, then the transaction failed, and a new request can be initiated.

TSQ Processing for Interbank Transfer

Transaction Query Processing (TSQ)

TSQ is required if a transfer response returns pending

  • If IsSuccessful response parameter is true, go ahead to check Status parameter to determine the actual status of the initiated transaction.

  • If IsSuccessful response parameter is false, a TSQ request should be reinitiated to determine the actual status of the initiated transaction.

  • If status is successful then, the initial transaction succeeded.

  • If status is Failed then, the initial transaction failed.

  • If Status is Pending then, a TSQ should be reinitiated to determine actual status of the initial transaction.

Please contact support to investigate and provide further details if status remains as Pending after 5 trials with the TSQ interval time.

PreviousIntra Bank (Local) Fund TransferNextCards API

Last updated 2 years ago