Listado de pagamentos

Listando todos os pagamentos

Para listar todos os pagamentos é necessário realizar uma request do tipo GET passando os parámetros definidos a continuação:

URL

https://api.bembit.com/api/v1/checkouts

Método

GET

Parametros

Observação

Os parametros para essa solicitação devem ser passados ao end-point via headers no momento da solicitação.

Parametro	Tipo	Valor padrão	Descrição
api	string	undefined	API Key obtída na plataforma
secret	string	undefined	Secret obtído na plataforma.

---

cURL

curl -X 'GET' \
  'https://api-sandbox.bembit.com/api/v1/checkouts' \
  -H 'accept: application/json' \
  -H 'api: [Sua API]' \
  -H 'secret: [Seu secret]'

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-07T15:58:10.961Z",
    "updatedAt": "2023-06-07T15:58:10.961Z",
    "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 401:

Response Body:

{
  "error": true
}

Veja em execução em nosso Swagger.