Skip to main content
GET
/
v1
/
billingProviders
Get Billing Providers
curl --request GET \
  --url https://qa-lynx.nayax.com/operational/v1/billingProviders \
  --header 'Authorization: <api-key>'
[
  {
    "BillingProviderID": 123,
    "BillingProviderName": "<string>",
    "TerminalIDLength": 123,
    "BillingProviderComments": "<string>",
    "LastUpdated": "2023-11-07T05:31:56Z",
    "MinimumTransactionAmount": "<string>",
    "RegularAuthorizationBit": true,
    "CancelAuthorizationBit": true,
    "PreSelectionBit": true,
    "TransactionVoidBit": true,
    "ECommerceTransactionsBit": true,
    "ForcedTransactionsBit": true,
    "ConstantPreAuthorizationBit": true,
    "EMVTransactionsBit": 123,
    "AutomaticTransactionVoidBit": true,
    "ForceSettlementBit": true,
    "OfflineEMVTransactionsBit": true,
    "SettlementRetryBit": true,
    "AutomaticRefund": true,
    "PartialRefundSupport": true,
    "CKey": "<string>",
    "SupportReconciliation": true,
    "ReconciliationTimeZoneKey": 123,
    "ReconciliationSourceType": "<string>",
    "SupportIncrementalAuth": true
  }
]

Authorizations

Authorization
string
header
required

Enter your API key. It's required to authenticate API requests.

Query Parameters

BillingProviderID
integer<int32>

The unique identifier of the billing provider to filter the results.

Response

200 - application/json

A list of billing providers matching the specified criteria.

BillingProviderID
integer<int32> | null

The unique identifier of the billing provider.

BillingProviderName
string | null

The name of the billing provider.

TerminalIDLength
integer<int32> | null

The length of the terminal ID used by the billing provider.

BillingProviderComments
string | null

Additional comments or notes about the billing provider.

LastUpdated
string<date-time> | null

The date and time when the billing provider information was last updated.

MinimumTransactionAmount
string | null

The minimum transaction amount allowed by the billing provider.

RegularAuthorizationBit
boolean | null

Indicates whether the billing provider supports regular authorizations.

CancelAuthorizationBit
boolean | null

Indicates whether the billing provider supports authorization cancellations.

PreSelectionBit
boolean | null

Indicates whether the billing provider supports pre-selection of transactions.

TransactionVoidBit
boolean | null

Indicates whether the billing provider supports transaction voids.

ECommerceTransactionsBit
boolean | null

Indicates whether the billing provider supports e-commerce transactions.

ForcedTransactionsBit
boolean | null

Indicates whether the billing provider supports forced transactions.

ConstantPreAuthorizationBit
boolean | null

Indicates whether the billing provider supports constant pre-authorizations.

EMVTransactionsBit
integer<int32> | null

Indicates whether the billing provider supports EMV transactions.

AutomaticTransactionVoidBit
boolean | null

Indicates whether the billing provider supports automatic transaction voids.

ForceSettlementBit
boolean | null

Indicates whether the billing provider supports force settlements.

OfflineEMVTransactionsBit
boolean | null

Indicates whether the billing provider supports offline EMV transactions.

SettlementRetryBit
boolean | null

Indicates whether the billing provider supports settlement retries.

AutomaticRefund
boolean | null

Indicates whether the billing provider supports automatic refunds.

PartialRefundSupport
boolean | null

Indicates whether the billing provider supports partial refunds.

CKey
string | null

A unique key associated with the billing provider for additional identification or reference.

SupportReconciliation
boolean | null

Indicates whether the billing provider supports reconciliation processes.

ReconciliationTimeZoneKey
integer<int32> | null

The time zone key associated with the reconciliation process.

ReconciliationSourceType
string | null

The source type associated with the reconciliation process.

SupportIncrementalAuth
boolean | null

Indicates whether the billing provider supports incremental authorization.