Recorrência

APIs de Conciliação

# Verificação do Status do Cobrança via API

Embora o Sistema Bass Pago envie automaticamente um WebHook (se configurado no módulo de Gerenciamento de Chaves) assim que o processo de pagamento for finalizado, com status APPROVED ou REJECTED, é possível verificar o status e os detalhes da Cobrança a qualquer momento por meio de uma solicitação à seguinte API:

        {
    "key": "UydmVYUIYdfKmeED1JgdRMvXkeyri7iu"
}

      

Campos de Resposta Detalhados:

• createdAt: Data de criação da cobrança.
• createdAt: Data de atualização da cobrança.
• subscriptionCreatedAt: Data de criação da Assinatura.
• referenceNumber: Um identificador exclusivo gerado pelo Sistema Bass Pago para cada cobrança.
• amount: Valor a ser pago de acordo com o tipo de operação.
• devedorNome*: Nome completo do devedor.
• devedorInscricaoNacional*: CPF ou CNPJ do devedor. Só dígitos. [CPF: 11 dígitos, CNPJ: 14 dígitos].
• externalId: Número de referência ou identificador exclusivo da Assinatura.
• externalProductId*: Número de identificação do produto e/ou serviço no sistema externo.
• status: Status atual do pagamento. (PENDING, APPROVED, REJECTED)
• type: Tipo de pagamento. Por enquanto, apenas CARD
• type: Tipo de pagamento. Por enquanto, apenas CARD
• planReferenceNumber: Identificador único do Plano associado à cobrança.
• subscriptionReferenceNumber: Identificador único para a assinatura gerado Sistema Bass Pago.
• subscriptionStatus: Estado da Assinatura.
• installment: Parcela correspondente à cobrança.
• installments: Número total de parcelas na assinatura.
• isWebHookNotified: Define se no momento da notificação do WebHook foi recebida uma resposta do sistema externo.

        {
    "createdAt": "2024-08-26T12:32:45.261411Z",
    "updatedAt": "2024-08-26T12:32:45.261411Z",
    "subscriptionCreatedAt": "2024-08-26T12:32:45.875750Z",
    "referenceNumber": "PCH218T0U9O",
    "amount": 10.0,
    "devedorNome": "Pedro Neri",
    "devedorInscricaoNacional": "60375093072",
    "externalId": "ABCD000008",
    "externalProductId": "0001",
    "status": "PENDING",
    "type": null,
    "planReferenceNumber": "PL8HGAEQAG",
    "subscriptionReferenceNumber": "SBG76XY857",
    "subscriptionStatus": "CREATED",
    "installment": 1,
    "installments": 12,
    "isWebHookNotified": false
}

      

# Consultar lista de Cobranças

É possível conciliar as Cobranças recebidos de uma Chave.

        {
    "key": "UydmVYUIYdfKmeED1JgdRMvXkeyri7iu"
}

      

        [
    {
        "createdAt": "2024-08-26T15:35:57.400942Z",
        "updatedAt": "2024-08-26T15:55:00.106484Z",
        "subscriptionCreatedAt": "2024-08-26T15:35:58.021271Z",
        "referenceNumber": "PCHELCTHCL9",
        "amount": 10.0,
        "devedorNome": "Pedro Neri",
        "devedorInscricaoNacional": "60375093072",
        "externalId": "ABCD000009",
        "externalProductId": "0001",
        "status": "REJECTED",
        "type": null,
        "planReferenceNumber": "PLJD0LFM80",
        "subscriptionReferenceNumber": "SBBAFVJ0A9",
        "subscriptionStatus": "CANCELLED",
        "installment": 1,
        "installments": 12,
        "isWebHookNotified": false
    }
]

      

# Aplicando paginação e filtros à consulta

Quando a quantidade dos Checkouts em uma consulta é muito grande, o ideal é paginar a resposta. Isso evita sobrecarga de memória e também resposta lenta. O número máximo de elementos por página no sistema é 50 (o padrão é 10 elementos).

# Paginar a resposta:

Campos do paginado:

• page: Aponte para a página onde a solicitação está sendo feita. A primeira página está sempre no valor 0.
• size: Número de elementos que a consulta retornará.

# Filtros:

É possível aplicar filtros à consulta, bem como ordená-la

Ordenar:

• sort: É possível ordenar por campo, Crescente (Asc) ou Decrescente (Desc)

Filtrar:

• createdAt: Data de criação do Checkout
• updatedAt: Data da última atualização de Checkout
• status: Status do Checkout(PENDING, APPROVED, REJECTED)