Starpago

代收

代收订单创建

/api/v3/payment/create POST

！注意事项

支付完成状态与订单金额不挂钩，订单状态为"PAID"时，并不等于订单金额(amount字段)已完全成交，请以实际成交额为准(paidAmount字段)，详情请咨询工作人员

请求参数

Body 参数(application/json)

{
  "merOrderNo": "20220408123109677",  // 商户订单号
  "currency": "MXN",   // 币种
  "amount": 1,   // 金额（可保留2位有效小数）
  "payMethod": "xxx", // 支付类型（详询工作人员）
  "extra":{}, // 拓展参数，不同币种略有不同，详见extra参数部分
  "returnUrl": "https://www.starpago.com/",  // 支付成功或者失败跳转地址
  "notifyUrl": "https://www.starpago.com/",  // 消息通知回调地址
}

curl --location -g --request POST 'https://api.starpago.com/api/v3/payment/create' \
--header 'User-Agent: apiHttp' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtaWQiOjEwMCwidHlwZSI6Im1lcmNoYW50IiwiaXNzIjoic3RhcnBhZ28iLCJleHAiOjE3MjU0NTY0NzN9.TTWj2Ctem2qfPhLtvpx4XG5lrXUH4veQD7dsQb0B9SI' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merOrderNo": "20220408123109677",
    "currency": "MXN",
    "amount": 1,
    "payMethod": "xxx",
    "extra": {
        "repeat": true
      },
    "returnUrl": "https://www.starpago.com/",
    "notifyUrl": "https://www.starpago.com/",
}'

返回响应

{
    "code": 0,
    "data": {
      "amount": 1, // 订单金额
      "params": {
        "clabe": "123456789012345678",
        "url": "https://h5.starpago.com/payment/94230311013500999186060015"
      }, // 不同币种，内容响应略有不同，具体以实际响应为主
      "status": "PENDING",
      "orderNo": "94230311013500999186060015",
      "currency": "MXN",
      "payMethod": "xxx",
      "createTime": 1678498652499,
      "merOrderNo": "orderxxx",
      "updateTime": 1678498652719
    },
    "msg": "请求成功"
}

代收订单查询

/api/v3/payment/query GET

请求参数

URL 参数

{
  "orderNo": "orderNo*****",  // Starpago订单号
  "merOrderNo": "merOrderNo****" // 商户端订单号(部分币种此订单号会重复使用，请勿用作唯一性数据判断)
}

curl --location -g --request GET 'https://api.starpago.com/api/v3/payment/query?orderNo=20220408123109677' \
--header 'User-Agent: apiHttp' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtaWQiOjEwMCwidHlwZSI6Im1lcmNoYW50IiwiaXNzIjoic3RhcnBhZ28iLCJleHAiOjE3MjU0NTY0NzN9.TTWj2Ctem2qfPhLtvpx4XG5lrXUH4veQD7dsQb0B9SI'

返回响应

{
    "code": 0,
    "data": {
        "amount": 1, // 订单金额
        "paidAmount": 0, // 实际成交金额，金额处理请以此为准
        "tradeCharge": 5, // 交易手费费，该值在交易完成之前无效
        "tradeNo": "xxx", // 渠道交易号(非固定存在)
        "params": {
            "clabe": "123456789012345678",
            "url": "https://h5.starpago.com/payment/94230311013500999186060015"
        }, // 不同币种，内容响应略有不同，具体以实际响应为主
        "status": "PENDING",
        "orderNo": "94230311013500999186060015",
        "currency": "MXN",
        "payMethod": "xxx",
        "createTime": 1678498652499,
        "merOrderNo": "orderxxx",
        "updateTime": 1678498652719,
        "payer": {}, // 付款人信息(非固定存在)
    },
    "msg": "请求成功"
}

代收 Extra 参数

(BRL) 巴西

// payMethod: PIX
{
  "payerCPF": "xxx", // 付款人CPF
  "payerName": "xxx", // 付款人名称
}

