cashin

Criação de ordem de cashin

/api/v3/payment/create POST

!Assuntos que precisam de atenção

Em alguns países, o status de conclusão do cashin não está vinculado ao valor do pedido. Quando o status do pedido é “PAID”, não significa que o valor do pedido (campo valor) foi totalmente vendido. Consulte o valor real da transação (campopaidAmount). Para mais detalhes, consulte a equipe

parâmetro de solicitação

parâmetros do corpo (application/json)

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

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",
    "payMethod": "xxx",
    "amount": 1,
    "extra": {
        "repeat": true
      },
    "returnUrl": "https://www.starpago.com/",
    "notifyUrl": "https://www.starpago.com/",
}'

Retornando respostas

{
    "code": 0,
    "data": {
      "amount": 1, // Order amount
      "params": {
        "clabe": "123456789012345678",
        "url": "https://h5.starpago.com/payment/94230311013500999186060015"
      }, // Different currencies have slightly different content responses, please refer to the actual response
      "status": "PENDING",
      "orderNo": "94230311013500999186060015",
      "currency": "MXN",
      "payMethod": "xxx",
      "createTime": 1678498652499,
      "merOrderNo": "orderxxx",
      "updateTime": 1678498652719,
    },
    "msg": "请求成功"
}

Consulta de ordem de cashin

/api/v3/payment/query GET

parâmetro de solicitação

parâmetros de URL

{
  "orderNo": "orderNo****", // order number
  "merOrderNo": "merOrderNo*****" // merchant order number (Este número de pedido será reutilizado para algumas moedas, não o utilize para determinar dados exclusivos)
}

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'

Retornando respostas

{
    "code": 0,
    "data": {
        "amount": 1, // order amount
        "paidAmount": 0, // The actual transaction amount, please refer to this amount for processing
        "tradeCharge": 0, // Transaction Fees, This value is invalid until the transaction is completed.
        "tradeNo": "xxx", // Channel transaction number(not fixed)
        "params": {
            "clabe": "123456789012345678",
            "url": "https://h5.starpago.com/payment/94230311013500999186060015"
        }, // Different currencies have slightly different content responses, please refer to the actual response
        "status": "PENDING",
        "orderNo": "94230311013500999186060015",
        "currency": "MXN",
        "payMethod": "xxx",
        "createTime": 1678498652499,
        "merOrderNo": "orderxxx",
        "updateTime": 1678498652719,
        "payer": {}, // Payer information (non-fixed)
    },
    "msg": "请求成功"
}

Parâmetros extras do Payin

(BRL) Brazil

// payMethod: PIX
{
  "payerCPF": "xxx", // Payer CPF
  "payerName": "xxx", // Payer Name
}

(COP) Colombia

// payMethod: PSE
{
  "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
  "bankCode": "xxx", // Código do banco
}

// payMethod: NEQUI
{
  "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
  "accountNo": "xxx", // NEQUI Wallet Account
}

// payMethod: BREB
{
  "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
}

(MXN) Mexico

// payMethod: CLABE
{
  "repeat": false, // Whether to receive payment repeatedly (bool value)
  "minAmount": 0, // [Optional] Minimum allowable payment amount
  "maxAmount": 0 // [Optional] Maximum allowable payment amount
}

// payMethod: OXXO
{} // No data available, can be ignored

// payMethod: CASH
{} // No data available, can be ignored

(CLP) Chile

// payMethod: WEBPAY
{
  "customerName": "xxx", // Customer Name
  "customerEmail": "xxx", // Customer Email
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. RUT: Tax number, PAS: Passport
}

// payMethod: KHIPU
{
  "customerName": "xxx", // Customer Name
  "customerEmail": "xxx", // Customer Email
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. RUT: Tax number, PAS: Passport
}

// payMethod: MACH
{
  "customerName": "xxx", // Customer Name
  "customerEmail": "xxx", // Customer Email
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. RUT: Tax number, PAS: Passport
}

// payMethod: PAGO46
{
  "customerName": "xxx", // Customer Name
  "customerEmail": "xxx", // Customer Email
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. RUT: Tax number, PAS: Passport
}

(PEN) Peru

// payMethod: BANKTRANSFER
{
  "customerName": "xxx", // Customer Name
  "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
}

// payMethod: CASH
{
  "customerName": "xxx", // Customer Name
  "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
}

// payMethod: EWALLET
{
  "customerName": "xxx", // Customer Name
  "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
}

