Get payout batch detail with commission lines

GET/v1/referral/admin/payouts/{batchId}

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

batchIdstringrequired

Responses

200OK

batchPayoutBatchItemrequired

Show properties

commission_countinteger<int32>required

created_atstringrequired

idstringrequired

notesstring

paid_atstring

statusstringrequired

total_amount_idrinteger<int64>required

commissionsPayoutCommissionLine[] | nullrequired

Show properties

Array of PayoutCommissionLine

amount_idrinteger<int64>required

commerce_order_nostring

commission_typestringrequired

descriptionstring

idstringrequired

referrer_emailstringrequired

referrer_namestringrequired

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/referral/admin/payouts/string"

const response = await fetch("/v1/referral/admin/payouts/string", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/referral/admin/payouts/string",
)

Response

{
  "batch": {
    "commission_count": 0,
    "created_at": "string",
    "id": "string",
    "notes": "string",
    "paid_at": "string",
    "status": "string",
    "total_amount_idr": 0
  },
  "commissions": [
    {
      "amount_idr": 0,
      "commerce_order_no": "string",
      "commission_type": "string",
      "description": "string",
      "id": "string",
      "referrer_email": "string",
      "referrer_name": "string"
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}