Consultar limites de uma conta - Apenas Pós-Pago
Consulte os limites estabelecidos para uma conta, função disponível APENAS para CARTÕES PÓS-PAGOS, aquelas que possuem um limite de crédito concedido para ser utilizado em compras ou saques, e que irá gerar uma fatura para o cliente ao final do período pré-determinado.
Passos para Integrar
- Realizar autenticação na API -
- Realizar a consulta das informações -
Consultar limites da conta
Para atualizar as informações de uma conta, autentique-se e envie a seguinte requisição:
cURL da chamada
curl -X 'GET' \
'https://kubernetes-prod.celcoin.dev/api/accounts/{accountId}/balance?accountId=1' \
-H 'accept: application/json' \
-H 'Client-Id: 1'
Sucesso 200
{
"account_id": 49,
"total_credit_limit": 1000,
"max_credit_limit": 1000,
"total_overdraft_limit": 0,
"withdrawal_credit_limit": 0,
"percentage_over_limit": 0,
"total_installment_credit_limit": 0
}
Campo | Tipo | Descrição |
---|---|---|
account_id | int | Id da conta que é fornecido na criação |
total_credit_limit | int | O total de limite que o cliente possui |
max_credit_limit | int | O quanto o cliente escolheu utilizar do limite total |
total_overdraft_limit | int | |
withdrawal_credit_limit | int | Valor total disponível para saque |
percentage_over_limit | int | Percentual máximo que pode ser utilizado para uma aprovação extraordinária (limite total já utilizado) |
total_installment_credit_limit | int | Valor máximo por parcela |
Atualizar os limites de uma conta
Atualize o limite de uma conta enviando a seguinte requisição:
cURL da chamada
curl -X 'PATCH' \
'https://kubernetes-prod.celcoin.dev/api/accounts/1/balance/withdraw' \
-H 'accept: */*' \
-H 'Client-Id: 1' \
-H 'Content-Type: application/json' \
-d '{
"value": 1100.05
}'
Sucesso 200
Campo | Tipo | Descrição |
---|---|---|
operation | string(10) | seleciona se o tipo de alteração no momento que for realizar a alteração, WITHDRAW para retirada de credito, CREDIT para fornecer mais crédito. |
Updated 2 days ago