(COP) 哥伦比亚

// payMethod: PSE
{
  "customerName": "xxx", // 客户名称
  "customerPhone": "xxx", // 客户手机号（10位数字串）
  "customerEmail": "xxx", // 客户邮箱
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user type. Allowed values: CC, TI, CE, PA, NIT
  "bankCode": "xxx", // 银行代码
}

// payMethod: NEQUI
{
  "customerName": "xxx", // 客户名称
  "customerPhone": "xxx", // 客户手机号（10位数字串）
  "customerEmail": "xxx", // 客户邮箱
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user type. Allowed values: CC, TI, CE, PA, NIT
  "accountNo": "xxx", // NEQUI钱包账号
}

// payMethod: BREB
{
  "customerName": "xxx", // 客户名称
  "customerPhone": "xxx", // 客户手机号（10位数字串）
  "customerEmail": "xxx", // 客户邮箱
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user type. Allowed values: CC, TI, CE, PA, NIT
}

(MXN) 墨西哥

// payMethod: CLABE
{
  "repeat": false, // 是否可重复收款 (bool值)
  "minAmount": 0, // [选填] 最小可允许收款金额
  "maxAmount": 0 // [选填] 最大可允许收款金额
}

// payMethod: OXXO
{} // 无可用数据，可忽略

// payMethod: CASH
{} // 无可用数据，可忽略

(CLP) 智利

// payMethod: WEBPAY
{
  "customerName": "xxx", // 客户名称
  "customerEmail": "xxx", // 客户邮箱
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. RUT:税号, PAS:护照
}

// payMethod: KHIPU
{
  "customerName": "xxx", // 客户名称
  "customerEmail": "xxx", // 客户邮箱
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. RUT:税号, PAS:护照
}

// payMethod: MACH
{
  "customerName": "xxx", // 客户名称
  "customerEmail": "xxx", // 客户邮箱
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. RUT:税号, PAS:护照
}

// payMethod: PAGO46
{
  "customerName": "xxx", // 客户名称
  "customerEmail": "xxx", // 客户邮箱
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. RUT:税号, PAS:护照
}

(PEN) 秘鲁

// payMethod: BANKTRANSFER
{
  "customerName": "xxx", // 客户名称
  "customerPhone": "xxx", // 客户手机号（9位数字串）
  "customerEmail": "xxx", // 客户邮箱
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user type. DNI:身份证, CE:外国人身份证, RUC:税号, PAS:护照
}

// payMethod: CASH
{
  "customerName": "xxx", // 客户名称
  "customerPhone": "xxx", // 客户手机号（9位数字串）
  "customerEmail": "xxx", // 客户邮箱
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user type. DNI:身份证, CE:外国人身份证, RUC:税号, PAS:护照
}

// payMethod: EWALLET
{
  "customerName": "xxx", // 客户名称
  "customerPhone": "xxx", // 客户手机号（9位数字串）
  "customerEmail": "xxx", // 客户邮箱
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user type. DNI:身份证, CE:外国人身份证, RUC:税号, PAS:护照
}

(TRY) 土耳其

// payMethod: BANKTRANSFER
{
  "customerId": "xxx", // 客户ID
  "customerName": "xxx", // 客户名称
  "customerPhone": "xxx", // 客户手机号
  "customerEmail": "xxx", // 客户邮箱
}

// payMethod: EWALLET
{
  "customerId": "xxx", // 客户ID
  "customerName": "xxx", // 客户名称
  "customerPhone": "xxx", // 客户手机号
  "customerEmail": "xxx", // 客户邮箱
}

