CEcelcoin
billpayments

Cancela a transação de pagamento de contas efetuada

Changed on
delete/v5/transactions/billpayments/{transactionId}/void

Request

Path parameters

transactionIdinteger required

ID da transação para cancelar.

Request body

externalNSUinteger

Identificador da transação do sistema cliente.

externalTerminalstring nullable

Terminal de identificação externa do sistema do cliente, Ex: CPF.

Example request

{
  "externalNSU": 1234,
  "externalTerminal": "11122233344"
}

Response

Success

errorCodestring nullable

Código do status da operação.

messagestring nullable

Descrição.

statusinteger

Status da operação.

Example response

{
  "errorCode": "000",
  "message": "SUCESSO"
}

Changes

  • b1e1fd65abf5Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • info

      api operation id cancela-a-transação-de-pagamento-de-contas-efetuada removed and replaced with

    • info

      the endpoint scheme security Bearer was added to the API

    • info

      api tag billpayments added

    • info

      added the media type application/*+json to the request body

    • info

      added the media type application/json-patch+json to the request body

    • info

      added the media type text/json to the request body

    • info

      the request property became nullable

    • info

      removed subschema #1: TRANSACAO NAO ENCONTRADA subschema #2: FALHA NA COMUNIC COM A SUA INSTUICAO subschema #3: FALHA NA COMUNIC COM A INSTITUICAO subschema #4: FALHA NA COMUNIC JUNTO AO NOSSO PARCEIRO. from the response body oneOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response's property default value 0 was removed for the status