Payments
Payments which is a synonym for transfer of funds from one account to another is the most important or core feature of the banking domain. Customers use this feature to meet its various obligations. The funds deposited in the bank are required to be available to be used as and when required by the customers. This is made possible by the various features of ‘Payments’. Thus payments module is designed as per the need and convenience of the customer. The different types of money transfer are anticipated, perceived and developed under the payments module.
For a payment to be effected to a payee, it is required to be added or maintained. Thus Payee Maintenance precedes the payments. The Flow:
Payee/Beneficiary Maintenance
This feature enables maintenance of customers beneficiary whom they intend to transfer funds. In-order to effect the payments the user needs to store the details of the beneficiary. This is a one-time activity and the detail can be modified as and when required. Payee can be added, modified and viewed for all types of transfers and demand drafts. Different API’s are written for viewing the list of payee and for addition and deleting the payees. These are listed below:
Inquiry:
View Payees for money Transfers: Added payees can be viewed using the below API.
GET/payments/payeeGroup/{groupId}/payees
Transact:
Add /Modify/Delete Payee: The maintained payees can be easily selected during the payment. This is a one-time activity required to be done by the users. Users can even personalize the payees by providing a nick name. Below mentioned APIs are used for creating a payee.

Creates payee group

POST/payments/payeeGroup

Creates Internal Payee

POST/payments/payeeGroup/{groupId}/payees/internal

Creates Domestic Payee

POST/payments/payeeGroup/{groupId}/payees/domestic

Creates International Payee

POST/payments/payeeGroup/{groupId}/payees/international

Creates Payee for Demand Draft

POST/payments/payeeGroup/{groupId}/payees/demandDraft

Creates Payee for Peer to Peer Transfer

POST/payments/payeeGroup/{groupId}/payees/peerToPeer
Domestic Payments
Transfer of funds to an account of the beneficiary which would be in any bank within the geographical boundaries of the country bank is referred to as ‘Domestic Account Transfer’. Depending where the account of the payee resides, the transfer is further divided into different types viz–
Inquiry:
View Own/Self-Transfer: Fetches the self-transfer transaction details.
GET/payments/transfers/self
View Internal Account Transfer: Allows user to view all the internal account transfer initiated.
GET/payments/transfers/internal
View Domestic Account Transfer: Fetches details of domestic transfer.
GET/payments/payouts/domestic/{paymentId}
Transact:
Request/Cancel Own Account Transfer: Facilitates transfer of funds between the customers own accounts. This post and patch API initiates and updates the status of a self-transfer initiated by the user. User can even cancel the initiated ‘Self Transfer’

Initiates self-transfer

POST/payments/transfers/self

Updates status of the initiated self-transfer

PATCH/payments/transfers/self/{paymentId}

Cancels self-transfer initiated.

DELETE/payments/transfers/self/{paymentId}
Request/Cancel Internal Account Transfer: Transfer of funds to another account where payee has account within the bank is referred to as ‘Internal Account Transfer’. Below API enables initiate, updating status and cancelling of Internal Transfer.

Initiates internal transfer

POST/payments/transfers/internal

Updates status of internal transfer initiated

PATCH/payments/transfers/internal/{paymentId}

Cancel/Deletes Internal Transfer Transaction

DELETE/payments/transfers/internal/{paymentId}
Request/Cancel Domestic Account Transfer: Use this transfer when the payee to whom the funds are being remitted has account in another bank. Below API is used to initiate, update status and delete a domestic transfer.

Initiates domestic transfer

POST/payments/payouts/domestic

Updates status of domestic transfer initiated

PATCH/payments/payouts/domestic/{paymentId}

Cancels/Deletes Domestic Transfer

DELETE/payments/payouts/domestic/{paymentId}
International Payments
When funds are required to be transferred to an account across the geographical boundaries of the country is referred to as International Payments.
Inquiry:
View International Transfer: Fetches and displays all the international transfers executed by the user.

Fetches details of international transfer.

GET/payments/payouts/international

Fetches details of a specific international transfer.

GET/payments/payouts/international/{paymentId}
Transact:
Request International Account Transfer: Facilitates user to transfer funds to the payee having account in any other bank in another country. The given API would be used to initiate, update status or cancel an international transfer.

Initiates international transfer.

POST/payments/payouts/international

