Skip to main content
GET
/
api
/
billing
/
paymentgateways
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}
A PaymentGateway represents a connection to one of the supported payment gateways used to process card payments. Each gateway can be associated to one or more locations (Business entity) via the DefaultPaymentGatewayId property on the business. A gateway is configured with a specific PaymentGatewayType (e.g. stripe, braintree, adyen) and the corresponding credentials (AccessToken, ConfigurationXml). An optional TransactionFee can be set to track per-transaction costs, and a FinancialAccountId and TaxRateId can be linked for accounting purposes.

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the PaymentGateway-List role.

​
Enums

ValueName
0None
1test
2authorize_net
3beanstream
4braintree
6first_data_e4
7jetpay_v2
8merchant_e_solutions
9netbilling
10payment_express
12sage
13stripe
14trans_first
15usa_epay
17blue_pay
18cyber_source
19elavon
20first_data_e4_v27
21litle
22mercury
23nmi
24payflow_pro
25quantum
26secure_net
27trust_commerce
28worldpay
29wirecard
30paymill
31merchant_warrior
32nab_transact
33secure_pay_au
34eway
35migs
36pin
37ogone
38realex
39moneris
40psi_gate
41epay
42hdfc
43net_pay
44redsys
45iridium
46barclays_epdq_extra_plus
49paypal
50payex
51openpay
52hps
53checkout
54checkout_v2
55worldpay_us
56conekta
57orbital
59barclaycard_smartpay
60trans_first_transaction_express
63forte
65citrus_pay
66payu_latam
67global_collect
68cayan
69clearhaus
70sage_pay
71safe_charge
72mercado_pago
73payeezy
200acapture
201adyen
203banco_sabadell
208blue_snap
209borgun
210bpoint
212bridge_pay
213card_connect
214card_stream
215cardprocess
217cecabank
218cenpos
224creditcall
225credorax
226ct_payment
227culqi
229data_cash
230diamond_mind
231dibs
232digitzs
234element
237eway_rapid
238ezic
239fat_zebra
242first_giving
243first_pay
244flo2cash
245flo2cash_simple
247global
249global_iris
250global_transport
253iats_payments
255iveri
256ixopay
257jabstry
258jetpay
260kushki
261latitude19
263maxipago
266merchant_partners
272mundipagg
274ncr_secure_pay
280optimal_payments
282pay_conex
283pay_junction_v2
288paymentez
291paystation
294pro_pay
296qbms
298quickpay
299quickpay_v10
300qvalent
303s5
309securion_pay
312tns
317vanco
318visanet_peru
319wepay
320stripe_payment_intents
321stripeACH
323quickbooks
324monei
401HostedPaymentPage1
402HostedPaymentPage2
403HostedPaymentPage3

​
Query Parameters

​
Pagination & Sorting

​
page
integer
default:"1"
The page number to retrieve.
​
size
integer
default:"25"
The number of records per page.
​
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
​
dir
integer
Sort direction. 1 for ascending, -1 for descending.

​
Filters

​
PaymentGateway_Business
integer
Filter by Business Id.
​
PaymentGateway_Name
string
Filter by display name for this payment gateway configuration.
​
PaymentGateway_PaymentGatewayType
integer
Filter by the payment provider to use (e.g. stripe, braintree, adyen). Determines which credentials are required.
​
PaymentGateway_Attempt3dSecure
boolean
Filter by Attempt3d Secure.
​
PaymentGateway_AccessToken
string
Filter by aPI access token or secret key for authenticating with the payment provider.
​
PaymentGateway_ConfigurationXml
string
Filter by provider-specific configuration in XML format (e.g. merchant ID, additional keys).
​
PaymentGateway_XmlResponse
string
Filter by last XML response returned by the payment provider.
​
PaymentGateway_TransactionFee
number
Filter by fee charged per transaction processed through this gateway.
​
PaymentGateway_FinancialAccount
integer
Filter by Financial Account Id.
​
PaymentGateway_TaxRate
integer
Filter by Tax Rate Id.

​
Range Filters

​
from_PaymentGateway_TransactionFee
number
Filter by fee charged per transaction processed through this gateway greater than or equal to this value.
​
to_PaymentGateway_TransactionFee
number
Filter by fee charged per transaction processed through this gateway less than or equal to this value.
​
from_PaymentGateway_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_PaymentGateway_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
​
from_PaymentGateway_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_PaymentGateway_UpdatedOn
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

​
Code Examples

​
Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/billing/paymentgateways?page=1&size=15&orderBy=Name&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/billing/paymentgateways?PaymentGateway_Name=example-value&orderBy=Name&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/billing/paymentgateways?from_PaymentGateway_UpdatedOn=2025-01-01T00:00&to_PaymentGateway_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Records
PaymentGateway[]
The list of PaymentGateway records matching the query. See the Get one PaymentGateway endpoint for the full list of properties returned for each record.
Partial records — The listing endpoint returns a summary representation of each PaymentGateway. The following fields are not included in the Records[] response: ConfigurationXml, TransactionFee.To get all fields, fetch the full record using the Get one PaymentGateway endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
​
CurrentPage
integer
Current page number.
​
CurrentPageSize
integer
Number of records per page.
​
CurrentOrderField
string
The field used for sorting.
​
CurrentSortDirection
integer
The sort direction (1 = ascending, -1 = descending).
​
FirstItem
integer
Index of the first item on the current page.
​
LastItem
integer
Index of the last item on the current page.
​
TotalItems
integer
Total number of matching records across all pages.
​
TotalPages
integer
Total number of pages.
​
HasNextPage
boolean
Whether there is a next page of results.
​
HasPreviousPage
boolean
Whether there is a previous page of results.
Example Response
{
  "Records": [
    {
      "BusinessId": 0,
      "Name": "",
      "PaymentGatewayType": 0,
      "Attempt3dSecure": false,
      "AccessToken": null,
      "ConfigurationXml": null,
      "XmlResponse": null,
      "TransactionFee": null,
      "FinancialAccountId": null,
      "TaxRateId": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "PaymentGateway Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}