Skip to main content

CreatePaymentRequest

amountinteger<int32>required

Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge 1.00 USD).

Example: 110
currencyPayment-Currency (string)required

Three-letter ISO currency code, in uppercase. Must be a supported currency.

Example: EUR
orderIdPayment-OrderId (string)required

An order ID from your system. A unique identifier that can be used to reconcile the payment with your internal system.

Example: 14379133960355
callbackUrlPayment-CallbackUrl (string)

The URL to which a payment result should be sent asynchronously.

Example: https://example.com/checkout/callback
completeUrlPayment-CompleteUrl (string)

The URL the customer will be directed to after transaction completed (successful or failed - except if failUrl is provided).

Example: https://example.com/checkout/complete
failUrlPayment-FailUrl (string)

The URL the customer will be directed to after transaction has failed, instead of completeUrl (used in hosted payment page). This allows to provide two different URLs for successful and failed payments.

Example: https://example.com/checkout/fail
cancelUrlPayment-CancelUrl (string)

The URL the customer will be directed to if they decide to cancel payment and return to your website (used in hosted payment page).

Example: https://example.com/checkout/cancel
paymentTokenPayment-PaymentToken (string)

A payment token generated by monei.js Components or a paymentToken saved after a previous successful payment. In case of the first one, you will also need to send the sessionId used to generate the token in the first place.

Example: 7cc38b08ff471ccd313ad62b23b9f362b107560b
sessionIdPayment-SessionId (string)

A unique identifier within your system that adds security to the payment process. You need to pass the same session ID as the one used on the frontend to initialize MONEI Component (if you needed to). This is required if a payment token (not permanent) was already generated in the frontend.

Example: 39603551437913
generatePaymentTokenPayment-GeneratePaymentToken (boolean)

If set to true a permanent token that represents a payment method used in the payment will be generated.

Default value: false
Example: false
paymentMethod object

An information about a payment method used for this payment. We recommend using paymentToken instead, as it is more secure way to pass sensitive payment information. Processing credit card information on your server requires PCI DSS compliance.

card object

Details about the card used as payment method. If provided, MONEI will try to confirm the payment directly.

numberstring

The card number, as a string without any separators.

cvcstring

Card security code.

expMonthstring

Two-digit number representing the card's expiration month.

expYearstring

Two-digit number representing the card's expiration year.

cardholderNameCardholderName (string)

The cardholder's name, as stated in the credit card.

Example: John Doe
cardholderEmailCardholderEmail (string)

The cardholder's email address.

Example: john.doe@monei.com
bizum object

Details about the Bizum account used for this payment. If provided phone number is valid and registered in Bizum, MONEI will try to confirm the payment directly.

phoneNumberstring

Phone number in E.164 format used to pay with bizum.

Example: null
allowedPaymentMethodsstring[]

An array of allowed payment methods (used in hosted payment page). Must be enabled payment methods.

Enum ValueDescription
alipayAlipay
cardCard
bizumBizum
paypalPayPal
mbwayMB WAY
multibancoMultibanco
iDealiDEAL
bancontactBancontact
sofortSOFORT
trustlyTrustly
sepaSEPA
klarnaKlarna
giropayGiropay
epsEPS
blikBLIK
Example: ["card","bizum","paypal"]
transactionTypePayment-TransactionType (string)

Controls when the funds will be captured.

Enum ValueDescription
SALEAutomatically captures funds when the customer authorizes the payment
AUTHPlaces a hold on funds without immediate capture, allowing for later capture
PAYOUTSends funds to the customer
VERIFVerifies the payment method without placing a hold or capturing funds

Possible values: [SALE, AUTH, PAYOUT, VERIF]

Default value: SALE
Example: SALE
sequence object

This field needs to be sent in order to mark the beginning of a sequence of payments (recurring/subscriptions, installments, and so). Specific configurations can be set in the inside properties (recurring).

typestringrequired

Possible values: [recurring]

Example: recurring
recurring object

Specific configurations for recurring payments. Will only be used when sequence.type is recurring.

expirystring

Date after which no further recurring payments will be performed. Must be formatted as YYYYMMDD.

