Mesta API Reference
Changelog

Create Beneficiary (V3)

post
https://api.stg.mesta.xyz/v3/beneficiaries

Create a new beneficiary with mandatory compliance fields. Same as V2 but beneficiaryRelationship and purposeOfPayment are required.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Same as V2 POST but beneficiaryRelationship and purposeOfPayment are required

string
enum
required

Type of beneficiary

Allowed:
string

First name (required for individual type)

string

Last name (required for individual type)

string

Middle name (optional, individual type only)

string

Full business name (required for business type)

string

Business registration number (required for business type)

string
enum

Type of business (optional)

Allowed:
string

Beneficiary email

string

Beneficiary phone number

date

Date of birth (YYYY-MM-DD, individual type)

uuid

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

address
object
required

Beneficiary address

identity
object

Identity document details

paymentMethods
array of objects
required
length ≥ 1

At least one payment method must be provided

paymentMethods*
string
enum
required

Type of payment method

Allowed:
data
object
required

Payment method data. Structure depends on type.

string

Display label

metadata
object

Custom metadata

string
enum
required

Relationship between sender and beneficiary

string
enum
required

Purpose of payment for the beneficiary

purposeOfPaymentDocument
object

Purpose of payment document upload request

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?