nicheclear.ca API (1.0.311)

Download OpenAPI specification:

License: Apache-2.0

Merchant API

Payments

Payments API

Get payments

Get a list of payments sorted by creation date (most recent first)

Authorizations:

BasicAuth

query Parameters

offset	integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0.
limit	integer [ 1 .. 10000 ] The numbers of items to return. Default is 50.
created.gte	string <ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)> Example: created.gte=2025-10-12T10:26:18 Return only payments created at or after the specified time. Default is beginning of the current day.
created.lt	string <ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)> Example: created.lt=2025-10-13T10:39:34 If passed, return only payments created strictly before the specified time

Responses

Response samples

200
400
401

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"hasMore": true,
"result": [{"id": "91d27876e87f4b22b3ecd53924bf973d",
"created": "2025-10-25T10:11:12",
"updated": "2025-10-25T10:12:12",
"state": "PENDING",
"errorCode": "4.01 Insufficient Funds",
"type": "DEPOSIT",
"method": "BASIC_CARD",
"description": "Deposit via TEST shop",
"referenceId": "payment-123",
"parentPaymentId": "91d27876e87f4b22b3ecd53924bf973d",
"startRecurring": true,
"recurringToken": "string",
"preAuth": true,
"merchantId": 0,
"merchantName": "string",
"shopId": 0,
"shopName": "string",
"providerId": 0,
"providerName": "string",
"terminalId": 0,
"terminalName": "string",
"externalId": "string",
"externalResultCode": "42",
"amount": 11.12,
"refundedAmount": 11.12,
"currency": "EUR",
"baseAmount": 15,
"customerAmount": 15,
"customerCurrency": "USD",
"shopBaseAmount": 15,
"shopBaseCurrency": "USD",
"customerReferenceId": "customer_123",
"customerAccountNumber": "string",
"customerBank": "string",
"customerBankBranch": "string",
"customerBankCode": "string",
"customerBankBranchCode": "string",
"customerCitizenshipCountryCode": "AU",
"customerFirstName": "John",
"customerLastName": "Smith",
"customerDateOfBirth": "2001-12-03",
"customerEmail": "[email protected]",
"customerPhone": "357 123123123",
"customerRoutingGroup": "John",
"customerIp": "127.0.0.1",
"customerIpCountryCode": "CY",
"billingCountryCode": "CY",
"billingPostalCode": "4141",
"billingCity": "Limassol",
"billingState": "CA",
"billingAddressLine1": "7, Sunny street",
"billingAddressLine2": "Office 3",
"cardholderName": "John Smith",
"cardBrand": "VISA",
"cardType": "CREDIT",
"cardCountryCode": "CY",
"cardIssuingOrganization": "BANK OF CYPRUS PUBLIC COMPANY LIMITED"
}
]
}

Operations

Payment operations API

Get payment operations

Get a list of payment operations sorted by completion date (most recent first)

Authorizations:

BasicAuth

query Parameters

offset	integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0.
limit	integer [ 1 .. 10000 ] The numbers of items to return. Default is 50.
completed.gte	string <ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)> Example: completed.gte=2025-10-12T10:26:18 Return only operations completed at or after the specified time. Default is beginning of the current day.
completed.lt	string <ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)> Example: completed.lt=2025-10-13T10:39:34 If passed, return only operations completed strictly before the specified time
operation.in	string Example: operation.in=CREATE_PAYMENT,CHECKOUT,CANCEL Comma-separated list of operations
paymentState.in	string Example: paymentState.in=CHECKOUT,COMPLETED,DECLINED Comma-separated list of payment states after operation completion

Responses

Response samples

200
400
401

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"hasMore": true,
"result": [{"id": 0,
"paymentId": "91d27876e87f4b22b3ecd53924bf973d",
"operation": "CREATE_PAYMENT",
"paymentState": "PENDING",
"started": "2025-10-25T10:12:12",
"completed": "2025-10-25T10:12:13",
"rawPaymentData": "string",
"terminalId": 0,
"terminalName": "string",
"paymentCreated": "2025-10-25T10:11:12",
"paymentType": "DEPOSIT",
"paymentMethod": "BASIC_CARD",
"paymentDescription": "Deposit via TEST shop",
"paymentReferenceId": "payment-123",
"paymentAmount": 11.12,
"paymentCurrency": "EUR",
"paymentBaseAmount": 15,
"parentPaymentId": "91d27876e87f4b22b3ecd53924bf973d",
"merchantId": 0,
"merchantName": "string",
"shopId": 0,
"shopName": "string",
"providerId": 0,
"providerName": "string",
"errorCode": "4.01 Insufficient Funds",
"externalResultCode": "42",
"externalId": "string"
}
]
}