Default value: *(The payment method or card expiration)*
Example: 20210630
frequencyinteger<int32>

The minimum number of days between the different recurring payments.

Default value: 25
Example: 30
storeIdPayment-StoreId (string)

A unique identifier of the Store. If specified the payment is attached to this Store.

Example: e5f28150d9e8974c58ab5ec9c4a880f8734dcf05
pointOfSaleIdPayment-PointOfSaleId (string)

A unique identifier of the Point of Sale. If specified the payment is attached to this Point of Sale. If there is a QR code attached to the same Point of Sale, this payment will be available by scanning the QR code.

Example: fb269cccfa0cc021f5d0b8eb1421646c696213e1
subscriptionIdPayment-SubscriptionId (string)

A unique identifier of the Subscription. If specified the payment is attached to this Subscription.

Example: 575bcd84-09fc-4a6e-8c4c-f88b8eb90bfa
autoRecoverPayment-AutoRecover (boolean)

If set to true, the new payment will be automatically created when customer visits the payment link of the previously failed payment. Is automatically set to true if completeUrl is not provided.(set this value to true to create "Pay By Link" payments).

Example: false
descriptionPayment-Description (string)

An arbitrary string attached to the payment. Often useful for displaying to users.

Example: Test Shop - #84370745531439
customer object
emailstring

The customer's email address.

Example: john.doe@example.com
namestring

The customer's full name or business name.

Example: John Doe
phonestring

The customer's phone number in E.164 format.

Example: null
billingDetails object

Billing information associated with the payment method at the time of the transaction.

namestring

The customer's billing full name.

Example: John Doe
emailstring

The customer's billing email address.

Example: john.doe@example.com
phonestring

The customer's billing phone number in E.164 format.

Example: null
companystring

Billing company name.

Example: null
taxIdstring

Company tax ID.

Example: null
address object
countryCountry (string)

Two-letter country code (ISO 3166-1 alpha-2).

Example: ES
citystring

City, district, suburb, town, or village.

Example: Málaga
line1string

Address line 1 (e.g., street, PO Box, or company name).

Example: Fake Street 123
line2string

Address line 2 (e.g., apartment, suite, unit, or building).

Example: null
zipstring

ZIP or postal code.

Example: 1234
statestring

State, county, province, or region.

Example: Málaga
shippingDetails object

Shipping information associated with the payment.

namestring

The shipping customer's full name.

Example: John Doe
emailstring

The shipping customer's email address.

Example: john.doe@example.com
phonestring

The shipping customer's phone number in E.164 format.

Example: null
companystring

Name of the company where the shipment is going.

Example: null
taxIdstring

Company tax ID.

Example: null
address object
countryCountry (string)

Two-letter country code (ISO 3166-1 alpha-2).

Example: ES
citystring

City, district, suburb, town, or village.

Example: Málaga
line1string

Address line 1 (e.g., street, PO Box, or company name).

Example: Fake Street 123
line2string

Address line 2 (e.g., apartment, suite, unit, or building).

Example: null
zipstring

ZIP or postal code.

Example: 1234
statestring

State, county, province, or region.

Example: Málaga
sessionDetails Payment-SessionDetails

Information related to the browsing session of the user who initiated the payment.

ipIP (string)

The IP address where the operation originated.

Example: 100.100.200.100
countryCodeCountry (string)

Two-letter country code (ISO 3166-1 alpha-2).

Example: ES
langLang (string)

Two-letter language code (ISO 639-1).

Example: es
deviceTypeDeviceType (string)

Device type, could be desktop, mobile, smartTV, tablet.

Example: desktop
deviceModelDeviceModel (string)

Information about the device used for the browser session (e.g., iPhone).

Example: null
browserBrowser (string)

The browser used in this browser session (e.g., Mobile Safari).

Example: Chrome
browserVersionBrowserVersion (string)

The version for the browser session (e.g., 13.1.1).

Example: 83.0.4103.116
osOs (string)

Operation system (e.g., iOS).

Example: Mac OS
osVersionOsVersion (string)

Operation system version (e.g., 13.5.1).

