Jump to

• Request
• Response

listAllPaymentGateways

get

/ccagent/v1/merchant/paymentGateways

Retrieves the payment gateways for the given site and organization.

Request

Supported Media Types

• application/json

Query Parameters

• enabledOnly(optional): boolean
  Filters enabled payment gateways when true else all.

Header Parameters

• x-ccorganization(optional): string
  Organization Id corresponding to which the payment gateways should be fetched.
• x-ccsite(optional): boolean
  The site id corresponding to which payment types should be fetched.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listAllPaymentGateways_response

Type: array

Payment gateway details.

Show Source

• Array of: object items

{
    "description":"Payment gateway details.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "firstname":{
                "description":"First Name.",
                "type":"string"
            },
            "sopCredentials":{
                "description":"SOP credential information.",
                "type":"object",
                "properties":{
                    "agent":{
                        "description":"SOP credential information to be used by agent.",
                        "type":"object",
                        "properties":{
                            "hasAccessKey":{
                                "description":"A flag indicating if access key is present for agent.",
                                "type":"boolean"
                            },
                            "sopURL":{
                                "description":"CyberSource SOP URL to be used by agent.",
                                "type":"string"
                            },
                            "profileId":{
                                "description":"SOP Profile ID to be used by agent.",
                                "type":"string"
                            },
                            "repositoryId":{
                                "description":"Repository ID of SOP Credential of agent.",
                                "type":"string"
                            },
                            "hasSecretKey":{
                                "description":"A flag indicating if secret key is present to generate signature for agent.",
                                "type":"boolean"
                            },
                            "expirationDate":{
                                "description":"Key expiration date for SOP Credentials of agent.",
                                "type":"string"
                            }
                        }
                    },
                    "storefront":{
                        "description":"SOP credential information to be used by storefront.",
                        "type":"object",
                        "properties":{
                            "hasAccessKey":{
                                "description":"A flag indicating if access key is present for storefront.",
                                "type":"boolean"
                            },
                            "sopURL":{
                                "description":"CyberSource SOP URL to be used by storefront.",
                                "type":"string"
                            },
                            "profileId":{
                                "description":"SOP Profile ID to be used by storefront.",
                                "type":"string"
                            },
                            "repositoryId":{
                                "description":"Repository ID of SOP Credential of storefront.",
                                "type":"string"
                            },
                            "hasSecretKey":{
                                "description":"A flag indicating if secret key is present to generate signature for storefront.",
                                "type":"boolean"
                            },
                            "expirationDate":{
                                "description":"Key expiration date for SOP Credentials of storefront.",
                                "type":"string"
                            }
                        }
                    }
                }
            },
            "soapCredential":{
                "description":"SOAP Credential information.",
                "type":"object",
                "properties":{
                    "hasTransactionSecurityKey":{
                        "description":"A flag indicating if transaction security key is present to validate signature.",
                        "type":"boolean"
                    },
                    "soapURL":{
                        "description":"CyberSource SOAP URL.",
                        "type":"string"
                    },
                    "profileId":{
                        "description":"SOAP Profile ID.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"ID for the SOAP Credential.",
                        "type":"string"
                    },
                    "expirationDate":{
                        "description":"Key expiration date.",
                        "type":"string"
                    }
                }
            },
            "repositoryId":{
                "description":"Repository ID for the payment gateway.",
                "type":"string"
            },
            "ignoreAVS":{
                "description":"A flag to tell the Cybersource whether to ignore the AVS results.",
                "type":"boolean"
            },
            "type":{
                "description":"Type of the payment gateway.",
                "type":"string"
            },
            "enabled":{
                "description":"Is the setup enabled?",
                "type":"boolean"
            },
            "username":{
                "description":" CyberSource Username.",
                "type":"string"
            },
            "lastname":{
                "description":"Last Name.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

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.
• 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.

{
    "type":"object",
    "properties":{
        "firstname":{
            "description":"First Name.",
            "type":"string"
        },
        "sopCredentials":{
            "description":"SOP credential information.",
            "type":"object",
            "properties":{
                "agent":{
                    "description":"SOP credential information to be used by agent.",
                    "type":"object",
                    "properties":{
                        "hasAccessKey":{
                            "description":"A flag indicating if access key is present for agent.",
                            "type":"boolean"
                        },
                        "sopURL":{
                            "description":"CyberSource SOP URL to be used by agent.",
                            "type":"string"
                        },
                        "profileId":{
                            "description":"SOP Profile ID to be used by agent.",
                            "type":"string"
                        },
                        "repositoryId":{
                            "description":"Repository ID of SOP Credential of agent.",
                            "type":"string"
                        },
                        "hasSecretKey":{
                            "description":"A flag indicating if secret key is present to generate signature for agent.",
                            "type":"boolean"
                        },
                        "expirationDate":{
                            "description":"Key expiration date for SOP Credentials of agent.",
                            "type":"string"
                        }
                    }
                },
                "storefront":{
                    "description":"SOP credential information to be used by storefront.",
                    "type":"object",
                    "properties":{
                        "hasAccessKey":{
                            "description":"A flag indicating if access key is present for storefront.",
                            "type":"boolean"
                        },
                        "sopURL":{
                            "description":"CyberSource SOP URL to be used by storefront.",
                            "type":"string"
                        },
                        "profileId":{
                            "description":"SOP Profile ID to be used by storefront.",
                            "type":"string"
                        },
                        "repositoryId":{
                            "description":"Repository ID of SOP Credential of storefront.",
                            "type":"string"
                        },
                        "hasSecretKey":{
                            "description":"A flag indicating if secret key is present to generate signature for storefront.",
                            "type":"boolean"
                        },
                        "expirationDate":{
                            "description":"Key expiration date for SOP Credentials of storefront.",
                            "type":"string"
                        }
                    }
                }
            }
        },
        "soapCredential":{
            "description":"SOAP Credential information.",
            "type":"object",
            "properties":{
                "hasTransactionSecurityKey":{
                    "description":"A flag indicating if transaction security key is present to validate signature.",
                    "type":"boolean"
                },
                "soapURL":{
                    "description":"CyberSource SOAP URL.",
                    "type":"string"
                },
                "profileId":{
                    "description":"SOAP Profile ID.",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"ID for the SOAP Credential.",
                    "type":"string"
                },
                "expirationDate":{
                    "description":"Key expiration date.",
                    "type":"string"
                }
            }
        },
        "repositoryId":{
            "description":"Repository ID for the payment gateway.",
            "type":"string"
        },
        "ignoreAVS":{
            "description":"A flag to tell the Cybersource whether to ignore the AVS results.",
            "type":"boolean"
        },
        "type":{
            "description":"Type of the payment gateway.",
            "type":"string"
        },
        "enabled":{
            "description":"Is the setup enabled?",
            "type":"boolean"
        },
        "username":{
            "description":" CyberSource Username.",
            "type":"string"
        },
        "lastname":{
            "description":"Last Name.",
            "type":"string"
        }
    }
}

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.

{
    "description":"SOAP Credential information.",
    "type":"object",
    "properties":{
        "hasTransactionSecurityKey":{
            "description":"A flag indicating if transaction security key is present to validate signature.",
            "type":"boolean"
        },
        "soapURL":{
            "description":"CyberSource SOAP URL.",
            "type":"string"
        },
        "profileId":{
            "description":"SOAP Profile ID.",
            "type":"string"
        },
        "repositoryId":{
            "description":"ID for the SOAP Credential.",
            "type":"string"
        },
        "expirationDate":{
            "description":"Key expiration date.",
            "type":"string"
        }
    }
}

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.

{
    "description":"SOP credential information.",
    "type":"object",
    "properties":{
        "agent":{
            "description":"SOP credential information to be used by agent.",
            "type":"object",
            "properties":{
                "hasAccessKey":{
                    "description":"A flag indicating if access key is present for agent.",
                    "type":"boolean"
                },
                "sopURL":{
                    "description":"CyberSource SOP URL to be used by agent.",
                    "type":"string"
                },
                "profileId":{
                    "description":"SOP Profile ID to be used by agent.",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"Repository ID of SOP Credential of agent.",
                    "type":"string"
                },
                "hasSecretKey":{
                    "description":"A flag indicating if secret key is present to generate signature for agent.",
                    "type":"boolean"
                },
                "expirationDate":{
                    "description":"Key expiration date for SOP Credentials of agent.",
                    "type":"string"
                }
            }
        },
        "storefront":{
            "description":"SOP credential information to be used by storefront.",
            "type":"object",
            "properties":{
                "hasAccessKey":{
                    "description":"A flag indicating if access key is present for storefront.",
                    "type":"boolean"
                },
                "sopURL":{
                    "description":"CyberSource SOP URL to be used by storefront.",
                    "type":"string"
                },
                "profileId":{
                    "description":"SOP Profile ID to be used by storefront.",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"Repository ID of SOP Credential of storefront.",
                    "type":"string"
                },
                "hasSecretKey":{
                    "description":"A flag indicating if secret key is present to generate signature for storefront.",
                    "type":"boolean"
                },
                "expirationDate":{
                    "description":"Key expiration date for SOP Credentials of storefront.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : agent

Type: object

SOP 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.

{
    "description":"SOP credential information to be used by agent.",
    "type":"object",
    "properties":{
        "hasAccessKey":{
            "description":"A flag indicating if access key is present for agent.",
            "type":"boolean"
        },
        "sopURL":{
            "description":"CyberSource SOP URL to be used by agent.",
            "type":"string"
        },
        "profileId":{
            "description":"SOP Profile ID to be used by agent.",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID of SOP Credential of agent.",
            "type":"string"
        },
        "hasSecretKey":{
            "description":"A flag indicating if secret key is present to generate signature for agent.",
            "type":"boolean"
        },
        "expirationDate":{
            "description":"Key expiration date for SOP Credentials of agent.",
            "type":"string"
        }
    }
}

Nested Schema : storefront

Type: object

SOP 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.

{
    "description":"SOP credential information to be used by storefront.",
    "type":"object",
    "properties":{
        "hasAccessKey":{
            "description":"A flag indicating if access key is present for storefront.",
            "type":"boolean"
        },
        "sopURL":{
            "description":"CyberSource SOP URL to be used by storefront.",
            "type":"string"
        },
        "profileId":{
            "description":"SOP Profile ID to be used by storefront.",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID of SOP Credential of storefront.",
            "type":"string"
        },
        "hasSecretKey":{
            "description":"A flag indicating if secret key is present to generate signature for storefront.",
            "type":"boolean"
        },
        "expirationDate":{
            "description":"Key expiration date for SOP Credentials of storefront.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "merchantId":"oraclecc",
    "repositoryId":"Merchant-A",
    "paymentGateways":[
        {
            "settingsConfigId":"PayULatamPaymentGatewaySettings",
            "enabledTypes":[
                "payULatamWebcheckout"
            ],
            "source":100,
            "agentConfig":{
                "preview":{
                    "BR":"500719",
                    "AR":"509171",
                    "PA":"500537",
                    "environment":"test",
                    "apiKey":"6u39nqhq8ftd0hlvnjfs66eh8c",
                    "apiLogin":"11959c415b33d0c",
                    "PE":"500546",
                    "merchantId":"500238",
                    "CL":"509666",
                    "paymentMethodTypes":"payULatamWebcheckout",
                    "MX":"500547",
                    "CO":"500538"
                },
                "storefront":{
                    "BR":"500719",
                    "AR":"509171",
                    "PA":"500537",
                    "environment":"test",
                    "apiKey":"6u39nqhq8ftd0hlvnjfs66eh8c",
                    "apiLogin":"11959c415b33d0c",
                    "PE":"500546",
                    "merchantId":"500238",
                    "CL":"509666",
                    "paymentMethodTypes":"payULatamWebcheckout",
                    "MX":"500547",
                    "CO":"500538"
                }
            },
            "type":"Generic",
            "previewConfigEnabledTypes":[
                "payULatamWebcheckout"
            ],
            "enabled":true,
            "storefrontConfig":{
                "BR":"500719",
                "AR":"509171",
                "PA":"500537",
                "environment":"test",
                "apiKey":"6u39nqhq8ftd0hlvnjfs66eh8c",
                "apiLogin":"11959c415b33d0c",
                "PE":"500546",
                "merchantId":"500238",
                "CL":"509666",
                "paymentMethodTypes":"payULatamWebcheckout",
                "MX":"500547",
                "CO":"500538"
            },
            "agentConfigEnabledTypes":null,
            "provider":"PayU Latam",
            "repositoryId":"PULAW-A",
            "storefrontConfigEnabledTypes":[
                "payULatamWebcheckout"
            ],
            "supportedTypes":[
                "payULatamWebcheckout"
            ],
            "previewConfig":{
                "BR":"500719",
                "AR":"509171",
                "PA":"500537",
                "environment":"test",
                "apiKey":"6u39nqhq8ftd0hlvnjfs66eh8c",
                "apiLogin":"11959c415b33d0c",
                "PE":"500546",
                "merchantId":"500238",
                "CL":"509666",
                "paymentMethodTypes":"payULatamWebcheckout",
                "MX":"500547",
                "CO":"500538"
            }
        },
        {
            "clientId":"AYLY2qpHNPE2RrnaEWb_dmQXLUxj7SGW_A7sskh_xokKIcJUGzyjdcewvaBtnnRuosakb7zDneetI7vu",
            "production":false,
            "captureType":"PlaceOrder",
            "repositoryId":"PP-A",
            "hasSecretKey":true,
            "enabledTypes":[
                "paypalCheckout"
            ],
            "type":"PayPal",
            "enabled":true
        },
        {
            "firstname":"John",
            "sopCredentials":{
                "preview":{
                    "hasAccessKey":true,
                    "profileId":"90B575C6-A062-4C69-BC17-56E9765084D5",
                    "sopURL":"https://testsecureacceptance.cybersource.com/silent/pay",
                    "repositoryId":"SOP-C",
                    "hasSecretKey":true,
                    "applicationName":"preview",
                    "expirationDate":"2017-08-26T00:00:00.000Z"
                },
                "agent":{
                    "hasAccessKey":true,
                    "profileId":"Test123",
                    "sopURL":"http://10.191.198.240:9080/ccagentui/v1/testQA/cybersourceSOP",
                    "repositoryId":"SOP-B",
                    "hasSecretKey":true,
                    "applicationName":"agent",
                    "expirationDate":"2016-08-14T11:54:30.207Z"
                },
                "storefront":{
                    "hasAccessKey":true,
                    "profileId":"Test111",
                    "sopURL":"http://10.191.198.240:8080/ccstoreui/v1/testQA/cybersourceSOP",
                    "repositoryId":"SOP-A",
                    "hasSecretKey":true,
                    "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",
            "enabledTypes":[
                "card"
            ],
            "ignoreAVS":false,
            "type":"CyberSource",
            "enabled":true,
            "username":"UserA",
            "lastname":"X"
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/merchant/paymentGateways"
        }
    ],
    "__stateData__":"ey9hdGcvdXNlcnByb2ZpbGluZy9TaG9wcGVyQ29udGV4dExvYWRhYmxlU2VydmljZT17aXNFeHRlcm5hbENvbnRleHQ9ZmFsc2V9fQ==.p5PI/DKUY9B1HmARs0wgUC41Q4eq8ycJa9qKujA9SZU=",
    "___etag___":"eyJ2ZXJzaW9uIjowLCJ1cmkiOiJtZXJjaGFudC9wYXltZW50R2F0ZXdheXMiLCJoYXNoIjoiSzNmZGxBPT0ifQ=="
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |100107|Site id {0} does not exist.| |100108|Invalid organization id for fetching site account properties.| |100105|Error while fetching site account properties.| |34005|Error in getting Payment Setup data|

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top