Updates status of international transfer initiated.

PATCH/payments/payouts/international/{paymentId}

Deletes international transfer.

DELETE/payments/payouts/international/{paymentId}
Peer to Peer Payments
Payments effected to the payee’s mobile number or email id or any social media account is referred to as ‘Peer to Peer’ Transfer.
Inquiry:
View Peer to Peer Transfer: List all the peer to peer transactions or even fetches details of an individual transaction.

Fetches details of the peer to peer transaction.

GET/payments/transfers/peerToPeer

Fetches details of a specific peer to peer transaction.

GET/payments/transfers/peerToPeer/{paymentId}
Transact:
Request Peer to Peer Transfer: Enables user to transfer funds to the payee added as a Peer. Its also facilitates updating the status of the transfer or cancelling a peer to peer transfer.

Initiates peer to peer transfer.

POST/payments/transfers/peerToPeer

Updates peer to peer transfer.

PATCH/payments/transfers/peerToPeer/{paymentId}

Cancels peer to peer transfer.

DELETE/payments/transfers/peerToPeer/{paymentId}
Domestic Demand Draft
Demand Draft is an important instrument and often asked for educational or vocational courses. Customers can now request for a demand draft in local currency using the option of Domestic Demand Draft. OB API has facility to issue a domestic demand draft. Any of these drafts can be viewed using the below API. It enables to view or transact in all the drafts requested by the user.
Inquiry:
View Domestic Drafts: Fetches and Lists all the domestic drafts.

Fetches Domestic Demand Drafts details.

GET/payments/drafts/domestic

Fetches Details for a specific demand draft.

GET/payments/drafts/domestic/{paymentId}
Transact:
Request Domestic Demand Draft : Enables to request or issue a demand draft or cancel the draft using the specific rest option.

Initiates a domestic demand request.

POST/payments/drafts/domestic

Cancels or Deletes a domestic demand draft.

DELETE/payments/drafts/domestic/{paymentId}
International Demand Drafts
Similar to domestic demand draft, when draft are required in other than local currency is referred to as ‘International Demand Draft’.
Inquiry:
View International Drafts: OB API has facility to issue a international demand draft as well. These drafts can be viewed using the below API.

Fetches details for International Demand Draft.

GET/payments/drafts/international

Fetches details of specific demand draft.

GET/payments/drafts/international/{paymentId}
Transact:
Request International Demand Draft: Below API’s would facilitate in requesting or cancelling an international demand draft.

Initiates a request for international demand draft.

POST/payments/drafts/international

Updates status of international demand draft transfer.

PATCH/payments/drafts/international/{paymentId}

Cancels or Deletes the international demand draft.

DELETE/payments/drafts/international/{paymentId}
Merchant Transfer
Inquiry:
View Merchant Transfer: Provides the list of all the merchant transactions. Customer can view all or even view a single transaction in detail.

API to fetch the details of Merchant Transfer.

GET/payments/transfers/merchantTransferData
Transact:
Request Merchant Transfer: Persists details of merchant transfer to local system.

API to initiate a Merchant Transfer.

POST/payments/transfers/merchantTransferData
Credit Card Transfer
Payment effected towards settling an outstanding bill of the credit card is referred to as ‘Credit Card Transfer’.
Inquiry:
View Credit Card Transfers: Fetches and lists credit card payment details.
GET/payments/transfers/creditCard

API to fetch a specific credit card transfer.

GET/payments/transfers/creditCard/{paymentId}
Transact:
Request Credit Card Transfer: Payments effected towards the payment of credit card transaction is referred to as ‘Credit Card Transfer’. Listed API enables to update or cancel the transfer.

Initiates a Credit card Transfer.

POST/payments/transfers/creditCard

Updates the status of Credit Card Transfer.

PATCH/payments/transfers/creditCard/{paymentId}

Cancels or Deletes the credit card transfer.

DELETE/payments/transfers/creditCard/{paymentId}
QR Code Transfer
Inquiry:
View QR Code Transfer: List all the QR Code Transactions. Even fetches the details of the single QR code transfer.

Fetch all the QR Code transfers.

GET/payments/transfers/qrCode

Cancels or Deletes the credit card transfer.

GET/payments/transfers/qrCode/{paymentId}
Transact:
Request QR Code based Transfer: Enables initiation or cancellation of a QR Code Transfer. Customers can set up a QR code so that payments can be done by just scanning the QR code. API’s for the same are -

