Create a Payout

Create payout transactions, supports capability for bulk payout or single payout.

Method and URL

POST [BASE_URL]/v1/payouts

Request

Request Body using Inquiry ID

{
  "payouts": [
    {
      "referenceId": "1999",
      "inquiryId": "d6a46a2c-1b26-40c5-9ca3-e063e69635a0",
      "amount": {
        "value": "100000",
        "currency": "IDR"
      },
      "description": "test Reforza Pivot"
    }
  ]
}

Detail Parameter Request

Parameter	Data Type	Character limit	Requirement	Description
payouts	Array of Object	1-1000	M
referenceId	String	1-100	M	Merchant provide unique identifier for payout request
inquiryId	Uuid	-	M	Merchant provide Inquiry ID returned by Pivot from inquiry bank account
amount	Object	-	M
value	String	-	M	Amount E.g: 10000
currency	String	1-10	M	ISO 4217 Example: Rupiah = IDR
description	String	1-20	O	Information that will be seen by beneficiary account in statement Note: Maximum length each channel code is 20 characters Support alphanumeric characters only

Request Body using Channel Code & Channel Information

{
  "payouts": [
    {
      "referenceId": "999",
      "channelCode": "BRI",
      "channelInformation": {
        "accountNumber": "888801000157508",
        "accountName": "Reforza Pivot"
      },
      "amount": {
        "value": "100000",
        "currency": "IDR"
      },
      "description": "test Reforza Pivot"
    }
  ]
}

Detail Parameter Request

Parameter	Data Type	Character limit	Requirement	Description
payouts	Array of Object	1-1000	M
referenceId	String	1-100	M	Merchant provide unique identifier for payout request
channelCode	String	1-30	M	Channel code for payout destination such as Bank, E wallet or other channels List of Channel code can be accessed here
channelInformation	Object	-	M
accountNumber	String	1-60	M	Account Number of payout destination
accountName	String	1-60	M	Account Name of payout destination
amount	Object	-	M
value	String	-	M	Amount E.g: 10000
currency	String	1-10	M	ISO 4217 Example: Rupiah = IDR
description	String	1-20	O	Information that will be seen by beneficiary account in statement Note: Maximum length each channel code is 20 characters Support alphanumeric characters only

Response

Response Body

{
  "code": "00",
  "message": "Success",
  "data": {
    "created": "2024-05-13T08:21:44.967496435Z",
    "merchantId": "922e39ab-7565-49f6-b84f-fb56122821ae",
    "payouts": [
      {
        "amount": {
          "currency": "IDR",
          "value": "100000"
        },
        "inquiryId": "",
        "channelCode": "BRI",
        "channelInformation": {
          "accountName": "Reforza Pivot",
          "accountNumber": "888801000157508"
        },
        "description": "test Reforza Pivot",
        "referenceId": "999"
      }
    ],
    "status": "IN_PROGRESS",
    "updated": "2024-05-13T08:21:44.967496538Z",
    "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