Request

HTTP Request

Service Code	91
Name	API disbursement cash out
Version	v2.0
HTTP Method	POST
Path	{Base URL}/v2.0/disbursement/pay-out

Header Parameters

Area	Field	Attribute	Type	Description
Header	Content-Type	M	String	application/json
	X-TIMESTAMP	M	String	yyyy-MM-ddTHH:mm:ss[zoneOffset] eg: 2020-12-17T10:55:00+07:00
	X-SIGNATURE	M	String	Signature
	X-PARTNER-ID	M	String	merchant_id

Notes: X-SIGNATURE

Tips

• X-SIGNATURE = SHA256withRSA(private_key, stringToSign)
• private_key is merchant rsa private key
• stringToSign = X-TIMESTAMP + "|" + merchant_secret + "|" + minify(requestBody)
• minify(requestBody) is convert the request parameters to JSON string, and then remove line breaks, spaces, and other escape characters
• we provide some development languages minify and SHA256withRSA demo. please refer to signature

Body Parameters

Area	Field	Attribute	Type	Description
Body	orderNo	M	String(32)	unique no. length between 6 and 32
	purpose	M	String(64)	purpose
	money	M	Object	money
	merchant	M	Object	merchant
	paymentMethod	M	String(6)	paymentMethod
	cashAccount	M	String(32)	E-wallet account number/Bank Account number/Digital currency virtual address
	area	C	Number	Area
	additionalParam	C	Object	AdditionalReq
	callbackUrl	O	String(256)	the notify address that to notify merchant the final order status
	itemDetailList	O	List(Object)	ItemDetail
	billingAddress	O	Object	BillingAddress
	shippingAddress	O	Object	ShippingAddress
	productDetail	O	String(128)	production description
	payer	O	Object	payer
	receiver	O	Object	receiver

Note

For cashAccount fields.
If paymentMethod is W_DANA please make sure to use the format of 8xxxxxxx.

OrderNo Format

important

• orderNo format:
  • Only numbers and letters are supported, no special symbols are allowed

Example Body – Disbursement Request:

POST {Base URL}/v2.0/disbursement/pay-out HTTP/1.2

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
X-SIGNATURE: 7MHd9v5/m9JeqmDZVwWBZUZ5J5...7120QnFEny7Qm7uQR1G0TWCh10fsU6nVxiRoeoQ==
X-PARTNER-ID: 20001

{
  "area": "10",
  "orderNo": "2000102900000000000001",
  "purpose": "transaction for business bla bla",
  "productDetail": "electronics. Apple",
  "additionalParam": {},
  "paymentMethod": "BRI",
  "cashAccount": "32473289839938",
  "money": {
    "currency": "IDR",
    "amount": 10000
  },
  "itemDetailList": [
    {
      "name": "Apple",
      "quantity": 1,
      "price": 10000
    }
  ],
  "billingAddress": {
    "countryCode": "Indonesia",
    "city": "Djakarta",
    "address": "djakarta #1002873",
    "postalCode": "10045",
    "phone": "62895359978010"
  },
  "shippingAddress": {
    "countryCode": "Indonesia",
    "city": "Djakarta",
    "address": "djakarta #1002873",
    "postalCode": "10045",
    "phone": "62895359978010"
  },
  "merchant": {
    "merchantId": "20001",
    "merchantName": "Betty",
    "accountNo": "22102014422"
  },
  "payer": {
    "name": "Betty",
    "email": "[email protected]",
    "phone": "62895359978010"
  },
  "receiver": {
    "name": "Vincent.CH",
    "phone": "62895359978010",
    "email": "[email protected]"
  }
}

POST {Base URL}/v2.0/disbursement/pay-out HTTP/1.2


Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
X-SIGNATURE: 7MHd9v5/m9JeqmDZVwWBZUZ5J5...7120QnFEny7Qm7uQR1G0TWCh10fsU6nVxiRoeoQ==
X-PARTNER-ID: 20001

{
  "orderNo": "2001902900000000000001",
  "paymentMethod": "KBANK",
  "purpose": "Purpose For Disbursement from Java SDK",
  "additionalParam": {},
  "area": 11,
  "cashAccount": "17385238451",
  "merchant": {
    "merchantId": "20019"
  },
  "money": {
    "amount": 200,
    "currency": "THB"
  }
}

POST {Base URL}/v2.0/disbursement/pay-out HTTP/1.2

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
X-SIGNATURE: 7MHd9v5/m9JeqmDZVwWBZUZ5J5...7120QnFEny7Qm7uQR1G0TWCh10fsU6nVxiRoeoQ==
X-PARTNER-ID: 20001

{
    "additionalParam": {
        "taxNumber": "123.456.789-09"
    },
    "area": 13,
    "cashAccount": "1234567890",
    "merchant": {
        "merchantId": "20019"
    },
    "money": {
        "amount": 10000,
        "currency": "BRL"
    },
    "orderNo": "20019e2bab4f1-41dd-4e7d-91ce-2ad",
    "paymentMethod": "CPF",
    "purpose": "Purpose For Disbursement from Java SDK"
}

POST {Base URL}/v2.0/disbursement/pay-out HTTP/1.2

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
X-SIGNATURE: 7MHd9v5/m9JeqmDZVwWBZUZ5J5...7120QnFEny7Qm7uQR1G0TWCh10fsU6nVxiRoeoQ==
X-PARTNER-ID: 20001

{
    "additionalParam": {
        "ifscCode": "YESB0000097"
    },
    "area": 12,
    "cashAccount": "1234567890",
    "merchant": {
        "merchantId": "20019"
    },
    "money": {
        "amount": 10000,
        "currency": "INR"
    },
    "orderNo": "20019a069b102-455d-41e8-9428-dac",
    "paymentMethod": "YES",
    "purpose": "Purpose For Disbursement from Java SDK"
}