代付

代付订单创建

/api/v3/payout/create POST

DANGER

代付订单创建发起时，若 HTTP 响应状态码非 200 的情况，一定要通过商户管理后台或者订单查询接口二次核验订单状态，若订单存在且状态为"生成订单"和“交易异常”，则当前订单暂处于进行中状态，不要进行任何订单变更行为，否则将有可能发生不必要的资损，因此请谨慎操作。如果是创建接口返回业务 code 为 400 且有明确的参数验证失败的情况，可以无需查询，直接判定订单失败。若有任何疑问请第一时间向 Starpago 团队确认，查询接口一定要以订单状态（status）为订单判断依据，若是其他任何异常情况，请不要擅自修改订单状态，需要向 Starpago 团队人工参与进行后续确认，请不要对订单中的提现信息进行二次提现操作，以避免不必要的资金损失。

请求参数

Body 参数(application/json)

{
  "merOrderNo": "202202231234566",  // 商户订单号
  "currency": "MXN",  // 币种
  "payMethod": "xxx", // 支付类型（详询工作人员）
  "amount": 1,  // 金额（保留2位小数，若需保留 .00, .0类无效小数位，请转换为字符串格式，避免签名数据不一致）
  "notifyUrl": "https://www.starpago.com/",  // 消息通知回调地址
  "extra": {}, // 拓展参数，不同币种略有不同，详见extra参数部分
}

curl --location -g --request POST 'https://api.starpago.com/api/v3/payout/create' \
--header 'User-Agent: apiHttp' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtaWQiOjEwMCwidHlwZSI6Im1lcmNoYW50IiwiaXNzIjoic3RhcnBhZ28iLCJleHAiOjE3MjU0NTY0NzN9.TTWj2Ctem2qfPhLtvpx4XG5lrXUH4veQD7dsQb0B9SI' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merOrderNo": "202202231234566",
    "currency": "MXN",
    "payMethod": "xxx",
    "amount": 1,
    "notifyUrl": "https://www.starpago.com/",
    "extra":{
      "bankCode": "90648",
      "bankName": "STP",
      "accountNo": "646180146010131618",
      "accountName": "Alejandro fino",
      "accountType": "40"
    }
}'

返回响应

{
    "code": 0,
    "data": {
        "status": "PENDING",
        "orderNo": "202204191703308526031",
        "merOrderNo": "202204191703302152",
        "amount": 10,
        "currency": "MXN",
        "payMethod": "xxx",
        "attach": null,
        "createTime": 1650359010851,
        "updateTime": 1650359011745,
    },
    "msg": "请求成功"
}

{
  "code": 400,
  "error": "request parameter [extra.accountNo] is invalid"
}

代付订单查询

/api/v3/payout/query GET

请求参数

URL 参数

{
  "orderNo": "orderNo*****",  // Starpago订单号
  "merOrderNo": "merOrderNo****" // 商户端订单号
}

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

返回响应

{
    "code": 0,
    "data": {
        "status": "PENDING",
        "orderNo": "202204191703308526031",
        "merOrderNo": "202204191703302152",
        "amount": 10,
        "tradeCharge": 5, // 交易手费费，该值在交易完成之前无效
        "tradeNo": "xxx", // 渠道交易号(非固定存在)
        "receiptUrl": "xxx", // 交易凭证链接(非固定存在)
        "currency": "MXN",
        "payMethod": "xxx",
        "attach": null,
        "createTime": 1650359010851,
        "updateTime": 1650359011745,
    },
    "msg": "请求成功"
}

代付 Extra 参数

(BRL) 巴西

// payMethod: PIX
{
  "bankCode": "CPF", // PIX 账号类型[CPF, CNPJ, PHONE, EMAIL]
  "accountNo": "xxx", // PIX 账号
  "accountName": "xxx", // 银行账户名
  "document": "xxx", // CPF号码（11位数字串）
}

(COP) 哥伦比亚

// payMethod: BANKTRANSFER
{
  "bankName": "xxx", // 银行名称
  "accountNo": "xxx", // 银行账号
  "customerName": "xxx", // 客户名称
  "customerPhone": "xxx", // 客户手机号（10位数字串）
  "customerEmail": "xxx", // 客户邮箱
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // tipo de usuário. Valores permitidos: [CC, TI, CE, PA, NIT]
} // 代付需上传客户提款真实参数

// payMethod: BREB
{
  "bankName": "xxx", // 银行名称
  "accountNo": "xxx", // BREB 账号
  "customerName": "xxx", // 客户名称
  "customerPhone": "xxx", // 客户手机号（10位数字串）
  "customerEmail": "xxx", // 客户邮箱
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // tipo de usuário. Valores permitidos: [CC, TI, CE, PA, NIT]
} // 代付需上传客户提款真实参数

(MXN) 墨西哥

// payMethod: BANKTRANSFER
{
  "bankCode": "xxx", // 银行代码
  "bankName": "xxx", // 银行名称
  "accountNo": "xxx", // 账号信息
  "accountName": "xxx", // 银行账户名
  "accountType": "xxx" // 账号类型 40:Clabe 18位,3:银行卡
}

