Criar uma cobrança
Requisição
curl -X POST https://api.bitsby.app/invoices/create \
-H "Authorization: Token MSvL2ltaDZdWVjmZURURMVWhqSJLT2NURjhL2Fla1Z1T1IxQTltKs1T3Ay" \
-F "projectId=9deea1e2-0c08-41a3-bdc2-a34eada3892d" \
-F "amountFiat=10.55" \
-F "currencyFiat=EUR" \
-F "description=12 months license for BITSBY" \
-F "serviceData={\"userId\":100,\"orderId\":500}" \
-F "timeToPay=12"
Parâmetros da requisição
| Parâmetro | Tipo de dado | Descrição | Exemplo | Obrigatório? |
|---|---|---|---|---|
projectId | UUID | ID do projeto no formato UUID | 1c48b092-9878-48f5-b441-07a8a48e7b54 | sim |
amountFiat | Float | Valor em moeda fiat | 10.55 | sim |
currencyFiat | String | Moeda fiat. Valores permitidos: USD, EUR, RUB | EUR | sim |
description | String | Descrição do produto ou serviço. Exibida ao cliente na página de pagamento | 12 months license for BITSBY | não |
serviceData | String | Identificador do pedido no lado da loja. Não é exibido ao cliente. Esses dados associam a cobrança e o pagamento ao cliente na loja do lojista. JSON é um formato conveniente para isso | {"userId":100,"orderId":500} | não |
timeToPay | Float | Tempo para pagar a cobrança, em horas. Valores permitidos: 0.5, 1, 3, 6, 12 | 1 | sim |
Exemplo de resposta
{
"result":"success",
"data":{
"id":"ade9550d-3dc7-4fd3-b94e-3b4c12aaaa0c",
"uid":"MXNj4m8HhcM4",
"createDatetime":"2024-02-29 15:20:24",
"timeToPayDatetime":"2024-03-01 03:20:24",
"commissionFiatUSD":0.1,
"amountFiatUSD":10,
"url":"https:\/\/dash.bitsby.app\/invoices\/pay\/MXNj4m8HhcM4"
}
}
Parâmetros da resposta
| Parâmetro | Descrição |
|---|---|
id | ID da cobrança no formato UUID |
uid | ID da cobrança (para o cliente) |
createDatetime | Data e hora de criação da cobrança (UTC) |
timeToPayDatetime | Data e hora até as quais a cobrança é válida (UTC). O cliente deve pagar a cobrança antes desse horário |
commissionFiatUSD | Valor da taxa do serviço. Calculado a partir do valor amountFiatUSD |
amountFiatUSD | Valor em USD, calculado na criação da cobrança a partir de invoice.amountFiat pela cotação atual |
url | Link da página de pagamento para o cliente. Envie este link ao cliente para pagar a cobrança |