MONEI

https://docs.monei.com
Admin
MONEI is a comprehensive payment processing platform that enables developers to securely collect...
Tokens:407,611
Snippets:3,974
Trust Score:9.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Subscription Description Example

Source: https://docs.monei.com/apis/rest/schemas/subscription-description

This is an example of a Subscription-Description string. It can be any arbitrary string.

```json
"MoonMail Monthly Lite"
```

--------------------------------

### Subscription Configuration Example

Source: https://docs.monei.com/apis/rest/subscriptions-create

Example JSON payload for a subscription with a discounted trial period of 3 months.

```json
{

  "amount": 1000,

  "currency": "EUR",

  "interval": "month",

  "intervalCount": 1,

  "trialAmount": 500,

  "trialIntervalCount": 3

}
```

--------------------------------

### Install the MONEI Pay SDK

Source: https://docs.monei.com/monei-pay/app-integration/react-native

Commands to install the SDK via npm or directly from the GitHub repository.

```bash
npx expo install @monei-js/monei-pay-react-native-sdk
```

```bash
npx expo install @monei-js/monei-pay-react-native-sdk@github:MONEI/monei-pay-react-native-sdk
```

--------------------------------

### Install MONEI PHP SDK

Source: https://docs.monei.com/e-commerce/adobe-commerce

Required when installing the module manually from a raw package.

```bash
composer require monei/monei-php-sdk:^2.8.3
```

--------------------------------

### Install @monei-js/components via npm

Source: https://docs.monei.com/monei-js/overview

Install the MONEI components package using npm for your project.

```bash
npm install @monei-js/components
```

--------------------------------

### Install @monei-js/components via yarn

Source: https://docs.monei.com/monei-js/overview

Install the MONEI components package using yarn for your project.

```bash
yarn add @monei-js/components
```

--------------------------------

### Install @monei-js/components via pnpm

Source: https://docs.monei.com/monei-js/overview

Install the MONEI components package using pnpm for your project.

```bash
pnpm add @monei-js/components
```

--------------------------------

### Install MONEI Vue Components

Source: https://docs.monei.com/llms-full.txt

Installation commands for adding MONEI components to a Vue 3 project using various package managers.

```bash
npm install @monei-js/vue-components @monei-js/components
```

```bash
yarn add @monei-js/vue-components @monei-js/components
```

```bash
pnpm add @monei-js/vue-components @monei-js/components
```

--------------------------------

### Install MONEI Angular Components

Source: https://docs.monei.com/llms-full.txt

Commands to install the required packages using different package managers.

```bash
npm install @monei-js/angular-components @monei-js/components
```

```bash
yarn add @monei-js/angular-components @monei-js/components
```

```bash
pnpm add @monei-js/angular-components @monei-js/components
```

--------------------------------

### Merchant Website URL Example

Source: https://docs.monei.com/apis/rest/schemas/paymentmethods-merchanturl

Provides an example of a merchant website URL as a string.

```json
"https://monei.com/"
```

--------------------------------

### Install MONEI.js

Source: https://docs.monei.com/llms-full.txt

Methods to include the MONEI.js library in your project.

```html
<script src="https://js.monei.com/v3/monei.js"></script>
```

```bash
npm install @monei-js/components
```

```bash
yarn add @monei-js/components
```

```bash
pnpm add @monei-js/components
```

--------------------------------

### Install @monei-js/vue-components with npm

Source: https://docs.monei.com/monei-js/vue

Install the necessary MONEI Vue components and core components using npm. Requires Vue 3.3 or later.

```bash
npm install @monei-js/vue-components @monei-js/components
```

--------------------------------

### Merchant Name Example

Source: https://docs.monei.com/apis/rest/schemas/paymentmethods-merchantname

Provides an example of the merchant name as a string.

```json
"MONEI"
```

--------------------------------

### Install MONEI Svelte Components (yarn)

Source: https://docs.monei.com/monei-js/svelte

Install the necessary MONEI Svelte components and core library using yarn. Requires Svelte 5 or later.

```bash
yarn add @monei-js/svelte-components @monei-js/components
```

--------------------------------

### Install MONEI Svelte Components (npm)

Source: https://docs.monei.com/monei-js/svelte

Install the necessary MONEI Svelte components and core library using npm. Requires Svelte 5 or later.

```bash
npm install @monei-js/svelte-components @monei-js/components
```

--------------------------------

### DomainName String Example

Source: https://docs.monei.com/apis/rest/schemas/domainname

Provides an example of a domain name string as required for Apple Pay registration.

```json
"example.com"
```

--------------------------------

### Install @monei-js/vue-components with pnpm

Source: https://docs.monei.com/monei-js/vue

