Cobrar Recebível

Descrição

Realiza a cobrança de um recebível utilizando o cartão de crédito do membro. Este endpoint deve ser utilizado quando for necessário efetuar a transação diretamente vinculada a um recebível existente no sistema, debitando o valor informado do cartão de crédito associado ao membro.

📨 Corpo da Requisição (Request Body)

Os campos necessários para a cobrança devem ser informados no corpo da requisição.

Parâmetro	Tipo	Obrigatoriedade	Descrição
idReceivable	int32	Sim	ID do recebível a ser cobrado.
idMember	int32	Sim	ID do membro titular do cartão de crédito que realizará o pagamento.
idBranch	int32	Sim	ID da unidade do membro.
idCreditCard	int32	Sim	ID do cartão de crédito.
amount	int32	Sim	Valor a cobrar. Deve ser igual ou maior ao valor do saldo devedor. Se maior, o excedente é gerado como crédito na conta do aluno.

📤 Estrutura da Resposta

A resposta retorna informações detalhadas sobre o resultado da operação de cobrança.

Campo	Tipo	Descrição
success	boolean	Informa se a operação foi bem sucedida.
idSale	int32	ID da venda.
receiptWidth	int32	Largura do recibo.
receipt	string	Recibo.

Requisição

Authorization

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Parâmetros Body

application/json-patch+json

Exemplo

{
    "idReceivable": 0,
    "idMember": 0,
    "idBranch": 0,
    "idCreditCard": 0,
    "amount": 0
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Charge a receivable using a member's credit card

Cobrar Recebível

Descrição

📨 Corpo da Requisição (Request Body)

📤 Estrutura da Resposta

Requisição

Exemplos de Requisição

Respostas

Charge a receivable using a member's credit card

Cobrar Recebível#

Descrição#

📨 Corpo da Requisição (Request Body)#

📤 Estrutura da Resposta#

Requisição

Exemplos de Requisição

Respostas

Cobrar Recebível

Descrição

📨 Corpo da Requisição (Request Body)

📤 Estrutura da Resposta