Payment

idPayment-Id (string)required

Unique identifier for the payment.

Example: af6029f80f5fc73a8ad2753eea0b1be0

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)

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

Example: 14379133960355

descriptionPayment-Description (string)

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

Example: Test Shop - #84370745531439

accountIdAccountId (string)required

MONEI Account identifier.

Example: aa9333ba-82de-400c-9ae7-087b9f8d2242

authorizationCodePayment-AuthorizationCode (string)

Unique identifier provided by the bank performing transaction.

Example: 475816

livemodeLivemode (boolean)required

Has the value true if the resource exists in live mode or the value false if the resource exists in test mode.

Example: false

statusPayment-Status (string)required

The status of the payment.

Enum Value	Description
SUCCEEDED	The payment has been successfully processed and funds have been captured
PENDING	The payment is being processed and awaiting completion
FAILED	The payment attempt was unsuccessful
CANCELED	The payment was canceled before completion
REFUNDED	The full payment amount has been refunded
PARTIALLY_REFUNDED	Only a portion of the payment amount has been refunded
AUTHORIZED	The payment has been authorized but funds have not been captured yet
EXPIRED	The payment has expired without being completed

Possible values: [SUCCEEDED, PENDING, FAILED, CANCELED, REFUNDED, PARTIALLY_REFUNDED, AUTHORIZED, EXPIRED]

Example: PENDING

statusCodePayment-StatusCode (string)

Payment status code.

Example: E000

statusMessagePayment-StatusMessage (string)

Human readable status message, can be displayed to a user.

Example: Transaction approved

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

shop object

The information about the shop (used in hosted payment page).

namestring

The shop name.

Example: Test Shop

countryCountry (string)

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

Example: ES

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

refundedAmountinteger<int32>

Amount in cents refunded (can be less than the amount attribute on the payment if a partial refund was issued).

Example: null

lastRefundAmountinteger<int32>

Amount in cents refunded in the last transaction.

Example: null

lastRefundReasonPayment-LastRefundReason (string)

The reason of the last refund transaction.

Possible values: [duplicated, fraudulent, requested_by_customer]

Example: null

cancellationReasonPayment-CancellationReason (string)

The reason for canceling the Payment.

Possible values: [duplicated, fraudulent, requested_by_customer]

Example: null

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

traceDetails Payment-TraceDetails

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

userIdstring

The ID of the user that started the operation.

Example: null

userEmailstring

The email of the user that started the operation.

Example: user@example.com

paymentTokenPayment-PaymentToken (string)

A permanent token represents a payment method used in the payment. Pass generatePaymentToken: true when you creating a payment to generate it. You can pass it as paymentToken parameter to create other payments with the same payment method. This token does not expire, and should only be used server-side.

Example: 7cc38b08ff471ccd313ad62b23b9f362b107560b

paymentMethod object

Details about the payment method at the time of the transaction.

methodstring

Payment method type.

Enum Value	Description
alipay	Alipay
card	Card
bizum	Bizum
paypal	PayPal
mbway	MB WAY
multibanco	Multibanco
iDeal	iDEAL
bancontact	Bancontact
sofort	SOFORT
trustly	Trustly
sepa	SEPA
klarna	Klarna
giropay	Giropay
eps	EPS
blik	BLIK

Possible values: [alipay, card, bizum, paypal, mbway, multibanco, iDeal, bancontact, sofort, trustly, sepa, klarna, giropay, eps, blik]

Example: card

card object

Details about the card used as payment method at the time of the transaction.

countryCountry (string)

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

Example: ES

brandstring

Card brand.

Enum Value	Description
visa	Visa credit or debit card
mastercard	Mastercard credit or debit card
diners	Diners Club credit card
amex	American Express credit card
jcb	Japan Credit Bureau card
unionpay	UnionPay card from China
unknown	Card brand could not be determined

Possible values: [visa, mastercard, diners, amex, jcb, unionpay, unknown]

Example: visa

typestring

Card type debit or credit.

Possible values: [debit, credit]

Example: credit

threeDSecureboolean

Whether this transaction used 3D Secure authentication.

Example: false

threeDSecureVersionstring

