Pular para o conteúdo principal

Informações

Para obter todas as informações relativas a um link de pagamento em especifico, é necessário realizar uma request do tipo GET incluindo o Slug do link:

URL

https://api.bembit.com/api/v1/checkouts/{slug}

Método

GET

Parametros

Observação

Os parametros para essa solicitação devem ser passados ao end-point embutido no final da URL da request.

ParametroTipoValor padrãoDescrição
slugstringundefinedAlias do link de pagamento (definido no momento da criação)

cURL

curl -X 'GET' \
'https://api.bembit.com/api/v1/checkouts/{slug}' \
-H 'accept: application/json'

Respostas do Server:

Status 200:

Response Body:

{
"title": "string",
"description": "string",
"slug": "string",
"active": true,
"paymentMethodPix": {
"expiryTimeInMinutes": 0,
"enabled": true
},
"paymentMethodCrypto": {
"highlightTokens": ["string"],
"enabled": true,
"allTokens": true,
"expiryTimeInMinutes": 0
},
"logo": "string",
"createdAt": "2023-06-07T12:55:04.759Z",
"updatedAt": "2023-06-07T12:55:04.759Z",
"id": "string"
}
  • Title: Título ou nome do Link de pagamento, definido ao momento da criação.
  • Description: Descrição do link / pagamento.
  • Slug: Alias do link de pagamento (definido no momento da criação).
  • Active: Status do Link de pagamento podendo ser True ou False.
  • paymentMethodPix / expiryTimeInMinutes: Tempo de validade em minutos do QR gerado para pagamento.
  • paymentMethodPix / enabled: Status do metodo PIX, true se estiver habilidato ou false se não.
  • paymentMethodCrypto / highlightTokens: É um Array de strings com os símbolos dos tokens aceitos.
  • paymentMethodCrypto / enabled: Define se o pagamento por Cryptomoedas é aceito.
  • paymentMethodCrypto / allTokens: É true caso sejam aceitas todas as criptomoedas, caso contrario é false.
  • paymentMethodCrypto / expiryTimeInMinutes: Tempo de validade em minutos do QR gerado para pagamento.
  • Logo: URL da imagem do logo utilizado no link de pagamento.
  • CreatedAt: Data de criação do link de pagamento.
  • UpdatedAt: Data de atualização do link de pagamento (caso tenha sido atualizado).
  • Id: Identificador do link de pagamento.

Status 404:

Response Body:

{
"httpCode": 404,
"description": "Checkout não encontrado."
}

Veja em execução em nosso Swagger.