> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get one PaymentGateway

> Retrieve a single PaymentGateway record by its Id.

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

<Note>
  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.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the PaymentGateway record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/paymentgateways/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/paymentgateways/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/paymentgateways/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  Business Id.
</ResponseField>

<ResponseField name="Name" type="string">
  Display name for this payment gateway configuration.
</ResponseField>

<ResponseField name="PaymentGatewayType" type="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.
</ResponseField>

<ResponseField name="Attempt3dSecure" type="boolean">
  Attempt3d Secure.
</ResponseField>

<ResponseField name="AccessToken" type="string">
  API access token or secret key for authenticating with the payment provider.
</ResponseField>

<ResponseField name="ConfigurationXml" type="string">
  Provider-specific configuration in XML format (e.g. merchant ID, additional keys).
</ResponseField>

<ResponseField name="XmlResponse" type="string">
  Last XML response returned by the payment provider.
</ResponseField>

<ResponseField name="TransactionFee" type="number">
  Fee charged per transaction processed through this gateway.
</ResponseField>

<ResponseField name="FinancialAccountId" type="integer">
  Financial Account Id.
</ResponseField>

<ResponseField name="TaxRateId" type="integer">
  Tax Rate Id.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "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
}
```