Starpago

cashout

Criação de ordem de cashout

/api/v3/payout/create POST

DANGER

Ao criar e iniciar uma ordem de cashout, se o código de status de resposta HTTP não for 200, você deverá verificar novamente o status do pedido por meio do back-end de gerenciamento do comerciante ou da interface de consulta de pedidos. Se o pedido existir e o status for "Gerar pedido" e "Transação anormal", então o pedido atual está em andamento, não faça nenhuma alteração no pedido, caso contrário, poderão ocorrer perdas de capital desnecessárias, portanto, opere com cautela. Se a interface criada retornar um código comercial 400 e houver uma falha clara na verificação do parâmetro, você poderá determinar diretamente a falha do pedido sem consultar. Se você tiver alguma dúvida, confirme com a equipe Starpago o mais rápido possível. A interface de consulta deve usar o status do pedido (status) como base para o julgamento do pedido. Se houver outras situações anormais, não modifique o status do pedido sem autorização. Você precisa participar manualmente da equipe Starpago para confirmação de acompanhamento. , por favor, não realize operações secundárias de retirada nas informações de retirada, a fim de evitar perdas de capital desnecessárias.

parâmetro de solicitação

parâmetros do corpo (application/json)

{
  "merOrderNo": "202202231234566",  // merchant order number
  "currency": "MXN",  // Currency
  "payMethod": "xxx", // Método de pagamento
  "amount": 1,  // Amount
  "notifyUrl": "https://www.starpago.com/",  // Message notification callback address
  "extra": {}, // Extension parameters, different currencies are slightly different, see the extra parameters section for details
}

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": "BRL",
    "payMethod": "xxx",
    "amount": 1,
    "notifyUrl": "https://www.starpago.com/",
    "extra":{
      "bankCode": "90648",
      "bankName": "STP",
      "accountNo": "646180146010131618",
      "accountName": "Alejandro fino"
    },
}'

Retornando respostas

{
    "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"
}

Consulta de ordem de cashout

/api/v3/payout/query GET

parâmetro de solicitação

parâmetros de URL

{
  "orderNo": "orderNo****", // order number
  "merOrderNo": "merOrderNo*****" // merchant order number
}


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'

Retornando respostas

{
    "code": 0,
    "data": {
        "status": "PENDING",
        "orderNo": "202204191703308526031",
        "merOrderNo": "202204191703302152",
        "amount": 10,
        "tradeCharge": 0, // Transaction Fees, This value is invalid until the transaction is completed.
        "tradeNo": "xxx", // Channel transaction number(not fixed)
        "receiptUrl": "xxx", // Transaction voucher link (not fixed)
        "currency": "MXN",
        "payMethod": "xxx",
        "attach": null,
        "createTime": 1650359010851,
        "updateTime": 1650359011745,
    },
    "msg": "请求成功"
}

Parâmetros extras de payout

(BRL) Brazil

// payMethod: PIX
{
  "bankCode": "CPF", // Tipo de conta PIX [CPF, CNPJ, PHONE, EMAIL]
  "accountNo": "xxx", // Conta PIX
  "accountName": "xxx", // Nome da conta bancária
  "document": "xxx", // Número do CPF (cadeia de 11 dígitos)
}

(COP) Colombia

// payMethod: BANKTRANSFER
{
  "bankName": "xxx", // Nome do banco
  "accountNo": "xxx", // Conta bancária
  "customerName": "xxx", // Nome do cliente
  "customerPhone": "xxx", // Número de celular do cliente (10 dígitos)
  "customerEmail": "xxx", // E-mail do cliente
  "documentNumber": "xxx", // número de identificação do usuário
  "documentType": "xxx", // tipo de usuário. Valores permitidos: [CC, TI, CE, PA, NIT]
} // Cashout requires uploading the customer's actual withdrawal parameters

// payMethod: BREB
{
  "bankName": "xxx", // Nome do banco
  "accountNo": "xxx", // BREB account
  "customerName": "xxx", // Nome do cliente
  "customerPhone": "xxx", // Número de celular do cliente (10 dígitos)
  "customerEmail": "xxx", // E-mail do cliente
  "documentNumber": "xxx", // número de identificação do usuário
  "documentType": "xxx", // tipo de usuário. Valores permitidos: [CC, TI, CE, PA, NIT]
} // Cashout requires uploading the customer's actual withdrawal parameters

