Set Collection Account

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 Name	Type	Required	Description
clientId	Number	Yes	The unique identifier of the client associated with the collection account.
groupCode	String	Yes	A unique code representing the group to which the collection account belongs.
collectionAccountNUBAN	String	Yes	The NUBAN (Bank Account Number) of the collection account.

Response Body

Field Name	Type	Description
clientId	Number	The unique identifier of the client associated with the collection account.
groupCode	String	A unique code representing the group to which the collection account belongs.
collectionAccountNUBAN	String	The NUBAN (Bank Account Number) of the collection account.

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

Body Params application/json

Example

{
  "clientId": 2,
  "groupCode": "822PZCCHVI",
  "collectionAccountNUBAN": "4973039672"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Response

application/json

Bodyapplication/json

Example

{
  "clientId": 2,
  "groupCode": "822PZCCHVI",
  "collectionAccountNUBAN": "4973039672"
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Request Body#

Response Body#

Request

Request Code Samples

Responses

Request Body

Response Body