哥伦比亚
国家域名及编码(哥伦比亚)
| 国家/地区 | 国家编码 | 域名 | 货币代码 | 货币名称 |
|---|---|---|---|---|
| 哥伦比亚 | co | global-co-openapi.toppayment.com | COP | 哥伦比亚比索 |
域名:推荐使用统一域名
openapi.toppayment.com(路径不变);原国别域名仍可继续使用。
实际域名与商户环境以运营配置为准;路径模板与其他国家一致:/sandbox/{countryCode}/...(沙箱)、/{countryCode}/...(生产)。
代收支付方式编码(method)
调用哥伦比亚代收接口(/pay/prePay)时,在 method 传递下列编码:
| 支付方式编码 | 说明 |
|---|---|
| PSE | PSE 网银借记等 |
| NEQUI | NEQUI 钱包 |
| BRE-B-LLAVE | Bre-B Llave |
| CASH | 现金类收银 |
若网关扩展更多 method,以接口返回与运营下发清单为准。开放接口字段及示例见 代收订单-哥伦比亚。
金额格式(代收 / 代付)
正数金额,整数或最多两位小数;不允许全为 0;不允许三位及以上小数。各接口请求体中的 amount 说明见 代收订单-哥伦比亚、代付订单-哥伦比亚。
代收通知规则(多笔到账,与墨西哥一致)
哥伦比亚代收在同一笔商户订单(同一 orderNum)下,可能出现分多笔入账、多笔成功类回调的情形;处理规则与 墨西哥 — 地区支付说明 中「代收通知规则(SPEI / 同一 CLABE 多笔到账)」一致:
orderNum:多次回调中保持不变。platOrderNum:每笔到账事件可对应不同平台单号(多个平台订单号)。- 实付金额类字段(如
payMoney等,以网关实际字段名为准):可表示该次回调对应的单笔实收金额,各次通知可以不同;不要求与下单金额一致。
商户处理建议:以 platOrderNum 作为入账与幂等校验的主键,对每笔通知单独记账、对账。
示意(字段名以实际回调为准;method 仅为示例):
第一次到账通知示例:
{
"code": "00",
"description": "desc",
"method": "PSE",
"msg": "SUCCESS",
"orderNum": "TEST00000000000001",
"payFee": "3",
"payMoney": "25",
"platOrderNum": "PRE10262034203986608803927",
"platSign": "…",
"status": "SUCCESS"
}
第二次到账通知示例(同一 orderNum,不同 platOrderNum 与 payMoney):
{
"code": "00",
"description": "desc",
"method": "PSE",
"msg": "SUCCESS",
"orderNum": "TEST00000000000001",
"payFee": "3",
"payMoney": "15",
"platOrderNum": "SUB1034205556524208141",
"platSign": "…",
"status": "SUCCESS"
}
哥伦比亚证件类型(代付 documentType)
与开放接口代付侧 documentType 取值一致(忽略大小写)。
| 编码 | 说明 |
|---|---|
| CC | 公民身份证(Cédula de ciudadanía) |
| CE | 外国人身份证(Cédula de extranjería) |
| NIT | 税号(Número de Identificación Tributaria) |
| PAS | 护照 |
哥伦比亚代付账户类型(accountType)
与开放接口代付侧 accountType 取值一致(忽略大小写)。对外书写 Bre-B 相关取值时建议使用连字符 BRE-B。
| 编码 | 说明 |
|---|---|
| CORRIENTE | 活期账户 |
| AHORROS | 储蓄账户 |
| BRE-B | Bre-B 类账户 |
| WALLET | 钱包 |
代付银行及对应编码(bankCode / bankName)
以下编码用于哥伦比亚代付订单创建与查询(/disbursement/cash、/disbursement/query)的 bankCode 与展示名 bankName。渠道为网关侧路由分类(Wallet / Transfer),类型为银行或钱包。代付请求体字段及示例见 代付订单-哥伦比亚。
| bankCode | bankName | 渠道 | 类型 |
|---|---|---|---|
| DAVIPLATA | DAVIPLATA | Wallet | 钱包 |
| NEQUI | NEQUI | Wallet | 钱包 |
| RAPPIPAY | RAPPIPAY | Wallet | 钱包 |
| MOVII | MOVII | Wallet | 钱包 |
| IRIS | IRIS | Wallet | 钱包 |
| DALE | DALE | Wallet | 钱包 |
| BANCAMIA | BANCAMIA | Transfer | 银行 |
| AGRARIO | BANCO AGRARIO | Transfer | 银行 |
| SOCIAL | BANCO CAJA SOCIAL | Transfer | 银行 |
| COOPERATIVO | BANCO COOPERATIVO COOPCENTRAL | Transfer | 银行 |
| CREDIFINANCIERA | BANCO CREDIFINANCIERA | Transfer | 银行 |
| DE_BOGOTA | BANCO DE BOGOTA | Transfer | 银行 |
| DE_OCCIDENTE | BANCO DE OCCIDENTE | Transfer | 银行 |
| FALABELLA | BANCO FALABELLA | Transfer | 银行 |
| POPULAR | BANCO POPULAR | Transfer | 银行 |
| SERFINANZA | BANCO SERFINANZA | Transfer | 银行 |
| GNB_SUDAMERIS | BANCO_GNB_SUDAMERIS | Transfer | 银行 |
| BANCOLOMBIA | BANCOLOMBIA | Transfer | 银行 |
| BANCOOMEVA | BANCOOMEVA | Transfer | 银行 |
| BBVA | BBVA | Transfer | 银行 |
| CITIBANK | CITIBANK | Transfer | 银行 |
| COLTEFINANCIERA | COLTEFINANCIERA | Transfer | 银行 |
| COOFINEP | COOFINEP | Transfer | 银行 |
| DAVIVIENDA | DAVIVIENDA | Transfer | 银行 |
| ITAU | ITAU | Transfer | 银行 |
| LULO | LULO BANK | Transfer | 银行 |
| PICHINCHA | PICHINCHA | Transfer | 银行 |
| SCOTIABANK | SCOTIABANK COLPATRIA | Transfer | 银行 |
| COTRAFA | COTRAFA | Transfer | 银行 |
| CFA_COOPERATIVA | CFA COOPERATIVA FINANCIERA | Transfer | 银行 |
| BANCO_UNION | BANCO UNION antes GIROS | Transfer | 银行 |
| SANTANDER | BANCO SANTANDER COLOMBIA | Transfer | 银行 |
| AV_VILLAS | BANCO AV VILLAS | Transfer | 银行 |
| BANCOLDEX_SA | BANCOLDEX S.A. | Transfer | 银行 |
| BNP_PARIBAS | BNP PARIBAS COLOMBIA | Transfer | 银行 |
| MUNDO_MUJER | BANCO MUNDO MUJER | Transfer | 银行 |
| BANCO_W | BANCO W | Transfer | 银行 |
| MIBANCO_SA | MIBANCO S.A. | Transfer | 银行 |
| JPM_SA | BANCO J.P. MORGAN COLOMBIA S.A. | Transfer | 银行 |
| FJ_SA_CDF | FINANCIERA JURISCOOP S.A. COMPAÑIA DE FINANCIAMIENTO | Transfer | 银行 |
| JFK_CF | JFK COOPERATIVA FINANCIERA | Transfer | 银行 |
| COOTRAFA_CF | COOTRAFA COOPERATIVA FINANCIERA | Transfer | 银行 |
| CONFIAR_CF | CONFIAR COOPERATIVA FINANCIERA | Transfer | 银行 |
| BAN100_SA | BAN100 S.A | Transfer | 银行 |
| PIBANK | PIBANK | Transfer | 银行 |
| DING_TECNIPAGOS | DING TECNIPAGOS SA | Transfer | 银行 |
| POWWI | POWWI | Transfer | 银行 |
| UALA | UALA | Transfer | 银行 |
| BTG_PACTUAL | BANCO BTG PACTUAL | Transfer | 银行 |
| BOLD_CF | BOLD CF | Transfer | 银行 |
| NU | NU COLOMBIA | Transfer | 银行 |
| COINK | COINK | Transfer | 银行 |
| SANTANDER_CONSUMER | SANTANDER CONSUMER | Transfer | 银行 |
| GLOBAL66 | GLOBAL66 | Transfer | 银行 |
| CONTACTAR | BANCO CONTACTAR | Transfer | 银行 |
代收与代付订单 status 字段取值说明见 交易状态码。
