Withdrawal Object

A withdrawal object is created when you initiate a refund request.

{
  "code": "00",
  "message": "OK",
  "data": {
    "id": "0199130c-f3aa-7024-b547-0ef3216f9602",
    "merchantId": "e485e01b-ff59-4a47-bb7d-9b39064f3388",
    "withdrawal": {
      "referenceId": "TEST-REFORZA-2025-001",
      "withdrawType": "BANK_TRANSFER",
      "balanceType": "PAYOUT_BALANCE",
      "isFullAmount": false,
      "amount": {
        "currency": "IDR",
        "value": "10000"
      },
      "description": "Test Reforza Pivot"
    },
    "status": "SUCCESS",
    "createdAt": "2025-09-04T04:47:20Z",
    "updatedAt": "2025-09-04T04:47:20Z"
  }
}

Detail Withdrawal Object

Parameter	Data Type	Character limit	Requirement	Description
id	String	-	Auto Generated	Unique ID generated from Pivot as withdrawal identifier
merchantId	String	-	M	Unique merchant ID given by Pivot
withdrawal	Object	-	M
referenceId	String	-	M	Unique ID from merchant to identify the withdrawal
withdrawType	String	-	M	Withdrawal destination, possible values: BALANCE_TRANSFER BANK_TRANSFER
balanceType	String	-	C	Required if balanceType = BALANCE_TRANSFER Balance Type: PAYOUT_BALANCE WALLET_BALANCE
isFullAmount	Boolean	-	C	possible values: false (default) true
amount	Object	-	C	Requred if isFullAmount = false
currency	String	1-3	M	Currency ISO 4217
value	String	1-18	M	Amount value
description	String	1-50	O	Information describing the withdrawal for merchant internal notes
status	String	-	M	Status of Withdrawal , possible values: PENDING SUCCESS FAILED
createdAt	String	-	M	Withdrawal created time with format YYYY-MM-DDTHH:MM:SSZ
updatedAt	String	-	M	Withdrawal latest updated time with format YYYY-MM-DDTHH:MM:SSZ