Add credit card payment
POST /api/connector/v1/payments/addCreditCard
Adds a new credit card payment to a bill of the specified customer. Note that the payment is added to open bill of the customer, either to the specified one or the default one. This operation only serves to record a credit card payment that has already been taken outside of Mews or Mews’ payment terminal, and does not actually charge the customer’s credit card. The bill can then be closed manually by a Mews user, or automatically via API with the Close bill operation.
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 an open bill of the customer where to assign the payment.
Unique identifier of an Accounting category to be assigned to the credit card payment.
Unique identifier of the reservation the payment belongs to.
Amount of the credit card payment.
object
ISO-4217 code of the Currency.
The tax values applied.
Net value in case the item is taxed.
Gross value including all taxes.
Additional payment notes.
Unique identifier of the Customer.
object
Type of the credit card, one of: Visa, MasterCard, Amex, Discover, DinersClub, Jcb, EnRoute, Maestro, UnionPay.
Obfuscated credit card number. At most first six digits and last four digits can be specified, the digits in between should be replaced with *. It is possible to provide even more obfuscated number or just last four digits. Never provide full credit card number. For example 411111******1111.
Expiration of the credit card in format MM/YYYY, e.g. 12/2016 or 04/2017.
Name of the card holder.
Identifier of the payment receipt.
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "CustomerId": "35d4b117-4e60-44a3-9580-c582117eff98", "Amount": { "Currency": "GBP", "GrossValue": 100 }, "CreditCard": { "Type": "Visa", "Number": "411111******1111", "Expiration": "12/2016", "Name": "John Smith" }, "AccountingCategoryId": null, "ReceiptIdentifier": "123456", "Notes": "Terminal A"}Responses
Section titled “ Responses ”OK
object
Unique identifier of the Credit card.
Example
{ "CreditCardId": "ee2209ce-71c6-4e3a-978f-aac700c82c7b"}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.