updateGateway
put
/ccadmin/v1/merchant/paymentGateways
Update Gateway. Update the payment gateway setup based on request parameters.
Request
Supported Media Types
- application/json
Root Schema : updateGateway_request
Type:
Show Source
object
-
gatewayName:
string
Gateway Name.
-
merchantId(optional):
string
CyberSource Merchant ID.
-
paymentGateway(optional):
object paymentGateway
Payment gateway details.
Example:
{
"gatewayName":"cybersource",
"merchantId":"CCommerce",
"paymentGateway":{
"firstname":"John",
"sopCredentials":{
"agent":{
"secretKey":"asd234",
"accessKey":"345hjx",
"sopURL":"https://testsecureacceptance.cybersource.com/silent/pay",
"profileId":"Test123",
"repositoryId":"SOP-B",
"applicationName":"agent",
"expirationDate":"2016-08-14T11:54:30.207Z"
},
"storefront":{
"secretKey":"asdfg",
"accessKey":"rtyhj",
"sopURL":"https://testsecureacceptance.cybersource.com/silent/pay",
"profileId":"Test111",
"repositoryId":"SOP-A",
"applicationName":"storefront",
"expirationDate":"2017-01-28T11:54:30.207Z"
}
},
"soapCredential":{
"transactionSecurityKey":"as23K9Iud0",
"profileId":"admin1",
"expirationDate":"2015-03-10T11:54:30.207Z"
},
"ignoreAVS":true,
"enabled":true,
"username":"JohnD",
"lastname":"D"
}
}
Nested Schema : paymentGateway
Type:
object
Payment gateway details.
Show Source
-
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.
-
soapCredential(optional):
object soapCredential
SOAP Credential information.
-
sopCredentials(optional):
object sopCredentials
SOP credential information.
-
username(optional):
string
CyberSource Username.
Nested Schema : soapCredential
Type:
object
SOAP 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.
-
transactionSecurityKey(optional):
string
Transaction Security key.
Nested Schema : sopCredentials
Type:
object
SOP 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:
object
SOP credential information to be used by agent.
Show Source
-
accessKey(optional):
string
SOP access key for agent.
-
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.
-
secretKey(optional):
string
SOP secret key for agent.
-
sopURL(optional):
string
CyberSource SOP URL to be used by agent.
Nested Schema : storefront
Type:
object
SOP credential information to be used by storefront.
Show Source
-
accessKey(optional):
string
SOP access key for storefront.
-
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.
-
secretKey(optional):
string
SOP secret key for storefront.
-
sopURL(optional):
string
CyberSource SOP URL to be used by storefront.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateGateway_response
Type:
Show Source
object
-
merchantId(optional):
string
CyberSource Merchant ID.
-
paymentGateways(optional):
array paymentGateways
Payment gateway details.
-
repositoryId(optional):
string
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.
-
partnerSolutionId(optional):
string
A field that identifies a transaction as occurring through Oracle Commerce.
-
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:
object
SOAP Credential information.
Show Source
-
expirationDate(optional):
string
Key expiration date.
-
profileId(optional):
string
SOAP Profile ID.
-
repositoryId(optional):
string
ID for the SOAP Credential.
-
transactionSecurityKey(optional):
string
Transaction Security key.
Nested Schema : sopCredentials
Type:
object
SOP credential information.
Show Source
-
agent(optional):
object agent
SOP credential information for agent.
-
storefront(optional):
object storefront
SOP credential information for storefront.
Nested Schema : agent
Type:
object
SOP credential information for agent.
Show Source
-
expirationDate(optional):
string
Key expiration date.
-
hasAccessKey(optional):
boolean
A flag indicating if access key is present.
-
hasSecretKey(optional):
boolean
A flag indicating if secret key is present to generate signature.
-
profileId(optional):
string
SOP Profile ID for agent profile.
-
repositoryId(optional):
string
ID for the SOP Credential.
-
sopURL(optional):
string
CyberSource SOP URL for agent.
Nested Schema : storefront
Type:
object
SOP credential information for storefront.
Show Source
-
expirationDate(optional):
string
Key expiration date.
-
hasAccessKey(optional):
boolean
A flag indicating if access key is present.
-
hasSecretKey(optional):
boolean
A flag indicating if secret key is present to generate signature.
-
profileId(optional):
string
SOP Profile ID for storefront profile.
-
repositoryId(optional):
string
ID for the SOP Credential.
-
sopURL(optional):
string
CyberSource SOP URL for 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":"https://testsecureacceptance.cybersource.com/silent/pay",
"profileId":"Test111",
"hasSecretKey":true,
"repositoryId":"SOP-A",
"applicationName":"storefront",
"expirationDate":"2017-01-28T11:54:30.207Z"
}
},
"soapCredential":{
"transactionSecurityKey":"g9TNb1l8rlJnk+JJ/tqvVlUM5Xr76Rez2u81gzO0KasKwOfVdVeiwTDYa82bipayslV+tQaILGD74QqHyWWJWN1rVTMSgt3VzaRRTzX/5gF2S+qElnojrjXloEPXvML/weqDwqwic9IiiTlgyEmKWNsBpNokUkL2krQ9N4RimshVo3KNk9bSOzKMbKJoikNWVQzlevvpF7Pa7zWDM7QpqwrA59V1V6LBMNhrzZuKlrKyVX61BogsYPvhCofJZYlY3WtVMxKC3dXNpFFPNf/mAXZL6oSWeiOuNeWgQ9e8wv/B6oPCrCJz0iKJOWDISYpY2wGk2iRSQvaStD03hGKayA==",
"profileId":"CS-A",
"repositoryId":"SOAP-A",
"expirationDate":"2020-05-20T11:54:30.207Z"
},
"repositoryId":"CS-A",
"ignoreAVS":true,
"partnerSolutionId":"ABCDXYZ",
"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:
array
An 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