Skip to main content
PUT
/
recipients
/
{id}
Atualizar recipient
curl --request PUT \
  --url https://api.sandbox.z2pay.com/recipients/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "document": "<string>",
  "companyType": "<string>",
  "companyLegalName": "<string>",
  "companyFoundingDate": "<string>",
  "annualRevenue": 123,
  "corporationType": "<string>",
  "birthDate": "<string>",
  "motherName": "<string>",
  "profession": "<string>",
  "monthlyIncome": 123,
  "legalRepresentativeInfo": {
    "name": "<string>",
    "document": "<string>",
    "email": "jsmith@example.com",
    "motherName": "<string>",
    "birthdate": "<string>",
    "monthlyIncome": 123,
    "profession": "<string>",
    "phone": "<string>",
    "selfDeclaredRepresentative": true
  },
  "pixKeyType": "<string>",
  "pixKey": "<string>",
  "website": "<string>",
  "address": {
    "address": "<string>",
    "number": "<string>",
    "complement": "<string>",
    "neighborhood": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "referencePoint": "<string>"
  },
  "files": {
    "identificationDocument": "<string>",
    "selfie": "<string>",
    "socialContract": "<string>"
  }
}
'

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Path Parameters

id
string
required

ID do recipient

Body

application/json
name
string
Minimum string length: 2
email
string<email>
phone
string | null
document
string
Minimum string length: 11
kind
enum<string>
Available options:
merchant,
platform
type
enum<string>
Available options:
individual,
company
companyType
string | null
companyFoundingDate
string | null
annualRevenue
integer
corporationType
string | null
birthDate
string | null
motherName
string | null
profession
string | null
monthlyIncome
integer | null
pixKeyType
string | null
pixKey
string | null
website
string | null
address
object
bankAccount
object
files
object

Response

Recipient atualizado