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 --request GET \
--url https://sandbox-apicorp.celcoin.com.br/cards/v1/accounts/297/balance \
--header 'Authorization: Bearer TOKEN' \
--header 'Content-Type: application/json' \
--header 'User-Agent: insomnia/10.0.0' \
Sucesso 200
{
"version": false,
"status": 200,
"body": {
"accountId": 297,
"totalCreditLimit": 100,
"maximumCreditLimit": 1000,
"totalOverdraftLimit": 0,
"totalCreditWithdrawalLimit": 10,
"percentageOverLimit": 0,
"totalCrteditInstallmentLimit": 0
}
}
Campo | Tipo | Descrição |
---|---|---|
accountId | int | Id da conta que é fornecido na criação |
totalCreditLimit | int | O total de limite que o cliente possui |
maximumCreditLimit | int | O quanto o cliente escolheu utilizar do limite total |
totalOverdraftLimit | int | |
totalCreditWithdrawalLimit | int | Valor total disponível para saque |
percentageOverLimit | int | Percentual máximo que pode ser utilizado para uma aprovação extraordinária (limite total já utilizado) |
totalCrteditInstallmentLimit | 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 3 months ago