Payout Balance

This API is used to get Payout Balance information

GET [BASE_URL]/v1/payouts/balance?currency=IDR

Response

Response Body

{
  "code": "string",
  "message": "string",
  "data": {
    "availableBalance": {
      "currency": "string",
      "value": "string"
    }
  }
}

Detail Parameter Response

Parameter

Data Type

Requirement

Description

code

String

M

Response code

message

String

M

Response description

data

Object

M

  • availableBalance

Object

M

>> currency

String

M

IDR

>> value

String

M

Amount with 2 decimals

E.g: 10000.00

List of Response Codes

Response Code

Response Message

Error Object

00

Success

-

credentials_invalid

Access Token is Invalid

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "",
        "message": "Request new access token"
      }
    ],
    "traceId": "{trace id}" 
  }
}

service_unavailable

Gateway / Partner service is unavailable

{
  "error": {
    "type": "GATEWAY_ERROR",
    "details": [
      {
        "field": "",
        "message": "Please hit periodically"
      }
    ],
    "traceId": "{trace id}" 
  }
}

general_error

General Error

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "",
        "message": "Please contact our representative team"
      }
    ],
    "traceId": "{trace id}" 
  }
}