Get Group Code Collection Account

Returns the collection account configured for one group code, with its balances. When the group code has no collection account the response body is empty.

GET /merchant/account/{clientId}/collection-account/{groupCode}

Path Parameters

Field Name	Type	Required	Description
clientId	Long	TRUE	Identifier of the merchant
groupCode	String	TRUE	Group code whose collection account is wanted

Response

Field Name	Type	Description
name	String	Account name
bvn	String	BVN on the account
nin	String	NIN on the account
groupCode	String	Group code the account belongs to
accountID	String	10 digit account id
balance	Number	Ledger balance
availableBalance	Number	Balance available to spend
blockedAmount	Number	Amount on hold
mainLedger	Boolean	`true` for the main account of the group code

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Responses

🟢200Success

application/json

Success

Bodyapplication/json

Example

{
  "name": "Sample Merchant Collections",
  "bvn": "22000000000",
  "groupCode": "ER3GZR04KR",
  "accountID": "4000000257",
  "balance": 15000,
  "availableBalance": 14000,
  "blockedAmount": 1000,
  "mainLedger": false
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Get Group Code Collection Account