Pay-Out · Bolivia

Request

The Pay-Out API lets merchants initiate payments to beneficiaries. This page covers Bolivia (country code bo, currency BOB). Use platform bank or wallet codes in bankCode; see Regional Payment Guide — Bolivia for the complete list.

Request URL

Domain: Prefer unified host openapi.toppayment.com (path unchanged); legacy country domain (e.g. global-bo-openapi.toppayment.com) remains available.

Environment	URL
Sandbox	https://openapi.toppayment.com/sandbox/bo/disbursement/cash
Production	https://openapi.toppayment.com/bo/disbursement/cash

Request Header

Field	Required	Type	Description
Content-Type	M	String	Fixed value: application/json

Request Body

Field	Required	Type	Description
mchNo	M	String(32)	Merchant number
orderNum	M	String(50)	Merchant order number
amount	M	Number(32,8)	Transaction amount; positive, an integer or at most two decimal places
bankCode	M	String(32)	Receiving bank or wallet code; see Bolivia code list
bankCard	M	String(50)	Beneficiary account; for YAPE, enter the beneficiary's Yape account
accountName	M	String(50)	Beneficiary name
description	O	String(255)	Transaction description
feeType	M	Number	Fee type: 0 deducted from the order amount; 1 charged separately
downNotifyUrl	M	String(164)	Async notification URL
timestamp	M	String(13)	Millisecond timestamp
sign	M	String	Signature; see Signature

Request Body Example

Content-type: application/json

{
  "mchNo": "{{mchNo}}",
  "orderNum": "BOPAYOUT1234561",
  "amount": 100.50,
  "bankCode": "YAPE",
  "bankCard": "70012345",
  "accountName": "Maria Lopez",
  "description": "test",
  "feeType": 1,
  "downNotifyUrl": "https://example.com/notify",
  "timestamp": "1749451858772",
  "sign": "Generate per signature rules and replace"
}

Response

Response Body Parameters

Field	Required	Type	Description
success	M	Boolean	Request success flag
code	M	String	9999 = accepted; determine other outcomes from the order status
msg	O	String	Response message
timeStamp	M	Number	Response timestamp (ms)
data	M	Object	Transaction data
orderNum	M	String	Merchant order number
platOrderNum	M	String	Platform order number
amount	M	Number	Transaction amount
fee	M	Number	Fee
feeType	M	Number	Fee type
status	M	Number	Transaction status; see Transaction Status Codes
statusMsg	M	String	Status message
bankCode	M	String	Bank or wallet code
bankCard	M	String	Beneficiary account
accountName	M	String	Beneficiary name
description	O	String	Transaction description

{
  "success": true,
  "code": "9999",
  "msg": "SUCCESS",
  "timeStamp": 1767772957433,
  "data": {
    "orderNum": "BOPAYOUT1234561",
    "platOrderNum": "TRANS2008811496544403456",
    "amount": 100.50,
    "fee": 2,
    "feeType": 1,
    "status": 1,
    "statusMsg": "ORDER_RECEIVED_PROCESSING",
    "bankCode": "YAPE",
    "bankCard": "70012345",
    "accountName": "Maria Lopez",
    "description": "test"
  }
}

Notification

HTTP Request

Field	Required	Type	Description
Content-Type	M	String	application/json

Notification Body

Field	Required	Type	Description
platOrderNum	M	String	Platform order number
version	M	String	API version
orderNum	M	String	Merchant order number
amount	M	Number	Transaction amount
fee	M	Number	Fee
feeType	M	Number	Fee type
status	M	Number	Transaction status; see Transaction Status Codes
statusMsg	M	String	Status message
bankCode	M	String	Bank or wallet code
bankCard	M	String	Beneficiary account
accountName	M	String	Beneficiary name
description	O	String	Transaction description
sign	M	String	Notification signature

Response

Verify the signature, then return the plain string SUCCESS only.

SUCCESS

Notification Example

{
  "platOrderNum": "TRANS2008812168572567552",
  "version": "v1",
  "orderNum": "BOPAYOUT1234561",
  "amount": 100.50,
  "fee": 2,
  "feeType": 1,
  "status": 2,
  "statusMsg": "SUCCESS",
  "bankCode": "YAPE",
  "bankCard": "70012345",
  "accountName": "Maria Lopez",
  "description": "test",
  "sign": "…"
}