Carteiras

Cadastrar uma nova carteira

Esse endpoint permite a realização do cadastro dos dados para uma nova carteira de cobrança para uma conta escrow.

Parâmetros da Requisição

  • name (string): Nome da carteira.

  • accountId (string): ID de cadastro da conta para ser associada a nova carteira.

  • daysToExpireAfterPayment (integer): Quantidade de dias para expiração da cobrança.

  • fine (float): Taxa percentual de multa a ser aplicada nas cobranças com pagamento em atraso.

  • discountModality (string): Modalidade de desconto. Possíveis valores aceitos: PERCENT

  • discountValue (float): Valor de desconto a ser aplicado nos pagamentos.

  • interest (float): Taxa percentual de juros de atraso nos pagamentos.

Resposta

Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato:

  • id(string/uuid v4): ID de cadastro gerado para a carteira de cobranças.
Exemplo de JSON:
{
   "id": "<string>"
}

post/escrow/api/v1/wallets

Request

  • Base URL
    https://sandbox.platform.credit.celcoin.com.br
  • URL
    https://sandbox.platform.credit.celcoin.com.br/escrow/api/v1/wallets
  • Auth
    none declared

Headers

Content-Typestring
Acceptstring

Request body

object required

Example request

{
  "name": "<string>",
  "accountId": "<uuid>",
  "fine": "<number>",
  "daysToExpireAfterPayment": "<number>",
  "discountValue": "<number>",
  "interest": "<number>",
  "discountModality": "PERCENT"
}

Response

OK

object required

Changes

No recorded changes to this operation across all 1 revision of this API.