Skip to main content
DELETE
/
v1
/
merchants
/
{merchantId}
/
pix
/
keys
Delete a PIX key for a specific merchant
curl --request DELETE \
  --url https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/pix/keys \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "key": "user@example.com",
  "provider": "CELCOIN"
}
'
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Validation error",
    "status": 400,
    "details": {
      "issues": [
        {
          "field": "email",
          "type": "REQUIRED",
          "message": "Field 'email' is required",
          "value": "invalid_value",
          "constraints": {
            "min": 18,
            "max": 120
          }
        }
      ]
    },
    "path": "/companies",
    "timestamp": "2023-12-01T10:00:00.000Z",
    "requestId": "req_123456789"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.rinne.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Company API key for authentication

Path Parameters

​
merchantId
string
required

The merchant ID

Body

application/json
​
key
string
required

Pix key to delete

Minimum string length: 1
Example:

"user@example.com"

​
provider
enum<string>
required

Provider name (accepts lowercase and uppercase, returns uppercase)

Available options:
CELCOIN,
RINNE,
CAPPTA
Minimum string length: 1
Example:

"CELCOIN"

Response

PIX key deleted successfully