API Reference

Payout Callback

This callback catered the case the payout has been successfully sent to the supplier, that is triggered from payment out process


Parameter:

PathData Type ValidationDescription
additional_infoobjectAdditional information related to the payment
messagestringMessage response related to the payment data
payment_datedatePayment Date by customer / buyer in YYYY-MM-DD
ref_idstringPayment Transaction reference ID created by client
payment_infoobjectPayment data and details which had been made by customer / buyer
payment_info.amountdoubleBilled amount that need to be paid by the customer
payment_info.createdtimestampThe time stamp when the transaction was created
payment_info.paid_amountdoubleAmount of payment that has been paid by the customer
payment_info.paid_attimestampThe time stamp of successful payment
payment_info.updatedtimestampThe time stamp of latest update happens on the payment request
payment_info.channelstringThe payment channel used by customer that identify which brand/channel that we used for identify specific payment method (e.g: visa, mastercard, ovo, bni, etc)
payment_info.grand_amountdoubleTotal amount billed, including additional fees (e.g., admin fee)
payment_info.methodstringThe payment method used by customers.
payment_info.sourcestringThe source of the underlying document. Default value: digpayout
payment_info.statusstringPayment transaction status. Expect that you will received PAID status for successful payment.

JSON Payload

{
  "additional_info": null,
  "message": "transaction succeed",
  "payment_date": "2021-01-21",
  "payment_info": {
    "bank_transfer": {
      "amount": 1234567,
      "created": "2025-08-20T16:10:22.427501665+07:00",
      "paid_amount": 1234567,
      "paid_at": "2025-08-20T16:10:53.536572498+07:00",
      "status": "PAID",
      "updated": "2025-08-20T16:10:53.536572498+07:00"
    },
    "channel": "BCA",
    "grand_amount": 1237567,
    "method": "bank_transfer",
    "source": "digpayout",
    "status": "PAID"
  },
  "ref_id": "987654xxxxx"
}
{
  "additional_info": null,
  "message": "transaction succeed",
  "payment_date": "2021-01-21",
  "payment_info": {
    "credit_card": {
      "amount": 1234567,
      "created": "2025-08-20T16:10:22.427501665+07:00",
      "paid_amount": 1234567,
      "paid_at": "2025-08-20T16:10:53.536572498+07:00",
      "status": "PAID",
      "updated": "2025-08-20T16:10:53.536572498+07:00"
    },
    "channel": "visa",
    "grand_amount": 1237567,
    "method": "credit_card",
    "source": "digpayout",
    "status": "PAID"
  },
  "ref_id": "987654xxxxx"
}
{
  "additional_info": null,
  "message": "transaction succeed",
  "payment_date": "2021-01-21",
  "payment_info": {
    "channel": "OVO",
    "ewallet": {
      "amount": 12345,
      "created": "2025-08-20T16:30:57.759515376+07:00",
      "paid_amount": 12345,
      "paid_at": "2025-08-20T16:31:00.992720561+07:00",
      "status": "PAID",
      "updated": "2025-08-20T16:31:00.992720561+07:00"
    },
    "ewallet_type": "ovo",
    "grand_amount": 13345,
    "method": "ewallet",
    "source": "digpayout",
    "status": "PAID"
  },
  "ref_id": "987654xxxxx"
}
{
  "additional_info": null,
  "message": "transaction succeed",
  "payment_date": "2021-01-21",
  "payment_info": {
    "mitra_pembayaran_digital": {
      "amount": 1234567,
      "created": "2025-08-20T16:10:22.427501665+07:00",
      "paid_amount": 1234567,
      "paid_at": "2025-08-20T16:10:53.536572498+07:00",
      "status": "PAID",
      "updated": "2025-08-20T16:10:53.536572498+07:00"
    },
    "channel": "tokopedia",
    "grand_amount": 1237567,
    "method": "mitra_pembayaran_digital",
    "source": "digpayout",
    "status": "PAID"
  },
  "ref_id": "987654xxxxx"
}