logo

MerchantApiTokens

Create API Token for a Merchant

Create a new API token for a merchant managed by your affiliate account.

Provide the Merchant ID and a Token Name to generate a unique Client ID and Secret for the merchant.

Use the returned credentials to authenticate as the merchant for API operations.

Note: This endpoint requires the Bearer token to be an Affiliate (ISV) token. Merchant tokens are not accepted.

SecurityBearer or Bearer or Bearer or Bearer
Request
Request Body schema: application/json
merchantId
required
string <uuid>

The unique identifier of the merchant.

tokenName
required
string non-empty

A descriptive name for the API token.

Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

post/pay-api/v1/merchants/tokens
Request samples
application/json
{
  • "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
  • "tokenName": "string"
}
Response samples
application/json
{
  • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
  • "clientSecret": "string"
}

List API Tokens

List all API tokens created for merchants under your affiliate account.

Optionally, filter the results by a specific Merchant ID.

Note: This endpoint requires the Bearer token to be an Affiliate (ISV) token. Merchant tokens are not accepted.

SecurityBearer or Bearer or Bearer or Bearer
Request
query Parameters
merchantId
string <uuid>

Filter tokens by a specific merchant.

Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

get/pay-api/v1/merchants/tokens
Request samples 
Response samples 
application/json
{
  • "tokens": [
    ]
}
Remove API Token for a Merchant
Remove an API token associated with a merchant under your affiliate account.


Provide the Merchant ID and the Client ID of the token to be deleted.


This action revokes the token and prevents further API access using those credentials.


Note: This endpoint requires the Bearer token to be an Affiliate (ISV) token. Merchant tokens are not accepted.


SecurityBearer or Bearer or Bearer or Bearer 
Request 
path Parameters
clientId
required
string <uuid> 
The client ID of the token to be removed.


 
query Parameters
merchantId
required
string <uuid> 
The unique identifier of the merchant.


 
Responses 
200
OK


400
Bad Request


404
Not Found


500
Internal Server Error


delete/pay-api/v1/merchants/tokens/{clientId}
Request samples 
Response samples 
application/json
{
  • "errors": {
    },
  • "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error",
  • "statusCode": 400,
  • "source": "<Service>",
  • "exceptionType": "FluentValidation.ValidationException",
  • "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee",
  • "entityId": null,
  • "errorCode": null
}
➔ Next to SettlementBatches