Mesta API Reference
Changelog

Update Beneficiary

patch
https://api.stg.mesta.xyz/v1/beneficiaries/

Updates an existing beneficiary's information. Note that certain fields cannot be modified after initial creation.

Non-updatable fields:

  • type (individual/business)
  • identificationNumber (for business beneficiaries)
  • taxIdentificationNumber (for business beneficiaries)
  • bankAccountType
  • bankAccountNumber
  • bankCode

Before updating a beneficiary, always check the validation rules using: GET /v1/validation-rules/beneficiaries?ownerType=[individual|business]&country=[ISO 3166-1 alpha-2 code]

Path Params
string
required

Unique identifier for the beneficiary

Body Params
string
enum
required

The type for the beneficiary (individual).

Allowed:
string
required

First name of the individual beneficiary.

string

Middle name of the individual beneficiary.

string
required

Last name of the individual beneficiary.

date

Birthdate of the Beneficiary in the format yyyy-mm-dd.

string

Email address of the beneficiary.

string

Phone number of the beneficiary in international format (e.g., +11234567890).

uuid

Merchant ID (optional, auto-assigned from API key)

address
object
required

Postal address.

identity
object
string
enum
required

Type of payment method for the beneficiary.

Allowed:
paymentInfo
required

Payment information for the beneficiary, varies based on payment type.

metadata
object

Additional custom metadata.

Responses

Updated 20 days ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 20 days ago