Skip to content

Charge credit card

POST
/api/connector/v1/creditCards/charge

Creates payment for specified customer credit card and charges the credit card via a gateway. Note that the kind of the card has to be Gateway.

CreditCard payment data
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
BillId
string format: uuid
nullable
AccountingCategoryId

Unique identifier of the Accounting category.

string format: uuid
nullable
ReservationId

Unique identifier of the reservation the payment belongs to.

string format: uuid
nullable
Amount
required
Amount parameters

Amount of the credit card payment.

object
Currency
required

ISO-4217 code of the Currency.

string format: currency
>= 1 characters
TaxCodes

The tax values applied.

Array<string>
nullable
NetValue

Net value in case the item is taxed.

number format: double
nullable
GrossValue

Gross value including all taxes.

number format: double
nullable
Notes

Additional payment notes.

string
nullable
CreditCardId

Unique identifier of the Credit card.

string format: uuid
ReceiptIdentifier

Identifier of the payment receipt.

string
nullable
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"CreditCardId": "866d3f51-5b8b-4e8f-a3af-5b84768c522d",
"Amount": {
"GrossValue": 5,
"Currency": "EUR"
},
"AccountingCategoryId": null,
"Notes": null,
"ReceiptIdentifier": null
}

OK

ChargeCreditCardResult
object
PaymentId

Unique identifier of the Payment item.

string format: uuid
Example
{
"PaymentId": "98753f51-5b8b-4e8f-a3af-5b8476865983"
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable