Payout Object

A payout object is created when you initiate a payout to a local bank account.

{
  "created": "2024-05-13T08:21:45Z",
  "merchantId": "922e39ab-7565-49f6-b84f-fb56122821ae",
  "payoutResults": {
    "totalFailedAmount": 0,
    "totalFailedCount": 0,
    "totalPendingAmount": 0,
    "totalPendingCount": 0,
    "totalSuccessAmount": 200000,
    "totalSuccessCount": 2
  },
  "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"
    },
    {
      "amount": {
        "currency": "IDR",
        "value": "100000"
      },
      "created": "2024-05-13T08:21:45Z",
      "inquiryId": "d6a46a2c-1b26-40c5-9ca3-e063e69635a0",
      "description": "test Reforza Pivot",
      "channelCode": "BRI",
      "channelInformation": {
        "accountName": "Reforza Pivot",
        "accountNumber": "888801000157508"
      },
      "referenceId": "1999",
      "status": "SUCCESS",
      "reason": "", 
      "updated": "2024-05-13T08:21:46Z"
    }
  ],
  "status": "DONE",
  "updated": "2024-05-13T08:21:46Z",
  "uuid": "d6a46a2c-1b26-40c5-9ca3-e063e69635a0"
}

Detail Payout Object

Parameter	Data Type	Required	Description
created	String	YES	Timestamp when Payout request is made (using ISO 8601, Timezone UTC+0)
merchantId	String	YES	Unique merchant ID given by Pivot
payoutsResults	Object	YES
totalFailedAmount	Integer	YES	Total Amount of all disbursement that has status Failed
totalFailedCount	Integer	YES	The count of all disbursement that has status Failed
totalPendingAmount	Integer	YES	Total Amount of all disbursement that has status Pending
totalPendingCount	Integer	YES	The count of all disbursement that has status Pending
totalSuccessAmount	Integer	YES	Total Amount of all disbursement that has status Success
totalSuccessCount	Integer	YES	The count of all disbursement that has status Success
payouts	Array of Object	YES
amount	Object	YES
amount.value	String	YES	Amount E.g: 10000
amount.currency	String	YES	ISO 4217 Example: Rupiah = IDR
channelCode	String	YES	Channel code for payout destination such as Bank, E wallet or other channels List of Channel code can be accessed here
channelInformation	Object	YES
channelInformation.accountName	String	YES	Account Name of payout destination
channelInformation.accountNumber	String	YES	Account Number of payout destination
created	String	YES	Timestamp when Payout transaction is made (using ISO 8601, Timezone UTC+0)
inquiryId	String		Inquiry ID returned by Pivot from inquiry bank account
description	String	NO	Information that will be seen by beneficiary account in statement Note: Maximum length each channel code is 20 characters Support alphanumeric characters only
referenceId	String	YES	Merchant provide unique identifier for payout request
status	String		Status of Payout transaction : APPROVED / REJECTED (current state always APPROVED in Open API) PENDING SUCCESS FAILED
reason	String		Detail reason for FAILED Payout transaction status Failure Reason
updated	String		Timestamp when Payout transaction status is updated (using ISO 8601, Timezone UTC+0)
status	String		Status of Payout request: IN PROGRESS DONE PENDING
updated	String		Timestamp when Payout request status is updated (using ISO 8601, Timezone UTC+0)
uuid	String		Unique payout ID