(TRY) Turkey

// payMethod: BANKTRANSFER
{
  "customerId": "xxx", // Customer ID
  "customerName": "xxx", // Customer Name
  "customerPhone": "xxx", // Customer's mobile phone number
  "customerEmail": "xxx", // Customer Email
}

// payMethod: EWALLET
{
  "customerId": "xxx", // Customer ID
  "customerName": "xxx", // Customer Name
  "customerPhone": "xxx", // Customer's mobile phone number
  "customerEmail": "xxx", // Customer Email
}

// payMethod: CREDITCARD_EU
{
  "cardNo": "5555555555554444", // Número do cartão
  "cardType": "MASTERCARD", // Tipo do cartão. Para TRY, apenas MASTERCARD
  "cardCcv": "123", // Código de segurança do cartão (3 dígitos)
  "cardExpMonth": "12", // Mês de validade do cartão, formato MM
  "cardExpYear": "2029", // Ano de validade do cartão, formato YYYY
  "firstName": "xxx", // Nome do titular do cartão
  "lastName": "xxx", // Sobrenome do titular do cartão
  "country": "TR", // Código do país, ISO 3166-1 alpha-2
  "city": "xxx", // Cidade
  "address": "xxx", // Endereço de cobrança
  "phone": "xxx", // Número de celular do cliente
  "postcode": "xxx", // Código postal
  "email": "xxx", // E-mail do cliente
  "userIp": "xxx", // IP do cliente
  "userAgent": "xxx" // User-Agent do navegador do cliente
}

// payMethod: CREDITCARD_NON_EU
{
  "cardNo": "5555555555554444", // Número do cartão
  "cardType": "MASTERCARD", // Tipo do cartão. Para TRY, apenas MASTERCARD
  "cardCcv": "123", // Código de segurança do cartão (3 dígitos)
  "cardExpMonth": "12", // Mês de validade do cartão, formato MM
  "cardExpYear": "2029", // Ano de validade do cartão, formato YYYY
  "firstName": "xxx", // Nome do titular do cartão
  "lastName": "xxx", // Sobrenome do titular do cartão
  "country": "TR", // Código do país, ISO 3166-1 alpha-2
  "city": "xxx", // Cidade
  "address": "xxx", // Endereço de cobrança
  "phone": "xxx", // Número de celular do cliente
  "postcode": "xxx", // Código postal
  "email": "xxx", // E-mail do cliente
  "userIp": "xxx", // IP do cliente
  "userAgent": "xxx" // User-Agent do navegador do cliente
}

(ARS) Argentina

// payMethod: BANKTRANSFER
{
  "firstName": "xxx", // Customer FirstName
  "lastName": "xxx", // Customer LastName
  "email": "xxx", // Customer Email
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. DNI: ID card, CUIT: Tax number
}

// payMethod: QRIS
{
  "firstName": "xxx", // Customer FirstName
  "lastName": "xxx", // Customer LastName
  "email": "xxx", // Customer Email
  "phone": "xxx", // Customer's mobile phone number (10 digits)
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. DNI: ID card, CUIT: Tax number
}

// payMethod: CVU
{
  "firstName": "xxx", // Customer FirstName
  "lastName": "xxx", // Customer LastName
  "email": "xxx", // Customer Email
  "phone": "xxx", // Customer's mobile phone number (10 digits)
  "documentNumber": "xxx", // user identification number
  "documentType": "xxx", // user identification type. DNI: ID card, CUIT: Tax number
}

(USD) America

// payMethod: CASHAPP
{
  "name": "xxx", // Customer name
  "email": "xxx", // Customer Email
  "phone": "xxx", // Customer's mobile phone number
  "ipAddress": "xxx", // Customer's ip address. 
  "uid": "xxx", // [Optional] Customer ID. 
}

// payMethod: CREDITCARD
{
  "name": "xxx", // Customer name
  "email": "xxx", // Customer Email
  "phone": "xxx", // Customer's mobile phone number
  "ipAddress": "xxx", // Customer's ip address. 
  "uid": "xxx", // [Optional] Customer ID. 
}

// payMethod: APPLEPAY
{
  "name": "xxx", // Customer name
  "email": "xxx", // Customer Email
  "phone": "xxx", // Customer's mobile phone number
  "ipAddress": "xxx", // Customer's ip address. 
  "uid": "xxx", // [Optional] Customer ID. 
}

