Disbursement

• Short Description
• Request URL
• Request Method
• Account Type
• ID Type
• Header
• Request Body
• Request Example
• Response Results
• Accepted Response Example

Tips

The Payout API is used to initiate transfer requests to e-wallets or bank accounts.

• All requests use the POST method and the data format is JSON.

Short Description

Refer to the bank list for supported bank codes.

Request URL

• /v1/paypro/payOut

Request Method

• Method: POST
• Content-Type: application/json

Account Type

accountType	Description
AHORRO	Savings account. Use AHORRO for Colombia payout wallet accounts.
CORRIENTE	Checking account

ID Type

idType	Description
CC	Citizen ID Card, 6–10 digits
CE	Foreigner ID Card, 6–10 digits
NIT	Tax ID, 9 digits
PA	Passport, 9 digits

Header

Header	Required	Type	Description
merchantNo	Yes	String	Merchant number

Request Body

Parameter Name	Required	Type	Description
sign	Yes	String	Sort all fields except sign alphabetically and concatenate them as key1=value1key2=value2.... Use the app secret as the salt for MD5 encryption. The result must be lowercase.
timestamp	Yes	Long	13-digit Unix timestamp in milliseconds
tradeNo	Yes	String	Unique merchant transaction number. A timestamp plus a random number is recommended.
amount	Yes	String	Payout amount in COP, expressed as an integer string. Decimals are not supported.
bankCode	Yes	String	Bank code. Refer to the bank list.
accountType	Yes	String	Account type. Refer to the account-type table above.
bankNumber	Yes	String	Recipient's bank account number or wallet account identifier
name	Yes	String	Recipient's full name
mobile	Yes	String	Recipient's 10-digit mobile number, starting with 3
email	Yes	String	Recipient's email address
idType	Yes	String	ID type. Refer to the ID-type table above.
idCardNumber	Yes	String	Recipient's ID number. It must match the selected idType.
notifyUrl	Yes	String	HTTPS endpoint that receives asynchronous server-to-server transaction notifications
remark	Yes	String	Merchant remark returned unchanged in the response

Request Example

{
  "timestamp": 1750649949476,
  "tradeNo": "XDfKV3nX6sMnDVitqTUIO",
  "amount": "100",
  "name": "Test",
  "bankCode": "0001",
  "accountType": "AHORRO",
  "bankNumber": "09361961511",
  "idType": "CC",
  "idCardNumber": "1114818656",
  "mobile": "3123456789",
  "email": "recipient@example.com",
  "notifyUrl": "https://merchant.example/payout/notify",
  "remark": "Test remark",
  "sign": "2fc96846f313661bd088227ea06bd517"
}

Response Results

Parameter Name	Required	Type	Description
msg	Yes	String	Request result. A value of success only means the request was accepted and must not be used as the transaction result.
code	Yes	String	Request response code. 0000 only means the request was accepted. Refer to the error-code documentation for other values.
timestamp	Yes	Long	Transaction timestamp
success	Yes	Boolean	Whether the API request was accepted
data	Yes	Object	Response object
data.tradeNo	Yes	String	Merchant transaction number
data.platFormTradeNo	Yes	String	Paypro transaction number, unique
data.status	Yes	String	Transaction status: 0000 success, 0015 processing, or 00029 failed.
data.desc	Yes	String	Status description
data.remark	Yes	String	Merchant remark returned unchanged

Accepted Response Example

{
  "msg": "success",
  "code": "0000",
  "timestamp": 1728611805322,
  "success": true,
  "data": {
    "tradeNo": "test_111",
    "platFormTradeNo": "2tjba3vz6wm6hx3l",
    "status": "0015",
    "desc": "CREATED",
    "remark": "test"
  }
}