Install the necessary MONEI Vue components and core components using pnpm. Requires Vue 3.3 or later.

```bash
pnpm add @monei-js/vue-components @monei-js/components
```

--------------------------------

### Install MONEI Svelte Components (pnpm)

Source: https://docs.monei.com/monei-js/svelte

Install the necessary MONEI Svelte components and core library using pnpm. Requires Svelte 5 or later.

```bash
pnpm add @monei-js/svelte-components @monei-js/components
```

--------------------------------

### Install @monei-js/vue-components with yarn

Source: https://docs.monei.com/monei-js/vue

Install the necessary MONEI Vue components and core components using yarn. Requires Vue 3.3 or later.

```bash
yarn add @monei-js/vue-components @monei-js/components
```

--------------------------------

### Example Subscription Callback URL

Source: https://docs.monei.com/apis/rest/schemas/subscription-callbackurl

This is an example of a valid URL format for the subscription callback. The URL will be invoked when a subscription's status changes.

```text
"https://example.com/subscriptions/callback"
```

--------------------------------

### PaymentMethodInput JSON Example

Source: https://docs.monei.com/apis/rest/schemas/payment-paymentmethodinput

This example demonstrates the structure of the PaymentMethodInput object, showing how to include details for both card and Bizum payment methods.

```json
{

  "card": {

    "number": "string",

    "cvc": "string",

    "expMonth": "string",

    "expYear": "string",

    "cardholderName": "John Doe",

    "cardholderEmail": "john.doe@monei.com"

  },

  "bizum": {

    "phoneNumber": null

  }

}
```

--------------------------------

### Payment Methods Array Example

Source: https://docs.monei.com/apis/rest/schemas/payment-paymentmethods

Provides an example of the expected format for the Payment-PaymentMethods array, which should contain strings of enabled payment methods.

```json
[
  "card",
  "bizum",
  "paypal"
]
```

--------------------------------

### Payment Callback URL Example

Source: https://docs.monei.com/apis/rest/schemas/payment-callbackurl

This is an example of a Payment-CallbackUrl. Ensure the URL is correctly formatted and accessible by the payment system.

```text
https://example.com/checkout/callback
```

```json
"https://example.com/checkout/callback"
```

--------------------------------

### Generate Payment Token Example

Source: https://docs.monei.com/apis/rest/schemas/payment-paymenttoken

This example shows the format of a generated payment token. Pass `generatePaymentToken: true` when creating a payment to obtain this token.

```json
"7cc38b08ff471ccd313ad62b23b9f362b107560b"
```

--------------------------------

### Payment NextAction Example

Source: https://docs.monei.com/apis/rest/schemas/payment-nextaction

This example shows the structure of the Payment NextAction object when a customer needs to confirm the payment.

```json
{
  "type": "CONFIRM",
  "mustRedirect": false,
  "redirectUrl": "https://secure.monei.com/payments/af6029f80f5fc73a8ad2753eea0b1be0"
}
```

--------------------------------

### Install MONEI React Components

Source: https://docs.monei.com/monei-js/react

Install the necessary MONEI packages for React integration using npm, yarn, or pnpm. Requires React 17 or later.

```bash
npm install @monei-js/react-components @monei-js/components
```

```bash
yarn add @monei-js/react-components @monei-js/components
```

```bash
pnpm add @monei-js/react-components @monei-js/components
```

--------------------------------

### Example Browser Value

Source: https://docs.monei.com/apis/rest/schemas/browser

Represents the browser used in a session. Example values include 'Mobile Safari' or 'Chrome'.

```json
"Chrome"
```

--------------------------------

### BrowserAccept Header Example

Source: https://docs.monei.com/apis/rest/schemas/browseraccept

This example shows a typical string value for the BrowserAccept header, which can include multiple MIME types.

```text
"text/html,application/xhtml+xml,application/json"
```

--------------------------------

### Subscription Retry Schedule Example

Source: https://docs.monei.com/apis/rest/schemas/subscription-retryschedule

This example demonstrates how to define a custom retry schedule for subscription payments, specifying daily and weekly intervals.

```json
[
  {
    "interval": "day",
    "intervalCount": 1
  },
  {
    "interval": "day",
    "intervalCount": 3
  },
  {
    "interval": "week",
    "intervalCount": 1
  }
]
```

--------------------------------

### Install @monei-js/angular-components

Source: https://docs.monei.com/monei-js/angular

Install the necessary MONEI Angular components and core components packages using npm, yarn, or pnpm. Requires Angular 14 or later.

```bash
npm install @monei-js/angular-components @monei-js/components
```

```bash
yarn add @monei-js/angular-components @monei-js/components
```

```bash
pnpm add @monei-js/angular-components @monei-js/components
```

--------------------------------

