Virtual Account Services
  1. Group Codes
Virtual Account Services
  • Introduction
  • Terminologies
  • Webhooks
  • Authentication
  • Account
    • Create Account
      POST
    • Rename Account
      POST
    • Balance Inquiry
      GET
    • Create Bulk Accounts
      POST
    • List Accounts
      GET
  • Transaction
    • Credit Account
      POST
    • Debit Account
      POST
    • Credit Account [Agency Banking]
      POST
    • Debit Account [Agency Banking]
      POST
    • Transaction Query
      GET
    • Transaction Details
      GET
    • Transaction History
      GET
  • Transfer
    • Get Institutions
      GET
    • Name Inquiry
      POST
    • Interbank Transfer
      POST
    • Interbank Transfer [Sync]
      POST
    • Transfer Query
      GET
    • Transfer Enquiry
      GET
    • Virtual Account Intrabank Transfer
      POST
    • Core Banking Intrabank Transfer
      POST
    • Collection Accounts Intrabank Transfer
      POST
  • Invoice
    • Create Invoice
    • Get Invoice Detail
    • List Merchant Invoices
  • Refunds
    • Initiate Refund
    • Get Refund Status
    • Get Refunds
  • Notifications
    • Notification
    • Send Notification
  • Merchant
    • Account
      • Get Account
      • Activate Sub Ledger For Merchant
      • Get SubLedger Callback Urls
      • Set SubLedger Callback Urls
      • Get Collection Accounts
    • Transfer
      • Get Transfer History
      • Get Subledger transfers
      • Get Transfer Details
      • Name Inquiry
    • Refund
      • Refund Details
  • Admin
    • Accounting
      • Get GL Accounts
      • Get Classification Codes
    • Dashboard
      • Dashboard Summary
      • Dashboard Transactions
      • Dashboard Transaction Details
    • Group Codes
      • Get Group Codes
        GET
      • Set Collection Account
        POST
      • Create Group Code
        POST
    • Reporting
      • Get Report Types
      • Get Report Parameters
      • Create Report
      • Get Reports
      • Get Reports Details
  1. Group Codes

Set Collection Account

POST
/admin/groupcodes/setcollectionaccount
This API operation enables merchants to designate a specific account as the primary collection account within the merchant portal. By setting a collection account, merchants can streamline the receipt of payments, ensuring all transactions are directed to a designated account for efficient tracking and reconciliation.

Request Body#

Field NameTypeRequiredDescription
clientIdNumberYesThe unique identifier of the client associated with the collection account.
groupCodeStringYesA unique code representing the group to which the collection account belongs.
collectionAccountNUBANStringYesThe NUBAN (Bank Account Number) of the collection account.

Response Body#

Field NameTypeDescription
clientIdNumberThe unique identifier of the client associated with the collection account.
groupCodeStringA unique code representing the group to which the collection account belongs.
collectionAccountNUBANStringThe NUBAN (Bank Account Number) of the collection account.

Request

Body Params application/json

Example
{
    "clientId":2,
    "groupCode":"822PZCCHVI",
    "collectionAccountNUBAN":"0000000052"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/admin/groupcodes/setcollectionaccount' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clientId":2,
    "groupCode":"822PZCCHVI",
    "collectionAccountNUBAN":"0000000052"
}'

Responses

🟢200Set Collection Amount
application/json
Body

Example
{
    "clientId": 2,
    "groupCode": "822PZCCHVI",
    "collectionAccountNUBAN": "0000000052"
}
Modified at 2025-03-02 14:50:02
Previous
Get Group Codes
Next
Create Group Code
Built with