Skip to main content
POST
Deprecated — Cancel a deal under a contract
Cancels a deal found under a contract. POST /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/cancel takes the same body and finds the deal without a contract.

Path Parameters

realmId
string
required
organizationId
string
required
contractId
string
required
dealId
string
required

Body

application/json
cancelAllInvoices
boolean

Response

200 - application/json

Successful response

id
string
required
realm
string
required
organization
string
required
chargeType
enum<string>
required
Available options:
SINGLE,
RECURRENT,
SUBSCRIPTION
status
enum<string>
required
Available options:
OPEN,
CANCELED,
TERMINATED,
EXPIRED,
REVOKED
startAt
string<date-time>
required
products
object[]
required
paymentMethods
enum<string>[]
required
Available options:
BANK_SLIP,
PIX_INITIATION,
PIX_AUTOMATIC,
PIX,
P2P
creditParties
object[]
required
debitParties
object[]
required
closingAt
string
required
firstChargeDate
string<date-time>
required
numberOfInstallments
number
required
dueAt
string
required
createdBy
string
required
updatedBy
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
description
string
contract
string
endAt
string<date-time> | null
secondaryPaymentMethods
enum<string>[]
Available options:
BANK_SLIP,
PIX_INITIATION,
PIX_AUTOMATIC,
PIX,
P2P
fine
object
interest
object
discount
object
paymentUrl
string
settings
object
externalCard
object