Create Merchant

POST

/v2.0/crm/addressBook/createMerchant

API Overview

Item	Value
API Status	Recommended
Current Version	v2.0
Backward Compatibility	Yes
Applicable Environment	Production
Applicable User Roles	PSP

Description

This is the recommended API for creating a merchant.

Request

Authorization

Body Params application/json

Example

{
    "applicationType": 2,
    "merchantDetails": {
        "personalDetails": {
            "firstName": "John",
            "middleName": "Michael",
            "lastName": "Doe",
            "dateOfBirth": "1985-06-15",
            "nationality": "US",
            "residentialAddress": {
                "country": "US",
                "state": "Arkansas",
                "city": "Little Rock",
                "postcode": "02162",
                "addressLine1": "123 Main Street",
                "addressLine2": "Apt 4B"
            },
            "contactNumber": {
                "countryCode": "US",
                "phoneNumber": "(501) 555-1234"
            },
            "email": "john.doe@example.com",
            "taxResidency": "US"
        },
        "additionalPersonalDetails": {
            "occupation": "Software Engineer",
            "purposesOfAccountOpening": [
                "Sell Crypto"
            ],
            "sourceOfFunds": [
                "Sale of Assets"
            ],
            "sourceOfWealth": [
                "Investments or Trading"
            ]
        },
        "supportingDocuments": [
            {
                "type": 2,
                "fileId": "FILE_PASSPORT_US_123456"
            }
        ]
    },
    "acceptedTnC": [
        "X101"
    ],
    "clientReference": "REF202604150003"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v2.0/crm/addressBook/createMerchant' \
--header 'Content-Type: application/json' \
--data-raw '{
    "applicationType": 2,
    "merchantDetails": {
        "personalDetails": {
            "firstName": "John",
            "middleName": "Michael",
            "lastName": "Doe",
            "dateOfBirth": "1985-06-15",
            "nationality": "US",
            "residentialAddress": {
                "country": "US",
                "state": "Arkansas",
                "city": "Little Rock",
                "postcode": "02162",
                "addressLine1": "123 Main Street",
                "addressLine2": "Apt 4B"
            },
            "contactNumber": {
                "countryCode": "US",
                "phoneNumber": "(501) 555-1234"
            },
            "email": "john.doe@example.com",
            "taxResidency": "US"
        },
        "additionalPersonalDetails": {
            "occupation": "Software Engineer",
            "purposesOfAccountOpening": [
                "Sell Crypto"
            ],
            "sourceOfFunds": [
                "Sale of Assets"
            ],
            "sourceOfWealth": [
                "Investments or Trading"
            ]
        },
        "supportingDocuments": [
            {
                "type": 2,
                "fileId": "FILE_PASSPORT_US_123456"
            }
        ]
    },
    "acceptedTnC": [
        "X101"
    ],
    "clientReference": "REF202604150003"
}'

Responses

🟢200Success

application/json

Body

Example

{
    "code": 200,
    "msg": "success",
    "data": {
        "applicationId": "2044242841240592386",
        "merchantDetails": {
            "participantCode": "B0100106",
            "applicationType": 1,
            "clientReference": "REF202604150003",
            "merchantDetails": {
                "personalDetails": {
                    "name": "Josh Hartmann",
                    "dateOfBirth": "1985-06-15",
                    "nationality": "US",
                    "residentialAddress": {
                        "country": "US",
                        "state": "Indiana",
                        "city": "Indianapolis",
                        "postcode": "46201",
                        "addressLine1": "123 Tech Avenue",
                        "addressLine2": "Suite 400"
                    },
                    "jobDesignation": "Senior Software Engineer"
                },
                "additionalPersonalDetails": {
                    "phoneNumber": "(317) 555-1234",
                    "emailAddress": "josh.hartmann@example.com",
                    "employerName": "TechCorp Inc.",
                    "occupation": "Software Engineer",
                    "industry": 18,
                    "purposes": [
                        "Sell Crypto",
                        "Wealth Products (fiat)"
                    ],
                    "sourceOfFunds": [
                        "Other"
                    ],
                    "sourceOfWealth": [
                        "Other",
                        "Business Loan",
                        "Sale of Assets"
                    ]
                }
            },
            "requiredDocuments": [
                "Passport",
                "Proof of Address",
                "Bank Statement"
            ]
        },
        "status": 3,
        "createAt": 1744704000000
    }
}

Modified at 2026-04-15 07:17:45

Get Internal Transfer

Get Merchant