(CLP) 智利

// payMethod: BANKTRANSFER
{
  "customerPhone": "xxx", // 客户手机号（9位数字串）
  "customerEmail": "xxx", // 客户邮箱
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. RUT:税号, PAS:护照
  "bankCode": "xxx", // 银行代码
  "accountName": "xxx", // 账号名称
  "accountNo": "xxx", // 银行账号
  "accountType": "xxx", // Account type. 1:Corriente, 2:Vista/Cuenta RUT, 3:Ahorro
}

(PEN) 秘鲁

// payMethod: BANKTRANSFER
{
  "customerPhone": "xxx", // 客户手机号（9位数字串）
  "customerEmail": "xxx", // 客户邮箱
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. DNI:身份证, CE:外国人身份证, RUC:税号, PAS:护照
  "accountName": "xxx", // 账号名称
  "accountNo": "xxx", // 银行账号
  "accountType": "xxx", // Account type. 1:活期账户, 2:储蓄账户 
  "cciNo": "xxx", // 收款人中转账户
  "bankCode": "xxx", // 银行代码
}

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

(TRY) 土耳其

// payMethod: BANKTRANSFER
{
  "accountName": "xxx", // 账号名称
  "accountNo": "xxx", // IBAN 账号信息
}

// payMethod: PAPARA
{
  "accountName": "xxx", // 账号名称
  "accountNo": "xxx", // Papara 账号
}

(ARS) 阿根廷

// payMethod: BANKTRANSFER
{
  "firstName": "xxx", // 客肪 FirstName
  "lastName": "xxx", // 客户 LastName
  "email": "xxx", // 客户 Email
  "phone": "xxx", // 客户 Phone
  "address": "xxx", // 客户 Address
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. DNI: ID card, CUIT: Tax number
  "accountNo": "xxx", // Account Information
  "accountType": "xxx", // Account type. 1: CBU, 2: CVU. 3: ALIAS
}

(USD) 美国

// payMethod: CASHAPP
{
  "name": "xxx", // 客户 名称
  "email": "xxx", // 客户 邮箱
  "phone": "xxx", // 客户 电话
  "accountNo": "xxx", // CASHAPP 账号
  "dateOfBirth": "xxx", // 客户生日，例：2002-02-02
  "countryOfResidence": "xxx", // 居住国家，例：US
  "stateOfResidence": "xxx", // 居住州，例：CA
  "cardCity": "xxx", // 居住城市，例：Los Angeles
  "cardStreet": "xxx", // 居住街道，例：211 Main St
  "cardPostCode": "xxx", // 邮政编码，例：323500
}

(USDT)

// payMethod: USDT-TRC20
{
  "address": "xxx", // 区块链钱包地址
  "uid": "xxx" // 用户唯一id
}

// payMethod: USDT-ERC20
{
  "address": "xxx", // 区块链钱包地址
  "uid": "xxx" // 用户唯一id
}

// payMethod: USDT-BEP20
{
  "address": "xxx", // 区块链钱包地址
  "uid": "xxx" // 用户唯一id
}

(RUB) 俄罗斯

// payMethod: P2P
{
  "name": "xxx", // 客户 名称
  "email": "xxx", // 客户 邮箱
  "phone": "xxx", // 客户 电话
  "bankCode": "xxx", // 银行编码
  "accountNo": "xxx" // 银行账号
}

// payMethod: SBP
{
  "name": "xxx", // 客户 名称
  "email": "xxx", // 客户 邮箱
  "phone": "xxx", // 客户 电话
  "bankCode": "xxx", // 银行编码
  "accountNo": "xxx" // SBP账号
}

代付凭证图片查询

/api/v3/payout/receipt/png GET

请求参数

URL 参数

{
  "orderNo": "20220408123109677", // 代付订单号
}

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

返回响应

{
   
}

# 代付

# 代付订单创建

# 请求参数

# Body 参数(application/json)

# 返回响应

# 代付订单查询

# 请求参数

# URL 参数

# 返回响应

# 代付 Extra 参数

# (BRL) 巴西

# (COP) 哥伦比亚

# (MXN) 墨西哥

# (CLP) 智利

# (PEN) 秘鲁

# (TRY) 土耳其

# (ARS) 阿根廷

# (USD) 美国

# (USDT)

# (RUB) 俄罗斯

# 代付凭证图片查询

# 请求参数

# URL 参数

# 返回响应

代付

代付订单创建

请求参数

Body 参数(application/json)

返回响应

代付订单查询

请求参数

URL 参数

返回响应

代付 Extra 参数

(BRL) 巴西

(COP) 哥伦比亚

(MXN) 墨西哥

(CLP) 智利

(PEN) 秘鲁

(TRY) 土耳其

(ARS) 阿根廷

(USD) 美国

(USDT)

(RUB) 俄罗斯

代付凭证图片查询

请求参数

URL 参数

返回响应