Skip to content

Add alternative payment

POST
/api/connector/v1/payments/addAlternative

Adds a new alternative payment to a specified customer. Pre-requisites: The property must have the relevant type of alternative payment method enabled in their Mews subscriptions in order to accept such payments in their Mews environment. Please ask the property to confirm.

AlternativePaymentParameters
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
CustomerId
required

Unique identifier of the Customer.

string format: uuid
Amount
required
Amount parameters

Price of the product that overrides the price defined in Mews.

object
Currency
required
string format: currency
>= 1 characters
TaxCodes
required
Array<string>
NetValue
number format: double
nullable
GrossValue
number format: double
nullable
Method
Any of:
Alternative payment methods
string
Allowed values: Ideal ApplePay GooglePay
RedirectUrl

URL where the customer will be redirected after completing their payment.

string format: uri
nullable
ReservationId

Unique identifier of the reservation the payment belongs to.

string format: uuid
nullable
Data
required
Alternative payment method data

Data specific to particular alternative payment method.

object
Discriminator
required
Alternative payment method data discriminator

Type of alternative payment method (e.g. Ideal).

Ideal (iDEAL data.)

ApplePay (No additional data.)

GooglePay (No additional data.)

SepaDirectDebit (SEPA Direct Debit data.)

string
Allowed values: Ideal ApplePay GooglePay SepaDirectDebit
SepaDirectDebit
SEPA Direct Debit data

SEPA Direct Debit payment method data. Required when Discriminator is SepaDirectDebit.

object
Iban
required

The customer’s bank account number in IBAN format.

string
>= 1 characters
Name
required

Full name of the customer.

string
>= 1 characters
Email
required

Email address of the customer.

string format: email
>= 1 characters
UserAgent
required

The user agent of the browser from which the Mandate was accepted by the customer.

string
>= 1 characters
RemoteIpAddress
required

The IP address from which the Mandate was accepted by the customer.

string
>= 1 characters
Ideal
iDEAL data

IDEAL payment method data. Required when Discriminator is Ideal.

object
RedirectUrl
required

URL where the customer will be redirected after completing their iDEAL payment.

string format: uri
>= 1 characters
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"CustomerId": "35d4b117-4e60-44a3-9580-c582117eff98",
"Method": "Ideal",
"RedirectUrl": "https://mews.com",
"Amount": {
"Currency": "GBP",
"GrossValue": 100
}
}

OK

AlternativePaymentResult
object
PaymentId
required

Unique identifier of the created payment.

string format: uuid
NextAction
Alternative payment next action

Next action to take in order to complete the payment.

object
Discriminator
required
Payment next action discriminator

Determines type of value.

RedirectToUrl (Redirect customer to a URL where they can complete their payment.)

string
Allowed values: RedirectToUrl
Value
required

String value depending on Type.

string
>= 1 characters
Example
{
"PaymentId": "3ae3976f-8f22-4936-a4e8-abf800bd7278",
"NextAction": {
"Discriminator": "RedirectToUrl",
"Value": "https://sample-payment-gateway.com/redirect/authenticate/unFR1tjshd9OGDaSSyCeVEbO"
}
}

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