Payment Gateways
Endpoints
The Payment Gateway object
Attributes
_id
Required
string
The ID of the payment gateway
name
Required
string
The display name of the payment gateway
secret
Required
string
The secret of the payment gateway
sellerId
Required
string
The ID of the seller that gateway belongs to
createdAt
Required
string date-time
An ISO timestamp indicating when the gateway was created
updatedAt
Required
string date-time
An ISO Timestamp indicating when the gateway was last updated
Optional Attributes
Collapse allExample
{"_id": "string","type": "custom","name": "string","data": {},"orgId": "string","active": true,"secret": "string","sellerId": "string","redirectUrl": "https://vivenu.com","channels": ["online"],"entitlements": {"target": "all","sellerIds": ["string"]},"capabilities": {"refunds": {"enabled": true,"endpointUrl": "https://vivenu.com"}},"icon": "string","description": "string","createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z"}
Create a Payment Gateway
Payload
name
Required
string
The display name of the payment gateway
Optional Attributes
Collapse allResponses
200
OK
400
Bad Request
401
Unauthorized
post
/api/payments/gateways
{"type": "custom","name": "string","redirectUrl": "https://vivenu.com","data": {},"orgId": "string"}
Response
application/json
{"_id": "string","type": "custom","name": "string","data": {},"orgId": "string","active": true,"secret": "string","sellerId": "string","redirectUrl": "https://vivenu.com","channels": ["online"],"entitlements": {"target": "all","sellerIds": ["string"]},"capabilities": {"refunds": {"enabled": true,"endpointUrl": "https://vivenu.com"}},"icon": "string","description": "string","createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z"}
get
/api/payments/gateways/{id}
Response
application/json
{"_id": "string","type": "custom","name": "string","data": {},"orgId": "string","active": true,"secret": "string","sellerId": "string","redirectUrl": "https://vivenu.com","channels": ["online"],"entitlements": {"target": "all","sellerIds": ["string"]},"capabilities": {"refunds": {"enabled": true,"endpointUrl": "https://vivenu.com"}},"icon": "string","description": "string","createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z"}
Update a Payment Gateway
Payload
name
Required
string
The display name of the payment gateway
Optional Attributes
Collapse allResponses
200
OK
400
Bad Request
401
Unauthorized
put
/api/payments/gateways/{id}
{"name": "string","active": true,"redirectUrl": "https://vivenu.com","channels": ["online"],"data": {},"entitlements": {"target": "all","sellerIds": ["string"]},"capabilities": {"refunds": {"enabled": true,"endpointUrl": "https://vivenu.com"}},"icon": "string","description": "string"}
Response
application/json
{"_id": "string","type": "custom","name": "string","data": {},"orgId": "string","active": true,"secret": "string","sellerId": "string","redirectUrl": "https://vivenu.com","channels": ["online"],"entitlements": {"target": "all","sellerIds": ["string"]},"capabilities": {"refunds": {"enabled": true,"endpointUrl": "https://vivenu.com"}},"icon": "string","description": "string","createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z"}
get
/api/payments/gateways
Response
application/json
[{"_id": "string","type": "custom","name": "string","data": {},"orgId": "string","active": true,"secret": "string","sellerId": "string","redirectUrl": "https://vivenu.com","channels": ["online"],"entitlements": {"target": "all","sellerIds": ["string"]},"capabilities": {"refunds": {"enabled": true,"endpointUrl": "https://vivenu.com"}},"icon": "string","description": "string","createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z"}]