Create an allowed origin

post /merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins

Adds a new allowed origin to the API credential's list of allowed origins.

To make this request, your API credential must have the following roles:

  • Management APIā€”API credentials read and write

Endpoint destination URL{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins
Click to copy

Path parameters

apiCredentialId string Required

Unique identifier of the API credential.

merchantId string Required

The unique identifier of the merchant account.

Request parameters

_links object

References to resources linked to the allowed origin.

domain string Required

Domain of the allowed origin.

id string

Unique identifier of the allowed origin.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show more Show less
  • 204 - No Content

    The request has been successfully processed, but there is no additional content.

  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy