Policy

GET /v1/policies

Parameter	Description
rows	A limit of objects to be returned, between 1 and 100 items	Optional
page	The page for the list of objects to return	Optional
cursor	The cursor of the current page list of objects	Optional

The above request returns JSON structured like this:

Parameter	Description
total	The total of items
items.id	The ID of the policy

{
  "total": 0,
  "items": [
    {
      "id": "string"
    }
  ]
}

DELETE /v1/policies/{policy_id}

Parameter	Description
policy_id	The ID of policy to cancel

The request has the following parameters in body:

Parameter	Description
cancel_reason	The cancel reason of the policy	Required
cancel_description	The cancel description of the policy	Optional
reversal_method	The reversal method	Optional
reversal_bank_account	The reversal bank account	Optional

One Of
CreditCard, WireTransfer, Pix

{
  "cancel_reason": 0,
  "cancel_description": "string",
  "reversal_method": "string",
  "reversal_bank_account": {}
}

The above request returns JSON structured like this:

Parameter	Description
id	The ID of the Policy
status	The status canceled for the Policy
date_end	The date policy was canceled

{
  "id": "string",
  "status": 0,
  "date_end": "string"
}