Skip to content

Servipag

HTTP Request

POST /v1/payments/charges/servipag

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Request Body
{
    "idempotencyKey": "2ec983fa-1c37-679b-809b-067861d000002",
    "amount": 100,
    "currency": "CLP",
    "country": "CL",
    "paymentMethod": "SERVIPAG",
    "paymentFlow": "DIRECT",
    "payer": {
        "name": "Juan Garcia",
        "email": "account@example.com"
    },
    "orderInfo": {  
        "orderId": "test-order-id111"
    },
    "description": "this is a test pay",
    "callbackUrl": "http://api.client.com/notifications"
}
Content-Type: application/json
{
    "transferStatusCode": 200,
    "idempotencyKey": "2ec983fa-1c37-679b-809b-067861d000002",
    "referenceId": "2ec983fa-1c37-679b-809b-067861d000002",
    "paymentFlow": "DIRECT",
    "paymentMethod": "SERVIPAG",
    "amount": 100,
    "currency": "CLP",
    "finalAmount": 100,
    "finalCurrency": "CLP",
    "country": "CL",
    "createTime": "2023-05-30 01:05:42 GMT-07:00",
    "scheduledTime": "2023-05-30 01:05:45 GMT-07:00",
    "finalStatusTime": "2023-05-30 01:05:45 GMT-07:00",
    "payer": {
        "name": "Juan Garcia",
        "email": "account@example.com"
    },
    "transferStatus": "IN_PROGRESS",
    "description": "this is a test pay",
    "callbackUrl": "http://api.client.com/notifications",
    "transferDetails": {
        "servipag": {
            "expiresAt": 1686873540,
            "referenceNumber": "852116540"
        }
    }
}

通知 / 回调

Content-Type: application/json
{
    "eventType": "CHARGE_SUCCEEDED",
    "data": {
        "chargeDetails": {
            "transferStatusCode": 200,
            "transferErrorMsg": null,
            "idempotencyKey": "2ec983fa-1c37-679b-809b-067861d000002",
            "referenceId": "2ec983fa-1c37-679b-809b-067861d000002",
            "paymentMethod": "SERVIPAG",
            "amount": 100,
            "currency": "CLP",
            "country": "CL",
            "finalAmount": 100,
            "finalCurrency": "CLP",
            "createTime": "2023-05-30 01:05:45 GMT-07:00",
            "scheduledTime": "2023-05-30 01:05:45 GMT-07:00",
            "finalStatusTime": "2023-05-30 01:59:59 GMT-07:00",
            "payer": {
                "name": "Juan Garcia",
                "email": "account@example.com"
            },
            "transferDetails": {
                "servipag": {
                    "expiresAt": 1686873540,
                    "referenceNumber": "852116540"
                }
            },
            "transferStatus": "SETTLED",
            "description": "this is a test pay",
            "callbackUrl": "http://api.client.com/notifications"
        }
    }
}

HTTP Headers 字段说明

健 值
Authorization "Bearer" + " " + {{access_token}}
x-api-key {{api_key}}

Request Body 字段说明

参数 必填 类型 描述
idempotencyKey String 商户系统创建的唯一ID， 长度不大于128个字节。
amount Long 收款金额，单位是货币最小粒度。 如 1 = 0.01CLP
country String 国家编号国际缩写码，遵循ISO 3166-1 alpha-2 code标准, 如智利CL
currency String 货币代码，如智利CL
paymentMethod String 交易方式，枚举值SERVIPAG
paymentFlow String 交易流程, DIRECT
payer JSON 买家个人信息
orderInfo JSON 订单信息
description String 描述
callbackUrl String 接收交易状态变更通知的地址，接收post请求
riskData JSON 支付的风险信息。MERCHANT_APP_NAME 或 MERCHANT_WEBSITE 在riskData中必须填一个。 请参考这里查看更多详情。
#### 创建一个带风控信息的支付

请参考这里查看更多详情。

Payer 对象字段说明
参数 必填 类型 描述
name String 名字，全称（入参名字规范：只允许大小写字母，数字和空格的组合。请勿包含西班牙语和葡萄牙语字母，以及其他特殊字符。）
email String 邮箱
phone String 电话号码，需包含“+56”的前缀。
billingAddress JSON 账单邮寄地址
BillingAddress 对象字段说明
参数 必填 类型 描述
zipCode String 邮政编码
state String 州
city String 城市
street String 街道
number String 门牌号
OrderInfo 对象字段说明
参数 必填 类型 描述
orderId String 订单号
shippingInfo JSON 运输信息
ShippingInfo 对象字段说明
参数 必填 类型 描述
name String 名称
phone String 电话号码，需包含“+56”的前缀。
email String 邮箱地址
address JSON 地址信息，结构和billingAddress一致

Response Body 字段说明

参数 类型 描述
transferStatus String 汇款状态，枚举值，"SETTLED", "FAILED", "IN_PROGRESS"
transferStatusCode Integer 此次交易的状态码, 200表示交易成功或者进行中, 其他代表失败
transferErrorMsg String 此次交易失败原因
referenceId String 此次交易的ID
idempotencyKey String 此参数用于幂等目的，交易的唯一标识ID，长度不大于128个字节。
amount Long 收款金额
country String 国家编码 CL
currency String 收款货币代码，长度为3个字节，CLP
finalAmount Long 用于创建收款订单的最终金额。对于需要转换汇率的收款订单，这个字段的值表示源请求金额被转换后的金额。
finalCurrency String finalAmount的收款货币代码
paymentMethod String 支付方式. 枚举值, SERVIPAG
payer JSON 付款人信息
transferDetails JSON 交易类型的详细信息
description String 描述信息
callbackUrl String 商户接收通知的回调地址. 接收http的get请求
createTime String 创建时间
scheduledTime String 执行时间
finalStatusTime String 最终状态更新时间. 最终状态，包括"REFUNDED", "FAILED"
TransferDetails 对象字段说明
参数 类型 描述
servipag JSON servipag的详细信息
Servipag 对象字段说明
参数 类型 描述
referenceNumber String 这个支付的参考编号
expiresAt long 这个支付的过期时间,秒级时间戳，如: 1686873540.

支付状态

参数 描述
IN_PROGRESS 交易处理中
SETTLED 交易完成
REFUNDING 退款中
REFUNDED 已退款
CHARGED_BACK 拒付
FAILED 交易失败，异常

Notification 事件类型

CHARGE_SUCCEEDED,
CHARGE_FAILED,
CHARGE_CHARGED_BACK,
CHARGE_REFUND_SUCCEEDED,
CHARGE_REFUND_FAILED;
Back to top