> ## 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.

# Update PaymentGateway

> Update an existing PaymentGateway record.

Updates an existing PaymentGateway record. You must include the `Id` of the record to update along with all required fields.

## 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-Edit`** role.
</Note>

## Enums

<Accordion title="ePaymentGatewayType — PaymentGatewayType values">
  | Value | Name                               |
  | ----- | ---------------------------------- |
  | 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                 |
</Accordion>

## Request Body

### Required Fields

<ParamField body="Id" type="integer" required>
  The Id of the PaymentGateway record to update.
</ParamField>

<ParamField body="BusinessId" type="integer" required>
  Business Id.
</ParamField>

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

<ParamField body="PaymentGatewayType" type="integer" required>
  The payment provider to use (e.g. stripe, braintree, adyen). Determines which credentials are required.
</ParamField>

### Optional Fields

<ParamField body="Attempt3dSecure" type="boolean">
  Attempt3d Secure.
</ParamField>

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

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

<ParamField body="FinancialAccountId" type="integer">
  Financial Account Id.
</ParamField>

<ParamField body="TaxRateId" type="integer">
  Tax Rate Id.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/paymentgateways" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Name": "",
      "PaymentGatewayType": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/paymentgateways',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Name: '',
        PaymentGatewayType: 0,
        Id: 87654321
      })
    }
  );

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

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

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/paymentgateways',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'Name': '',
          'PaymentGatewayType': 0,
          'Id': 87654321
      }
  )

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

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the paymentgateway was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "PaymentGateway was successfully updated.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 400

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```