The protocol version of the 3DS challenge.

Example: 2.1.0

threeDSecureFlowstring

The flow used for 3DS authentication.

Enum Value	Description
CHALLENGE	Authentication requiring additional shopper interaction through biometrics, 2FA, or other SCA methods
FRICTIONLESS	Background authentication using device fingerprint without additional shopper interaction
FRICTIONLESS_CHALLENGE	Complete 3DS flow with additional authentication if initial data collection is insufficient
DIRECT	Transaction exempt from SCA due to low risk assessment

Possible values: [CHALLENGE, FRICTIONLESS, FRICTIONLESS_CHALLENGE, DIRECT]

Example: CHALLENGE

expirationinteger<int64>

Time at which the card will expire. Measured in seconds since the Unix epoch.

Example: 2048544000

last4string

The last four digits of the card.

Example: 0004

tokenizationMethodstring

The digital wallet used to tokenize the card.

Possible values: [applePay, googlePay, clickToPay]

Example: applePay

cardholderNamestring

The name of the cardholder.

Example: John Doe

cardholderEmailstring

The email of the cardholder.

Example: email@example.com

bizum object

Details about the Bizum account used as payment method at the time of the transaction.

phoneNumberstring

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

Example: null

paypal object

Details from Paypal order used as payment method at the time of the transaction.

orderIdstring

The Paypal's order ID.

Example: 7XP21983KL5672104

payerIdstring

The Paypal's payer ID.

Example: QWRTNBFHZXLPD

emailstring

The Paypal's payer email.

Example: john.doe@example.com

namestring

The Paypal's payer name.

Example: John Doe

mbway object

Details from MBWay order used as payment method at the time of the transaction.

phoneNumberstring

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

Example: null

trustly object

Details from Trustly order used as payment method at the time of the transaction.

customerIdstring

The Trustly's customer ID.

Example: null

sepa object

Details from SEPA order used as payment method at the time of the transaction.

accountholderAddressstring

The address of the account holder.

Example: null

accountholderEmailstring

The email of the account holder.

Example: null

accountholderNamestring

The name of the account holder.

Example: null

countryCodestring

The country code of the account holder.

Example: null

bankAddressstring

The address of the bank.

Example: null

bankCodestring

The code of the bank.

Example: null

bankNamestring

The name of the bank.

Example: null

bicstring

The BIC of the bank.

Example: null

last4string

The last 4 digits of the IBAN.

Example: null

klarna object

Details from Klarna order used as payment method at the time of the transaction.

billingCategorystring

Enum Value	Description
PAY_LATER	Pay after delivery within a specified timeframe
PAY_NOW	Immediate payment at time of purchase
SLICE_IT	Split payment into installments
SLICE_IT_BY_CARD	Split payment into installments using a card

Possible values: [PAY_LATER, PAY_NOW, SLICE_IT, SLICE_IT_BY_CARD]

Example: PAY_LATER

authPaymentMethodstring

Enum Value	Description
invoice	Traditional invoice payment
fixed_amount	Payment with a predetermined fixed amount
pix	Brazilian instant payment system
base_account	Payment from a basic account
deferred_interest	Payment with delayed interest charges
direct_debit	Direct bank account debit
direct_bank_transfer	Immediate bank transfer
b2b_invoice	Business-to-business invoice payment
card	Credit or debit card payment
slice_it_by_card	Installment payment using a card

Possible values: [invoice, fixed_amount, pix, base_account, deferred_interest, direct_debit, direct_bank_transfer, b2b_invoice, card, slice_it_by_card]

Example: card

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

sequenceIdPayment-SequenceId (string)

A permanent identifier that refers to the initial payment of a sequence of payments. This value needs to be sent in the path for RECURRING payments.

Example: 62b23b9f3627cc38b08ff471ccd313ad

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

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"}

nextAction object

If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.

typestring