Counterparties

Counterparties API

Get counterparties

Get all counterparties

Authorizations:

BasicAuth

query Parameters

offset	integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0.
limit	integer [ 1 .. 10000 ] The numbers of items to return. Default is 50.

Responses

Response samples

200
401
404

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"result": [{"id": 111,
"name": "Best Counterparty",
"affiliateId": "d941c1d7805530",
"affiliateName": "SomeName",
"uniqueCode": "c1d7",
"registrationDate": "2025-11-17",
"createdAt": "2025-11-17T12:12:12",
"counterpartyTypes": ["MERCHANT",
"PROVIDER"
]
}
]
}

Shops

Shops API

Get merchants shops

Get all merchants shops

Authorizations:

BasicAuth

query Parameters

offset	integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0.
limit	integer [ 1 .. 10000 ] The numbers of items to return. Default is 50.

Responses

Response samples

200
401
403
404

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"result": [{"id": 111,
"name": "Best Shop",
"state": "ACTIVE",
"displayName": "Best Shop",
"merchantId": 192,
"merchantName": "Best Merchant",
"introducerId": 12345,
"introducerName": "Mr. John",
"countryCode": "US",
"shopUrl": "https://best-shop-every.bestshop",
"webhookUrl": "https://best-shop-every.bestshop/webhooks/tid/111",
"returnUrl": "https://best-shop-every.bestshop",
"checkoutUrl": "https://best-shop-every.bestshop/checkout",
"alternativeReturnUrl": "https://super-shop.bestshop",
"baseCurrency": "string",
"checkoutTimeout": 60,
"cascadingConfirmationTimeout": 0,
"resultPageRedirectTimeout": 5,
"antiFraudProfileId": 100,
"checkoutThemeCode": "string",
"postProcessors": [0
],
"preProcessors": [0
],
"routingStrategy": "string",
"depositRequiredParameters": ["customerFirstName",
"customerLastName",
"customerEmail",
"customerPhone",
"customerDateOfBirth",
"billingAddress"
],
"shopGroups": ["string"
],
"createdAt": "2025-11-17T12:12:12"
}
]
}

Get shop groups

Get a paginated list of shop groups.

Authorizations:

BasicAuth

query Parameters

offset	integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0.
limit	integer [ 1 .. 10000 ] The numbers of items to return. Default is 50.

Responses

Response samples

200
400
401
403

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"hasMore": true,
"result": [{"id": 10,
"name": "My Shop Group",
"shops": [{"id": 111,
"name": "Best Shop"
}
]
}
]
}

Terminals

Terminals API

Get terminal balance

Get terminal balance by terminal Id

Authorizations:

BasicAuth

path Parameters

terminalId

required

integer

Terminal Id

Responses

Response samples

200
401
404

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"result": {"available": [{"currency": "EUR",
"amount": 11.12
}
],
"reserved": [{"currency": "EUR",
"amount": 11.12
}
]
}
}

Get merchants terminals

Get all merchant terminals

Authorizations:

BasicAuth

query Parameters

offset	integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0.
limit	integer [ 1 .. 10000 ] The numbers of items to return. Default is 50.

Responses

Response samples

200
401
403
404

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"result": [{"id": 111,
"name": "Basic Card Terminal",
"state": "Basic Card Terminal",
"merchantId": 2281,
"merchantName": "Best Merchant",
"providerId": 345,
"providerName": "Best Provider",
"apiCode": "ApiCode",
"apiName": "ApiName",
"createdAt": "2025-11-17T12:12:12",
"apiTypes": ["PSP",
"BANKING",
"COMPLIANCE",
"PRE_PROCESSOR",
"POST_PROCESSOR"
]
}
]
}

Balances

Balances API

Get balances

Get a list of all merchant balances in the Financial Module. For more detailed information, please contact our support team.

Authorizations:

BasicAuth

Responses

Response samples

200
401

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"result": [{"id": 123,
"accountType": "PROCESSING",
"name": "Processing Balance(EUR) of shop \"my-shop\"",
"currency": "EUR",
"amount": 1020.12
}
]
}

Get balances available for withdrawals via the gateway API

Get balances available for withdrawals via the gateway API. See the "Check Withdrawal Balance" section in the shop settings.

Authorizations:

BasicAuth

Responses

Response samples

200
401
403

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"result": [{"shopId": 1381,
"shopName": "Best Shop",
"terminalId": 11126,
"terminalName": "Best Terminal",
"currency": "EUR",
"amount": 500.25
}
]
}

BINs

BINs API

Get BINs

Get a paginated list of BINs