### CardholderName Example

Source: https://docs.monei.com/apis/rest/schemas/cardholdername

Example of a CardholderName value.

```json
"John Doe"
```

--------------------------------

### Create a Subscription

Source: https://docs.monei.com/llms-full.txt

Use these examples to initialize a subscription with billing details, customer information, and callback URLs.

```bash
curl --request POST 'https://api.monei.com/v1/subscriptions' \

--header 'Authorization: YOUR_API_KEY' \

--header 'Content-Type: application/json' \

--data-raw '{

  "amount": 1500,

  "currency": "EUR",

  "interval": "month",

  "intervalCount": 1,

  "description": "Pro Plan Monthly",

  "customer": {

    "name": "John Doe",

    "email": "john.doe@example.com"

  },

  "callbackUrl": "https://example.com/subscriptions/callback",

  "paymentCallbackUrl": "https://example.com/payments/callback"

}'
```

```javascript
import {Monei} from '@monei-js/node-sdk';



// Replace YOUR_API_KEY with your actual MONEI API key

const monei = new Monei('YOUR_API_KEY');



const subscription = await monei.subscriptions.create({

  amount: 1500,

  currency: 'EUR',

  interval: 'month',

  intervalCount: 1,

  description: 'Pro Plan Monthly',

  customer: {

    name: 'John Doe',

    email: 'john.doe@example.com'

  },

  callbackUrl: 'https://example.com/subscriptions/callback',

  paymentCallbackUrl: 'https://example.com/payments/callback'

});



// You will need the subscription id in the next step

const subscriptionId = subscription.id;
```

```php
<?php

require_once 'vendor/autoload.php';



use Monei\MoneiClient;

use Monei\Model\CreateSubscriptionRequest;

use Monei\Model\PaymentCustomer;



// Replace YOUR_API_KEY with your actual MONEI API key

$monei = new MoneiClient('YOUR_API_KEY');



$subscription = $monei->subscriptions->create(

  new CreateSubscriptionRequest([

    'amount' => 1500,

    'currency' => 'EUR',

    'interval' => 'month',

    'interval_count' => 1,

    'description' => 'Pro Plan Monthly',

    'customer' => new PaymentCustomer([

      'name' => 'John Doe',

      'email' => 'john.doe@example.com'

    ]),

    'callback_url' => 'https://example.com/subscriptions/callback',

    'payment_callback_url' => 'https://example.com/payments/callback'

  ])

);



// You will need the subscription id in the next step

$subscriptionId = $subscription->getId();

?>
```

```python
import Monei

from Monei import CreateSubscriptionRequest, PaymentCustomer



# Replace YOUR_API_KEY with your actual MONEI API key

monei = Monei.MoneiClient(api_key="YOUR_API_KEY")



subscription = monei.subscriptions.create(

    CreateSubscriptionRequest(

        amount=1500,

        currency="EUR",

        interval="month",

        interval_count=1,

        description="Pro Plan Monthly",

        customer=PaymentCustomer(

            name="John Doe",

            email="john.doe@example.com"

        ),

        callback_url="https://example.com/subscriptions/callback",

        payment_callback_url="https://example.com/payments/callback"

    )

)



# You will need the subscription id in the next step

subscription_id = subscription.id
```

--------------------------------

### Subscription-Interval Example

Source: https://docs.monei.com/apis/rest/schemas/subscription-interval

Represents a monthly subscription interval.

```json
"month"
```

--------------------------------

### Enable and compile manual module installation

Source: https://docs.monei.com/e-commerce/adobe-commerce

Run these commands after extracting the module files to the app/code directory.

```bash
bin/magento module:enable Monei_MoneiPayment

bin/magento setup:upgrade

bin/magento setup:di:compile

bin/magento setup:static-content:deploy

bin/magento cache:clean
```

--------------------------------

### Payment-PointOfSaleId Example

Source: https://docs.monei.com/apis/rest/schemas/payment-pointofsaleid

This is an example of a Payment-PointOfSaleId. It is a unique string identifier.

```text
"fb269cccfa0cc021f5d0b8eb1421646c696213e1"
```

--------------------------------

### AccountId Example

Source: https://docs.monei.com/apis/rest/schemas/accountid

This is an example of a valid MONEI AccountId string.

```string
"aa9333ba-82de-400c-9ae7-087b9f8d2242"
```

--------------------------------

### Device Model and Type Definitions

Source: https://docs.monei.com/llms-full.txt

Examples of device-related metadata fields.

```json
null
```

```json
"desktop"
```

--------------------------------

### CreatePaymentRequest Field Examples

Source: https://docs.monei.com/llms-full.txt

Example values for various fields used in a CreatePaymentRequest.

```json
110
```

```json
"EUR"
```

