Create a payment plan
POST /api/connector/v1/paymentPlans/add
Adds a payment plan with Name connected to a Reservation and returns the payment request URL associated with the created payment plan. The fulfillment of the payment request will initiate the payment plan.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.
Reservation Id associated with the payment plan.
Name of the payment plan.
Data related to the payment request associated with the payment plan created.
object
Allowed payment methods to pay for the payment plan.
Message in the payment request.
Internal note for the payment request.
Type of payment request to create. If not specified, defaults to Payment.
Payment
PaymentMethod
Custom expiration date offset in days for the payment request. If not set, it’ll expire in one week, unless the first scheduled payment should be executed before. In that case, The expiration date will be set one second before the scheduled payment execution (the last possible moment when we can get the payment method).
Specifies whether a payment request email is sent to the customer. Defaults to true.
Specifies the month when the payment plan begins collecting payments, in the ‘YYYY-MM’ format. The month must be in the future and fall within the reservation period.
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "ReservationId": "0f515589-99b4-423d-b83a-b237009f0509", "Name": "Payment Plan Name", "PaymentRequest": { "PaymentMethods": [ "PaymentCard", "SepaDirectDebit" ], "Message": "Payment request message", "Note": "Internal Note", "PaymentRequestType": "Payment", "PaymentRequestExpirationOffsetDays": 30, "SendEmail": false }, "StartMonth": "2023-10"}Responses
Section titled “ Responses ”OK
object
Payment request URL associated with the created payment plan.
Example
{ "PaymentRequestUrl": "https://example.com/payment-request-url"}Server has successfully fulfilled the request and there is no additional information to send back.
object
Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
object
Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts
object
Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.
object
Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.