Jump to

• Request
• Response

updateWhitelistUrls

put

/ccadmin/v1/merchant/whiteListUrls

Update list of outbounds urls that are whiteListed.

Request

Supported Media Types

• application/json

Body ()

Root Schema : updateWhitelistUrls_request

Type: object

Show Source

• items(optional): array items
  list of whitelist services and theirs outbound urls. This endpoint is deprecated, please use /merchant/allowedUrls.

{
    "properties":{
        "items":{
            "description":"list of whitelist services and theirs outbound urls. This endpoint is deprecated, please use /merchant/allowedUrls.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "whiteListId":{
                        "type":"string",
                        "example":"submitOrder"
                    },
                    "whiteListedUrls":{
                        "description":"outbound urls of the whitelist service",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "url":{
                                    "description":"outbound url",
                                    "type":"string",
                                    "example":"https://example.com"
                                }
                            }
                        }
                    },
                    "removeUrl":{
                        "description":"Indicates if the urls in payload are to be added or removed| True for remove and false to add",
                        "type":"boolean",
                        "example":false
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

list of whitelist services and theirs outbound urls. This endpoint is deprecated, please use /merchant/allowedUrls.

Show Source

• Array of: object items

{
    "description":"list of whitelist services and theirs outbound urls. This endpoint is deprecated, please use /merchant/allowedUrls.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "whiteListId":{
                "type":"string",
                "example":"submitOrder"
            },
            "whiteListedUrls":{
                "description":"outbound urls of the whitelist service",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "url":{
                            "description":"outbound url",
                            "type":"string",
                            "example":"https://example.com"
                        }
                    }
                }
            },
            "removeUrl":{
                "description":"Indicates if the urls in payload are to be added or removed| True for remove and false to add",
                "type":"boolean",
                "example":false
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• removeUrl(optional): boolean
  Indicates if the urls in payload are to be added or removed| True for remove and false to add

  Example: false
• whiteListedUrls(optional): array whiteListedUrls
  outbound urls of the whitelist service
• whiteListId(optional): string
  Example: submitOrder

{
    "type":"object",
    "properties":{
        "whiteListId":{
            "type":"string",
            "example":"submitOrder"
        },
        "whiteListedUrls":{
            "description":"outbound urls of the whitelist service",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "url":{
                        "description":"outbound url",
                        "type":"string",
                        "example":"https://example.com"
                    }
                }
            }
        },
        "removeUrl":{
            "description":"Indicates if the urls in payload are to be added or removed| True for remove and false to add",
            "type":"boolean",
            "example":false
        }
    }
}

Nested Schema : whiteListedUrls

Type: array

outbound urls of the whitelist service

Show Source

• Array of: object items

{
    "description":"outbound urls of the whitelist service",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "url":{
                "description":"outbound url",
                "type":"string",
                "example":"https://example.com"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• url(optional): string
  outbound url

  Example: https://example.com

{
    "type":"object",
    "properties":{
        "url":{
            "description":"outbound url",
            "type":"string",
            "example":"https://example.com"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getWhitelistUrls_response

Type: object

Show Source

• items(optional): array items
  list of whitelist services and theirs outbound urls. This endpoint is deprecated, please use /merchant/allowedUrls.

{
    "properties":{
        "items":{
            "description":"list of whitelist services and theirs outbound urls. This endpoint is deprecated, please use /merchant/allowedUrls.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "whiteListId":{
                        "type":"string",
                        "example":"submitOrder"
                    },
                    "whiteListedUrls":{
                        "description":"outbound urls of the whitelist service",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "url":{
                                    "description":"outbound url",
                                    "type":"string",
                                    "example":"https://example.com"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

list of whitelist services and theirs outbound urls. This endpoint is deprecated, please use /merchant/allowedUrls.

Show Source

• Array of: object items

{
    "description":"list of whitelist services and theirs outbound urls. This endpoint is deprecated, please use /merchant/allowedUrls.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "whiteListId":{
                "type":"string",
                "example":"submitOrder"
            },
            "whiteListedUrls":{
                "description":"outbound urls of the whitelist service",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "url":{
                            "description":"outbound url",
                            "type":"string",
                            "example":"https://example.com"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• whiteListedUrls(optional): array whiteListedUrls
  outbound urls of the whitelist service
• whiteListId(optional): string
  Example: submitOrder

{
    "type":"object",
    "properties":{
        "whiteListId":{
            "type":"string",
            "example":"submitOrder"
        },
        "whiteListedUrls":{
            "description":"outbound urls of the whitelist service",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "url":{
                        "description":"outbound url",
                        "type":"string",
                        "example":"https://example.com"
                    }
                }
            }
        }
    }
}

Nested Schema : whiteListedUrls

Type: array

outbound urls of the whitelist service

Show Source

• Array of: object items

{
    "description":"outbound urls of the whitelist service",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "url":{
                "description":"outbound url",
                "type":"string",
                "example":"https://example.com"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• url(optional): string
  outbound url

  Example: https://example.com

{
    "type":"object",
    "properties":{
        "url":{
            "description":"outbound url",
            "type":"string",
            "example":"https://example.com"
        }
    }
}

Default Response

The error response.

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