REST API for Oracle Commerce Cloud December 2017

getGateway

get

/ccadmin/v1/merchant/paymentGateways/{id}

Get Gateway. Get the payment gateway by gateway name.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

Gateway Name.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getGateway_response

Properties

merchantId: Type: string

CyberSource Merchant ID.
paymentGateways: Type: array paymentGateways

Additional Properties Allowed:

Payment gateway details.
repositoryId: Type: string

The repository ID of the Merchant.

Nested Schema : paymentGateways

Type: array

Payment gateway details.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

enabled: Type: boolean

Is the setup enabled?
firstname: Type: string

First Name.
ignoreAVS: Type: boolean

A flag to tell the Cybersource whether to ignore the AVS results.
lastname: Type: string

Last Name.
repositoryId: Type: string

Repository ID for the payment gateway.
soapCredential: Type: object soapCredential

Additional Properties Allowed:

SOAP Credential information.
sopCredentials: Type: object sopCredentials

Additional Properties Allowed:

SOP credential information.
type: Type: string

Type of the payment gateway.
username: Type: string

CyberSource Username.

Nested Schema : soapCredential

Type: object

SOAP Credential information.

Properties

expirationDate: Type: string

Key expiration date.
hasTransactionSecurityKey: Type: boolean

A flag indicating if transaction security key is present to validate signature.
profileId: Type: string

SOAP Profile ID.
repositoryId: Type: string

ID for the SOAP Credential.
soapURL: Type: string

CyberSource SOAP URL.

Nested Schema : sopCredentials

Type: object

SOP credential information.

Properties

agent: Type: object agent

Additional Properties Allowed:

SOP credential information to be used by agent.
storefront: Type: object storefront

Additional Properties Allowed:

SOP credential information to be used by storefront.

Nested Schema : agent

Type: object

SOP credential information to be used by agent.

Properties

expirationDate: Type: string

Key expiration date for SOP Credentials of agent.
hasAccessKey: Type: boolean

A flag indicating if access key is present for agent.
hasSecretKey: Type: boolean

A flag indicating if secret key is present to generate signature for agent.
profileId: Type: string

SOP Profile ID to be used by agent.
repositoryId: Type: string

Repository ID of SOP Credential of agent.
sopURL: Type: string

CyberSource SOP URL to be used by agent.

Nested Schema : storefront

Type: object

SOP credential information to be used by storefront.

Properties

expirationDate: Type: string

Key expiration date for SOP Credentials of storefront.
hasAccessKey: Type: boolean

A flag indicating if access key is present for storefront.
hasSecretKey: Type: boolean

A flag indicating if secret key is present to generate signature for storefront.
profileId: Type: string

SOP Profile ID to be used by storefront.
repositoryId: Type: string

Repository ID of SOP Credential of storefront.
sopURL: Type: string

CyberSource SOP URL to be used by storefront.

Example application/json


{
    "merchantId":"oraclecc",
    "paymentGateways":[
        {
            "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":"https://testsecureacceptance.cybersource.com/silent/pay",
                    "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",
            "enabled":true,
            "username":"UserA",
            "lastname":"X"
        },
        {
            "repositoryId":"PP-A"
        }
    ],
    "repositoryId":"Merchant-A",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/merchant/paymentGateways/cybersource"
        }
    ]
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "merchantId": "oraclecc",
  "paymentGateways": [
    {
      "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": "https://testsecureacceptance.cybersource.com/silent/pay",
          "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",
      "enabled": true,
      "username": "UserA",
      "lastname": "X"
    },
    {"repositoryId": "PP-A"}
  ],
  "repositoryId": "Merchant-A",
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadminui/v1/merchant/paymentGateways/cybersource"
  }]
}