Get Branch Codes

GET 
https://api.cleverhub.co/api/v2/payouts/branch_codes

You can get branch codes for a payout payment. Currently we only support branch codes for payout method vn_bank_vnd. Branch code is required when:

• Payout amount is greater than 300,000,000 VND
• The bank is in the list of banks requiring branch code

Request

Query Parameters

payout_method_name stringrequired
Payout method name
Example: vn_bank_vnd
swift_code stringrequired
SWIFT code
Example: SICOVNVX

Responses

200

OK

application/json

Schema

Schema

branch_codes object[]
Array [
branch_codestring
Branch code
Example: 79600001
branch_namestring
Branch name
Example: NH THE SIAM COMMERCIAL BANK PUBLIC-CN TP HO CHI MINH (NH The Siam Commercial Bank Public)
]

Example (auto)

{
  "branch_codes": [
    {
      "branch_code": "79600001",
      "branch_name": "NH THE SIAM COMMERCIAL BANK PUBLIC-CN TP HO CHI MINH (NH The Siam Commercial Bank Public)"
    }
  ]
}

400

Bad Request

401

Unauthorized

application/json

Schema

Schema

errors object
codestring
messagestring

Example (auto)

{
  "errors": {
    "code": "string",
    "message": "string"
  }
}

Example

{
  "errors": {
    "code": "REQUIRE_LOGIN",
    "message": "Not Authorised"
  }
}

422

Unprocessable Entity

application/json

Schema

Schema

errors object
messagestring

Example (auto)

{
  "errors": {
    "message": "string"
  }
}

Example

{
  "errors": {
    "message": "Error Lấy danh sách chi nhánh ngân hàng thất bại"
  }
}

Authorization: app-id

name: app-idtype: apiKeydescription: The app-id is registered and secured inside Hello Clever system and only required when client has initiated or in the middle of the transaction.in: header

name: secret-keytype: apiKeydescription: The secret-key is our client's secret of the source. Required if a publishable key is used to retrieve the source.in: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.cleverhub.co/api/v2/payouts/branch_codes");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("app-id", "<app-id>");
request.Headers.Add("secret-key", "<app-id>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.cleverhub.co/api

Auth

app-id

secret-key

Parameters

payout_method_name — queryrequired

swift_code — queryrequired

ResponseClear

Click the Send API Request button above and see the response here!