// payMethod: GOOGLEPAY
{
  "name": "xxx", // Customer name
  "email": "xxx", // Customer Email
  "phone": "xxx", // Customer's mobile phone number
  "ipAddress": "xxx", // Customer's ip address. 
  "uid": "xxx", // [Optional] Customer ID. 
}

(USDT)

// payMethod: USDT-TRC20
{
  "uid": "xxx" // User unique id
}

// payMethod: USDT-ERC20
{
  "uid": "xxx" // User unique id
}

// payMethod: USDT-BEP20
{
  "uid": "xxx" // User unique id
}

(RUB) Rússia

// payMethod: P2P
{
  "name": "xxx", // Customer name
  "email": "xxx", // Customer Email
  "phone": "xxx", // Customer's mobile phone number
  "document": "xxx", // Customer ID information
  "ipAddress": "xxx", // Customer's ip address. 
} 

// payMethod: SBP
{
  "name": "xxx", // Customer name
  "email": "xxx", // Customer Email
  "phone": "xxx", // Customer's mobile phone number
  "document": "xxx", // Customer ID information
  "ipAddress": "xxx", // Customer's ip address. 
} 

// payMethod: TPAY
{
  "name": "xxx", // Customer name
  "email": "xxx", // Customer Email
  "phone": "xxx", // Customer's mobile phone number
  "document": "xxx", // Customer ID information
  "ipAddress": "xxx", // Customer's ip address. 
} 

// payMethod: SBERPAY
{
  "name": "xxx", // Customer name
  "email": "xxx", // Customer Email
  "phone": "xxx", // Customer's mobile phone number
  "document": "xxx", // Customer ID information
  "ipAddress": "xxx", // Customer's ip address. 
} 

// payMethod: VTBPAY
{
  "name": "xxx", // Customer name
  "email": "xxx", // Customer Email
  "phone": "xxx", // Customer's mobile phone number
  "document": "xxx", // Customer ID information
  "ipAddress": "xxx", // Customer's ip address. 
} 

// payMethod: ALFAPAY
{
  "name": "xxx", // Customer name
  "email": "xxx", // Customer Email
  "phone": "xxx", // Customer's mobile phone number
  "document": "xxx", // Customer ID information
  "ipAddress": "xxx", // Customer's ip address. 
} 

(EUR) EU

// payMethod: CREDITCARD_EU
{
  "cardNo": "5555555555554444", // Número do cartão
  "cardType": "MASTERCARD", // Tipo do cartão. 
  "cardCcv": "123", // Código de segurança do cartão (3 dígitos)
  "cardExpMonth": "12", // Mês de validade do cartão, formato MM
  "cardExpYear": "2029", // Ano de validade do cartão, formato YYYY
  "firstName": "xxx", // Nome do titular do cartão
  "lastName": "xxx", // Sobrenome do titular do cartão
  "country": "EU", // Código do país, ISO 3166-1 alpha-2
  "city": "xxx", // Cidade
  "address": "xxx", // Endereço de cobrança
  "phone": "xxx", // Número de celular do cliente
  "postcode": "xxx", // Código postal
  "email": "xxx", // E-mail do cliente
  "userIp": "xxx", // IP do cliente
  "userAgent": "xxx" // User-Agent do navegador do cliente
}

// payMethod: CREDITCARD_NON_EU
{
  "cardNo": "5555555555554444", // Número do cartão
  "cardType": "MASTERCARD", // Tipo do cartão. 
  "cardCcv": "123", // Código de segurança do cartão (3 dígitos)
  "cardExpMonth": "12", // Mês de validade do cartão, formato MM
  "cardExpYear": "2029", // Ano de validade do cartão, formato YYYY
  "firstName": "xxx", // Nome do titular do cartão
  "lastName": "xxx", // Sobrenome do titular do cartão
  "country": "EU", // Código do país, ISO 3166-1 alpha-2
  "city": "xxx", // Cidade
  "address": "xxx", // Endereço de cobrança
  "phone": "xxx", // Número de celular do cliente
  "postcode": "xxx", // Código postal
  "email": "xxx", // E-mail do cliente
  "userIp": "xxx", // IP do cliente
  "userAgent": "xxx" // User-Agent do navegador do cliente
}

Consulta de taxa de USD

/api/v3/payment/usdRate GET

parâmetro de solicitação

parâmetros de URL

{
  "currency": "BRL", // currency type
  "payMethod": "payMethod",  // mode of payment
}

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'

Retornando respostas

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