CONFIRM - Your customer needs to be redirected to a hosted payment page or confirm payment using payment token. The redirectUrl will point to the hosted payment page.
FRICTIONLESS_CHALLENGE - Your customer needs to be redirected to the frictionless 3d secure challenge page provided by the bank. The redirectUrl will point to the frictionless 3d secure challenge page provided by the bank.
CHALLENGE - Your customer needs to be redirected to the 3d secure challenge page provided by the bank. The redirectUrl will point to the 3d secure challenge page provided by the bank.
COMPLETE - The payment is completed. The redirectUrl will be the completeUrl if it was provided when the payment was created.
BIZUM_CHALLENGE - Your customer will be redirected to the Bizum hosted payment page.

Possible values: [CONFIRM, CHALLENGE, FRICTIONLESS_CHALLENGE, BIZUM_CHALLENGE, COMPLETE]

Example: CONFIRM

mustRedirectboolean

If true you have to redirect your customer to the redirectUrl to continue payment process.

Example: false

redirectUrlstring

Redirect your customer to this url to continue payment process.

Example: https://secure.monei.com/payments/af6029f80f5fc73a8ad2753eea0b1be0

createdAtinteger<int64>

Time at which the resource was created. Measured in seconds since the Unix epoch.

Example: 1636366897

updatedAtinteger<int64>

Time at which the resource updated last time. Measured in seconds since the Unix epoch.

Example: 1636366897

Payment
{
  "id": "af6029f80f5fc73a8ad2753eea0b1be0",
  "amount": 110,
  "currency": "EUR",
  "orderId": "14379133960355",
  "description": "Test Shop - #84370745531439",
  "accountId": "aa9333ba-82de-400c-9ae7-087b9f8d2242",
  "authorizationCode": "475816",
  "livemode": false,
  "status": "PENDING",
  "statusCode": "E000",
  "statusMessage": "Transaction approved",
  "customer": {
    "email": "john.doe@example.com",
    "name": "John Doe",
    "phone": null
  },
  "shop": {
    "name": "Test Shop",
    "country": "ES"
  },
  "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"
    }
  },
  "refundedAmount": null,
  "lastRefundAmount": null,
  "lastRefundReason": null,
  "cancellationReason": null,
  "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"
  },
  "traceDetails": {
    "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",
    "userId": null,
    "userEmail": "user@example.com"
  },
  "paymentToken": "7cc38b08ff471ccd313ad62b23b9f362b107560b",
  "paymentMethod": {
    "method": "card",
    "card": {
      "country": "ES",
      "brand": "visa",
      "type": "credit",
      "threeDSecure": false,
      "threeDSecureVersion": "2.1.0",
      "threeDSecureFlow": "CHALLENGE",
      "expiration": 2048544000,
      "last4": "0004",
      "tokenizationMethod": "applePay",
      "cardholderName": "John Doe",
      "cardholderEmail": "email@example.com"
    },
    "bizum": {
      "phoneNumber": null
    },
    "paypal": {
      "orderId": "7XP21983KL5672104",
      "payerId": "QWRTNBFHZXLPD",
      "email": "john.doe@example.com",
      "name": "John Doe"
    },
    "mbway": {
      "phoneNumber": null
    },
    "trustly": {
      "customerId": null
    },
    "sepa": {
      "accountholderAddress": null,
      "accountholderEmail": null,
      "accountholderName": null,
      "countryCode": null,
      "bankAddress": null,
      "bankCode": null,
      "bankName": null,
      "bic": null,
      "last4": null
    },
    "klarna": {
      "billingCategory": "PAY_LATER",
      "authPaymentMethod": "card"
    }
  },
  "sequence": {
    "type": "recurring",
    "recurring": {
      "expiry": "20210630",
      "frequency": 30
    }
  },
  "sequenceId": "62b23b9f3627cc38b08ff471ccd313ad",
  "storeId": "e5f28150d9e8974c58ab5ec9c4a880f8734dcf05",
  "pointOfSaleId": "fb269cccfa0cc021f5d0b8eb1421646c696213e1",
  "metadata": {
    "systemId": "12345"
  },
  "nextAction": {
    "type": "CONFIRM",
    "mustRedirect": false,
    "redirectUrl": "https://secure.monei.com/payments/af6029f80f5fc73a8ad2753eea0b1be0"
  },
  "createdAt": 1636366897,
  "updatedAt": 1636366897
}