Retrieve a Payout

Retrieve Payout by ID

Retrieve details of a Payout Request by specifying the payout id.

GET [BASE_URL]/v1/payouts/:id

Detail Parameter Request

• id : "uuid" from response body whenever you create Single / Bulk Payout

Response

Response Body

{
  "code": "00",
  "message": "Success",
  "data": {
    "created": "2024-05-13T08:21:45Z",
    "merchantId": "922e39ab-7565-49f6-b84f-fb56122821ae",
    "payoutResults": {
      "totalFailedAmount": 0,
      "totalFailedCount": 0,
      "totalPendingAmount": 0,
      "totalPendingCount": 0,
      "totalSuccessAmount": 100000,
      "totalSuccessCount": 1
    },
    "payouts": [
      {
        "amount": {
          "currency": "IDR",
          "value": "100000"
        },
        "channelCode": "BRI",
        "channelInformation": {
          "accountName": "Reforza Pivot",
          "accountNumber": "888801000157508"
        },
        "created": "2024-05-13T08:21:45Z",
        "inquiryId": "d6a46a2c-1b26-40c5-9ca3-e063e69635a0",
        "description": "test Reforza Pivot",
        "referenceId": "999",
        "status": "SUCCESS",
        "reason": "",
        "updated": "2024-05-13T08:21:46Z"
      }
    ],
    "status": "DONE",
    "updated": "2024-05-13T08:21:46Z",
    "uuid": "d6a46a2c-1b26-40c5-9ca3-e063e69635a0"
  },
  "pagination": {
    "page": 1,
    "perPage": 20,
    "totalItems": 1,
    "totalPages": 1
  }
}

Detail Parameter Response

Parameter	Data Type	Requirement	Description
code	String	M	Response code
message	String	M	Response description
data	Object	M	Payout Object. Refers to Payout Object