```json
"14379133960355"
```

```json
"https://example.com/checkout/callback"
```

```json
"https://example.com/checkout/complete"
```

```json
"https://example.com/checkout/fail"
```

```json
"https://example.com/checkout/cancel"
```

```json
"7cc38b08ff471ccd313ad62b23b9f362b107560b"
```

```json
"39603551437913"
```

```json
false
```

--------------------------------

### OsVersion Example

Source: https://docs.monei.com/apis/rest/schemas/osversion

Represents an operating system version as a string. Use this format for specifying OS versions.

```string
"10.15.4"
```

--------------------------------

### Country Code Example

Source: https://docs.monei.com/llms-full.txt

Example of an ISO 3166-1 alpha-2 country code.

```json
"ES"
```

--------------------------------

### Install MONEI components via npm

Source: https://docs.monei.com/monei-js/reference

Use the npm package to load monei.js as a module.

```bash
npm i @monei-js/components
```

--------------------------------

### Subscription Retry Schedule Example

Source: https://docs.monei.com/apis/rest/schemas/subscription-retryschedule

An example of a subscription retry schedule array.

```APIDOC
## Subscription Retry Schedule Example

### Description
An example of a subscription retry schedule array.

### Request Example
```json
[
  {
    "interval": "day",
    "intervalCount": 1
  },
  {
    "interval": "day",
    "intervalCount": 3
  },
  {
    "interval": "week",
    "intervalCount": 1
  }
]
```
```

--------------------------------

### Payment-ExpireAt Timestamp Example

Source: https://docs.monei.com/apis/rest/schemas/payment-expireat

Provides an example of the Payment-ExpireAt value, which is a Unix timestamp.

```plaintext
1663581391
```

--------------------------------

### Payment Cancel URL Example

Source: https://docs.monei.com/apis/rest/schemas/payment-cancelurl

This is an example of a Payment-CancelUrl. It should be a valid URL string.

```text
https://example.com/checkout/cancel
```

```json
"https://example.com/checkout/cancel"
```

--------------------------------

### Payment Object Field Examples

Source: https://docs.monei.com/llms-full.txt

Examples of various fields within the Payment object.

```text
af6029f80f5fc73a8ad2753eea0b1be0
```

```text
110
```

```text
EUR
```

```text
14379133960355
```

```text
Test Shop - #84370745531439
```

```text
aa9333ba-82de-400c-9ae7-087b9f8d2242
```

```text
475816
```

```text
false
```

```text
PENDING
```

```text
E000
```

```text
Transaction approved
```

```text
john.doe@example.com
```

```text
John Doe
```

```text
null
```

```text
Test Shop
```

```text
ES
```

--------------------------------

### Initialize Monei Client and Verify Signature (Python)

Source: https://docs.monei.com/guides/verify-signature

Initialize the Monei client with your secret key and verify the incoming webhook signature. This example uses Flask and assumes the signature and payload are available in the request.

```python
import os

import Monei

from Monei.errors import SignatureVerificationError

from flask import Flask, request, abort, jsonify



app = Flask(__name__)



# Ensure you have your Monei secret key set as an environment variable

monei = Monei.Monei(os.environ.get('MONEY_SECRET_KEY'))



@app.route('/webhook', methods=['POST'])
def webhook():
    signature = request.headers.get('Monei-Signature')
    payload = request.data

    try:
        # Verify the signature
        monei.webhook.verify_signature(payload, signature)

        # If verification is successful, process the event
        event_data = request.get_json()
        print(f"Received event: {event_data}")

        return jsonify({'received': True}), 200

    except SignatureVerificationError:
        # Handle signature verification failure
        print('Invalid signature')
        abort(401)

    except Exception as e:
        # Handle other potential errors
        print(f'Error processing webhook: {e}')
        abort(500)



if __name__ == '__main__':
    app.run(port=5000)
```

--------------------------------

### Payment-PaymentMethodTrustly Schema Example

Source: https://docs.monei.com/apis/rest/schemas/payment-paymentmethodtrustly

This snippet shows an example of the Payment-PaymentMethodTrustly schema, where the customerId is null.

```json
{
  "customerId": null
}
```

--------------------------------

### Payment FailUrl Example

Source: https://docs.monei.com/apis/rest/schemas/payment-failurl

This is an example of a Payment-FailUrl string. It specifies the URL for failed transactions.

```json
"https://example.com/checkout/fail"
```

--------------------------------

### Create a payment with token generation

Source: https://docs.monei.com/llms-full.txt

Use these examples to initiate a payment and request a token for future use.

