Pay-In · Bolivia

Request

The Pay-In API lets merchants initiate cashier payments from customers. This page covers Bolivia (country code bo, currency BOB).

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/pay/prePay
Production	https://openapi.toppayment.com/bo/pay/prePay

Bolivia currently supports YAPE only. See Regional Payment Guide — Bolivia.

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(64)	Merchant order number
amount	M	Number(32,8)	Transaction amount; positive, an integer or at most two decimal places
productDetail	M	String(100)	Product detail
method	M	String(16)	Payment method; currently YAPE only
payerAccountNo	C	String(64)	Payer's Yape account; required when method=YAPE
timestamp	M	String(13)	Millisecond timestamp
customerName	M	String(64)	Payer name
customerEmail	M	String(64)	Payer email
customerPhone	M	String(32)	Payer phone
expiryPeriod	O	Number(1-9999)	Validity in minutes
downNotifyUrl	M	String(255)	Async notification URL
redirectUrl	O	String(512)	Redirect URL after payment
sign	M	String	Signature; see Signature

Request Body Example

Content-type: application/json

{
  "mchNo": "{{mchNo}}",
  "orderNum": "BO1234561",
  "amount": 100.50,
  "productDetail": "Product",
  "method": "YAPE",
  "payerAccountNo": "70012345",
  "timestamp": "1749451858772",
  "customerName": "Juan Perez",
  "customerEmail": "[email protected]",
  "customerPhone": "+59170000000",
  "expiryPeriod": 1440,
  "downNotifyUrl": "https://example.com/notify",
  "redirectUrl": "https://example.com/return",
  "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 = success
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
method	M	String	Payment method, currently YAPE
productDetail	M	String	Product detail
customerName	M	String	Payer name
customerEmail	M	String	Payer email
customerPhone	M	String	Payer phone
validTime	M	Number	Expiry timestamp (ms)
cashierUrl	M	String	Cashier URL; redirect the customer here to complete payment

Response Example

{
  "success": true,
  "code": "9999",
  "msg": null,
  "timeStamp": 1767840272829,
  "data": {
    "orderNum": "BO1234561",
    "platOrderNum": "PRE2009093829059153920",
    "amount": 100.50,
    "fee": 2.0,
    "method": "YAPE",
    "productDetail": "Product",
    "customerName": "Juan Perez",
    "customerEmail": "[email protected]",
    "customerPhone": "+59170000000",
    "validTime": 1767926672819,
    "cashierUrl": "https://example.cashier/pay"
  }
}

Notification

HTTP Request (callback)

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, e.g. v1
orderNum	M	String	Merchant order number
amount	M	Number	Amount
fee	M	Number	Fee
customerName	M	String	Customer name
customerEmail	M	String	Customer email
customerPhone	M	String	Customer phone
status	M	String	Status — see Transaction Status Codes
sign	M	String	Callback signature

Response

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

SUCCESS

Notification Example

{
  "platOrderNum": "PRE2009165141186183168",
  "version": "v1",
  "orderNum": "BO1234561",
  "amount": 100.50,
  "fee": 2,
  "customerName": "Juan Perez",
  "customerEmail": "[email protected]",
  "customerPhone": "+59170000000",
  "status": "SUCCESS",
  "sign": "…"
}