Pay-Out · Colombia

Request

The Pay-Out API initiates disbursement transactions. This page is for Colombia (country code co). bankCode is the receiving institution string code (see regional guide); bankCard is the beneficiary account or wallet identifier. Colombia Pay-Out also requires accountType, documentType, documentNo, accountPhone, and accountEmail as described below. Full bank list and code tables: Regional Payment Guide — Colombia.

Request URL

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

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

bankCode / bankName — Regional Payment Guide — Colombia.

Request Header

Field	Required	Type	Description
Content-Type	M	String	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)	Amount Colombia: positive, integer or at most 2 decimal places, not all zeros, no three or more decimal places.
bankCode	M	String(32)	Receiving bank/wallet code — Regional Payment Guide — Colombia
bankCard	M	String(50)	Account / card / wallet number; exact format per gateway and bank
accountType	M	String(32)	CORRIENTE / AHORROS / BRE-B / WALLET (case-insensitive) — Regional Payment Guide — Colombia
documentType	M	String(16)	CC / CE / NIT / PAS (case-insensitive) — Regional Payment Guide — Colombia
documentNo	M	String(100)	ID number; length is not validated against documentType.
accountPhone	M	String(32)	Beneficiary phone; must be non-empty; no strict local-format validation.
accountEmail	M	String(255)	Beneficiary email; must be a valid email format
accountName	M	String(50)	Beneficiary name; max 50; Unicode letters, digits, spaces
description	O	String(255)	Description
feeType	M	Number	Fee type 0: Deducted from order amount (net = amount − fee) 1: Fee separate (net = amount)
downNotifyUrl	M	String(164)	Callback URL
timestamp	M	String	Timestamp (13 digits)
sign	M	String	See Signature

Request Body Example (BANCOLOMBIA + sample account; align with your gateway)

Content-type: application/json

{
    "mchNo": "{{mchNo}}",
    "orderNum": "COPAYOUT1234561",
    "amount": 100.50,
    "bankCode": "BANCOLOMBIA",
    "bankCard": "1234567890123456",
    "accountType": "CORRIENTE",
    "documentType": "CC",
    "documentNo": "1234567890",
    "accountPhone": "+573001234567",
    "accountEmail": "[email protected]",
    "accountName": "Maria Lopez",
    "description": "test",
    "feeType": 1,
    "downNotifyUrl": "https://example.com/notify",
    "timestamp": "1749451858772",
    "sign": "Generate per signature rules and replace"
}

Response

HTTP Response

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

Response Body Parameters

Field	Required	Type	Description
success	M	Boolean	Request success
code	M	String	9999 = success; otherwise resolve via status codes before treating as final failure
msg	O	String	Message
timeStamp	M	Number	Server time (ms)
data	M	Object	Payload
orderNum	M	String	Merchant order number
platOrderNum	M	String	Platform order number
amount	M	Number	Amount
fee	M	Number	Fee
feeType	M	Number	Fee type
status	M	Number	Status — Transaction Status Codes
statusMsg	M	String	Status message
bankCode	M	String	Bank code (Colombia) — Regional Payment Guide — Colombia
bankCard	M	String	Account number (masked or echoed)
accountName	M	String	Account name
description	O	String	Description

Content-type: application/json

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

Notification

HTTP Request

Field	Required	Type	Description
Content-Type	M	String	HTTP request content type Fixed value: application/json Indicates JSON request format

Notification Body

Field	Required	Type	Description
platOrderNum	M	String	Platform order number System-generated internal transaction reference Used for internal transaction management and support
version	M	String	Version API version identifier Example: v1
orderNum	M	String	Merchant order number Same as orderNum in the original request Used for transaction identification and verification
amount	M	Number	Transaction amount Confirmed transaction amount
fee	M	Number	Fee Fee charged for the transaction
feeType	M	Number	Fee type 1: Merchant bears the fee
status	M	Number	Transaction status See Transaction Status Codes
statusMsg	M	String	Status message Human-readable order status description
bankCode	M	String	Bank code (Colombia) See Regional Payment Guide — Colombia
bankCard	M	String	Bank card number/account number
accountName	M	String	Account name
description	O	String	Description
sign	M	String	Signature Digital signature of callback data

Response

Important response

Notification response: Return only the string SUCCESS to acknowledge receipt of the notification

{
    "platOrderNum": "TRANS2008812168572567552",
    "version": "v1",
    "orderNum": "COPAYOUT12345648",
    "amount": 111.00,
    "fee": 3,
    "feeType": 1,
    "status": 2,
    "statusMsg": "supplement success!",
    "bankCode": "BANCOLOMBIA",
    "bankCard": "1234567890123456",
    "accountName": "Maria Lopez",
    "description": "test",
    "sign": "…"
}

SUCCESS