Create Sender (v2)

post

https://api.stg.mesta.xyz/v2/senders

Overview

Creates a new sender
Supports both individual and business senders
Includes additional onboarding fields used for compliance review
Requirements vary by country and ownerType

Validation Rules

Important: Always check validation rules before creating a sender
Validation rules endpoint: GET /v2/validation-rules/senders
Required query parameters:
- ownerType=[individual|business]
- country=[ISO 3166-1 alpha-2 code]
Example request:

GET /v2/validation-rules/senders?ownerType=individual&country=MX

Additional v2 Notes

expectedMonthlyVolumeEstimate, averageTransactionSize, primaryCounterpartyJurisdictions, natureOfPayments, and sourceOfFunds are required for both sender types
Each value in primaryCounterpartyJurisdictions must be an ISO 3166-1 alpha-2 country code (for example: US, IN, GB)
isFinancialInstitution and numberOfEmployees are required for business senders
websiteAbsenceReason is required for business senders when websiteUrl is not provided
If isFinancialInstitution is true, upload the FI registration proof using POST /v1/senders/{senderId}/documents with document type fi_registration_proof before calling POST /v1/senders/{senderId}/verify

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Additional compliance onboarding fields required for v2 sender creation.

type

string

enum

required

Defaults to individual

Type of the sender.

Allowed:

firstName

string

required

First name of the individual sender.

lastName

string

required

Last name of the individual sender.

birthDate

date

required

Birth date in ISO 8601 format (YYYY-MM-DD).

string

required

Email address of the sender.

phone

string

required

A phone number in international format (e.g., +11234567890).

addresses

array of objects

required

Array of addresses for the sender.

addresses*

identity

object

required

websiteUrl

uri

Website URL of the individual or business.

metadata

object

Additional custom metadata for the sender account.

gender

string

enum

required

Gender of the sender

Allowed:

occupation

string

enum

required

Occupation of the sender

middleName

string

Middle name of the sender

merchantId

uuid

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

expectedMonthlyVolumeEstimate

number

required

Expected monthly transaction volume estimate for the sender.

averageTransactionSize

number

required

Expected average transaction size for the sender.

primaryCounterpartyJurisdictions

array of strings

required

Primary jurisdictions the sender expects to transact with. Each value must be an ISO 3166-1 alpha-2 country code.

primaryCounterpartyJurisdictions*

natureOfPayments

array of strings

required

Primary purposes for the sender's payments.

natureOfPayments*

sourceOfFunds

string

enum

required

Primary source of funds for the sender.

Responses

200Sender created successfully

400Bad Request - The request was invalid or cannot be served.

401Unauthorized - The request requires user authentication.

403Forbidden - The server understood the request, but refuses to authorize it.

404Not Found - The requested resource could not be found.

500Internal Server Error - The server encountered an unexpected condition.