v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Realizar pagamento

Essa API possibilita que seja realizado a solicitação de um ou vários pagamentos de forma assíncrona, sendo assim, após enviar a requisição enviaremos um gatilho no formato JSON em seu webhook.

Para mais informações de como realizar a implementação dessa API criamos esse artigo.

Criamos uma tabela que contém todos os erros que essa api pode retornar, recomendamos a leitura do da mesma para realizar a implementação dessa [api] (https://developers.celcoin.com.br/docs/tabela-de-erros-3#api-de-pagamentos-de-debitos-veiculares).

post/vehicledebtsapi/v1/payDebts

Request body

transactionIdinteger required

ID único gerado para pesquisa de seus débitos

debtIdListstring[] required

ID dos Débitos que você quer realizar o pagamento

clientRequestIdstring required

Identificador da transação. Pode ser um ID interno da transação e é utilizado com idempotência

Response

200

paymentIdstring

errorCodestring

messagestring

Example response

{
  "paymentId": "4DD6E025-869F-4467-B982-FFB8E6D4CC61",
  "errorCode": "000",
  "message": "Solicitação recebida com sucesso. Aguarde a resposta do processamento no webhook cadastrado."
}