```bash
curl --request POST 'https://api.monei.com/v1/payments' \

--header 'Authorization: pk_test_3c140607778e1217f56ccb8b50540e00' \

--header 'Content-Type: application/json' \

--data-raw '{

    "amount": 110,

    "currency": "EUR",

    "orderId": "14379133960355",

    "generatePaymentToken": true,

    "callbackUrl": "https://example.com/checkout/callback",

    "completeUrl": "https://example.com/checkout/complete"

}'
```

```javascript
const {Monei} = require('@monei-js/node-sdk');

const monei = new Monei('pk_test_36cf3e8a15eff3f5be983562ea6b13ec');

monei.payments.create({

  amount: 110,

  currency: 'EUR',

  orderId: '14379133960355',

  generatePaymentToken: true,

  callbackUrl: 'https://example.com/checkout/callback',

  completeUrl: 'https://example.com/checkout/complete'

});
```

```php
$monei = new Monei\MoneiClient('pk_test_36cf3e8a15eff3f5be983562ea6b13ec');

$monei->payments->create([

  'amount' => 110,

  'currency' => 'EUR'

  'orderId' => '14379133960355',

  'generatePaymentToken' => true,

  'callbackUrl' => 'https://example.com/checkout/callback',

  'completeUrl' => 'https://example.com/checkout/complete'

]);
```

--------------------------------

### Installment GraphQL Type Definition

Source: https://docs.monei.com/apis/graphql/types/objects/installment

Defines the schema structure for an installment plan object.

```graphql
type Installment {  

  installmentType: String  

  quotaNum: Int  

  quotaAmount: Int  

  firstQuotaAmount: Int  

  totalAmount: Int  

  tae: Float  

  tin: Float  

  commision: Float  

  commisionType: Int  

  pendingChargesDateList: [String!]  

}  
```

--------------------------------

### Initialize and Render Bizum Component

Source: https://docs.monei.com/llms-full.txt

Create an instance of the Bizum component and render it into the specified container.

```javascript
// Create an instance of the Bizum component.

const bizum = monei.Bizum({

  paymentId: '{{payment_id}}',

  onSubmit(result) {

    // result.paymentMethod === 'bizum'

    moneiTokenHandler(result.token);

  },

  onError(error) {

    console.log(error);

  }

});



// Render an instance of the Bizum component into the `bizum_container` <div>.

bizum.render('#bizum_container');
```

--------------------------------

### Subscription Request Field Examples

Source: https://docs.monei.com/llms-full.txt

Individual field examples used within a subscription request.

```json
110
```

```json
month
```

```json
1
```

```json
["card","bizum"]
```

```json
MoonMail Monthly Lite
```

```json
john.doe@example.com
```

```json
John Doe
```

```json
null
```

```json
ES
```

```json
MÃ¡laga
```

```json
Fake Street 123
```

```json
1234
```

```json
1636366897
```

--------------------------------

### Unix Timestamp Example

Source: https://docs.monei.com/apis/rest/schemas/payment

Example of a Unix epoch timestamp used for resource update tracking.

```text
1636366897
```

--------------------------------

### Payment-SequenceId Example

Source: https://docs.monei.com/apis/rest/schemas/payment-sequenceid

This is an example of a Payment-SequenceId. It is a string value that needs to be sent in the path for RECURRING payments.

```string
"62b23b9f3627cc38b08ff471ccd313ad"
```

--------------------------------

### Browser Timezone Offset Example

Source: https://docs.monei.com/apis/rest/schemas/browsertimezoneoffset

This example shows the string representation of a browser timezone offset.

```string
" -120"
```

--------------------------------

### Create Subscription (Python)

Source: https://docs.monei.com/subscriptions/build-custom-checkout

Use the MONEI Python SDK to create a subscription server-side. Replace 'YOUR_API_KEY' with your MONEI API key.

```python
import Monei
from Monei import CreateSubscriptionRequest, PaymentCustomer


monei = Monei.MoneiClient(api_key="YOUR_API_KEY")


subscription = monei.subscriptions.create(
    CreateSubscriptionRequest(
        amount=1500,
        currency="EUR",
        interval="month",
        interval_count=1,
        description="Pro Plan Monthly",
        customer=PaymentCustomer(
            name="John Doe",
            email="john.doe@example.com"
        ),
        callback_url="https://example.com/subscriptions/callback",
        payment_callback_url="https://example.com/payments/callback"
    )
)


subscription_id = subscription.id

```

--------------------------------

### Create Payment with Python SDK

Source: https://docs.monei.com/integrations/pay-by-link

This snippet shows how to initiate a payment using the MONEI Python SDK. Further implementation details would follow.

```python
import Monei

from Monei import CreatePaymentRequest, PaymentCustomer




```

--------------------------------

### Get Payment Methods

Source: https://docs.monei.com/apis/rest/payment-methods-get

