Deactivate a pix recurrence

DELETE 
/pix/scheduled-payments/recurrence/:id/deactivate

Tag: api-paas-deactivate-pix-recurrence-by-idDescription: Deactivate a pix recurrence.

Request

Path Parameters

id stringrequired

Pix recurrence ID.

Header Parameters

x-wallet-uuid string

Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

nonce stringrequired

The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

x-lang string

Possible values: [pt-BR, en-US]

Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

x-product-uuid string

The product ID is a UUID (v4) used to identify the Z.ro product configuration.

x-product-target-user-uuid string

The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses

200

The recurrence deactivated successfully.

application/json

Schema

Schema

id stringrequired

Pix recurrence ID.

Example (from schema)

{
  "id": "0a5c6a43-d7d4-4635-9075-c9a5aaf24a44"
}

400

If any required params are missing or has invalid format or type.

401

User authentication failed.

422

If any required params are missing or has invalid format or type.

Authorization: http

name: bearertype: httpscheme: bearerbearerFormat: JWT

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X DELETE 'https://docs.zrobank.io/pix/scheduled-payments/recurrence/:id/deactivate' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Auth

Bearer Token

Parameters

id — pathrequired

nonce — headerrequired

x-wallet-uuid — header

x-lang — header

---pt-BRen-US

x-product-uuid — header

x-product-target-user-uuid — header

ResponseClear

Click the Send API Request button above and see the response here!