Provide CirclePay the partner’s IP addresses that make the request.
Method: POST
URL:
| Authorization Type | Basic |
|---|---|
| Username | Partner Email |
| Password | hash_hmac(‘sha256’, Partner Email, API Key) |
Content-Type: Multipart / Form-data
| Fields | Description |
|---|---|
| total_amount | Total amount that the partner would like to payout out. (Must less than or equal to the partner wallet amount) Limit: 100,000 - 20,000,000 VND / request |
| bank_code | The partner can request the API in section 3 for the list of bank_code. |
| card_fullname | The bank account name. |
| card_number | The bank account number. |
| reason | Message for the bank transfer. |
| partner_tran_id | The unique ID from the partner to record this payout transaction. |
| token | hash_hmac(‘sha256’,[total_amountBank_code][card_fullname][card_ number][partner_tran_id], the API Key) *The API Key is provided by CirclePay |
| Fields | Description |
|---|---|
| error_code | 00: Successful making the payout request 01: Error with the input fields 02: Method is Maintenance or Disabled 03: Not valid bank_code 04: Not enough balance 05: System error. Please contact CirclePay |
| error_message | Detail message for the error_code |
| tran_id | The request ID of this transaction on CirclePay |
| partner_tran_id | The unique ID from the partner to record this payout transaction. |
| total_amount | Total amount of the request. |
| status | 04: Pending (This is the default status) |