Response Codes & Failure Reason

Response Codes

Response Code

Response Message

Error Object

Success

credentials_invalid

Signature is Invalid

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "",
        "message": "Make sure the signature value and method is correct"
      }
    ],
    "traceId": "{trace id}" 
  }
}

credentials_invalid

Access Token is Invalid

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

field_format_invalid

Format Field is Invalid

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "{field name}",
        "message": "Make sure {field name} format is correct"
      }
    ],
    "traceId": "{trace id}" 
  }
}

field_required

Mandatory Field is Missing

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "{field name}",
        "message": "Make sure {field name} value is fulfilled"
      }
    ],
    "traceId": "{trace id}" 
  }
}

amount_below_limit

Amount Value below the minimum

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "{field name}",
        "message": "Make sure {field name} amount is above minimum"
      }
    ],
    "traceId": "{trace id}" 
  }
}

resource_already_exists

X-REQUEST-ID is already exists

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "",
        "message": "Use unique X-EXTERNAL-ID"
      }
    ],
    "traceId": "{trace id}" 
  }
}

resource_already_exists

ID is already exists

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "{field name}",
        "message": "Use unique {field name}"
      }
    ],
    "traceId": "{trace id}" 
  }
}

service_unavailable

Gateway / Partner service is unavailable

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

service_unavailable

Gateway / Partner service is unavailable

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

unsupported_channel_code

Channel Code is currently not supported

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "{field name}",
        "message": "Make sure channel code following on the API Document"
      }
    ],
    "traceId": "{trace id}" 
  }
}

resource_missing

Payout ID is not exist

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "",
        "message": "Make sure payout id is correct"
      }
    ],
    "traceId": "{trace id}" 
  }
}

format_invalid

Payout format is invalid

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "",
        "message": "Make sure payout object no more than 1000 items"
      }
    ],
    "traceId": "{trace id}" 
  }
}

resource_missing

Inquiry ID is not exist

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "{field name}",
        "message": "Make sure inquiry id is correct"
      }
    ],
    "traceId": "{trace id}" 
  }
}

general_error

General Error

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

amount_above_limit

Amount value above the maximum

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "{field name}",
        "message": "Make sure {field name} amount is below maximum"
      }
    ],
    "traceId": "{trace id}"
  }
}

daily_payout_limit_exceeded

Exceed daily Payout limit

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "",
        "message": "Remaining amount today: Rp [current Payout balance]. Please try again tomorrow or contact Helpdesk"
      }
    ],
    "trace_id": "{trace id}"
  }
}

payouts_in_process

Payouts are being process

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "",
        "message": "Wait a moment to retrieve the Payout"
      }
    ],
    "trace_id": "{trace id}"
  }
}

format_invalid

Payouts format is invalid

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "",
        "message": "Make sure Payout request format is correct"
      }
    ],
    "trace_id": "{trace id}"
  }
}

Failure Reason

Failure reason will appear whenever Payout Transactin Status is "FAILED"

Failure Reason

Description

Invalid account

Beneficiary account is invalid or doesn't exist

Inactive account

Beneficiary account is inactive

Dormant account

Beneficiary account is closed or deactivated

Failed to process by Bank Network

Bank is failed to process the transaction

Feature not allowed at this time

Merchant is not eligible to access the feature at the moment

Unknown Bank Network error

Undefined Bank error response

Declined due to beneficiary limit

Beneficiary account has already reached the daily limit

PreviousPayout Webhook NextTest Scenarios