Register Payee

post

https://mapi.pockyt.io/v3/payee/register

This endpoint is used to register a new payee. The response includes a customerNo used to refer to the registered payee for future transactions. This endpoint supports both Direct Merchant and Merchant of Record (MoR) flows. MoR merchants must include the payorNo parameter to associate payees with their Payor. Direct Merchants can ignore Payor-related fields.

Body Params

merchantNo

string

required

Defaults to 202333

Merchant Account ID generated by Pockyt

storeNo

string

required

Defaults to 301854

Generated by Pockyt

profileType

string

required

Defaults to INDIVIDUAL

Payee's profile type. Possible types are: INDIVIDUAL, BUSINESS

lang

string

Defaults to en

The preferred language for the payee's account

timestamp

string

required

Defaults to 2023-02-13T12:37:58Z

Current UTC time, correct format should be "yyyy-mm-ddTHH:MM:SSZ"

city

string

required

Defaults to hometown

city

country

string

Defaults to USA

The payee's country, e.g. United States of America

countryCode

string

required

Defaults to US

Payee's 2-character ISO 3166 country/region code

customerCode

string

Defaults to 1665425422

Payee's unique code in the merchant's system

dateOfBirth

string

required

Defaults to 1999-01-01

The payee's date of birth

string

required

Defaults to [email protected]

The payee's unique email address

firstName

string

required

Defaults to John

The payee's first name

lastName

string

required

Defaults to Doe

The payee's last name

phone

string

Defaults to 1234567890

The phone number of the payee contact

state

string

required

Defaults to NY

Payee's state. For US, only 2-letter code is used (NY)

street

string

required

Defaults to 123 main St

The payee's address

street2

string

Defaults to Apt 4B

The payee's address, second line

zip

string

required

Defaults to 10005

Postal code

governmentId

string

required

Defaults to 1234567890

Government ID for the payee (Driver's license, SSN, Passport #). Required when profileType is set to 'INDIVIDUAL'

governmentIdType

string

required

Defaults to ID_CARD

Type of government id (ID_CARD, SSN, PASSPORT, DRIVER_LICENSE, BUSINESS_REGISTRATION_CERT). Required when profileType is set to 'INDIVIDUAL'

verifySign

string

required

Defaults to cb74eb92eebadc97445d559bc5501012

API MD5 hashed signature

company

string

required

Defaults to Pockyt

Company name. Required when profileType is sent to 'BUSINESS'

payorNo

string

Defaults to P87654321

Payor merchant number. Required for Merchant of Record (MoR) integrations. Not applicable for Direct Merchant flows — omit this parameter.

merGroupNo

string

Defaults to 100001

ISV (Independent Software Vendor) merchant group number. Required only for ISV integrations where the ISV manages sub-merchants through Pockyt. Direct Merchants and MoR merchants can omit this parameter.

Response

200200