Update boleto beneficiary registration data

PATCH

https://tenant.api.corpx.com/v1/accounts/:accountId/boleto/charge/beneficiary

PATCH

/v1/accounts/:accountId/boleto/charge/beneficiary

curl -X PATCH https://tenant.api.corpx.com/v1/accounts/accountId/boleto/charge/beneficiary \
     -H "X-Tenant-Id: X-Tenant-Id" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "legalName": "MARIA DA SILVA",
  "tradeName": "MARIA DA SILVA",
  "name": "MARIA DA SILVA",
  "socialName": "MARIA DA SILVA",
  "email": "maria.silva@example.com",
  "phone": "+5511999999999",
  "representativeName": "MARIA DA SILVA",
  "representativeEmail": "maria.silva@example.com",
  "representativePhone": "+5511999999999"
}'

{
  "operationId": "8c1f6a2e-4d3b-4b9a-9f0e-1a2b3c4d5e6f",
  "beneficiaryId": "8c1f6a2e-4d3b-4b9a-9f0e-1a2b3c4d5e6f",
  "processingStatus": "ELIGIBLE"
}

Updates registration data of this account’s beneficiary. The facade looks up the beneficiary from the account; do not send a beneficiary id. At least one field is required. A person account accepts name and socialName; a company account accepts legalName and tradeName. email, phone and representative fields apply to both. Asynchronous: 202 with operationId. Scope boleto_charge.manage. Requires boleto_charge.

Updates registration data of this account's beneficiary. The facade looks up the beneficiary from the account; do not send a beneficiary id. At least one field is required. A person account accepts `name` and `socialName`; a company account accepts `legalName` and `tradeName`. `email`, `phone` and representative fields apply to both. Asynchronous: **202** with `operationId`. Scope `boleto_charge.manage`. Requires `boleto_charge`.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired

Account identifier.

Request

This endpoint expects an object.

legalNamestringOptional<=200 characters

tradeNamestringOptional<=200 characters

namestringOptional<=200 characters

socialNamestringOptional<=200 characters

emailstringOptional

phonestringOptional<=30 characters

representativeNamestringOptional<=200 characters

representativeEmailstringOptional

representativePhonestringOptional<=30 characters

Response

Accepted. The settlement bank confirms later.

operationIdstringOptional

beneficiaryIdstringOptional

processingStatusenumOptional

Allowed values:

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Request

Response

Errors