Retrieve a single payout request

Retrieve payout by ID and reference Id

Get A Single Payout by ID

Retrieve details of a Payout Transaction by specifying the payout ID and reference ID.

Method and URL

GET [BASE_URL]/v1/payouts/:{uuid}?referenceId=:{referenceId}

uuid from the response body whenever you create a Payout

referenceId from the request body whenever you create a Payout

Response

Response Body

{
  "code": "00",
  "message": "Success",
  "data": {
    "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"
    },
    "uuid": "d6a46a2c-1b26-40c5-9ca3-e063e69635a0"
  }
}

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

Get A Single Payout by Reference ID

Retrieve details of a Payout Transaction by specifying the payout reference ID.

Method and URL

GET [BASE_URL]/v1/payouts/:{referenceId}?type=single

referenceId from the request body whenever you create a Payout

Response

Response Body

{
  "code": "00",
  "message": "Success",
  "data": [
    {
      "referenceId": "TestJojo24032025-001",
      "inquiryId": "",
      "channelCode": "BRI",
      "channelInformation": {
        "accountNumber": "999966660001",
        "accountName": "Dummy Simulation"
      },
      "amount": {
        "currency": "IDR",
        "value": "25000"
      },
      "description": "Test Jojo",
      "status": "SUCCESS",
      "reason": "",
      "created": "2025-03-24T06:25:43Z",
      "updated": "2025-03-24T06:25:44Z"
    }
  ]
}

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