latestOpenAPI 3.0.32026-08-215925112.0 MB
36be0dca14e7
api
payment-gateways
Get all Payment Gateways
get/api/payments/gateways
Query parameters
string
OR
string
string
OR
string
Response
OK
_idstring required
The ID of the payment gateway
typestring
The type of the gateway
namestring required
The display name of the payment gateway
dataobject
Any additional data required for the integration to work
orgIdstring
The ID of the organization to create this payment gateway for
activeboolean
Whether the payment gateway is active
secretstring required
The secret of the payment gateway
sellerIdstring required
The ID of the seller that gateway belongs to
redirectUrlstring uri nullable
The URL to which the customer gets redirected
channelsstring[]
An array of channels the payment gateway is used for
iconstring nullable
The URL of the icon of the payment gateway
descriptionstring
A description of the payment gateway for the user
createdAtstring date-time required
An ISO timestamp indicating when the gateway was created
updatedAtstring date-time required
An ISO Timestamp indicating when the gateway was last updated