Example: 10.15.4
sourceSource (string)

The source component from where the operation was generated (mostly for our SDK's).

Example: MONEI/PHP
sourceVersionSourceVersion (string)

The source component version from where the operation was generated (mostly for our SDK's).

Example: 0.1.2
userAgentUserAgent (string)

Full user agent string of the browser session.

Example: Mozilla/5.0 (Windows NT 10.0; Win64; x64) ...
browserAcceptBrowserAccept (string)

Browser accept header.

Example: text/html,application/xhtml+xml,application/json
browserColorDepthBrowserColorDepth (string)

The color depth of the browser session (e.g., 24).

Example: 24
browserScreenHeightBrowserScreenHeight (string)

The screen height of the browser session (e.g., 1152).

Example: 1152
browserScreenWidthBrowserScreenWidth (string)

The screen width of the browser session (e.g., 2048).

Example: 2048
browserTimezoneOffsetBrowserTimezoneOffset (string)

The timezone offset of the browser session (e.g., -120).

Example: -120
expireAtnumber<int64>

Payment expiration time.

Example: 1663581391
metadataobject

A set of key-value pairs that you can attach to a resource. This can be useful for storing additional information about the resource in a structured format.

Example: {"systemId":"12345"}
CreatePaymentRequest
{
  "amount": 110,
  "currency": "EUR",
  "orderId": "14379133960355",
  "callbackUrl": "https://example.com/checkout/callback",
  "completeUrl": "https://example.com/checkout/complete",
  "failUrl": "https://example.com/checkout/fail",
  "cancelUrl": "https://example.com/checkout/cancel",
  "paymentToken": "7cc38b08ff471ccd313ad62b23b9f362b107560b",
  "sessionId": "39603551437913",
  "generatePaymentToken": false,
  "paymentMethod": {
    "card": {
      "number": "string",
      "cvc": "string",
      "expMonth": "string",
      "expYear": "string",
      "cardholderName": "John Doe",
      "cardholderEmail": "john.doe@monei.com"
    },
    "bizum": {
      "phoneNumber": null
    }
  },
  "allowedPaymentMethods": [
    "card",
    "bizum",
    "paypal"
  ],
  "transactionType": "SALE",
  "sequence": {
    "type": "recurring",
    "recurring": {
      "expiry": "20210630",
      "frequency": 30
    }
  },
  "storeId": "e5f28150d9e8974c58ab5ec9c4a880f8734dcf05",
  "pointOfSaleId": "fb269cccfa0cc021f5d0b8eb1421646c696213e1",
  "subscriptionId": "575bcd84-09fc-4a6e-8c4c-f88b8eb90bfa",
  "autoRecover": false,
  "description": "Test Shop - #84370745531439",
  "customer": {
    "email": "john.doe@example.com",
    "name": "John Doe",
    "phone": null
  },
  "billingDetails": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": null,
    "company": null,
    "taxId": null,
    "address": {
      "country": "ES",
      "city": "Málaga",
      "line1": "Fake Street 123",
      "line2": null,
      "zip": "1234",
      "state": "Málaga"
    }
  },
  "shippingDetails": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": null,
    "company": null,
    "taxId": null,
    "address": {
      "country": "ES",
      "city": "Málaga",
      "line1": "Fake Street 123",
      "line2": null,
      "zip": "1234",
      "state": "Málaga"
    }
  },
  "sessionDetails": {
    "ip": "100.100.200.100",
    "countryCode": "ES",
    "lang": "es",
    "deviceType": "desktop",
    "deviceModel": null,
    "browser": "Chrome",
    "browserVersion": "83.0.4103.116",
    "os": "Mac OS",
    "osVersion": "10.15.4",
    "source": "MONEI/PHP",
    "sourceVersion": "0.1.2",
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) ...",
    "browserAccept": "text/html,application/xhtml+xml,application/json",
    "browserColorDepth": "24",
    "browserScreenHeight": "1152",
    "browserScreenWidth": "2048",
    "browserTimezoneOffset": "-120"
  },
  "expireAt": 1663581391,
  "metadata": {
    "systemId": "12345"
  }
}