Set Collection Account

Sets the collection account of a group code. The collection account must be an account that belongs to the same group code.

POST /merchant/account/{clientId}/collection-accounts

Path Parameter

Field Name	Type	Required	Description
clientId	Long	TRUE	Identifier of the merchant

Request Body

Field Name	Type	Required	Description
groupCode	String	TRUE	Group code to update
collectionAccount	String	TRUE	10 digit account id (NUBAN) of an account inside the group code

Response

Field Name	Type	Description
clientId	Long	Merchant identifier
type	String	Group code type: Normal, Invoice or Utility
subLedgerType	String	Same as `type`
groupCode	String	Group code
accountId	String	Parent account id of the group code
balance	Number	Balance of the group code
description	String	Group code description
enforceExternalId	String	`true` when customer NUBANs are enforced
lastTransDate	String	Date of the last transaction
collectionAccount	String	The collection account now set
createdOn	String	Creation date

Request

Authorization

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

Path Params

Body Params application/json

Example

{
  "groupCode": "ER3GZR04KR",
  "collectionAccount": "4000000257"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Success

Bodyapplication/json

Example

{
  "clientId": 11,
  "type": "Normal",
  "subLedgerType": "Normal",
  "groupCode": "ER3GZR04KR",
  "accountId": "9900000100",
  "balance": 0,
  "description": "Main collections",
  "enforceExternalId": "false",
  "lastTransDate": "2025-01-15T10:15:30",
  "collectionAccount": "4000000257",
  "createdOn": "2025-01-01T09:00:00"
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Set Collection Account