Retrieves available payment methods for an account or a specific payment. This endpoint is deprecated and should not be used for new implementations. Use Get Allowed Payment Methods or Get Client Payment Methods instead.

```APIDOC
## GET /payment-methods

### Description
Retrieve available payment methods for an account or a specific payment. You can provide either an `accountId` or a `paymentId` as a query parameter to get the available payment methods. When providing a `paymentId`, the response will include additional payment-specific information such as amount and currency. You can also filter results by `amount`, `currency`, or `countryCode` to narrow down available payment methods.

### Method
GET

### Endpoint
/payment-methods

### Query Parameters
- **accountId** (string) - Optional - The ID of the account to retrieve payment methods for.
- **paymentId** (string) - Optional - The ID of the payment to retrieve payment methods for.
- **amount** (number) - Optional - Filter payment methods by a specific amount.
- **currency** (string) - Optional - Filter payment methods by a specific currency (e.g., EUR, USD).
- **countryCode** (string) - Optional - Filter payment methods by a specific country code (e.g., NL, DE).

### Responses
#### Success Response (200)
- **Available payment methods** (object) - A list of available payment methods.

#### Error Responses
- **400** - The request is incorrect or could not be processed.
- **401** - Unauthorized error. Please check your auth credentials.
- **404** - The specified resource was not found.
- **422** - The request was well-formed but could not be processed due to semantic errors.
- **500** - Unexpected server error.
- **503** - The service is temporarily unavailable.
```

--------------------------------

### MONEI Connect Event Payload Example

Source: https://docs.monei.com/monei-connect

Example of a JSON event payload for an account approval event.

```json
{

  "id": "evt_…",

  "type": "account.approved",

  "objectType": "account",

  "objectId": "<MERCHANT_SUB_ACCOUNT_ID>",

  "accountId": "<MERCHANT_SUB_ACCOUNT_ID>",

  "livemode": true,

  "createdAt": 1748390400,

  "object": {

    "id": "<MERCHANT_SUB_ACCOUNT_ID>",

    "name": "ACME Shop",

    "status": "APPROVED",

    "test": false,

    "adminEmail": "owner@acme.com",

    "iban": "ES12********6789",

    "externalId": "merchant-7421",

    "language": "es",

    "billingPlan": "MONEI_X",

    "blocked": false,

    "business": {

      "legalName": "ACME COMERCIO SL",

      "documentNumber": "B12345678",

      "country": "ES",

      "website": "https://acme.com",

      "email": "info@acme.com",

      "status": "active"

    }

  }

}
```

--------------------------------

### monei.Bizum()

Source: https://docs.monei.com/monei-js/reference

Initializes the Bizum component instance with payment configuration and event handlers.

```APIDOC
## monei.Bizum(options)

### Description
Creates an instance of the Bizum component to render a payment button.

### Parameters
- **paymentId** (string) - Required* - Payment ID from create payment.
- **accountId** (string) - Required* - Your MONEI account ID.
- **sessionId** (string) - Conditional - Unique session ID in your system.
- **phoneNumber** (string) - Optional - Pre-fill the customer's phone number.
- **amount** (number) - Conditional - Amount in the smallest currency unit.
- **currency** (string) - Conditional - Three-letter ISO currency code.
- **transactionType** ('SALE' | 'AUTH') - Optional - Controls when funds are captured.
- **fullscreen** (boolean) - Optional - Set to true to open in fullscreen mode.
- **language** (string) - Optional - ISO 639-1 language code.
- **onSubmit** (function) - Optional - Callback triggered on form submission.
- **onError** (function) - Optional - Callback triggered on error.

### Method
`bizum.render(selector)`

### Example
```javascript
const bizum = monei.Bizum({
  paymentId: 'af6029f80f5fc73a8ad2753eea0b1be0',
  onSubmit(result) {
    if (result.error) {
      // Handle error
    } else {
      moneiTokenHandler(result.token);
    }
  },
  onError(error) {
    console.log(error);
  }
});

bizum.render('#bizum');
```
```

--------------------------------

### Create Payment via SDKs

Source: https://docs.monei.com/llms-full.txt

Initialize the MONEI client with your API key and merchant-specific account details to create payments.

```javascript
import {Monei} from '@monei-js/node-sdk';



// Initialize with Partner API Key, Account ID, and User-Agent

const monei = new Monei('<PARTNER_API_KEY>', {

  accountId: '<MONEI_ACCOUNT_ID>',

  userAgent: 'MONEI/<PARTNER_NAME>/0.1.0'

});



async function createMerchantPayment() {

  try {

    const payment = await monei.payments.create({

      amount: 110,

      currency: 'EUR',

      orderId: '14379133960355',

      description: 'Test Shop - #14379133960355',

      customer: {

        email: 'email@example.com'

      },

      callbackUrl: 'https://example.com/checkout/callback'

    });

    console.log('Payment created:', payment.id);

    // Handle the payment response (e.g., redirect URL)

  } catch (error) {

    console.error('Error creating payment:', error.message);

  }

}



createMerchantPayment();
```