Authorizations:

BasicAuth

query Parameters

offset	integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0.
limit	integer [ 1 .. 10000 ] The numbers of items to return. Default is 50.

Responses

Response samples

200
400
401

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"hasMore": true,
"result": [{"bin": "411111",
"cardBrand": "VISA",
"cardType": "CREDIT",
"issuingCountryCode": "CY",
"issuingOrganization": "BANK OF CYPRUS PUBLIC COMPANY LIMITED"
}
]
}

Get BIN groups

Get a paginated list of BIN groups

Authorizations:

BasicAuth

query Parameters

offset	integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0.
limit	integer [ 1 .. 10000 ] The numbers of items to return. Default is 50.

Responses

Response samples

200
400
401

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"hasMore": true,
"result": [{"id": 42,
"merchantId": 192,
"merchantName": "Best Merchant",
"groupName": "My BIN Group"
}
]
}

Get BINs from a BIN group

Get a paginated list of BINs belonging to the specified BIN group

Authorizations:

BasicAuth

path Parameters

groupId

required

integer

BIN Group Id

query Parameters

offset	integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0.
limit	integer [ 1 .. 10000 ] The numbers of items to return. Default is 50.

Responses

Response samples

200
400
401
404

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"hasMore": true,
"result": ["411111",
"511111"
]
}

Customers

Customers API

Get customers

Get a paginated list of customers.

Authorizations:

BasicAuth

query Parameters

offset	integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0.
limit	integer [ 1 .. 10000 ] The numbers of items to return. Default is 50.

Responses

Response samples

200
400
401
403

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"hasMore": true,
"result": [{"id": 999,
"merchantId": 192,
"merchantName": "Best Merchant",
"shopId": 111,
"shopName": "Best Shop",
"referenceId": "customer_123",
"firstName": "John",
"lastName": "Smith",
"email": "[email protected]",
"phone": "357 123123123",
"dateOfBirth": "2001-12-03",
"paymentInstruments": [{"paymentMethod": "BASIC_CARD",
"accountNumber": "411111******1111",
"numberOfSuccessfulDeposits": 5
}
],
"connectedCards": [{"cardholderName": "John Smith",
"pan": "411111******1111",
"expiryDate": "12/26",
"updatedAt": "2025-11-17T12:12:12",
"savedByCustomer": true
}
]
}
]
}

Emails

Email Groups API

Get email groups

Get a paginated list of email groups

Authorizations:

BasicAuth

query Parameters

offset	integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0.
limit	integer [ 1 .. 10000 ] The numbers of items to return. Default is 50.

Responses

Response samples

200
400
401

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"hasMore": true,
"result": [{"id": 10,
"name": "My Email Group",
"merchantId": 192,
"merchantName": "Best Merchant",
"notificationEmails": "[email protected],[email protected]"
}
]
}

Get emails from an email group

Get a paginated list of email addresses belonging to the specified email group

Authorizations:

BasicAuth

path Parameters

groupId

required

integer

Email Group Id

query Parameters

offset	integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0.
limit	integer [ 1 .. 10000 ] The numbers of items to return. Default is 50.

Responses

Response samples

200
400
401
404

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"hasMore": true,
"result": ["[email protected]",
"[email protected]"
]
}

Cards

Card Groups API

Get card groups

Get a paginated list of card groups

Authorizations:

BasicAuth

query Parameters

offset	integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0.
limit	integer [ 1 .. 10000 ] The numbers of items to return. Default is 50.

Responses

Response samples

200
400
401

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"hasMore": true,
"result": [{"id": 10,
"name": "My Card Group",
"merchantId": 192,
"merchantName": "Best Merchant",
"notificationEmails": "[email protected]"
}
]
}

Get cards from a card group

Get a paginated list of masked card PANs belonging to the specified card group

Authorizations:

BasicAuth

path Parameters

groupId

required

integer

Card Group Id

query Parameters

offset	integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0.
limit	integer [ 1 .. 10000 ] The numbers of items to return. Default is 50.

Responses

Response samples

200
400
401
404

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"hasMore": true,
"result": ["411111******1111",
"511111******2222"
]
}

Countries

Country Groups API

Get country groups

Get a paginated list of country groups

Authorizations:

BasicAuth

query Parameters

offset	integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0.
limit	integer [ 1 .. 10000 ] The numbers of items to return. Default is 50.

Responses

Response samples

200
400
401

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"hasMore": true,
"result": [{"id": 10,
"name": "My Country Group",
"merchantId": 192,
"merchantName": "Best Merchant",
"countries": ["CY",
"US",
"GB"
]
}
]
}