Get one PaymentGateway

Retrieve a single PaymentGateway record by its Id.

GET /api/billing/paymentgateways/{id}

Get one PaymentGateway

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/paymentgateways/{id} \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "BusinessId": 123,
  "Name": "<string>",
  "PaymentGatewayType": 123,
  "Attempt3dSecure": true,
  "AccessToken": "<string>",
  "ConfigurationXml": "<string>",
  "XmlResponse": "<string>",
  "TransactionFee": 123,
  "FinancialAccountId": 123,
  "TaxRateId": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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-Read role.

Path Parameters

id · integer · required

The Id of the PaymentGateway record to retrieve.

Code Examples

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/billing/paymentgateways/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

BusinessId · integer

ID of the business linked to this record.

Name · string

Display name for this payment gateway configuration.

PaymentGatewayType · integer

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

Attempt3dSecure · boolean

Whether attempt3d secure is enabled.

AccessToken · string

API access token or secret key for authenticating with the payment provider.

ConfigurationXml · string

Provider-specific configuration in XML format (e.g. merchant ID, additional keys).

XmlResponse · string

Last XML response returned by the payment provider.

TransactionFee · number

Fee charged per transaction processed through this gateway.

FinancialAccountId · integer

ID of the financial account linked to this record.

TaxRateId · integer

ID of the tax rate linked to this record.

Id · integer

Unique record identifier.

UniqueId · string

UUID of the record.

CreatedOn · string

Date and time the record was created (ISO 8601).

UpdatedOn · string

Date and time the record was last updated (ISO 8601).

UpdatedBy · string

Email of the user who last updated this record.

IsNew · boolean

Whether the record was recently created.

SystemId · string

External system identifier.

Example Response

{
  "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": "[e-mail]",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "PaymentGateway Example",
  "LocalizationDetails": null,
  "CustomFields": null
}