```php
<?php

require_once 'vendor/autoload.php';



use Monei

MoneiClient;

use Monei

Model

CreatePaymentRequest;

use Monei

Model

PaymentCustomer;



// Initialize with Partner API Key

$monei = new MoneiClient('<PARTNER_API_KEY>');



// Set Account ID and User-Agent for the specific merchant

$monei->setAccountId('<MONEI_ACCOUNT_ID>');

$monei->setUserAgent('MONEI/<PARTNER_NAME>/0.1.0');



try {

  $payment = $monei->payments->create(

      new CreatePaymentRequest([

        'amount' => 110,

        'currency' => 'EUR',

        'order_id' => '14379133960355',

        'description' => 'Test Shop - #14379133960355',

        'customer' => new PaymentCustomer([

          'email' => 'email@example.com'

        ]),

        'callback_url' => 'https://example.com/checkout/callback'

      ])

  );

  echo 'Payment created: ' . $payment->getId();

  // Handle the payment response (e.g., redirect URL)



} catch (\Exception $e) {

  echo 'Error creating payment: ' . $e->getMessage();

}

?>
```

```python
import Monei

from Monei import CreatePaymentRequest, PaymentCustomer



# Initialize with Partner API Key

monei = Monei.MoneiClient(api_key='<PARTNER_API_KEY>')



# Set Account ID and User-Agent for the specific merchant

monei.set_account_id('<MONEI_ACCOUNT_ID>')
monei.set_user_agent('MONEI/<PARTNER_NAME>/0.1.0')



try:

    payment = monei.payments.create(

        CreatePaymentRequest(

            amount=110,

            currency="EUR",

            order_id="14379133960355",

            description="Test Shop - #14379133960355",

            customer=PaymentCustomer(

                email="email@example.com"

            ),

            callback_url="https://example.com/checkout/callback"

        )

    )

    print(f'Payment created: {payment.id}')

    # Handle the payment response (e.g., redirect URL)

except Exception as e:

    print(f'Error creating payment: {e}')
```

--------------------------------

### Cardholder Email Example

Source: https://docs.monei.com/apis/rest/schemas/cardholderemail

This is an example of a valid cardholder email address. Ensure the email is correctly formatted.

```json
"john.doe@monei.com"
```

--------------------------------

### Initialize and render the Bizum component

Source: https://docs.monei.com/monei-js/reference

Create a Bizum instance with required payment configuration and render it to a DOM element.

```javascript
const bizum = monei.Bizum({

  paymentId: 'af6029f80f5fc73a8ad2753eea0b1be0',

  onSubmit(result) {

    if (result.error) {

      // Inform the user if there was an error.

    } else {

      // result.paymentMethod === 'bizum'

      // Confirm payment using the token.

      moneiTokenHandler(result.token);

    }

  },

  onError(error) {

    console.log(error);

  },

  ...otherOptions

});



// render Component on the page

bizum.render('#bizum');
```

--------------------------------

### SourceVersion String Example

Source: https://docs.monei.com/apis/rest/schemas/sourceversion

Represents the version of the source component. Use this to indicate the specific version of the SDK or component from which an operation was generated.

```string
"0.1.2"
```

--------------------------------

### Initialize and Render PayPal Component

Source: https://docs.monei.com/monei-js/reference

Create a PayPal component instance with required payment options and render it to a container.

```javascript
const paypal = monei.PayPal({

  paymentId: 'af6029f80f5fc73a8ad2753eea0b1be0',

  onSubmit(result) {

    if (result.error) {

      // Inform the user if there was an error.

    } else {

      // result.paymentMethod === 'paypal'

      // Confirm payment using the token.

      moneiTokenHandler(result.token);

    }

  },

  onError(error) {

    console.log(error);

  },

  ...otherOptions

});



// render Component on the page

paypal.render('#paypal_container');
```

--------------------------------

### Subscription Event Payload Example

Source: https://docs.monei.com/monei-connect

Example JSON structure for a subscription.activated event where the object field represents a Subscription.

```json
{

  "id": "evt_…",

  "type": "subscription.activated",

  "objectType": "subscription",

  "objectId": "sub_…",

  "accountId": "<MERCHANT_SUB_ACCOUNT_ID>",

  "livemode": true,

  "createdAt": 1748390400,

  "object": {

    "id": "sub_…",

    "amount": 999,

    "currency": "EUR",

    "interval": "month",

    "intervalCount": 1,

    "status": "ACTIVE",

    "nextPaymentAt": 1751068800,

    "customer": {"email": "buyer@example.com"}

  }

}
```

