eComm Payment Gateways

Native Store Only

Payment Gateway Object

JSON

{
  "id": "string",
  "live_payment_methods_url": "string",
  "test_payment_methods_url": "string"
}

payment_gateway

Property	Type	Description	Mutable
id	string	System identifier of the custom payment gateway.	No
live_payment_methods_url	string	The payment methods API endpoint that will be called to retrieve the available payment methods for the cart in LIVE mode.	Yes
test_payment_methods_url	string	The payment methods API endpoint that will be called to retrieve the available payment methods for the cart in TEST mode. This URL can be the same as live_payment_methods_url.	Yes

List Payment Gateways

List Payment Gateways

GET https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/payment-gateways

Path Parameters

Name	Type	Description
site_name*	string	The unique identifier of the target site.

400: Bad Request

200: OK object

{
  "offset": 0,
  "limit": 0,
  "total_responses": 0,
  "results": [
    {
      "id": "string",
      "live_payment_methods_url": "string",
      "test_payment_methods_url": "string"
    }
  ]
}

curl

curl --request GET \
     --url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/payment-gateways \
     --header 'accept: application/json'

Get Payment Gateway

Get Payment Gateway

GET https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/payment-gateways/{gateway_id}

Path Parameters

Name	Type	Description
site_name*	string	The unique identifier for the target site
gateway_id*	string	The unique identifier for the target Payment Gateway.

400: Bad Request

200: OK object

{
  "id": "string",
  "live_payment_methods_url": "string",
  "test_payment_methods_url": "string"
}

curl

curl --request GET \
     --url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/payment-gateways/gateway_id \
     --header 'accept: application/json'

Create Payment Gateway

Create Payment Gateway

POST https://api.duda.co/apisites/multiscreen/{site_name}/ecommerce/payment-gateways

Path Parameters

Name	Type	Description
site_name*	string	The unique identifier for the target site

Request Body

Name	Type	Description
live_payment_methods_url*	string
test_payment_methods_url	string
name	string
description	string
image	string
icons	array of strings

201: Created object

{
  "id": "string",
  "live_payment_methods_url": "string",
  "test_payment_methods_url": "string",
  "name": "string",
  "description": "string",
  "image": "string",
  "icons": [
    "string"
  ]
}

400: Bad Request

curl

curl --request POST \
     --url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/payment-gateways \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "live_payment_methods_url": "https://domain.com"
}
'

Update Payment Gateway

Update Payment Gateway

PATCH https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/payment-gateways/{gateway_id}

Path Parameters

Name	Type	Description
site_name*	string	The unique identifier for the target site
gateway_id*	string	The unique identifier for the target Payment Gateway.

Request Body

Name	Type	Description
live_payment_methods_url*	string
test_payment_methods_url	string
name	string
description	string
image	string
icons	array of strings

200: OK object

{
  "id": "string",
  "live_payment_methods_url": "string",
  "test_payment_methods_url": "string",
  "name": "string",
  "description": "string",
  "image": "string",
  "icons": [
    "string"
  ]
}

400: Bad Request

curl

curl --request PATCH \
     --url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/payment-gateways/gateway_id \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "live_payment_methods_url": "https://domain.com"
}
'

Delete Payment Gateway

Delete Payment Gateway

DELETE https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/payment-gateways/{gateway_id}

Path Parameters

Name	Type	Description
site_name*	string	The unique identifier for the target site
gateway_id*	string	The unique identifier for the target Payment Gateway.

204: No Content

400: Bad Request

curl

curl --request DELETE \
     --url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/payment-gateways/gateway_id \
     --header 'accept: application/json'