(MXN) Mexico

// payMethod: BANKTRANSFER
{
  "bankCode": "xxx", // Código do banco
  "bankName": "xxx", // Nome do banco
  "accountNo": "xxx", // Informações da conta
  "accountName": "xxx", // Nome da conta bancária
  "accountName": "xxx", // Nome da conta
}

(CLP) Chile

// payMethod: BANKTRANSFER
{
  "customerPhone": "xxx", // Customer's mobile phone number (9 digits)
  "customerEmail": "xxx", // Customer Email
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. RUT: Tax number, PAS: Passport
  "bankCode": "xxx", // Bank code
  "accountName": "xxx", // Bank Account Name
  "accountNo": "xxx", // Account Information
  "accountType": "xxx", // Account type 1:Corriente, 2:Vista/Cuenta RUT, 3:Ahorro
}

(PEN) Peru

// payMethod: BANKTRANSFER
{
  "customerPhone": "xxx", // Customer's mobile phone number (9 digits)
  "customerEmail": "xxx", // Customer Email
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. DNI: ID card, CE: Foreigner ID card, RUC: Tax number, PAS: Passport
  "accountName": "xxx", // Bank Account Name
  "accountNo": "xxx", // Account Information
  "accountType": "xxx", // Account type. 1: CORRIENTE, 2: AHORROS 
  "cciNo": "xxx", // Payee's transit account
  "bankCode": "xxx", // Bank code
}

// payMethod: EWALLET
{
  "customerPhone": "xxx", // Customer's mobile phone number (9 digits)
  "customerEmail": "xxx", // Customer Email
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. DNI: ID card, CE: Foreigner ID card, RUC: Tax number, PAS: Passport
  "accountName": "xxx", // WALLET Account Name
  "accountNo": "xxx", // WALLET Account Information
  "bankCode": "xxx", // WALLET Code: Yape, Plin
}

(TRY) Turkey

// payMethod: BANKTRANSFER
{
  "accountName": "xxx", // Account Name
  "accountNo": "xxx", // IBAN Account NO
}

// payMethod: PAPARA
{
  "accountName": "xxx", // Account Name
  "accountNo": "xxx", // Account No
}

(ARS) Argentina

// payMethod: BANKTRANSFER
{
  "firstName": "xxx", // Customer FirstName
  "lastName": "xxx", // Customer LastName
  "email": "xxx", // Customer Email
  "phone": "xxx", // Customer Phone
  "address": "xxx", // Customer 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) America

// payMethod: CASHAPP
{
  "name": "xxx", // Customer name
  "email": "xxx", // Customer Email
  "phone": "xxx", // Customer's mobile phone number
  "accountNo": "xxx", // CASHAPP Number
  "dateOfBirth": "xxx", // Customer's birthday, e.g., 2002-02-02
  "countryOfResidence": "xxx", // Country of residence, e.g., US
  "stateOfResidence": "xxx", // State of residence, e.g., CA
  "cardCity": "xxx", // City of residence, e.g., Los Angeles
  "cardStreet": "xxx", // Street of residence, e.g., 211 Main St
  "cardPostCode": "xxx", // Postal code, e.g., 323500
}

(USDT)

// payMethod: USDT-TRC20
{
  "address": "xxx", // Blockchain wallet address
  "uid": "xxx" // User unique id
}

// payMethod: USDT-ERC20
{
  "address": "xxx", // Blockchain wallet address
  "uid": "xxx" // User unique id
}

// payMethod: USDT-BEP20
{
  "address": "xxx", // Blockchain wallet address
  "uid": "xxx" // User unique id
}

(RUB) Rússia

// payMethod: P2P
{
  "name": "xxx", // Customer name
  "email": "xxx", // Customer email
  "phone": "xxx", // Customer Phone
  "bankCode": "xxx", // Bank code
  "accountNo": "xxx" // Account Information
}

// payMethod: SBP
{
  "name": "xxx", // Customer name
  "email": "xxx", // Customer email
  "phone": "xxx", // Customer Phone
  "bankCode": "xxx", // Bank code
  "accountNo": "xxx" // SBP Account
}

Cheque de pagamento pedido de imagem

/api/v3/payout/receipt/png GET

parâmetro de solicitação

parâmetros de URL

{
  "orderNo": "20220408123109677", // order number
}


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'

Retornando respostas

{
   
}