Initiates a QR Code transfer.

POST/payments/transfers/qrCode

Cancels or Deletes a QR code Transfer.

DELETE/payments/transfers/qrCode/{paymentId}
Inward Remittance
Inquiry:
View Inward Remittance: Fetches details of inward remittance. It also lists all the inward remittances received by the customer. Any funds received in other than local currency is termed as inward remittance.

API to fetch the details of inward remittancce.

GET/payments/inwardRemittances

Fetches the details of specific inward remittance.

GET/payments/inwardRemittances/{txnReferenceNo}
Outward Remittance
Inquiry:
View Outward Remittance: Funds transferred in other than local currency is termed as ‘Outward Remittance.’ This feature lists all the outward remittance effected by the customer. Even fetches the details of a single outward remittance.

API to fetch the details of Outward Remittance.

GET/payments/outwardRemittances

Fetches the details of specific inward remittance.

GET/payments/outwardRemittances/{txnReferenceNo}
Standing Instructions
Standing Instructions or SI is a feature provided to the user to simply frequent payments. SI can be set up when user has a need to effect same type of payment at periodic interval. On setting a SI the system effects the payment to the scheduled account at scheduled time.
Inquiry:
View Standing Instructions: – Enables the user to view all the set Standing Instructions. Fetches and lists all the Standing Instructions. A detailed instruction can also be viewed specifying the transaction id. A SI can be set on any type of payment viz own/self, internal, domestic or international. Below API are listed for each type of payment.
Own/Self-

API Fetches the details of Standing Instructions set for self-transfer.

GET/payments/instructions/transfers/self

Fetches the details of a particular Standing Instruction set for self-transfer.

GET/payments/instructions/transfers/self/{instructionId}
Internal-

Fetches the details of Standing Instructions set for Internal Transfer.

GET/payments/instructions/transfers/internal

Fetches the details of particular Standing Instruction set for Internal Transfer.

GET/payments/instructions/transfers/internal/{instructionId}
Domestic-

API to fetch the details Standing Instructions for Domestic Transfer.

GET/payments/instructions/payouts/domestic

Fetches the details of Standing Instructions set for Domestic Transfer.

GET/payments/instructions/payouts/domestic/{instructionId}
International-

API to fetch the details Standing Instructions for International Transfer.

GET/payments/instructions/payouts/international

Fetches the details of a particular Standing Instruction set for International Transfer.

GET/payments/instructions/payouts/international/{instructionId}
Transact:
Request Standing Instructions: Enables user to set up a standing instruction(SI) for a payout. While setting up a SI user needs to input various details as one-time setup. A SI can be schedule for own, internal, domestic or international transfers. Listed below are the API’s which facilitate the setup and initiation of SI.
API for SI of Self Payout:

Initiates the SI for self-transfer

POST/payments/instructions/transfers/self

Updates the status of Standing Instruction set for self-transfer.

PATCH/payments/instructions/transfers/self/{instructionId}

Cancels or Deletes the Standing Instruction for self-transfer.

DELETE/payments/instructions/transfers/self/{instructionId}
API for SI of Internal Payout:

Initiates the SI for Internal Transfer

POST/payments/instructions/transfers/internal

Updates the status of Standing Instruction set for Internal Transfer.

PATCH/payments/instructions/transfers/internal/{instructionId}

Cancels or Deletes the Standing Instruction for Internal Transfer.

DELETE/payments/instructions/transfers/internal/{instructionId}
API for SI of Domestic Payout:

Initiates the SI for Domestic Transfer

POST/payments/instructions/payouts/domestic

Updates the status of Standing Instruction set for Domestic Transfer.

PATCH/payments/instructions/payouts/domestic/{instructionId}

Cancels or Deletes the Standing Instruction for Domestic Transfer.

DELETE/payments/instructions/payouts/domestic/{instructionId}
API SI of International Payout:

Initiates the SI for International Transfer

POST/payments/instructions/payouts/international

Updates the status of Standing Instruction set for International Transfer.

PATCH/payments/instructions/payouts/international/{instructionId}

Cancels and Deletes the Standing Instruction set for International Transfer.

DELETE/payments/instructions/payouts/international/{instructionId}