// payMethod: CREDITCARD_EU
{
  "cardNo": "5555555555554444", // 卡号
  "cardType": "MASTERCARD", // 卡类型，TRY 仅支持 MASTERCARD
  "cardCcv": "123", // 卡安全码（3位数字）
  "cardExpMonth": "12", // 卡有效期月份，格式 MM
  "cardExpYear": "2029", // 卡有效期年份，格式 YYYY
  "firstName": "xxx", // 持卡人名
  "lastName": "xxx", // 持卡人姓
  "country": "TR", // 国家二字码
  "city": "xxx", // 城市
  "address": "xxx", // 账单地址
  "phone": "xxx", // 客户手机号
  "postcode": "xxx", // 邮编
  "email": "xxx", // 客户邮箱
  "userIp": "xxx", // 客户 IP
  "userAgent": "xxx" // 客户浏览器 User-Agent
}

// payMethod: CREDITCARD_NON_EU
{
  "cardNo": "5555555555554444", // 卡号
  "cardType": "MASTERCARD", // 卡类型，TRY 仅支持 MASTERCARD
  "cardCcv": "123", // 卡安全码（3位数字）
  "cardExpMonth": "12", // 卡有效期月份，格式 MM
  "cardExpYear": "2029", // 卡有效期年份，格式 YYYY
  "firstName": "xxx", // 持卡人名
  "lastName": "xxx", // 持卡人姓
  "country": "TR", // 国家二字码
  "city": "xxx", // 城市
  "address": "xxx", // 账单地址
  "phone": "xxx", // 客户手机号
  "postcode": "xxx", // 邮编
  "email": "xxx", // 客户邮箱
  "userIp": "xxx", // 客户 IP
  "userAgent": "xxx" // 客户浏览器 User-Agent
}

(ARS) 阿根廷

// payMethod: BANKTRANSFER
{
  "firstName": "xxx", // 客户 FirstName
  "lastName": "xxx", // 客户 LastName
  "email": "xxx", // 客户邮箱
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. DNI: 身份证, CUIT: 税号
}

// payMethod: QRIS
{
  "firstName": "xxx", // 客户 FirstName
  "lastName": "xxx", // 客户 LastName
  "email": "xxx", // 客户邮箱
  "phone": "xxx", // 客户电话
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. DNI: 身份证, CUIT: 税号
}

// payMethod: CVU
{
  "firstName": "xxx", // 客户 FirstName
  "lastName": "xxx", // 客户 LastName
  "email": "xxx", // 客户邮箱
  "phone": "xxx", // 客户电话
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. DNI: 身份证, CUIT: 税号
}

(USD) 美国

// payMethod: CASHAPP
{
  "name": "xxx", // 客户姓名
  "email": "xxx", // 客户邮箱
  "phone": "xxx", // 客户电话
  "ipAddress": "xxx", // 客户IP地址. 
  "uid": "xxx", // [选填]客户ID. 
}

// payMethod: CREDITCARD
{
  "name": "xxx", // 客户姓名
  "email": "xxx", // 客户邮箱
  "phone": "xxx", // 客户电话
  "ipAddress": "xxx", // 客户IP地址. 
  "uid": "xxx", // [选填]客户ID. 
}

// payMethod: APPLEPAY
{
  "name": "xxx", // 客户姓名
  "email": "xxx", // 客户邮箱
  "phone": "xxx", // 客户电话
  "ipAddress": "xxx", // 客户IP地址. 
  "uid": "xxx", // [选填]客户ID. 
}

// payMethod: GOOGLEPAY
{
  "name": "xxx", // 客户姓名
  "email": "xxx", // 客户邮箱
  "phone": "xxx", // 客户电话
  "ipAddress": "xxx", // 客户IP地址. 
  "uid": "xxx", // [选填]客户ID. 
}

(USDT)

// payMethod: USDT-TRC20
{
  "uid": "xxx" // 用户唯一id
}

// payMethod: USDT-ERC20
{
  "uid": "xxx" // 用户唯一id
}

// payMethod: USDT-BEP20
{
  "uid": "xxx" // 用户唯一id
}

(RUB) 俄罗斯

// payMethod: P2P
{
  "name": "xxx", // 客户姓名
  "email": "xxx", // 客户邮箱
  "phone": "xxx", // 客户电话
  "document": "xxx", // 客户身份证
  "ipAddress": "xxx", // 客户IP地址. 
} 

