Dynamic Provisioning

This API allows third-party services to establish organizations and associate new merchants with these organizations.

Organization Provision Endpoint

POST {UI_URL_ISSUED_BY_PAYTIKO}/api/dynamic-provision/organization

Headers

Key	Type	Required	Description
Content-Type*	String		application/json
Api-Key*	String		{API_KEY_ISSUED_BY_PAYTIKO}

Request Body

Field	Type	Required	Description
name*	String		Organization name.
user.firstName	String		User first name (or full name if last name cannot be provided).
user.lastName	String		User last name.
user.email	String		Unique user e-mail.
user.password	String		User password.
user.phone	String		Phone number.

Not all user object fields are required. If any field within the user object is left blank, it will be automatically generated by Paytiko.

200: OK

{
    "organizationSecretKey": "6b717772-8d6f-4d6c-bac6-d6a497e65a28"
}

400: Bad Request

{
    "errors": {
        "Name": [
            "The Name field is required."
        ]
    },
    "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-48ba767b6ab8b363eda1015ab84acedf-7ad9d2a0aa6e49f8-00"
}

401: Unauthorized

"'ApiKey' header is required"

Merchant Provision Endpoint

POST {UI_URL_ISSUED_BY_PAYTIKO}/api/dynamic-provision/merchant/{ORGANIZATION_KEY}

Create a new merchant within a newly created organization. You can create unlimited number of merchants within one organization.

Headers

Key	Type	Required	Value
Content-Type*	String		application/json
Api-Key*	String		{API_KEY_ISSUED_BY_PAYTIKO}

Request Body

Field	Type	Required	Description
name*	String		Merchant name.
syncUrl*	String		Webhook notification URL.
email	String		Merchant e-mail.

Response

200

{
    "merchantSecretKey": "03e7277a72eb41bfb565053fc61873a9"
}

400

{
    "isSuccess": false,
    "errorMessage": "Merchant with provided e-mail already exists."
}