Find or Create Counterparty

Find or Create Counterparty

post

https://api.aurixpay.wshttps://sandbox.api.aurixpay.ws

/banking/v1/counterparties

This endpoint searches for or creates a counterparty based on the provided name and CPF/CNPJ.

scope: counterparties.write

Header parameters

AcceptstringOptionalExample: application/json

Content-TypestringOptionalExample: application/json

X-API-KeystringRequiredExample: {{API_KEY}}

Body

application/json

namestringRequired

tax_numberstringRequired

Responses

200

Success

application/json

403

Forbidden

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

post

/banking/v1/counterparties

HTTP

POST /banking/v1/counterparties HTTP/1.1
Host: api.aurixpay.ws
X-API-Key: text
Content-Type: application/json
Accept: application/json

{
  "name": "João Silva",
  "tax_number": "12345678901"
}

{
  "data": {
    "id": "0197c54c-e65f-70a8-bd70-bdf2e086aef6",
    "name": "João Silva",
    "tax_number": "12345678901",
    "created_at": "2025-07-01T09:24:00.000000Z",
    "updated_at": "2025-07-01T09:24:00.000000Z"
  }
}