API Reference

Update a PaymentGateway

put
https://api.vcita.biz/v3/payment_processing/payment_gateways/

Update an existing payment gateway - Available for Application Tokens

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the Payment Gateway

Body Params
string

The URL to the logo of the gateway

string

Specifies the fallback locale for the gateway's textual content. If a translation or string is missing, this locale will be used by default.

string
enum

Integration type: a payment service provider (e.g., Stripe, Square) that enables merchants to process multiple payment methods, or a digital wallet (e.g., PayPal, Google Pay) that allows consumers to store and use payment credentials

Allowed:
string
enum

Indicates the current status of the payment gateway: 'active' (available for use), 'disabled' (not available for use), or 'deprecated' (still available but not recommended for new integrations)

Allowed:
main_gateway_benefits
array of objects
length ≥ 1

A clear 3-4 bullet list highlighting the unique features and value of the gateway, aimed at encouraging merchants to connect with it. This information is stored per locale.

main_gateway_benefits
string
enum
required

The locale code (e.g., en, fr, es).

benefits
array of strings
required

A list of benefits in the specified locale.

benefits*
brief_benefit_highlights
array of objects
length ≥ 1

A brief, 2-4 word version of the gateway benefits, tailored for compact displays or mobile interfaces. This information is stored per locale.

brief_benefit_highlights
string
enum
required

The locale code (e.g., en, fr, es).

highlights
array of strings
required

A list of short benefit highlights in the specified locale.

highlights*
supported_countries
array of strings

A list of countries supported by the payment gateway, represented using ISO 3166-1 alpha-2 country codes.

supported_countries
supported_currencies
array of strings

A list of currencies supported by the payment gateway, represented using ISO 4217 format.

supported_currencies
number

The minimum value that can be charged using the payment gateway

payment_methods
object

The payment methods supported by the gateway

processing_features
object

The features the payment gateway supports and their current state (enabled/disabled)

Responses

Updated 7 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago