Create integration

Create a new payment integration

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 255

External identifier for the integration

string
required

Name of the integration

string
enum
required

PSP source type. Each PSP supports different connection types.

Allowed:
string
enum
required

Secret type for the PSP integration. Each secret type has specific authentication requirements:

Available Secret Types:

APIKEY_ONLY: Single API key authentication
Required fields: apiKey
Example:

{
"apiKey": "APIKEY280PRO22"
}

PUBLIC_SECRET_KEY: Public and secret key pair authentication
Required fields: secretKey Optional: publicKey
Example:

{
"secretKey": "SECRET_KEY_HERE",
"publicKey": "PUBLIC_KEY_HERE"
}

BASIC_AUTH: Basic authentication with client credentials
Required fields: clientId, clientSecret
Example:

{
"clientId": "your_client_id",
"clientSecret": "your_client_secret"
}

USERNAME_PASSWORD: Username and password authentication
Required fields: username, password
Example:

{
"username": "your_username",
"password": "your_password"
}

HMAC: HMAC signature based authentication
Required fields: hmac, apiKey Optional: merchantCode, accountCode
Example:

{
"hmac": "HMAC92749798124",
"apiKey": "APIKEY280PRO22",
"merchantCode": "MERCHANT_CODE",
"accountCode": "ACCOUNT_CODE"
}

APIKEY: API key authentication with additional fields
Required fields: apiKey Optional: storeUrl, shopName
Example:

{
"apiKey": "shpca_your_api_key",
"storeUrl": "https://your-store.myshopify.com",
"shopName": "your-store"
}

sftp: SFTP authentication: username with either a password or a private key. Paste the raw private key (PEM) — it is base64-encoded automatically on save. An optional passphrase may accompany the key.
Required fields: username Optional: password, privateKey, passphrase
Example:

{
"username": "sftp_user",
"privateKey": "-----BEGIN OPENSSH PRIVATE KEY-----\n...\n-----END OPENSSH PRIVATE KEY-----",
"passphrase": "optional-key-passphrase"
}
Allowed:
secretPayload
object
required

Secret payload containing PSP-specific configuration. Required fields depend on the selected secret type.

merchantAccountCodes
array of strings

Array of merchant account codes associated with this integration

merchantAccountCodes
date

Go-live date for the integration, as a calendar date (YYYY-MM-DD). It must be at least tomorrow and no more than 90 days ahead, measured against the current UTC date. When omitted, the go-live date is assigned by the automatic rules.

Headers
string

Use this header to select a merchant within the API key's scope, which can be Entire account (All Merchants), Merchant group, or Specific merchant. It is required for the Merchant group scope, or for the Entire account scope when the account has more than one merchant. It is not needed for the Specific merchant scope, which is issued for a single merchant. (https://developers.justt.ai/docs/reference-accounts)

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json