Create new permits linked to a recurring contract

post /createPermit

Create permits for a recurring contract, including support for defining restrictions.

Endpoint destination URL
Click to copy

Request parameters

merchantAccount string Required

The merchant account identifier, with which you want to process the transaction.

permits array [object] Required

The permits to create for this recurring contract.

recurringDetailReference string Required

The recurring contract the new permits will use.

shopperReference string Required

The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID).

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