--------------------------------

### Upgrade and compile Magento

Source: https://docs.monei.com/llms-full.txt

Run these commands to finalize the module installation and update the system state.

```bash
bin/magento setup:upgrade

bin/magento setup:di:compile

bin/magento setup:static-content:deploy

bin/magento cache:clean
```

--------------------------------

### Charge Event Payload Example

Source: https://docs.monei.com/monei-connect

Example JSON structure for a charge.succeeded event where the object field represents a Payment.

```json
{

  "id": "evt_5fda0f3b7b2f4e0d…",

  "type": "charge.succeeded",

  "objectType": "charge",

  "objectId": "ch_8e2f…",

  "accountId": "<MERCHANT_SUB_ACCOUNT_ID>",

  "livemode": true,

  "createdAt": 1748390400,

  "object": {

    "id": "ch_8e2f…",

    "amount": 1099,

    "currency": "EUR",

    "status": "SUCCEEDED",

    "orderId": "ORDER-4421",

    "customer": {"email": "buyer@example.com"},

    "paymentMethod": {"method": "card", "card": {"brand": "VISA", "last4": "4242"}}

  }

}
```

--------------------------------

### Activate Subscription with Payment Token (Python)

Source: https://docs.monei.com/subscriptions/build-custom-checkout

In your Python server's /activate-subscription route handler, use the MONEI library to activate a subscription. Pass the subscription ID and an ActivateSubscriptionRequest object containing the payment token and session ID.

```python
from Monei import ActivateSubscriptionRequest



# In your /activate-subscription route handler

activation = monei.subscriptions.activate(

    body["subscriptionId"],

    ActivateSubscriptionRequest(

        payment_token=body["paymentToken"],

        session_id=body["sessionId"]

    )

)
```

--------------------------------

### Payment Order ID Example

Source: https://docs.monei.com/apis/rest/schemas/payment-orderid

An example of a Payment Order ID. This is a string representing a unique identifier from your system.

```text
"14379133960355"
```

--------------------------------

### monei.Bizum(options)

Source: https://docs.monei.com/llms-full.txt

Initializes the Bizum component with the specified configuration options to handle payment processing.

```APIDOC
## monei.Bizum(options)

### Description
Creates an instance of the Bizum component to facilitate payments. The component requires a paymentId or accountId/sessionId configuration to function.

### Parameters
- **paymentId** (string) - Required* - Payment ID from the create payment API.
- **accountId** (string) - Required* - Your MONEI account ID.
- **sessionId** (string) - Conditional - Unique session ID, required with accountId.
- **phoneNumber** (string) - Optional - Pre-fill customer phone number.
- **amount** (number) - Conditional - Amount in smallest currency unit, required with accountId.
- **currency** (string) - Conditional - ISO currency code, required with accountId.
- **transactionType** ('SALE' | 'AUTH') - Optional - Controls fund capture timing.
- **fullscreen** (boolean) - Optional - Enables fullscreen payment window.
- **language** (string) - Optional - ISO 639-1 language code.

### Methods
- **render(selector)** - Renders the Bizum component into the specified DOM element.

### Example
```javascript
const bizum = monei.Bizum({
  paymentId: 'af6029f80f5fc73a8ad2753eea0b1be0',
  onSubmit(result) {
    if (!result.error) {
      moneiTokenHandler(result.token);
    }
  },
  onError(error) {
    console.log(error);
  }
});
bizum.render('#bizum');
```
```

--------------------------------

### Livemode Example: False

Source: https://docs.monei.com/apis/rest/schemas/livemode

Demonstrates the value for livemode when a resource is in test mode.

```text
false
```

--------------------------------

### NotFoundError Example

Source: https://docs.monei.com/apis/rest/schemas/notfounderror

This is an example of a NotFoundError response. It indicates that a requested resource could not be found and provides details about the request.

```json
{
  "status": "NotFoundError",
  "statusCode": 404,
  "message": "Resource not found",
  "requestId": "df011689-bd3e-4953-95ca-c7bbdacaf6f8",
  "requestTime": "2025-03-05T10:25:52Z"
}
```

--------------------------------

### SendSubscriptionStatusRequest Example

Source: https://docs.monei.com/apis/rest/schemas/sendsubscriptionstatusrequest

An example of the SendSubscriptionStatusRequest JSON payload. Use this structure when initiating a request to send subscription status information.

```json
{

  "customerEmail": "user@example.com",

  "customerPhone": "string",

  "channel": "EMAIL",

  "language": "string"

}
```
Tokens:
Raw