Cash-in/Cobrança

As funcionalidades de cash-in, são funcionalidades que permitem recebimento de dinheiro. Através desta API, é possível criar cobrança, onde esta é repassada ao cliente pagador, que por sua vez, ao efetivar o pagamento o dinheiro é creditado na sua conta.

Tipos de cobrança

Collection postman

Clique aqui para acessar

CorrelationId

Durante a criação das cobranças, faz-se necessário enviar uma chave de correlação do sistema cliente, a fim de possibilitar a conciliação do pagamento do lado do sistema cliente, deste modo, ao receber um pagamento será enviado as informações de pagamento via Webhook, incluindo esta chave de correlação.

De preferência, utilizar UUID para correlationId

Vários tipos de cobrança em um único endpoint

Note que, foi disponibilizado uma única rota /api/v1/charges, para criar uma nova cobrança, vale ressaltar que deve ter atenção ao tipo de cobrança informado, bem como seus devidos parâmetros, pois para cada tipo, existe uma particularidade.

Paginação

Todas as APIs, utilizam o mesmo padrão de paginação

Para realizar a paginação, é necessário que seja informado os valores: page, limit e afterNsu.

• Page: indica a página que deseja carregar, começando do número 1. Caso não seja informado, será considerado o valor 1.
• Limit: indica a quantidade máxima que deve ser retornada. Valor máximo: 50. Caso não seja informado, será considerado o valor 10.
• opcional AfterNsu: indica um referencial que será utilizado para buscar após este nsu. Por exemplo, a busca de pagamentos retorna o NSU (número sequencial único) de cada pagamento, caso informe o afterNsu = 10, significa que será retornado os pagamentos com NSU maior que 10. Este parâmetro funciona em conjunto com a paginação.

As informações da paginação serão retornadas no header da response da seguinte forma:

{
   "currentPage":1, // pagina atual solicitada
   "pageSize":20, // quantidade de itens por pagina
   "pageCount":34, // quantidade de paginas disponiveis
   "rowCount":673, // quantidade de registros
}