Cancelar uma Pré-Autorização

PATCH

/api/v1/oneos/prospects/pre-authorizations/{{pre_authorization_id}}

PRE-AUTHORIZATION

Enpoint responsável por cancelar uma pré-autorização via integração.

Request

Header Params

Authorization

string

required

Token de acesso obtido no enpoint de Autenticação.

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request PATCH 'https://one.app-hm.oneos.com.br/api/v1/oneos/prospects/pre-authorizations/{{pre_authorization_id}}' \
--header 'Authorization: '

Responses

🟢204No Content

text/plain

Body

integer

required

Identificador Interno

projectIdentifier

string

required

Identificador do projeto na pré-autorização

constructorName

string

required

Nome da construtora

clientTaxId

string

required

CNPJ do cliente indicado na pré-autorição

prospectAnticipationId

integer

optional

Id da solicitação de antecipação gerada a partir da pré-autorização

expirationDate

string

required

Data de expiração da pré-autorização

uniqueId

string

optional

Identificador externo referente ao projeto. Obrigatório somente via integração

status

string

required

Status da pré-autorização

revocationReason

string

optional

Motivo da revogação

constructorInvoice

object

required

Informações da fatura da construtora

originalAmount

number <float>

required

Valor Bruno da fatura

Examples:

1000010000.512500.55

withHoldTaxAmount

number <float>

optional

Valor da retenção fiscal da fatura

Examples:

10001000.5125.3222347.65

dueDate

string

required

Data de vencimento

number

string

required

Número da nota

description

string

optional

Descrição da nota

contractedReceiptNumber

string

optional

Número da nota fiscal do fornecedor

🟠400Bad Request

Criar uma Pré-Autorização

Utilizando Webhooks