Skip to main content
POST
/
api
/
billing
/
paymentgateways
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<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-Create 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

​
Request Body

​
Required Fields

​
BusinessId
integer
required
Business Id.
​
Name
string
required
Display name for this payment gateway configuration.

​
Optional Fields

​
PaymentGatewayType
integer
The payment provider to use (e.g. stripe, braintree, adyen). Determines which credentials are required. Defaults to ePaymentGatewayType.test. See ePaymentGatewayType enum above.
​
Attempt3dSecure
boolean
Attempt3d Secure.
​
ConfigurationXml
string
Provider-specific configuration in XML format (e.g. merchant ID, additional keys).
​
TransactionFee
number
Fee charged per transaction processed through this gateway.
​
FinancialAccountId
integer
Financial Account Id.
​
TaxRateId
integer
Tax Rate Id.

​
Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/paymentgateways" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": ""
}'

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the creation.
​
Value
object
Contains the Id of the newly created record.
​
WasSuccessful
boolean
true if the paymentgateway was created successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "PaymentGateway was successfully created.",
  "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

​
Message
string
A summary of the validation error(s), in the format PropertyName: error message.
​
Value
any
null on validation failure.
​
Errors
object[]
Array of validation errors.
​
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}