getGateways
get
/ccadmin/v1/merchant/paymentGateways
Get Gateways. Get all the payment gateways
Request
Supported Media Types
- application/json
Query Parameters
-
enabledOnly(optional): boolean
Filters enabled payment gateways when true else all.
-
production(optional): boolean
Fetches production data if true.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getGateways_response
Type:
Show Source
object-
merchantId(optional):
string
CyberSource Merchant ID.
-
paymentGateways(optional):
array paymentGateways
Payment gateway details.
-
repositoryId(optional):
string
The repository ID of the Merchant.
Nested Schema : items
Type:
Show Source
object-
enabled(optional):
boolean
Is the setup enabled?
-
firstname(optional):
string
First Name.
-
ignoreAVS(optional):
boolean
A flag to tell the Cybersource whether to ignore the AVS results.
-
lastname(optional):
string
Last Name.
-
repositoryId(optional):
string
Repository ID for the payment gateway.
-
soapCredential(optional):
object soapCredential
SOAP Credential information.
-
sopCredentials(optional):
object sopCredentials
SOP credential information.
-
type(optional):
string
Type of the payment gateway.
-
username(optional):
string
CyberSource Username.
Nested Schema : soapCredential
Type:
objectSOAP Credential information.
Show Source
-
expirationDate(optional):
string
Key expiration date.
-
hasTransactionSecurityKey(optional):
boolean
A flag indicating if transaction security key is present to validate signature.
-
profileId(optional):
string
SOAP Profile ID.
-
repositoryId(optional):
string
ID for the SOAP Credential.
-
soapURL(optional):
string
CyberSource SOAP URL.
Nested Schema : sopCredentials
Type:
objectSOP credential information.
Show Source
-
agent(optional):
object agent
SOP credential information to be used by agent.
-
storefront(optional):
object storefront
SOP credential information to be used by storefront.
Nested Schema : agent
Type:
objectSOP credential information to be used by agent.
Show Source
-
expirationDate(optional):
string
Key expiration date for SOP Credentials of agent.
-
hasAccessKey(optional):
boolean
A flag indicating if access key is present for agent.
-
hasSecretKey(optional):
boolean
A flag indicating if secret key is present to generate signature for agent.
-
profileId(optional):
string
SOP Profile ID to be used by agent.
-
repositoryId(optional):
string
Repository ID of SOP Credential of agent.
-
sopURL(optional):
string
CyberSource SOP URL to be used by agent.
Nested Schema : storefront
Type:
objectSOP credential information to be used by storefront.
Show Source
-
expirationDate(optional):
string
Key expiration date for SOP Credentials of storefront.
-
hasAccessKey(optional):
boolean
A flag indicating if access key is present for storefront.
-
hasSecretKey(optional):
boolean
A flag indicating if secret key is present to generate signature for storefront.
-
profileId(optional):
string
SOP Profile ID to be used by storefront.
-
repositoryId(optional):
string
Repository ID of SOP Credential of storefront.
-
sopURL(optional):
string
CyberSource SOP URL to be used by storefront.
Example Response (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"
}Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code