Jump to

• Request
• Response

getPaymentConfigurations

get

/ccstore/v1/merchant/paymentConfigurations

Returns the payment gateway settings for the current site and organization.

Request

Supported Media Types

• application/json

Header Parameters

• x-ccorganization(optional): string
  Organization Id corresponding to which the payment gateways should be fetched.
• x-ccsite(optional): string
  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 : getPaymentConfigurations_response

Type: object

Show Source

• paymentMethods(optional): array paymentMethods
  List of enabled payment methods
• settings(optional): array settings
  List containing payment gateways public settings

{
    "properties":{
        "settings":{
            "description":"List containing payment gateways public settings",
            "type":"array",
            "items":{
                "description":"Public gateway settings",
                "additionalProperties":true,
                "type":"object"
            }
        },
        "paymentMethods":{
            "description":"List of enabled payment methods",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : paymentMethods

Type: array

List of enabled payment methods

Show Source

• Array of: string

{
    "description":"List of enabled payment methods",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : settings

Type: array

List containing payment gateways public settings

Show Source

• Array of: object items
  Additional Properties Allowed: true

  Public gateway settings

{
    "description":"List containing payment gateways public settings",
    "type":"array",
    "items":{
        "description":"Public gateway settings",
        "additionalProperties":true,
        "type":"object"
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed: true

Public gateway settings

Example Response (application/json)

[
    {
        "settings":[
            {
                "paymentMethods":"card",
                "enabledForScheduledOrder":false,
                "enabledForApproval":false
            }
        ],
        "paymentMethods":[
            "physicalGiftCard",
            "paypalCheckout",
            "payULatamWebcheckout",
            "generic",
            "card"
        ]
    }
]

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