// payMethod: SBP
{
  "name": "xxx", // 客户姓名
  "email": "xxx", // 客户邮箱
  "phone": "xxx", // 客户电话
  "document": "xxx", // 客户身份证
  "ipAddress": "xxx", // 客户IP地址. 
} 

// payMethod: TPAY
{
  "name": "xxx", // 客户姓名
  "email": "xxx", // 客户邮箱
  "phone": "xxx", // 客户电话
  "document": "xxx", // 客户身份证
  "ipAddress": "xxx", // 客户IP地址. 
} 

// payMethod: SBERPAY
{
  "name": "xxx", // 客户姓名
  "email": "xxx", // 客户邮箱
  "phone": "xxx", // 客户电话
  "document": "xxx", // 客户身份证
  "ipAddress": "xxx", // 客户IP地址. 
} 

// payMethod: VTBPAY
{
  "name": "xxx", // 客户姓名
  "email": "xxx", // 客户邮箱
  "phone": "xxx", // 客户电话
  "document": "xxx", // 客户身份证
  "ipAddress": "xxx", // 客户IP地址. 
} 

// payMethod: ALFAPAY
{
  "name": "xxx", // 客户姓名
  "email": "xxx", // 客户邮箱
  "phone": "xxx", // 客户电话
  "document": "xxx", // 客户身份证
  "ipAddress": "xxx", // 客户IP地址. 
}

(EUR) 欧盟

// payMethod: CREDITCARD_EU
{
  "cardNo": "5555555555554444", // 卡号
  "cardType": "MASTERCARD", // 卡类型
  "cardCcv": "123", // 卡安全码（3位数字）
  "cardExpMonth": "12", // 卡有效期月份，格式 MM
  "cardExpYear": "2029", // 卡有效期年份，格式 YYYY
  "firstName": "xxx", // 持卡人名
  "lastName": "xxx", // 持卡人姓
  "country": "EU", // 国家二字码
  "city": "xxx", // 城市
  "address": "xxx", // 账单地址
  "phone": "xxx", // 客户手机号
  "postcode": "xxx", // 邮编
  "email": "xxx", // 客户邮箱
  "userIp": "xxx", // 客户 IP
  "userAgent": "xxx" // 客户浏览器 User-Agent
}

// payMethod: CREDITCARD_NON_EU
{
  "cardNo": "5555555555554444", // 卡号
  "cardType": "MASTERCARD", // 卡类型
  "cardCcv": "123", // 卡安全码（3位数字）
  "cardExpMonth": "12", // 卡有效期月份，格式 MM
  "cardExpYear": "2029", // 卡有效期年份，格式 YYYY
  "firstName": "xxx", // 持卡人名
  "lastName": "xxx", // 持卡人姓
  "country": "EU", // 国家二字码
  "city": "xxx", // 城市
  "address": "xxx", // 账单地址
  "phone": "xxx", // 客户手机号
  "postcode": "xxx", // 邮编
  "email": "xxx", // 客户邮箱
  "userIp": "xxx", // 客户 IP
  "userAgent": "xxx" // 客户浏览器 User-Agent
}

USD汇率查询

/api/v3/payment/usdRate GET

请求参数

URL 参数

{
  "currency": "BRL", // 币种
  "payMethod": "payMethod",  // 支付方式
}

curl --location -g --request GET 'https://api.starpago.com/api/v3/payment/usdRate?currency=BRL&payMethod=payMethod' \
--header 'User-Agent: apiHttp' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtaWQiOjEwMCwidHlwZSI6Im1lcmNoYW50IiwiaXNzIjoic3RhcnBhZ28iLCJleHAiOjE3MjU0NTY0NzN9.TTWj2Ctem2qfPhLtvpx4XG5lrXUH4veQD7dsQb0B9SI'

返回响应

{
    "code": 0,
    "message": "success",
    "data": {
        "usdRate": 18.774663
    }
}