1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Merchant Settings

getGateways

get

/ccadmin/v1/merchant/paymentGateways

Get Gateways. Get all the payment gateways

Request

Supported Media Types
  • application/json
Query Parameters
enabledOnly
Type: boolean
Filters enabled payment gateways when true else all.
production
Type: boolean
Fetches production data if true.

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getGateways_response
Nested Schema : paymentGateways
Type: array
Payment gateway details.
Nested Schema : items
Type: object
Nested Schema : soapCredential
Type: object
SOAP Credential information.
Nested Schema : sopCredentials
Type: object
SOP credential information.
Nested Schema : agent
Type: object
SOP credential information to be used by agent.
Nested Schema : storefront
Type: object
SOP credential information to be used by storefront.
Example application/json

{
    "merchantId":"oraclecc",
    "paymentGateways":[
        {
            "clientId":"Test113",
            "production":false,
            "captureType":"PlaceOrder",
            "hasSecretKey":true,
            "repositoryId":"PP-A",
            "type":"PayPal",
            "supportedTypes":[
                "paypalCheckout"
            ],
            "enabled":true
        },
        {
            "firstname":"John",
            "sopCredentials":{
                "agent":{
                    "hasAccessKey":true,
                    "sopURL":"https://testsecureacceptance.cybersource.com/silent/pay",
                    "profileId":"Test123",
                    "hasSecretKey":true,
                    "repositoryId":"SOP-B",
                    "applicationName":"agent",
                    "expirationDate":"2016-08-14T11:54:30.207Z"
                },
                "storefront":{
                    "hasAccessKey":true,
                    "sopURL":"http://10.191.198.240:8080/ccstoreui/v1/testQA/cybersourceSOP",
                    "profileId":"Test111",
                    "hasSecretKey":true,
                    "repositoryId":"SOP-A",
                    "applicationName":"storefront",
                    "expirationDate":"2017-01-28T11:54:30.207Z"
                }
            },
            "soapCredential":{
                "hasTransactionSecurityKey":true,
                "soapURL":"https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor",
                "profileId":"CS-A",
                "repositoryId":"SOAP-A",
                "expirationDate":"2020-05-20T11:54:30.207Z"
            },
            "repositoryId":"CS-A",
            "ignoreAVS":true,
            "type":"CyberSource",
            "supportedTypes":[
                "card"
            ],
            "enabled":true,
            "username":"UserA",
            "lastname":"X"
        }
    ],
    "repositoryId":"Merchant-A",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/merchant/paymentGateways"
        }
    ]
}
Default Response
The error response
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Response Payload returned by endpoint:

{
  "merchantId": "oraclecc",
  "paymentGateways": [
    {
      "clientId": "Test113",
      "production": false,
      "captureType": "PlaceOrder",
      "hasSecretKey": true,
      "repositoryId": "PP-A",
      "type": "PayPal",
      "supportedTypes": ["paypalCheckout"],
      "enabled": true
    },
    {
      "firstname": "John",
      "sopCredentials": {
        "agent": {
          "hasAccessKey": true,
          "sopURL": "https://testsecureacceptance.cybersource.com/silent/pay",
          "profileId": "Test123",
          "hasSecretKey": true,
          "repositoryId": "SOP-B",
          "applicationName": "agent",
          "expirationDate": "2016-08-14T11:54:30.207Z"
        },
        "storefront": {
          "hasAccessKey": true,
          "sopURL": "http://10.191.198.240:8080/ccstoreui/v1/testQA/cybersourceSOP",
          "profileId": "Test111",
          "hasSecretKey": true,
          "repositoryId": "SOP-A",
          "applicationName": "storefront",
          "expirationDate": "2017-01-28T11:54:30.207Z"
        }
      },
      "soapCredential": {
        "hasTransactionSecurityKey": true,
        "soapURL": "https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor",
        "profileId": "CS-A",
        "repositoryId": "SOAP-A",
        "expirationDate": "2020-05-20T11:54:30.207Z"
      },
      "repositoryId": "CS-A",
      "ignoreAVS": true,
      "type": "CyberSource",
      "supportedTypes": ["card"],
      "enabled": true,
      "username": "UserA",
      "lastname": "X"
    }
  ],
  "repositoryId": "Merchant-A",
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadminui/v1/merchant/paymentGateways"
  }]
}