Skip to main content

ConfirmPaymentRequest

paymentTokenPayment-PaymentToken (string)required

A payment token generated by monei.js Components or a paymentToken saved after a previous successful payment.

Example: 7cc38b08ff471ccd313ad62b23b9f362b107560b
paymentMethod object

Additional information about the payment method used for this payment.

card object

Additional information about the card used for this payment.

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
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
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
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"}
ConfirmPaymentRequest
{
  "paymentToken": "7cc38b08ff471ccd313ad62b23b9f362b107560b",
  "paymentMethod": {
    "card": {
      "cardholderName": "John Doe",
      "cardholderEmail": "john.doe@monei.com"
    }
  },
  "generatePaymentToken": false,
  "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"
  },
  "metadata": {
    "systemId": "12345"
  }
}