Merchant API Calls

Introduction

The Sticitt Pay Merchant API allows for managing merchants and transactions. This section provides details on the following API calls:

Clear Host
Create Merchant
Get All Transactions
Get All Merchants

Clear Host

Clears the host details for a specific merchant.

Method:
POST /v2/merchants/{MerchantId}/clear-host

Parameter	Description
MerchantId	Required: The unique identifier for the merchant.

Clear Host - Request Example

{
  "MerchantId": "0c21af18-e723-469c-a29c-8072cbf3f3f2"
} 

Clear Host - Successful Response Example

{
"merchantID": "0c21af18-e723-469c-a29c-8072cbf3f3f2",
"clientID": null,
"name": "sticitt ",
"email": "sticitt@sticitt.co.za",
"accountReference": "SCKTPPA",
"fee": 0.02875,
"availableBalance": null,
"actualBalance": null,
"createdAt": "2025-01-01T00:00:00.000000+00:00",
"lockedAt": null
}

Create Merchant

Creates a new merchant in the system.

Method:
POST /v2/merchants

Parameter	Description
name	Required: Name of the merchant.
email	Required: Email address of the merchant.
requestId	Required: Unique request identifier.

Create Merchant - Request Example

{
  "name": "sticitt",
  "email": "sticitt@sticitt.co.za",
  "requestId": "test"
}

Create Merchant - Successful Response Example

{
  "name": "sticitt",
  "email": "sticitt@sticitt.co.za",
  "requestId": "test"
}

Get All Transactions

Retrieves all transactions for a specific merchant within a date range.

Method:
POST /v2/merchants/{MerchantId}/transactions

Parameter	Description
MerchantId	Required: The unique identifier for the merchant.
fromDate	Required: Start date for transaction retrieval (ISO 8601).
toDate	Required: End date for transaction retrieval (ISO 8601).

Get All Transactions - Request Example

{
  "MerchantId": "0c21af18-e723-469c-a29c-8072cbf3f3f2",
  "fromDate": "2024-01-01T00:00:00.000Z",
  "toDate": "2025-01-01T00:00:00.000Z"
}

Get All Transactions - Successful Response Example

{
  "fromDate": "2024-01-01T00:00:00.000Z",
  "toDate": "2025-01-01T00:00:00.000Z",
  "merchantID": "0c21af18-e723-469c-a29c-8072cbf3f3f2",
  "merchantAccountReference": "SCKTPPA",
  "availableBalance": 0.0,
  "actualBalance": 0.0,
  "provisionalTransactions": [],
  "finalizedTransactions": []
}

Get All Merchants

Retrieves a list of all merchants.

Method:
GET /v2/merchants

Get All Merchants - Successful Response Example

[
  {
    "merchantID": "452547d4-198a-411f-b54a-791dc6e61c70",
    "clientID": "sticitt-host",
    "name": "sticitt",
    "email": "sticitt@sticitt.co.za",
    "accountReference": "SNBPPQQ",
    "fee": 0.02875,
    "availableBalance": null,
    "actualBalance": null,
    "createdAt": "2025-01-01T00:00:00.000000+00:00",
    "lockedAt": null
  },
  {
    "merchantID": "8511d35c-245-4309-bc14-3ae74fffac33",
    "clientID": "sticitt-host",
    "name": "sticitt 1",
    "email": "sticitt@sticitt.co.za",
    "accountReference": "SATPPLHN",
    "fee": 0.02875,
    "availableBalance": null,
    "actualBalance": null,
    "createdAt": "2025-01-01T00:00:00.000000+00:00",
    "lockedAt": null
  }
]

Last modified: 20 February 2025