Api Payout

Request

Payout API integration paves the way for streamlined, secure, efficient money transfers to various stakeholders, including employees, customers, vendors, and partners.

Request Path:

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

Header Parameters

Field	Attribute	Type	Description
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, How to signature
X-PARTNER-ID	M	String	merchant ID

Body Parameters

Field	Attribute	Type	Description
orderNo	M	String(32)	unique no. Focus OrderNumber Rule
purpose	M	String(64)	purpose
money	M	Object	Object Model Money
merchant	M	Object	Object Model Merchant
paymentMethod	M	String(6)	Model Object PaymentMethod
cashAccount	M	String(32)	Bank Account number
area	M	Number	Fixed value : 14
productDetail	O	String(128)	production description
callbackUrl	O	String(256)	notify address

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

{
  "orderNo": "2000102900000000000001",
  "paymentMethod": "BANXICO",
  "purpose": "Purpose For Disbursement from Java SDK",
  "additionalParam": {},
  "area": 14,
  "cashAccount": "17385238451",
  "merchant": {
    "merchantId": "20001"
  },
  "money": {
    "amount": 200,
    "currency": "MXN"
  }
}

Response

HTTP Request

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

Body Parameters

Field	Attribute	Type	Description
code	M	String	success = "00"
message	M	String	Response message
orderNo	M	String	transaction unique no
merchant	M	Merchant	Object Model Merchant
disbursementTime	M	String	yyyy-MM-ddTHH:mm:ss-06:00 eg: 2020-12-17T10:55:00-06:00
money	M	Money	Object Model Money
channel	M	Payer	channel
tradeNo	O	String	smilepayz order no
status	O	String	Object Model Status

Example Body – Transaction Request:

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00

{
  "channel": {
    "cashAccount": "123456789",
    "paymentMethod": "BANXICO"
  },
  "code": "00",
  "disbursementTime": "2024-01-13T13:31:11-06:00",
  "merchant": {
    "accountNo": "21220019202402271029",
    "merchantId": "20019",
    "merchantName": "20019"
  },
  "message": "Successful",
  "money": {
    "amount": 20,
    "currency": "MXN"
  },
  "orderNo": "20019ae81ede6-07bb-4c77-9937-658",
  "status": "PROCESSING",
  "tradeNo": "122200192401131501111816"
}

Notification

HTTP Request

Field	Attribute	Type	Description
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	how to check this value

Body Parameters

Field	Attribute	Type	Description
orderNo	M	String	merchant transaction unique no
tradeNo	M	String	smilepayz trade no.
merchantId	M	String	merchant id
merchantName	M	String	merchant name
subMerchantId	O	String	sub merchant id
subMerchantName	O	String	sub merchant name
paymentMethod	M	String	payment method. eg:BCA
transactionTime	M	String	yyyy-MM-ddTHH:mm:ss
status	M	String	Object Model Status
money	M	Object	Object Model Money

Return

Important

Notification please return only string SUCCESS

{
  "merchantId": "20001",
  "merchantName": "test",
  "money": {
    "amount": 10000.0000,
    "currency": "MXN"
  },
  "orderNo": "2000102900000000000001",
  "status": "SUCCESS",
  "tradeNo": "1022000109e998347483949",
  "transactionTime": "2024-07-03T17:34:07"
}

SUCCESS