# MONEI Documentation

> Explore our guides and examples to integrate MONEI.

- [MONEI Documentation](https://docs.monei.com/index.md)

## search

- [Search the documentation](https://docs.monei.com/search.md)

## accounting

- [Odoo](https://docs.monei.com/accounting/odoo.md): Learn how to integrate MONEI with Odoo using our official free app to manage payments, orders, and transactions directly from your Odoo instance.

## apis

- [MONEI GraphQL API](https://docs.monei.com/apis/graphql.md): With MONEI GraphQL API you have full access to all MONEI features.
- [defer](https://docs.monei.com/apis/graphql/operations/directives/defer.md): This directive allows results to be deferred during execution
- [include](https://docs.monei.com/apis/graphql/operations/directives/include.md): Directs the executor to include this field or fragment only when the if argument is true.
- [skip](https://docs.monei.com/apis/graphql/operations/directives/skip.md): Directs the executor to skip this field or fragment when the if argument is true.
- [activateAccount](https://docs.monei.com/apis/graphql/operations/mutations/activate-account.md): Requests approval for the account
- [activateApplePayCert](https://docs.monei.com/apis/graphql/operations/mutations/activate-apple-pay-cert.md): Activate Custom Apple Pay certificate
- [activateSubscription](https://docs.monei.com/apis/graphql/operations/mutations/activate-subscription.md): Active a subscription
- [addBlacklistItem](https://docs.monei.com/apis/graphql/operations/mutations/add-blacklist-item.md): Add a new item to the blacklist
- [cancelPayment](https://docs.monei.com/apis/graphql/operations/mutations/cancel-payment.md): Cancel a payment
- [cancelSubscription](https://docs.monei.com/apis/graphql/operations/mutations/cancel-subscription.md): Schedule a subscription
- [capturePayment](https://docs.monei.com/apis/graphql/operations/mutations/capture-payment.md): Capture a payment
- [connectMasterAccount](https://docs.monei.com/apis/graphql/operations/mutations/connect-master-account.md): Connect master account
- [connectShopifyShop](https://docs.monei.com/apis/graphql/operations/mutations/connect-shopify-shop.md): Connect a Shopify shop to an account
- [createAccount](https://docs.monei.com/apis/graphql/operations/mutations/create-account.md): Creates a new additional account attached to this account
- [createApiKey](https://docs.monei.com/apis/graphql/operations/mutations/create-api-key.md): Generates the API Key to access REST and GraphQL APIs
- [createApplePayCert](https://docs.monei.com/apis/graphql/operations/mutations/create-apple-pay-cert.md): Create Custom Apple Pay certificate
- [createAuthorizedUser](https://docs.monei.com/apis/graphql/operations/mutations/create-authorized-user.md): Creates an authorized user
- [createBankSession](https://docs.monei.com/apis/graphql/operations/mutations/create-bank-session.md): Create a new bank session
- [createCapitalEmbedToken](https://docs.monei.com/apis/graphql/operations/mutations/create-capital-embed-token.md): Create a MONEI Capital embed token to initialize their embedded UI
- [createCapitalLead](https://docs.monei.com/apis/graphql/operations/mutations/create-capital-lead.md): Create a MONEI Capital loan application for an accepted offer
- [createDocumentSession](https://docs.monei.com/apis/graphql/operations/mutations/create-document-session.md): Create a new document session
- [createDocument](https://docs.monei.com/apis/graphql/operations/mutations/create-document.md): Create new document
- [createExportSftpConfig](https://docs.monei.com/apis/graphql/operations/mutations/create-export-sftp-config.md): Create a new SFTP config export
- [createIdSession](https://docs.monei.com/apis/graphql/operations/mutations/create-id-session.md): Creates Identity Verification Session
- [createPayPalLink](https://docs.monei.com/apis/graphql/operations/mutations/create-pay-pal-link.md): Creates a link to connect PayPal account
- [createPaymentRule](https://docs.monei.com/apis/graphql/operations/mutations/create-payment-rule.md): Create a new payment rule
- [createPayment](https://docs.monei.com/apis/graphql/operations/mutations/create-payment.md): Create a payment
- [createPointOfSale](https://docs.monei.com/apis/graphql/operations/mutations/create-point-of-sale.md): Creates a new point of sale
- [createProvider](https://docs.monei.com/apis/graphql/operations/mutations/create-provider.md): Creates a new provider for the account
- [createStore](https://docs.monei.com/apis/graphql/operations/mutations/create-store.md): Creates a new store
- [createSubscription](https://docs.monei.com/apis/graphql/operations/mutations/create-subscription.md): Create a new subscription
- [createWebhook](https://docs.monei.com/apis/graphql/operations/mutations/create-webhook.md): Create new webhook
- [deleteApiKey](https://docs.monei.com/apis/graphql/operations/mutations/delete-api-key.md): Deletes the API Key
- [deleteApplePayCert](https://docs.monei.com/apis/graphql/operations/mutations/delete-apple-pay-cert.md): Delete Custom Apple Pay certificate
- [deleteAuthorizedUser](https://docs.monei.com/apis/graphql/operations/mutations/delete-authorized-user.md): Deletes an authorized user
- [deleteBlacklistItem](https://docs.monei.com/apis/graphql/operations/mutations/delete-blacklist-item.md): Delete blacklist item
- [deleteCode](https://docs.monei.com/apis/graphql/operations/mutations/delete-code.md): Deletes an existing code
- [deleteDocument](https://docs.monei.com/apis/graphql/operations/mutations/delete-document.md): Delete a document
- [deleteExportSftpConfig](https://docs.monei.com/apis/graphql/operations/mutations/delete-export-sftp-config.md): Delete a SFTP config export
- [deletePaymentRule](https://docs.monei.com/apis/graphql/operations/mutations/delete-payment-rule.md): Delete a payment rule
- [deletePointOfSale](https://docs.monei.com/apis/graphql/operations/mutations/delete-point-of-sale.md): Deletes an existing point of sale
- [deleteProvider](https://docs.monei.com/apis/graphql/operations/mutations/delete-provider.md): Deletes a provider
- [deleteStore](https://docs.monei.com/apis/graphql/operations/mutations/delete-store.md): Deletes a store
- [deleteWebhook](https://docs.monei.com/apis/graphql/operations/mutations/delete-webhook.md): Delete webhook
- [disableCustomDomain](https://docs.monei.com/apis/graphql/operations/mutations/disable-custom-domain.md): Deletes a custom domain
- [disableTokenizationMethod](https://docs.monei.com/apis/graphql/operations/mutations/disable-tokenization-method.md): Disable the selected tokenization method for the account
- [disconnectMasterAccount](https://docs.monei.com/apis/graphql/operations/mutations/disconnect-master-account.md): Disconnect master account
- [downloadAccountInvoice](https://docs.monei.com/apis/graphql/operations/mutations/download-account-invoice.md): Downloads account invoice
- [downloadContract](https://docs.monei.com/apis/graphql/operations/mutations/download-contract.md): Downloads account contract
- [downloadDocument](https://docs.monei.com/apis/graphql/operations/mutations/download-document.md): Create a download url for a document
- [downloadExport](https://docs.monei.com/apis/graphql/operations/mutations/download-export.md): Download the export of a charges
- [downloadOperationsFile](https://docs.monei.com/apis/graphql/operations/mutations/download-operations-file.md): Downloads a file with the fees per transaction of a settlement
- [enableCustomDomain](https://docs.monei.com/apis/graphql/operations/mutations/enable-custom-domain.md): Creates a custom domain
- [enableProvider](https://docs.monei.com/apis/graphql/operations/mutations/enable-provider.md): Updates the status of an existing provider
- [enableTokenizationMethod](https://docs.monei.com/apis/graphql/operations/mutations/enable-tokenization-method.md): Enable the selected tokenization method for the account
- [exportCharges](https://docs.monei.com/apis/graphql/operations/mutations/export-charges.md): Export a list of charges
- [pauseSubscription](https://docs.monei.com/apis/graphql/operations/mutations/pause-subscription.md): Pause a subscription
- [publishUpdateAccount](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-account.md): Private. For onUpdateAccount subscription.
- [publishUpdateAnalytics](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-analytics.md): Private. For onUpdateAnalytics subscription.
- [publishUpdateChargeEventsV2](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-charge-events-v2.md): Private. For onUpdateChargeEventsV2 subscription.
- [publishUpdateChargeEvents](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-charge-events.md): Use publishUpdateChargeEventsV2 instead
- [publishUpdateChargeV2](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-charge-v2.md): Private. For onUpdateChargeV2 subscription.
- [publishUpdateCharge](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-charge.md): Use publishUpdateChargeV2 instead
- [publishUpdateCharges](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-charges.md): Private. For onUpdateCharges subscription.
- [publishUpdateDocuments](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-documents.md): Private. For onUpdateDocuments subscription.
- [publishUpdateEvents](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-events.md): Private. For onUpdateEvents subscription.
- [publishUpdateSubscriptionEventsV2](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-subscription-events-v2.md): Private. For onUpdateSubscriptionEventsV2 subscription.
- [publishUpdateSubscriptionEvents](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-subscription-events.md): Use publishUpdateSubscriptionEventsV2 instead
- [publishUpdateSubscription](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-subscription.md): Private. For onUpdateSubscriptionV2 subscription.
- [publishUpdateSubscriptions](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-subscriptions.md): Private. For onUpdateSubscriptions subscription.
- [publishUpdateWebReport](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-web-report.md): Private. For onUpdateWebReport subscription.
- [refundPayment](https://docs.monei.com/apis/graphql/operations/mutations/refund-payment.md): Refund a payment
- [registerApplePayDomain](https://docs.monei.com/apis/graphql/operations/mutations/register-apple-pay-domain.md): Register domain name for Apple Pay
- [registerCode](https://docs.monei.com/apis/graphql/operations/mutations/register-code.md): Registers a new code
- [requestAccountReview](https://docs.monei.com/apis/graphql/operations/mutations/request-account-review.md): Request for account review after additional information has been provided
- [resumeSubscription](https://docs.monei.com/apis/graphql/operations/mutations/resume-subscription.md): Resume a subscription
- [selectUserAccount](https://docs.monei.com/apis/graphql/operations/mutations/select-user-account.md): Selects user account
- [sendPaymentLink](https://docs.monei.com/apis/graphql/operations/mutations/send-payment-link.md): Send a payment link over email (or sms)
- [sendPaymentReceipt](https://docs.monei.com/apis/graphql/operations/mutations/send-payment-receipt.md): Send a payment receipt over email
- [sendPaymentRequest](https://docs.monei.com/apis/graphql/operations/mutations/send-payment-request.md): Send a request to pay
- [sendSubscriptionLink](https://docs.monei.com/apis/graphql/operations/mutations/send-subscription-link.md): Send a subscription link over email (or sms)
- [sendSubscriptionStatus](https://docs.monei.com/apis/graphql/operations/mutations/send-subscription-status.md): Send a subscription status over email (or sms)
- [setDefaultCardProvider](https://docs.monei.com/apis/graphql/operations/mutations/set-default-card-provider.md): Updates existing card provider to make it the only one enabled
- [setupAccount](https://docs.monei.com/apis/graphql/operations/mutations/setup-account.md): Updates the account information during KYC process
- [startCompanyLookup](https://docs.monei.com/apis/graphql/operations/mutations/start-company-lookup.md): Lookup company in the registry
- [startExportCharges](https://docs.monei.com/apis/graphql/operations/mutations/start-export-charges.md): Start the export of a list of charges
- [updateAccount](https://docs.monei.com/apis/graphql/operations/mutations/update-account.md): Updates the account information
- [updateApplePayCert](https://docs.monei.com/apis/graphql/operations/mutations/update-apple-pay-cert.md): Update Custom Apple Pay certificate
- [updateAuthorizedUser](https://docs.monei.com/apis/graphql/operations/mutations/update-authorized-user.md): Updates an authorized user
- [updateCode](https://docs.monei.com/apis/graphql/operations/mutations/update-code.md): Updates an existing code
- [updateExportSftpConfig](https://docs.monei.com/apis/graphql/operations/mutations/update-export-sftp-config.md): Update a SFTP config export
- [updatePaymentRule](https://docs.monei.com/apis/graphql/operations/mutations/update-payment-rule.md): Update a payment rule
- [updatePointOfSale](https://docs.monei.com/apis/graphql/operations/mutations/update-point-of-sale.md): Updates an existing point of sale
- [updateProvider](https://docs.monei.com/apis/graphql/operations/mutations/update-provider.md): Updates an existing provider
- [updateShopifyShopSettings](https://docs.monei.com/apis/graphql/operations/mutations/update-shopify-shop-settings.md): Update Shopify shop settings
- [updateStore](https://docs.monei.com/apis/graphql/operations/mutations/update-store.md): Updates an existing store
- [updateSubscription](https://docs.monei.com/apis/graphql/operations/mutations/update-subscription.md): Schedule a subscription
- [updateWebhook](https://docs.monei.com/apis/graphql/operations/mutations/update-webhook.md): Update webhook
- [uploadDocument](https://docs.monei.com/apis/graphql/operations/mutations/upload-document.md): Create an upload url for a document
- [validateWebsite](https://docs.monei.com/apis/graphql/operations/mutations/validate-website.md): Validate a website.
- [verifyBusinessDetails](https://docs.monei.com/apis/graphql/operations/mutations/verify-business-details.md): Verifies information about the business and updates it
- [verifyCustomDomain](https://docs.monei.com/apis/graphql/operations/mutations/verify-custom-domain.md): Verifies a custom domain
- [accountBalances](https://docs.monei.com/apis/graphql/operations/queries/account-balances.md): List of the account balances
- [accountInvoice](https://docs.monei.com/apis/graphql/operations/queries/account-invoice.md): A single account invoice
- [accountInvoices](https://docs.monei.com/apis/graphql/operations/queries/account-invoices.md): List of the account invoices
- [accountSettlement](https://docs.monei.com/apis/graphql/operations/queries/account-settlement.md): A single account settlement
- [accountSettlements](https://docs.monei.com/apis/graphql/operations/queries/account-settlements.md): List of the account settlements
- [account](https://docs.monei.com/apis/graphql/operations/queries/account.md): Account information
- [applePayCert](https://docs.monei.com/apis/graphql/operations/queries/apple-pay-cert.md): Get Custom Apple Pay certificate by ID
- [applePayCerts](https://docs.monei.com/apis/graphql/operations/queries/apple-pay-certs.md): List of Custom Apple Pay certificates
- [authorizedUsers](https://docs.monei.com/apis/graphql/operations/queries/authorized-users.md): List of the authorized users
- [availablePaymentMethods](https://docs.monei.com/apis/graphql/operations/queries/available-payment-methods.md): Lists all the available payment methods
- [availableProcessors](https://docs.monei.com/apis/graphql/operations/queries/available-processors.md): Lists all the available processors for the payment method
- [banks](https://docs.monei.com/apis/graphql/operations/queries/banks.md): List of available banks for Bank Account Verification
- [blacklistItem](https://docs.monei.com/apis/graphql/operations/queries/blacklist-item.md): Get blacklist item by value
- [blacklistItems](https://docs.monei.com/apis/graphql/operations/queries/blacklist-items.md): List of the blacklist items
- [chargeEvents](https://docs.monei.com/apis/graphql/operations/queries/charge-events.md): List of the charge events
- [chargeSources](https://docs.monei.com/apis/graphql/operations/queries/charge-sources.md): List of possible charge sources
- [charge](https://docs.monei.com/apis/graphql/operations/queries/charge.md): A single charge
- [chargesDateRangeKPI](https://docs.monei.com/apis/graphql/operations/queries/charges-date-range-kpi.md): Get charges KPI for a date range
- [chargesExport](https://docs.monei.com/apis/graphql/operations/queries/charges-export.md): No description
- [chargesExports](https://docs.monei.com/apis/graphql/operations/queries/charges-exports.md): No description
- [charges](https://docs.monei.com/apis/graphql/operations/queries/charges.md): List of the charges
- [code](https://docs.monei.com/apis/graphql/operations/queries/code.md): A single code
- [codes](https://docs.monei.com/apis/graphql/operations/queries/codes.md): Lists all the codes of the account
- [countries](https://docs.monei.com/apis/graphql/operations/queries/countries.md): Returns all the countries and the user's current country
- [document](https://docs.monei.com/apis/graphql/operations/queries/document.md): No description
- [documents](https://docs.monei.com/apis/graphql/operations/queries/documents.md): No description
- [events](https://docs.monei.com/apis/graphql/operations/queries/events.md): List of application events
- [exportSftpConfig](https://docs.monei.com/apis/graphql/operations/queries/export-sftp-config.md): No description
- [exportSftpConfigs](https://docs.monei.com/apis/graphql/operations/queries/export-sftp-configs.md): No description
- [getCapitalDataByAccount](https://docs.monei.com/apis/graphql/operations/queries/get-capital-data-by-account.md): Get MONEI Capital data (offer and lead) for an account
- [getCapitalLoanDocument](https://docs.monei.com/apis/graphql/operations/queries/get-capital-loan-document.md): Get a MONEI Capital loan document
- [getCapitalLoanRepayments](https://docs.monei.com/apis/graphql/operations/queries/get-capital-loan-repayments.md): Get MONEI Capital loan repayments
- [getCapitalLoan](https://docs.monei.com/apis/graphql/operations/queries/get-capital-loan.md): Get a specific MONEI Capital loan by ID
- [getCapitalLoans](https://docs.monei.com/apis/graphql/operations/queries/get-capital-loans.md): Get MONEI Capital loans for an account
- [getShopifyShopSettings](https://docs.monei.com/apis/graphql/operations/queries/get-shopify-shop-settings.md): Get Shopify shop settings
- [liveAccount](https://docs.monei.com/apis/graphql/operations/queries/live-account.md): Live account information, returns production account regardless of the environment
- [notificationsPortalUrl](https://docs.monei.com/apis/graphql/operations/queries/notifications-portal-url.md): Link to account notifications preferences
- [paymentEmailPreview](https://docs.monei.com/apis/graphql/operations/queries/payment-email-preview.md): Use previewPaymentEmail instead
- [paymentRule](https://docs.monei.com/apis/graphql/operations/queries/payment-rule.md): Get payment rule by ID
- [paymentRules](https://docs.monei.com/apis/graphql/operations/queries/payment-rules.md): List payment rules filtered by account and rule type
- [pointOfSale](https://docs.monei.com/apis/graphql/operations/queries/point-of-sale.md): A single point of sale
- [pointsOfSale](https://docs.monei.com/apis/graphql/operations/queries/points-of-sale.md): Lists all the points of sale of the account or store
- [posAuthToken](https://docs.monei.com/apis/graphql/operations/queries/pos-auth-token.md): No description
- [previewPaymentEmail](https://docs.monei.com/apis/graphql/operations/queries/preview-payment-email.md): Preview payment email
- [previewSubscriptionEmail](https://docs.monei.com/apis/graphql/operations/queries/preview-subscription-email.md): Preview subscription email
- [providerConfig](https://docs.monei.com/apis/graphql/operations/queries/provider-config.md): Returns the configuration options for the provider
- [provider](https://docs.monei.com/apis/graphql/operations/queries/provider.md): A single provider
- [providers](https://docs.monei.com/apis/graphql/operations/queries/providers.md): Lists all the providers of the account
- [settlementEvents](https://docs.monei.com/apis/graphql/operations/queries/settlement-events.md): Events timeline of a settlement
- [shopifyStores](https://docs.monei.com/apis/graphql/operations/queries/shopify-stores.md): Lists all Shopify stores for the account
- [store](https://docs.monei.com/apis/graphql/operations/queries/store.md): A single store
- [stores](https://docs.monei.com/apis/graphql/operations/queries/stores.md): Lists all the stores of the account
- [subscriptionEmailPreview](https://docs.monei.com/apis/graphql/operations/queries/subscription-email-preview.md): Use previewSubscriptionEmail instead
- [subscriptionEvents](https://docs.monei.com/apis/graphql/operations/queries/subscription-events.md): List of the subscriptions events
- [subscription](https://docs.monei.com/apis/graphql/operations/queries/subscription.md): A single subscription
- [subscriptions](https://docs.monei.com/apis/graphql/operations/queries/subscriptions.md): List of the subscriptions
- [userAccounts](https://docs.monei.com/apis/graphql/operations/queries/user-accounts.md): List of user accounts
- [userEvents](https://docs.monei.com/apis/graphql/operations/queries/user-events.md): List of the user events
- [userPointOfSale](https://docs.monei.com/apis/graphql/operations/queries/user-point-of-sale.md): Point of sale attached to the logged in user
- [userStore](https://docs.monei.com/apis/graphql/operations/queries/user-store.md): Store attached to the logged in user
- [webReport](https://docs.monei.com/apis/graphql/operations/queries/web-report.md): Get a web report.
- [webhook](https://docs.monei.com/apis/graphql/operations/queries/webhook.md): No description
- [webhooks](https://docs.monei.com/apis/graphql/operations/queries/webhooks.md): No description
- [zendeskAuthToken](https://docs.monei.com/apis/graphql/operations/queries/zendesk-auth-token.md): No description
- [onUpdateAccountV2](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-account-v2.md): Notifies about Account updates
- [onUpdateAccount](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-account.md): Use onUpdateAccountV2 instead
- [onUpdateAnalyticsV2](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-analytics-v2.md): Notifies new Analytics
- [onUpdateAnalytics](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-analytics.md): Use onUpdateAnalyticsV2 instead
- [onUpdateChargeEventsV2](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-charge-events-v2.md): Notifies new Events for one Charge
- [onUpdateChargeEvents](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-charge-events.md): Use onUpdateChargeEventsV2 instead
- [onUpdateChargeV2](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-charge-v2.md): Notifies updates for one Charge
- [onUpdateCharge](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-charge.md): Use onUpdateChargeV2 instead
- [onUpdateChargesV2](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-charges-v2.md): Notifies creations and updates of Charges
- [onUpdateCharges](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-charges.md): Use onUpdateChargesV2 instead
- [onUpdateDocumentsV2](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-documents-v2.md): Notifies about Documents updates
- [onUpdateDocuments](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-documents.md): Use onUpdateDocumentsV2 instead
- [onUpdateEventsV2](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-events-v2.md): Notifies new Events
- [onUpdateEvents](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-events.md): Use onUpdateEventsV2 instead
- [onUpdateSubscriptionEventsV2](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-subscription-events-v2.md): Notifies new Events for one Subscription
- [onUpdateSubscriptionEvents](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-subscription-events.md): Use onUpdateSubscriptionEventsV2 instead
- [onUpdateSubscription](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-subscription.md): Notifies updates for one Subscription
- [onUpdateSubscriptions](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-subscriptions.md): Notifies about Subscriptions updates
- [onUpdateWebReport](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-web-report.md): Notifies creations and updates of Website Report
- [aws_api_key](https://docs.monei.com/apis/graphql/types/directives/aws-api-key.md): Tells the service this field/object has access authorized by an API key.
- [aws_auth](https://docs.monei.com/apis/graphql/types/directives/aws-auth.md): Directs the schema to enforce authorization on a field
- [aws_cognito_user_pools](https://docs.monei.com/apis/graphql/types/directives/aws-cognito-user-pools.md): Tells the service this field/object has access authorized by a Cognito User Pools token.
- [aws_iam](https://docs.monei.com/apis/graphql/types/directives/aws-iam.md): Tells the service this field/object has access authorized by sigv4 signing.
- [aws_lambda](https://docs.monei.com/apis/graphql/types/directives/aws-lambda.md): Tells the service this field/object has access authorized by a Lambda Authorizer.
- [aws_oidc](https://docs.monei.com/apis/graphql/types/directives/aws-oidc.md): Tells the service this field/object has access authorized by an OIDC token.
- [aws_publish](https://docs.monei.com/apis/graphql/types/directives/aws-publish.md): Tells the service which subscriptions will be published to when this mutation is called. This directive is deprecated use @aws_susbscribe directive instead.
- [aws_subscribe](https://docs.monei.com/apis/graphql/types/directives/aws-subscribe.md): Tells the service which mutation triggers this subscription.
- [deprecated](https://docs.monei.com/apis/graphql/types/directives/deprecated.md): Marks an element of a GraphQL schema as no longer supported.
- [oneOf](https://docs.monei.com/apis/graphql/types/directives/one-of.md): Indicates exactly one field must be supplied and this field must not be null.
- [specifiedBy](https://docs.monei.com/apis/graphql/types/directives/specified-by.md): Exposes a URL that specifies the behavior of this scalar.
- [AccountInvoicePaymentMethod](https://docs.monei.com/apis/graphql/types/enums/account-invoice-payment-method.md): Account invoice payment method
- [AccountInvoiceStatus](https://docs.monei.com/apis/graphql/types/enums/account-invoice-status.md): Account invoice status
- [AccountStatus](https://docs.monei.com/apis/graphql/types/enums/account-status.md): Account status
- [Acquirer](https://docs.monei.com/apis/graphql/types/enums/acquirer.md): No description
- [AuthPaymentMethodKlarna](https://docs.monei.com/apis/graphql/types/enums/auth-payment-method-klarna.md): No description
- [AuthorizedUserAccessLevel](https://docs.monei.com/apis/graphql/types/enums/authorized-user-access-level.md): Access level for the authorized user
- [AuthorizedUserStatus](https://docs.monei.com/apis/graphql/types/enums/authorized-user-status.md): A status of the authorized user
- [BankAccountStatus](https://docs.monei.com/apis/graphql/types/enums/bank-account-status.md): Bank account status
- [BillingCategoryKlarna](https://docs.monei.com/apis/graphql/types/enums/billing-category-klarna.md): No description
- [BillingPlans](https://docs.monei.com/apis/graphql/types/enums/billing-plans.md): MONEI Billing Plans
- [BlacklistItemType](https://docs.monei.com/apis/graphql/types/enums/blacklist-item-type.md): The type of the blacklist item
- [BusinessStatus](https://docs.monei.com/apis/graphql/types/enums/business-status.md): Account business status
- [CallbackStatus](https://docs.monei.com/apis/graphql/types/enums/callback-status.md): No description
- [CancellationReason](https://docs.monei.com/apis/graphql/types/enums/cancellation-reason.md): No description
- [CapitalLoanStatus](https://docs.monei.com/apis/graphql/types/enums/capital-loan-status.md): MONEI Capital loan status
- [CapitalLoanType](https://docs.monei.com/apis/graphql/types/enums/capital-loan-type.md): MONEI Capital loan type
- [CapitalOnboardingStatus](https://docs.monei.com/apis/graphql/types/enums/capital-onboarding-status.md): MONEI Capital onboarding status
- [CardBrand](https://docs.monei.com/apis/graphql/types/enums/card-brand.md): Possible card brands
- [CardRoutingActionType](https://docs.monei.com/apis/graphql/types/enums/card-routing-action-type.md): Card routing action type
- [CardType](https://docs.monei.com/apis/graphql/types/enums/card-type.md): Possible device types
- [ChargeStatus](https://docs.monei.com/apis/graphql/types/enums/charge-status.md): Charge status
- [CodeTypes](https://docs.monei.com/apis/graphql/types/enums/code-types.md): No description
- [CombinatorType](https://docs.monei.com/apis/graphql/types/enums/combinator-type.md): Combinator type for conditions
- [ContractStatus](https://docs.monei.com/apis/graphql/types/enums/contract-status.md): Account contract status
- [Currencies](https://docs.monei.com/apis/graphql/types/enums/currencies.md): Possible currencies
- [CustomDomainStatus](https://docs.monei.com/apis/graphql/types/enums/custom-domain-status.md): No description
- [DeviceType](https://docs.monei.com/apis/graphql/types/enums/device-type.md): No description
- [DocumentStatus](https://docs.monei.com/apis/graphql/types/enums/document-status.md): No description
- [DocumentType](https://docs.monei.com/apis/graphql/types/enums/document-type.md): No description
- [ExportStatus](https://docs.monei.com/apis/graphql/types/enums/export-status.md): No description
- [IdVerificationStatus](https://docs.monei.com/apis/graphql/types/enums/id-verification-status.md): Identity verification status
- [Industries](https://docs.monei.com/apis/graphql/types/enums/industries.md): Company industry
- [IntervalInput](https://docs.monei.com/apis/graphql/types/enums/interval-input.md): Subscription interval can only be set to minute and hour in test mode
- [Interval](https://docs.monei.com/apis/graphql/types/enums/interval.md): No description
- [LegalForm](https://docs.monei.com/apis/graphql/types/enums/legal-form.md): Business legal form
- [MessageChannel](https://docs.monei.com/apis/graphql/types/enums/message-channel.md): Available channels to send messages
- [MetadataItemType](https://docs.monei.com/apis/graphql/types/enums/metadata-item-type.md): No description
- [NextActionTypes](https://docs.monei.com/apis/graphql/types/enums/next-action-types.md): Next action types
- [NotConfiguredReason](https://docs.monei.com/apis/graphql/types/enums/not-configured-reason.md): No description
- [PaymentEmailType](https://docs.monei.com/apis/graphql/types/enums/payment-email-type.md): No description
- [PaymentMethodVisibilityActionType](https://docs.monei.com/apis/graphql/types/enums/payment-method-visibility-action-type.md): Payment method visibility action type
- [PaymentMethods](https://docs.monei.com/apis/graphql/types/enums/payment-methods.md): Possible payment methods
- [PaymentRuleType](https://docs.monei.com/apis/graphql/types/enums/payment-rule-type.md): Type of payment rule
- [PaymentStatus](https://docs.monei.com/apis/graphql/types/enums/payment-status.md): No description
- [PointOfSaleType](https://docs.monei.com/apis/graphql/types/enums/point-of-sale-type.md): Type of Point of Sale determining its capabilities and purpose.
- [Processor](https://docs.monei.com/apis/graphql/types/enums/processor.md): No description
- [RefundReason](https://docs.monei.com/apis/graphql/types/enums/refund-reason.md): No description
- [RejectedReason](https://docs.monei.com/apis/graphql/types/enums/rejected-reason.md): No description
- [RetryIntervalInput](https://docs.monei.com/apis/graphql/types/enums/retry-interval-input.md): Subscription retry interval can only be set to minute and hour in test mode
- [SettlementPayMethods](https://docs.monei.com/apis/graphql/types/enums/settlement-pay-methods.md): No description
- [SettlementStatus](https://docs.monei.com/apis/graphql/types/enums/settlement-status.md): No description
- [StatusReason](https://docs.monei.com/apis/graphql/types/enums/status-reason.md): The reason why the account status was changed
- [SubscriptionEmailType](https://docs.monei.com/apis/graphql/types/enums/subscription-email-type.md): No description
- [SubscriptionPaymentMethods](https://docs.monei.com/apis/graphql/types/enums/subscription-payment-methods.md): No description
- [SubscriptionStatus](https://docs.monei.com/apis/graphql/types/enums/subscription-status.md): No description
- [ThreeDSecureFlow](https://docs.monei.com/apis/graphql/types/enums/three-dsecure-flow.md): 3D Secure flows
- [TokenizationMethods](https://docs.monei.com/apis/graphql/types/enums/tokenization-methods.md): Possible tokenization methods for card payments
- [TransactionTypes](https://docs.monei.com/apis/graphql/types/enums/transaction-types.md): Controls when the funds will be captured.
- [UnitType](https://docs.monei.com/apis/graphql/types/enums/unit-type.md): Invoice line item unit type
- [WebReportStatus](https://docs.monei.com/apis/graphql/types/enums/web-report-status.md): No description
- [WebhookEventType](https://docs.monei.com/apis/graphql/types/enums/webhook-event-type.md): No description
- [AccountBrandingInput](https://docs.monei.com/apis/graphql/types/inputs/account-branding-input.md): Account branding input
- [AccountNotificationsInput](https://docs.monei.com/apis/graphql/types/inputs/account-notifications-input.md): Account notifications input
- [AccountPublicBusinessDetailsInput](https://docs.monei.com/apis/graphql/types/inputs/account-public-business-details-input.md): Account public business details input
- [ActivateApplePayCertInput](https://docs.monei.com/apis/graphql/types/inputs/activate-apple-pay-cert-input.md): No description
- [ActivateSubscriptionInput](https://docs.monei.com/apis/graphql/types/inputs/activate-subscription-input.md): No description
- [AddressInput](https://docs.monei.com/apis/graphql/types/inputs/address-input.md): No description
- [BlacklistItemInput](https://docs.monei.com/apis/graphql/types/inputs/blacklist-item-input.md): No description
- [BusinessDataInput](https://docs.monei.com/apis/graphql/types/inputs/business-data-input.md): Business data input
- [CancelPaymentInput](https://docs.monei.com/apis/graphql/types/inputs/cancel-payment-input.md): No description
- [CancelSubscriptionInput](https://docs.monei.com/apis/graphql/types/inputs/cancel-subscription-input.md): No description
- [CapturePaymentInput](https://docs.monei.com/apis/graphql/types/inputs/capture-payment-input.md): No description
- [ChargeEventsChangeInput](https://docs.monei.com/apis/graphql/types/inputs/charge-events-change-input.md): No description
- [ConnectShopifyShopInput](https://docs.monei.com/apis/graphql/types/inputs/connect-shopify-shop-input.md): No description
- [ContactDetailsInput](https://docs.monei.com/apis/graphql/types/inputs/contact-details-input.md): No description
- [CountryStoreInput](https://docs.monei.com/apis/graphql/types/inputs/country-store-input.md): No description
- [CreateAuthorizedUserInput](https://docs.monei.com/apis/graphql/types/inputs/create-authorized-user-input.md): No description
- [CreateDocumentInput](https://docs.monei.com/apis/graphql/types/inputs/create-document-input.md): No description
- [CreateExportSftpConfigInput](https://docs.monei.com/apis/graphql/types/inputs/create-export-sftp-config-input.md): No description
- [CreatePaymentInput](https://docs.monei.com/apis/graphql/types/inputs/create-payment-input.md): No description
- [CreatePaymentRuleInput](https://docs.monei.com/apis/graphql/types/inputs/create-payment-rule-input.md): Input for creating a payment rule
- [CreatePointOfSaleInput](https://docs.monei.com/apis/graphql/types/inputs/create-point-of-sale-input.md): No description
- [CreateProviderInput](https://docs.monei.com/apis/graphql/types/inputs/create-provider-input.md): No description
- [CreateStoreInput](https://docs.monei.com/apis/graphql/types/inputs/create-store-input.md): No description
- [CreateSubscriptionInput](https://docs.monei.com/apis/graphql/types/inputs/create-subscription-input.md): No description
- [CreateWebhookInput](https://docs.monei.com/apis/graphql/types/inputs/create-webhook-input.md): No description
- [CustomerInput](https://docs.monei.com/apis/graphql/types/inputs/customer-input.md): No description
- [GetShopifyShopSettingsInput](https://docs.monei.com/apis/graphql/types/inputs/get-shopify-shop-settings-input.md): No description
- [KeyValueInput](https://docs.monei.com/apis/graphql/types/inputs/key-value-input.md): No description
- [MetadataItemInput](https://docs.monei.com/apis/graphql/types/inputs/metadata-item-input.md): No description
- [PauseSubscriptionInput](https://docs.monei.com/apis/graphql/types/inputs/pause-subscription-input.md): No description
- [PaymentActionInput](https://docs.monei.com/apis/graphql/types/inputs/payment-action-input.md): Input for payment action
- [PaymentConditionInput](https://docs.monei.com/apis/graphql/types/inputs/payment-condition-input.md): Input for a single condition
- [PaymentConditionsInput](https://docs.monei.com/apis/graphql/types/inputs/payment-conditions-input.md): Input for payment conditions
- [PaymentMethodBizumInput](https://docs.monei.com/apis/graphql/types/inputs/payment-method-bizum-input.md): No description
- [PaymentMethodCardInput](https://docs.monei.com/apis/graphql/types/inputs/payment-method-card-input.md): No description
- [PaymentMethodCardPresentInput](https://docs.monei.com/apis/graphql/types/inputs/payment-method-card-present-input.md): No description
- [PaymentMethodInput](https://docs.monei.com/apis/graphql/types/inputs/payment-method-input.md): No description
- [PaymentMethodKlarnaInput](https://docs.monei.com/apis/graphql/types/inputs/payment-method-klarna-input.md): No description
- [PaymentMethodMBWayInput](https://docs.monei.com/apis/graphql/types/inputs/payment-method-mbway-input.md): No description
- [PaymentMethodPaypalInput](https://docs.monei.com/apis/graphql/types/inputs/payment-method-paypal-input.md): No description
- [PaymentMethodSepaInput](https://docs.monei.com/apis/graphql/types/inputs/payment-method-sepa-input.md): No description
- [PaymentMethodTrustlyInput](https://docs.monei.com/apis/graphql/types/inputs/payment-method-trustly-input.md): No description
- [ProviderRulesInput](https://docs.monei.com/apis/graphql/types/inputs/provider-rules-input.md): No description
- [RefundPaymentInput](https://docs.monei.com/apis/graphql/types/inputs/refund-payment-input.md): No description
- [RegisterApplePayDomainInput](https://docs.monei.com/apis/graphql/types/inputs/register-apple-pay-domain-input.md): No description
- [RegisterCodeInput](https://docs.monei.com/apis/graphql/types/inputs/register-code-input.md): No description
- [RepresentativeInput](https://docs.monei.com/apis/graphql/types/inputs/representative-input.md): Legal Representative input
- [ResumeSubscriptionInput](https://docs.monei.com/apis/graphql/types/inputs/resume-subscription-input.md): No description
- [RetryScheduleInput](https://docs.monei.com/apis/graphql/types/inputs/retry-schedule-input.md): No description
- [SearchableAccountInvoiceFilterInput](https://docs.monei.com/apis/graphql/types/inputs/searchable-account-invoice-filter-input.md): Filter for account invoices, currently only supports createdAt
- [SearchableAccountSettlementFilterInput](https://docs.monei.com/apis/graphql/types/inputs/searchable-account-settlement-filter-input.md): No description
- [SearchableBooleanFilterInput](https://docs.monei.com/apis/graphql/types/inputs/searchable-boolean-filter-input.md): No description
- [SearchableChargeFilterInput](https://docs.monei.com/apis/graphql/types/inputs/searchable-charge-filter-input.md): No description
- [SearchableEventFilterInput](https://docs.monei.com/apis/graphql/types/inputs/searchable-event-filter-input.md): No description
- [SearchableFloatFilterInput](https://docs.monei.com/apis/graphql/types/inputs/searchable-float-filter-input.md): No description
- [SearchableIDFilterInput](https://docs.monei.com/apis/graphql/types/inputs/searchable-idfilter-input.md): No description
- [SearchableIntFilterInput](https://docs.monei.com/apis/graphql/types/inputs/searchable-int-filter-input.md): No description
- [SearchableStringFilterInput](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input.md): No description
- [SearchableSubscriptionFilterInput](https://docs.monei.com/apis/graphql/types/inputs/searchable-subscription-filter-input.md): No description
- [SendPaymentMessageInput](https://docs.monei.com/apis/graphql/types/inputs/send-payment-message-input.md): No description
- [SendPaymentRequestInput](https://docs.monei.com/apis/graphql/types/inputs/send-payment-request-input.md): No description
- [SendSubscriptionMessageInput](https://docs.monei.com/apis/graphql/types/inputs/send-subscription-message-input.md): No description
- [SessionDetailsInput](https://docs.monei.com/apis/graphql/types/inputs/session-details-input.md): No description
- [SetupAccountInput](https://docs.monei.com/apis/graphql/types/inputs/setup-account-input.md): Setup account input
- [ShopInput](https://docs.monei.com/apis/graphql/types/inputs/shop-input.md): No description
- [SubscriptionEventsChangeInput](https://docs.monei.com/apis/graphql/types/inputs/subscription-events-change-input.md): No description
- [TraceDetailsInput](https://docs.monei.com/apis/graphql/types/inputs/trace-details-input.md): No description
- [UpdateAccountInput](https://docs.monei.com/apis/graphql/types/inputs/update-account-input.md): Update account input
- [UpdateApplePayCertInput](https://docs.monei.com/apis/graphql/types/inputs/update-apple-pay-cert-input.md): No description
- [UpdateAuthorizedUserInput](https://docs.monei.com/apis/graphql/types/inputs/update-authorized-user-input.md): No description
- [UpdateChargeInput](https://docs.monei.com/apis/graphql/types/inputs/update-charge-input.md): No description
- [UpdateCodeInput](https://docs.monei.com/apis/graphql/types/inputs/update-code-input.md): No description
- [UpdateExportSftpConfigInput](https://docs.monei.com/apis/graphql/types/inputs/update-export-sftp-config-input.md): No description
- [UpdatePaymentRuleInput](https://docs.monei.com/apis/graphql/types/inputs/update-payment-rule-input.md): Input for updating a payment rule
- [UpdatePointOfSaleInput](https://docs.monei.com/apis/graphql/types/inputs/update-point-of-sale-input.md): No description
- [UpdateProviderInput](https://docs.monei.com/apis/graphql/types/inputs/update-provider-input.md): No description
- [UpdateShopifyShopSettingsInput](https://docs.monei.com/apis/graphql/types/inputs/update-shopify-shop-settings-input.md): No description
- [UpdateStoreInput](https://docs.monei.com/apis/graphql/types/inputs/update-store-input.md): No description
- [UpdateSubscriptionInput](https://docs.monei.com/apis/graphql/types/inputs/update-subscription-input.md): No description
- [UpdateWebhookInput](https://docs.monei.com/apis/graphql/types/inputs/update-webhook-input.md): No description
- [UserEventsInput](https://docs.monei.com/apis/graphql/types/inputs/user-events-input.md): No description
- [AccountBalancesConnection](https://docs.monei.com/apis/graphql/types/objects/account-balances-connection.md): No description
- [AccountBalances](https://docs.monei.com/apis/graphql/types/objects/account-balances.md): No description
- [AccountBranding](https://docs.monei.com/apis/graphql/types/objects/account-branding.md): Account branding
- [AccountContract](https://docs.monei.com/apis/graphql/types/objects/account-contract.md): Account contract information
- [AccountInvoiceBusiness](https://docs.monei.com/apis/graphql/types/objects/account-invoice-business.md): Account invoice business details
- [AccountInvoiceLineItem](https://docs.monei.com/apis/graphql/types/objects/account-invoice-line-item.md): Account invoice line item
- [AccountInvoice](https://docs.monei.com/apis/graphql/types/objects/account-invoice.md): Invoice that MONEI issues to the account,
- [AccountInvoicesConnection](https://docs.monei.com/apis/graphql/types/objects/account-invoices-connection.md): Account invoices connection
- [AccountLevelUpdate](https://docs.monei.com/apis/graphql/types/objects/account-level-update.md): No description
- [AccountNotifications](https://docs.monei.com/apis/graphql/types/objects/account-notifications.md): Account notifications
- [AccountPaymentMethodsBizum](https://docs.monei.com/apis/graphql/types/objects/account-payment-methods-bizum.md): No description
- [AccountPaymentMethodsCreditCard](https://docs.monei.com/apis/graphql/types/objects/account-payment-methods-credit-card.md): No description
- [AccountPaymentMethods](https://docs.monei.com/apis/graphql/types/objects/account-payment-methods.md): No description
- [AccountPayoutTerms](https://docs.monei.com/apis/graphql/types/objects/account-payout-terms.md): Account payout terms
- [AccountPublicBusinessDetails](https://docs.monei.com/apis/graphql/types/objects/account-public-business-details.md): Account public business details
- [AccountSettlement](https://docs.monei.com/apis/graphql/types/objects/account-settlement.md): No description
- [AccountSettlementsConnection](https://docs.monei.com/apis/graphql/types/objects/account-settlements-connection.md): No description
- [AccountTokenizationMethodsClickToPayItem](https://docs.monei.com/apis/graphql/types/objects/account-tokenization-methods-click-to-pay-item.md): No description
- [AccountTokenizationMethodsItem](https://docs.monei.com/apis/graphql/types/objects/account-tokenization-methods-item.md): No description
- [AccountTokenizationMethods](https://docs.monei.com/apis/graphql/types/objects/account-tokenization-methods.md): No description
- [Account](https://docs.monei.com/apis/graphql/types/objects/account.md): Account information
- [ActivateAccount](https://docs.monei.com/apis/graphql/types/objects/activate-account.md): Account activation response
- [Address](https://docs.monei.com/apis/graphql/types/objects/address.md): Full address details
- [ApplePayCertificate](https://docs.monei.com/apis/graphql/types/objects/apple-pay-certificate.md): Custom Apple Pay Certificate needed to enable Apple Pay in the native iOS app.
- [AuthorizedUser](https://docs.monei.com/apis/graphql/types/objects/authorized-user.md): An authorized user that can access the MONEI dashboard.
- [AuthorizedUsersConnection](https://docs.monei.com/apis/graphql/types/objects/authorized-users-connection.md): No description
- [AvailablePaymentMethod](https://docs.monei.com/apis/graphql/types/objects/available-payment-method.md): No description
- [AvailableProcessor](https://docs.monei.com/apis/graphql/types/objects/available-processor.md): No description
- [BankAccount](https://docs.monei.com/apis/graphql/types/objects/bank-account.md): Bank account information
- [Bank](https://docs.monei.com/apis/graphql/types/objects/bank.md): No description
- [BlacklistItem](https://docs.monei.com/apis/graphql/types/objects/blacklist-item.md): Blacklist item, e.g. email, phone, ip, card, bin, fingerprint.
- [BlacklistItemsConnection](https://docs.monei.com/apis/graphql/types/objects/blacklist-items-connection.md): No description
- [BusinessData](https://docs.monei.com/apis/graphql/types/objects/business-data.md): Business details
- [CallbackData](https://docs.monei.com/apis/graphql/types/objects/callback-data.md): No description
- [CapitalAccountData](https://docs.monei.com/apis/graphql/types/objects/capital-account-data.md): MONEI Capital account data containing offer and optional lead information
- [CapitalLead](https://docs.monei.com/apis/graphql/types/objects/capital-lead.md): MONEI Capital lead information
- [CapitalLoanDefaultDetails](https://docs.monei.com/apis/graphql/types/objects/capital-loan-default-details.md): MONEI Capital loan default details
- [CapitalLoanDetails](https://docs.monei.com/apis/graphql/types/objects/capital-loan-details.md): MONEI Capital loan details
- [CapitalLoanDocumentItem](https://docs.monei.com/apis/graphql/types/objects/capital-loan-document-item.md): MONEI Capital loan document
- [CapitalLoanDocumentReference](https://docs.monei.com/apis/graphql/types/objects/capital-loan-document-reference.md): MONEI Capital loan document reference
- [CapitalLoanDocument](https://docs.monei.com/apis/graphql/types/objects/capital-loan-document.md): MONEI Capital loan document
- [CapitalLoanEarlyRenewalDetails](https://docs.monei.com/apis/graphql/types/objects/capital-loan-early-renewal-details.md): MONEI Capital loan early renewal details
- [CapitalLoanFundingDetails](https://docs.monei.com/apis/graphql/types/objects/capital-loan-funding-details.md): MONEI Capital loan funding details
- [CapitalLoanFundingPayment](https://docs.monei.com/apis/graphql/types/objects/capital-loan-funding-payment.md): MONEI Capital loan funding payment
- [CapitalLoanLead](https://docs.monei.com/apis/graphql/types/objects/capital-loan-lead.md): MONEI Capital loan lead information
- [CapitalLoanRepayment](https://docs.monei.com/apis/graphql/types/objects/capital-loan-repayment.md): MONEI Capital loan repayment information
- [CapitalLoanRepaymentsConnection](https://docs.monei.com/apis/graphql/types/objects/capital-loan-repayments-connection.md): MONEI Capital loan repayments connection
- [CapitalLoanThirdPartyReference](https://docs.monei.com/apis/graphql/types/objects/capital-loan-third-party-reference.md): MONEI Capital loan third party reference
- [CapitalLoanWriteOffDetails](https://docs.monei.com/apis/graphql/types/objects/capital-loan-write-off-details.md): MONEI Capital loan write off details
- [CapitalLoan](https://docs.monei.com/apis/graphql/types/objects/capital-loan.md): MONEI Capital loan information
- [CapitalLoansConnection](https://docs.monei.com/apis/graphql/types/objects/capital-loans-connection.md): MONEI Capital loans connection
- [CapitalOffer](https://docs.monei.com/apis/graphql/types/objects/capital-offer.md): MONEI Capital offer information
- [ChargeEventObject](https://docs.monei.com/apis/graphql/types/objects/charge-event-object.md): No description
- [ChargeEvent](https://docs.monei.com/apis/graphql/types/objects/charge-event.md): No description
- [ChargeEventsConnection](https://docs.monei.com/apis/graphql/types/objects/charge-events-connection.md): No description
- [Charge](https://docs.monei.com/apis/graphql/types/objects/charge.md): No description
- [ChargesConnection](https://docs.monei.com/apis/graphql/types/objects/charges-connection.md): No description
- [ChargesDateRangeKPI](https://docs.monei.com/apis/graphql/types/objects/charges-date-range-kpi.md): No description
- [ChargesDateRangeKPIRow](https://docs.monei.com/apis/graphql/types/objects/charges-date-range-kpirow.md): No description
- [ChargesDateRangeKPITotal](https://docs.monei.com/apis/graphql/types/objects/charges-date-range-kpitotal.md): No description
- [ChargesExport](https://docs.monei.com/apis/graphql/types/objects/charges-export.md): No description
- [ChargesExportsConnection](https://docs.monei.com/apis/graphql/types/objects/charges-exports-connection.md): No description
- [Code](https://docs.monei.com/apis/graphql/types/objects/code.md): No description
- [ConnectShopifyShopResult](https://docs.monei.com/apis/graphql/types/objects/connect-shopify-shop-result.md): No description
- [ContactDetails](https://docs.monei.com/apis/graphql/types/objects/contact-details.md): Contact details
- [Countries](https://docs.monei.com/apis/graphql/types/objects/countries.md): No description
- [CountryStore](https://docs.monei.com/apis/graphql/types/objects/country-store.md): No description
- [Country](https://docs.monei.com/apis/graphql/types/objects/country.md): No description
- [CustomDomainConfig](https://docs.monei.com/apis/graphql/types/objects/custom-domain-config.md): No description
- [Customer](https://docs.monei.com/apis/graphql/types/objects/customer.md): Customer details
- [DnsRecord](https://docs.monei.com/apis/graphql/types/objects/dns-record.md): No description
- [Document](https://docs.monei.com/apis/graphql/types/objects/document.md): No description
- [DocumentsConnection](https://docs.monei.com/apis/graphql/types/objects/documents-connection.md): No description
- [DownloadFile](https://docs.monei.com/apis/graphql/types/objects/download-file.md): No description
- [ExportCharges](https://docs.monei.com/apis/graphql/types/objects/export-charges.md): No description
- [ItemLevelUpdate](https://docs.monei.com/apis/graphql/types/objects/item-level-update.md): No description
- [KeyValueItem](https://docs.monei.com/apis/graphql/types/objects/key-value-item.md): No description
- [LastPayment](https://docs.monei.com/apis/graphql/types/objects/last-payment.md): No description
- [MetadataConfigItem](https://docs.monei.com/apis/graphql/types/objects/metadata-config-item.md): No description
- [MetadataItem](https://docs.monei.com/apis/graphql/types/objects/metadata-item.md): No description
- [NextAction](https://docs.monei.com/apis/graphql/types/objects/next-action.md): No description
- [PayPalLink](https://docs.monei.com/apis/graphql/types/objects/pay-pal-link.md): No description
- [PaymentAction](https://docs.monei.com/apis/graphql/types/objects/payment-action.md): Action for payment rule
- [PaymentCondition](https://docs.monei.com/apis/graphql/types/objects/payment-condition.md): Condition for payment rule
- [PaymentConditions](https://docs.monei.com/apis/graphql/types/objects/payment-conditions.md): Conditions for payment rule
- [PaymentMethodBizum](https://docs.monei.com/apis/graphql/types/objects/payment-method-bizum.md): Bizum payment method details
- [PaymentMethodCardPresent](https://docs.monei.com/apis/graphql/types/objects/payment-method-card-present.md): No description
- [PaymentMethodCard](https://docs.monei.com/apis/graphql/types/objects/payment-method-card.md): Card payment method details
- [PaymentMethodKlarna](https://docs.monei.com/apis/graphql/types/objects/payment-method-klarna.md): No description
- [PaymentMethodMBWay](https://docs.monei.com/apis/graphql/types/objects/payment-method-mbway.md): No description
- [PaymentMethodPaypal](https://docs.monei.com/apis/graphql/types/objects/payment-method-paypal.md): Paypal payment method details
- [PaymentMethodSepa](https://docs.monei.com/apis/graphql/types/objects/payment-method-sepa.md): No description
- [PaymentMethodTrustly](https://docs.monei.com/apis/graphql/types/objects/payment-method-trustly.md): No description
- [PaymentMethod](https://docs.monei.com/apis/graphql/types/objects/payment-method.md): Payment method details
- [PaymentRule](https://docs.monei.com/apis/graphql/types/objects/payment-rule.md): Payment rule
- [PaymentRulesConnection](https://docs.monei.com/apis/graphql/types/objects/payment-rules-connection.md): Connection type for paginated payment rules
- [Payment](https://docs.monei.com/apis/graphql/types/objects/payment.md): No description
- [Period](https://docs.monei.com/apis/graphql/types/objects/period.md): Account invoice period
- [PointOfSale](https://docs.monei.com/apis/graphql/types/objects/point-of-sale.md): No description
- [PointsOfSaleConnection](https://docs.monei.com/apis/graphql/types/objects/points-of-sale-connection.md): No description
- [ProviderConfig](https://docs.monei.com/apis/graphql/types/objects/provider-config.md): No description
- [ProviderRules](https://docs.monei.com/apis/graphql/types/objects/provider-rules.md): No description
- [Provider](https://docs.monei.com/apis/graphql/types/objects/provider.md): No description
- [Redirect](https://docs.monei.com/apis/graphql/types/objects/redirect.md): No description
- [RegisterApplePayDomain](https://docs.monei.com/apis/graphql/types/objects/register-apple-pay-domain.md): No description
- [Representative](https://docs.monei.com/apis/graphql/types/objects/representative.md): Account legal representative
- [RetrySchedule](https://docs.monei.com/apis/graphql/types/objects/retry-schedule.md): No description
- [SessionDetails](https://docs.monei.com/apis/graphql/types/objects/session-details.md): Session details
- [Session](https://docs.monei.com/apis/graphql/types/objects/session.md): No description
- [SettlementEventObject](https://docs.monei.com/apis/graphql/types/objects/settlement-event-object.md): No description
- [SettlementEvent](https://docs.monei.com/apis/graphql/types/objects/settlement-event.md): No description
- [SettlementEventsConnection](https://docs.monei.com/apis/graphql/types/objects/settlement-events-connection.md): No description
- [SftpConfigExport](https://docs.monei.com/apis/graphql/types/objects/sftp-config-export.md): No description
- [SftpConfigExportsConnection](https://docs.monei.com/apis/graphql/types/objects/sftp-config-exports-connection.md): No description
- [Shop](https://docs.monei.com/apis/graphql/types/objects/shop.md): Shop details
- [ShopifyShopSettings](https://docs.monei.com/apis/graphql/types/objects/shopify-shop-settings.md): No description
- [ShopifyStore](https://docs.monei.com/apis/graphql/types/objects/shopify-store.md): No description
- [ShopifyStoresConnection](https://docs.monei.com/apis/graphql/types/objects/shopify-stores-connection.md): No description
- [Store](https://docs.monei.com/apis/graphql/types/objects/store.md): No description
- [StoresConnection](https://docs.monei.com/apis/graphql/types/objects/stores-connection.md): No description
- [SubscriptionEventObject](https://docs.monei.com/apis/graphql/types/objects/subscription-event-object.md): No description
- [SubscriptionEvent](https://docs.monei.com/apis/graphql/types/objects/subscription-event.md): No description
- [SubscriptionEventsConnection](https://docs.monei.com/apis/graphql/types/objects/subscription-events-connection.md): No description
- [Subscription](https://docs.monei.com/apis/graphql/types/objects/subscription.md): No description
- [SubscriptionsConnection](https://docs.monei.com/apis/graphql/types/objects/subscriptions-connection.md): No description
- [TraceDetails](https://docs.monei.com/apis/graphql/types/objects/trace-details.md): No description
- [UpdateShopifyShopSettingsResult](https://docs.monei.com/apis/graphql/types/objects/update-shopify-shop-settings-result.md): No description
- [UploadFile](https://docs.monei.com/apis/graphql/types/objects/upload-file.md): No description
- [UserAccount](https://docs.monei.com/apis/graphql/types/objects/user-account.md): An account that can be accessed by the authorized user
- [UserAccountsConnection](https://docs.monei.com/apis/graphql/types/objects/user-accounts-connection.md): No description
- [UserEvent](https://docs.monei.com/apis/graphql/types/objects/user-event.md): No description
- [UserEventsConnection](https://docs.monei.com/apis/graphql/types/objects/user-events-connection.md): No description
- [WebReport](https://docs.monei.com/apis/graphql/types/objects/web-report.md): A web report is a report of the website.
- [Webhook](https://docs.monei.com/apis/graphql/types/objects/webhook.md): No description
- [WebhooksConnection](https://docs.monei.com/apis/graphql/types/objects/webhooks-connection.md): No description
- [AWSDateTime](https://docs.monei.com/apis/graphql/types/scalars/awsdate-time.md): The AWSDateTime scalar type provided by AWS AppSync, represents a valid ***extended*** ISO 8601 DateTime string. In other words, this scalar type accepts datetime strings of the form YYYY-MM-DDThhss.SSSZ.  The scalar can also accept "negative years" of the form -YYYY which correspond to years before 0000. For example, "**-2017-01-01T0000Z**" are both valid datetime strings.  The field after the two digit seconds field is a nanoseconds field. It can accept between 1 and 9 digits. So, for example, "**1970-01-01T1200.2Z**", "**1970-01-01T1200.277Z**" and "**1970-01-01T1200.123456789Z**" are all valid datetime strings.  The seconds and nanoseconds fields are optional (the seconds field must be specified if the nanoseconds field is to be used).  The time zone offset is compulsory for this scalar. The time zone offset must either be Z (representing the UTC time zone) or be in the format ±hhss. The seconds field in the timezone offset will be considered valid even though it is not part of the ISO 8601 standard.
- [AWSEmail](https://docs.monei.com/apis/graphql/types/scalars/awsemail.md): The AWSEmail scalar type provided by AWS AppSync, represents an Email address string that complies with RFC 822. For example, "**username@example.com**" is a valid Email address.
- [AWSIPAddress](https://docs.monei.com/apis/graphql/types/scalars/awsipaddress.md): The AWSIPAddress scalar type provided by AWS AppSync, represents a valid IPv4 or IPv6 address string.  IP addresses with subnet masks are considered valid. However, subnet masks are not necessary. For example, "**127.0.0.1**" and "**127.0.0.1/8**" are both considered valid IP Addresses.
- [AWSJSON](https://docs.monei.com/apis/graphql/types/scalars/awsjson.md): The AWSJSON scalar type provided by AWS AppSync, represents a JSON string that complies with RFC 8259.  Maps like "**{\\"upvotes\\" 1}**", "**{'a': 1}**" and "**Unquoted string**" will throw GraphQL validation errors.
- [AWSPhone](https://docs.monei.com/apis/graphql/types/scalars/awsphone.md): The AWSPhone scalar type provided by AWS AppSync, represents a valid Phone Number. Phone numbers are serialized and deserialized as Strings. Segments of the phone number may be whitespace delimited or hyphenated.  The number can specify a country code at the beginning. However, United States numbers without country codes are still considered to be valid.
- [AWSTimestamp](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp.md): The AWSTimestamp scalar type provided by AWS AppSync, represents the number of seconds that have elapsed since 1970-01-01T0000Z.  Timestamps are serialized and deserialized as integers. The minimum supported timestamp value is **-31557014167219200* which corresponds to -1000000000-01-01T0059:59.999999999Z.
- [Boolean](https://docs.monei.com/apis/graphql/types/scalars/boolean.md): The Boolean scalar type represents true or false.
- [Float](https://docs.monei.com/apis/graphql/types/scalars/float.md): The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
- [ID](https://docs.monei.com/apis/graphql/types/scalars/id.md): The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
- [Int](https://docs.monei.com/apis/graphql/types/scalars/int.md): The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
- [Long](https://docs.monei.com/apis/graphql/types/scalars/long.md): Long type
- [String](https://docs.monei.com/apis/graphql/types/scalars/string.md): The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
- [MONEI REST API](https://docs.monei.com/apis/rest.md): Complete reference documentation for the MONEI API. Includes representative code snippets and examples for our PHP and Node.js client libraries.
- [Apple Pay Certificate](https://docs.monei.com/apis/rest/apple-pay-certificate.md): Apple Pay Certificate
- [Activate Certificate](https://docs.monei.com/apis/rest/apple-pay-certificates-activate.md): Activates an Apple Pay certificate by uploading the signed certificate from Apple.
- [Create Certificate](https://docs.monei.com/apis/rest/apple-pay-certificates-create.md): Creates a new Apple Pay certificate by generating a Certificate Signing Request (CSR).
- [List Certificates](https://docs.monei.com/apis/rest/apple-pay-certificates-get-all.md): Retrieves all Apple Pay certificates for your account.
- [Get Certificate](https://docs.monei.com/apis/rest/apple-pay-certificates-get.md): Retrieves a specific Apple Pay certificate by its ID.
- [Delete Certificate](https://docs.monei.com/apis/rest/apple-pay-certificates-remove.md): Deletes an Apple Pay certificate.
- [Update Certificate](https://docs.monei.com/apis/rest/apple-pay-certificates-update.md): Updates an Apple Pay certificate's active status.
- [Register Domain](https://docs.monei.com/apis/rest/apple-pay-domain-register.md): Registers a domain with Apple Pay.
- [Apple Pay Domain](https://docs.monei.com/apis/rest/apple-pay-domain.md): Apple Pay Domain
- [Validate Phone](https://docs.monei.com/apis/rest/bizum-validate-phone.md): Validates if a phone number is registered with Bizum.
- [Bizum](https://docs.monei.com/apis/rest/bizum.md): Bizum
- [MONEI API v1](https://docs.monei.com/apis/rest/monei-api-v-1.md): The MONEI API is organized around REST principles. Our API is designed to be intuitive and developer-friendly.
- [Get Payment Methods](https://docs.monei.com/apis/rest/payment-methods-get.md): Retrieve available payment methods for an account or a specific payment.
- [Payment Methods](https://docs.monei.com/apis/rest/payment-methods.md): Payment Methods
- [Cancel Payment](https://docs.monei.com/apis/rest/payments-cancel.md): Releases reserved funds from a previously authorized payment. This endpoint can only
- [Capture Payment](https://docs.monei.com/apis/rest/payments-capture.md): Captures funds from a previously authorized payment. This endpoint can only
- [Confirm Payment](https://docs.monei.com/apis/rest/payments-confirm.md): Confirms a payment that was created without payment details. This endpoint can only be used with
- [Create Payment](https://docs.monei.com/apis/rest/payments-create.md): Creates a new payment with the specified parameters.
- [Get Payment](https://docs.monei.com/apis/rest/payments-get.md): Retrieves the complete details of an existing payment by its unique ID.
- [Recurring Payment](https://docs.monei.com/apis/rest/payments-recurring.md): Creates a subsequent charge using the payment details from a previous transaction.
- [Refund Payment](https://docs.monei.com/apis/rest/payments-refund.md): Returns funds from a completed payment back to the customer's original payment method.
- [Send Payment Link](https://docs.monei.com/apis/rest/payments-send-link.md): Sends a payment link to the customer through their preferred communication channel.
- [Send Payment Receipt](https://docs.monei.com/apis/rest/payments-send-receipt.md): Sends a payment receipt to the customer through their preferred communication channel.
- [Send Payment Request](https://docs.monei.com/apis/rest/payments-send-request.md): Sends a direct payment request to the customer's phone with smart channel selection.
- [Payments](https://docs.monei.com/apis/rest/payments.md): Payments
- [AccountId](https://docs.monei.com/apis/rest/schemas/accountid.md): MONEI Account identifier.
- [ActivateApplePayCertificateRequest](https://docs.monei.com/apis/rest/schemas/activateapplepaycertificaterequest.md)
- [ActivateSubscriptionRequest](https://docs.monei.com/apis/rest/schemas/activatesubscriptionrequest.md)
- [Address](https://docs.monei.com/apis/rest/schemas/address.md)
- [ApiException](https://docs.monei.com/apis/rest/schemas/apiexception.md)
- [ApplePayCertificate](https://docs.monei.com/apis/rest/schemas/applepaycertificate.md): An Apple Pay certificate for iOS app integration.
- [BadRequestError](https://docs.monei.com/apis/rest/schemas/badrequesterror.md)
- [Browser](https://docs.monei.com/apis/rest/schemas/browser.md): The browser used in this browser session (e.g., `Mobile Safari`).
- [BrowserAccept](https://docs.monei.com/apis/rest/schemas/browseraccept.md): Browser accept header.
- [BrowserColorDepth](https://docs.monei.com/apis/rest/schemas/browsercolordepth.md): The color depth of the browser session (e.g., `24`).
- [BrowserScreenHeight](https://docs.monei.com/apis/rest/schemas/browserscreenheight.md): The screen height of the browser session (e.g., `1152`).
- [BrowserScreenWidth](https://docs.monei.com/apis/rest/schemas/browserscreenwidth.md): The screen width of the browser session (e.g., `2048`).
- [BrowserTimezoneOffset](https://docs.monei.com/apis/rest/schemas/browsertimezoneoffset.md): The timezone offset of the browser session (e.g., `-120`).
- [BrowserVersion](https://docs.monei.com/apis/rest/schemas/browserversion.md): The version for the browser session (e.g., `13.1.1`).
- [CancelPaymentRequest](https://docs.monei.com/apis/rest/schemas/cancelpaymentrequest.md)
- [CancelSubscriptionRequest](https://docs.monei.com/apis/rest/schemas/cancelsubscriptionrequest.md)
- [CapturePaymentRequest](https://docs.monei.com/apis/rest/schemas/capturepaymentrequest.md)
- [CardholderEmail](https://docs.monei.com/apis/rest/schemas/cardholderemail.md): The cardholder's email address.
- [CardholderName](https://docs.monei.com/apis/rest/schemas/cardholdername.md): The cardholder's name, as stated in the credit card.
- [ConfirmPaymentRequest](https://docs.monei.com/apis/rest/schemas/confirmpaymentrequest.md)
- [Country](https://docs.monei.com/apis/rest/schemas/country.md): Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
- [CreatedAt](https://docs.monei.com/apis/rest/schemas/createdat.md): Time at which the resource was created. Measured in seconds since the Unix epoch.
- [CreatePaymentRequest](https://docs.monei.com/apis/rest/schemas/createpaymentrequest.md)
- [CreateSubscriptionRequest](https://docs.monei.com/apis/rest/schemas/createsubscriptionrequest.md)
- [DeviceModel](https://docs.monei.com/apis/rest/schemas/devicemodel.md): Information about the device used for the browser session (e.g., `iPhone`).
- [DeviceType](https://docs.monei.com/apis/rest/schemas/devicetype.md): Device type, could be `desktop`, `mobile`, `smartTV`, `tablet`.
- [DomainName](https://docs.monei.com/apis/rest/schemas/domainname.md): The domain name to register for Apple Pay.
- [InternalServerError](https://docs.monei.com/apis/rest/schemas/internalservererror.md)
- [IP](https://docs.monei.com/apis/rest/schemas/ip.md): The IP address where the operation originated.
- [Lang](https://docs.monei.com/apis/rest/schemas/lang.md): Two-letter language code ([ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1)).
- [Livemode](https://docs.monei.com/apis/rest/schemas/livemode.md): Has the value `true` if the resource exists in live mode or the value `false` if the resource exists in test mode.
- [Metadata](https://docs.monei.com/apis/rest/schemas/metadata.md): 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.
- [NotFoundError](https://docs.monei.com/apis/rest/schemas/notfounderror.md)
- [Os](https://docs.monei.com/apis/rest/schemas/os.md): Operation system (e.g., `iOS`).
- [OsVersion](https://docs.monei.com/apis/rest/schemas/osversion.md): Operation system version (e.g., `13.5.1`).
- [PauseSubscriptionRequest](https://docs.monei.com/apis/rest/schemas/pausesubscriptionrequest.md)
- [Payment-Amount](https://docs.monei.com/apis/rest/schemas/payment-amount.md): Amount intended to be collected by this payment. A positive integer
- [Payment-AuthorizationCode](https://docs.monei.com/apis/rest/schemas/payment-authorizationcode.md): Unique identifier provided by the bank performing transaction.
- [Payment-AutoRecover](https://docs.monei.com/apis/rest/schemas/payment-autorecover.md): 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).
- [Payment-BillingDetails](https://docs.monei.com/apis/rest/schemas/payment-billingdetails.md): Billing information associated with the payment method
- [Payment-CallbackUrl](https://docs.monei.com/apis/rest/schemas/payment-callbackurl.md): The URL to which a payment result should be sent asynchronously.
- [Payment-CancellationReason](https://docs.monei.com/apis/rest/schemas/payment-cancellationreason.md): The reason for canceling the Payment.
- [Payment-CancelUrl](https://docs.monei.com/apis/rest/schemas/payment-cancelurl.md): The URL the customer will be directed to if they decide to cancel
- [Payment-CompleteUrl](https://docs.monei.com/apis/rest/schemas/payment-completeurl.md): The URL the customer will be directed to after transaction
- [Payment-Currency](https://docs.monei.com/apis/rest/schemas/payment-currency.md): Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217),
- [Payment-Customer](https://docs.monei.com/apis/rest/schemas/payment-customer.md)
- [Payment-Description](https://docs.monei.com/apis/rest/schemas/payment-description.md): An arbitrary string attached to the payment. Often useful for
- [Payment-ExpireAt](https://docs.monei.com/apis/rest/schemas/payment-expireat.md): Payment expiration time.
- [Payment-FailUrl](https://docs.monei.com/apis/rest/schemas/payment-failurl.md): The URL the customer will be directed to after transaction has failed,
- [Payment-GeneratePaymentToken](https://docs.monei.com/apis/rest/schemas/payment-generatepaymenttoken.md): If set to true a permanent token that represents a payment
- [Payment-Id](https://docs.monei.com/apis/rest/schemas/payment-id.md): Unique identifier for the payment.
- [Payment-LastRefundAmount](https://docs.monei.com/apis/rest/schemas/payment-lastrefundamount.md): Amount in cents refunded in the last transaction.
- [Payment-LastRefundReason](https://docs.monei.com/apis/rest/schemas/payment-lastrefundreason.md): The reason of the last refund transaction.
- [Payment-MessageChannel](https://docs.monei.com/apis/rest/schemas/payment-messagechannel.md): The channel used to send the payment message.
- [Payment-MessageLanguage](https://docs.monei.com/apis/rest/schemas/payment-messagelanguage.md): The language of message sent to the customer. If not provided the default customer language is used if available.
- [Payment-NextAction](https://docs.monei.com/apis/rest/schemas/payment-nextaction.md): If present, this property tells you what actions you need
- [Payment-OrderId](https://docs.monei.com/apis/rest/schemas/payment-orderid.md): An order ID from your system. A unique identifier that can be used
- [Payment-PaymentMethod](https://docs.monei.com/apis/rest/schemas/payment-paymentmethod.md): Details about the payment method at the time of the transaction.
- [Payment-PaymentMethodBizum](https://docs.monei.com/apis/rest/schemas/payment-paymentmethodbizum.md): Details about the Bizum account used as payment method at the time of the transaction.
- [Payment-PaymentMethodBizumInput](https://docs.monei.com/apis/rest/schemas/payment-paymentmethodbizuminput.md): Details about the Bizum account used for this payment.
- [Payment-PaymentMethodCard](https://docs.monei.com/apis/rest/schemas/payment-paymentmethodcard.md): Details about the card used as payment method at the time of the transaction.
- [Payment-PaymentMethodCardInput](https://docs.monei.com/apis/rest/schemas/payment-paymentmethodcardinput.md): Details about the card used as payment method.
- [Payment-PaymentMethodInput](https://docs.monei.com/apis/rest/schemas/payment-paymentmethodinput.md): An information about a payment method used for this payment.
- [Payment-PaymentMethodKlarna](https://docs.monei.com/apis/rest/schemas/payment-paymentmethodklarna.md): Details from Klarna order used as payment method at the time of the transaction.
- [Payment-PaymentMethodMbway](https://docs.monei.com/apis/rest/schemas/payment-paymentmethodmbway.md): Details from MBWay order used as payment method at the time of the transaction.
- [Payment-PaymentMethodPaypal](https://docs.monei.com/apis/rest/schemas/payment-paymentmethodpaypal.md): Details from Paypal order used as payment method at the time of the transaction.
- [Payment-PaymentMethods](https://docs.monei.com/apis/rest/schemas/payment-paymentmethods.md): An array of allowed payment methods (used in hosted payment
- [Payment-PaymentMethodSepa](https://docs.monei.com/apis/rest/schemas/payment-paymentmethodsepa.md): Details from SEPA order used as payment method at the time of the transaction.
- [Payment-PaymentMethodTrustly](https://docs.monei.com/apis/rest/schemas/payment-paymentmethodtrustly.md): Details from Trustly order used as payment method at the time of the transaction.
- [Payment-PaymentToken](https://docs.monei.com/apis/rest/schemas/payment-paymenttoken.md): A permanent token represents a payment method used in the
- [Payment-PointOfSaleId](https://docs.monei.com/apis/rest/schemas/payment-pointofsaleid.md): 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.
- [Payment-RefundedAmount](https://docs.monei.com/apis/rest/schemas/payment-refundedamount.md): Amount in cents refunded (can be less than the amount
- [Payment-RefundReason](https://docs.monei.com/apis/rest/schemas/payment-refundreason.md): The reason for refunding the Payment.
- [Payment-Sequence](https://docs.monei.com/apis/rest/schemas/payment-sequence.md): This field needs to be sent in order to mark the beginning of a sequence of payments
- [Payment-SequenceId](https://docs.monei.com/apis/rest/schemas/payment-sequenceid.md): A permanent identifier that refers to the initial payment of
- [Payment-SequenceRecurring](https://docs.monei.com/apis/rest/schemas/payment-sequencerecurring.md): Specific configurations for recurring payments.
- [Payment-SessionDetails](https://docs.monei.com/apis/rest/schemas/payment-sessiondetails.md): Information related to the browsing session of the user
- [Payment-SessionId](https://docs.monei.com/apis/rest/schemas/payment-sessionid.md): A unique identifier within your system that adds security to the
- [Payment-ShippingDetails](https://docs.monei.com/apis/rest/schemas/payment-shippingdetails.md): Shipping information associated with the payment.
- [Payment-Shop](https://docs.monei.com/apis/rest/schemas/payment-shop.md): The information about the shop (used in
- [Payment-Status](https://docs.monei.com/apis/rest/schemas/payment-status.md): The status of the payment.
- [Payment-StatusCode](https://docs.monei.com/apis/rest/schemas/payment-statuscode.md): Payment status code.
- [Payment-StatusMessage](https://docs.monei.com/apis/rest/schemas/payment-statusmessage.md): Human readable status message, can be displayed to a user.
- [Payment-StoreId](https://docs.monei.com/apis/rest/schemas/payment-storeid.md): A unique identifier of the Store. If specified the payment is attached to this Store.
- [Payment-SubscriptionId](https://docs.monei.com/apis/rest/schemas/payment-subscriptionid.md): A unique identifier of the Subscription. If specified the payment is attached to this Subscription.
- [Payment-TraceDetails](https://docs.monei.com/apis/rest/schemas/payment-tracedetails.md): Information related to the browsing session of the user
- [Payment-TransactionType](https://docs.monei.com/apis/rest/schemas/payment-transactiontype.md): Controls when the funds will be captured.
- [Payment](https://docs.monei.com/apis/rest/schemas/payment.md)
- [PaymentMethods-Amount](https://docs.monei.com/apis/rest/schemas/paymentmethods-amount.md): The amount of the payment in the smallest currency unit.
- [PaymentMethods-Currency](https://docs.monei.com/apis/rest/schemas/paymentmethods-currency.md): Three-letter ISO currency code, in uppercase.
- [PaymentMethods-MerchantName](https://docs.monei.com/apis/rest/schemas/paymentmethods-merchantname.md): The name of the merchant
- [PaymentMethods-MerchantUrl](https://docs.monei.com/apis/rest/schemas/paymentmethods-merchanturl.md): The URL of the merchant's website
- [PaymentMethods-Metadata](https://docs.monei.com/apis/rest/schemas/paymentmethods-metadata.md): Additional configuration details for each payment method.
- [PaymentMethods-Methods](https://docs.monei.com/apis/rest/schemas/paymentmethods-methods.md): An array of available payment methods for the account or payment.
- [PaymentMethods](https://docs.monei.com/apis/rest/schemas/paymentmethods.md)
- [RecurringPaymentRequest](https://docs.monei.com/apis/rest/schemas/recurringpaymentrequest.md)
- [RefundPaymentRequest](https://docs.monei.com/apis/rest/schemas/refundpaymentrequest.md)
- [RegisterApplePayDomainRequest](https://docs.monei.com/apis/rest/schemas/registerapplepaydomainrequest.md)
- [SendPaymentLinkRequest](https://docs.monei.com/apis/rest/schemas/sendpaymentlinkrequest.md)
- [SendPaymentReceiptRequest](https://docs.monei.com/apis/rest/schemas/sendpaymentreceiptrequest.md)
- [SendPaymentRequestRequest](https://docs.monei.com/apis/rest/schemas/sendpaymentrequestrequest.md)
- [SendSubscriptionLinkRequest](https://docs.monei.com/apis/rest/schemas/sendsubscriptionlinkrequest.md)
- [SendSubscriptionStatusRequest](https://docs.monei.com/apis/rest/schemas/sendsubscriptionstatusrequest.md)
- [ServiceUnavailableError](https://docs.monei.com/apis/rest/schemas/serviceunavailableerror.md)
- [Source](https://docs.monei.com/apis/rest/schemas/source.md): The source component from where the operation was generated (mostly for our SDK's).
- [SourceVersion](https://docs.monei.com/apis/rest/schemas/sourceversion.md): The source component version from where the operation was generated (mostly for our SDK's).
- [Subscription-CallbackUrl](https://docs.monei.com/apis/rest/schemas/subscription-callbackurl.md): The URL will be called each time subscription status changes. You will receive a subscription object in the body of the request.
- [Subscription-CancelAtPeriodEnd](https://docs.monei.com/apis/rest/schemas/subscription-cancelatperiodend.md): If true, the subscription will be canceled at the end of the current period.
- [Subscription-CurrentPeriodEnd](https://docs.monei.com/apis/rest/schemas/subscription-currentperiodend.md): The end date of the current subscription period. Measured in seconds since the Unix epoch.
- [Subscription-CurrentPeriodStart](https://docs.monei.com/apis/rest/schemas/subscription-currentperiodstart.md): The start date of the current subscription period. Measured in seconds since the Unix epoch.
- [Subscription-Description](https://docs.monei.com/apis/rest/schemas/subscription-description.md): An arbitrary string attached to the subscription. Often useful for
- [Subscription-Id](https://docs.monei.com/apis/rest/schemas/subscription-id.md): Unique identifier for the subscription.
- [Subscription-Interval](https://docs.monei.com/apis/rest/schemas/subscription-interval.md): Subscription interval. The `minute` and `hour` intervals are only available in test mode.
- [Subscription-IntervalCount](https://docs.monei.com/apis/rest/schemas/subscription-intervalcount.md): Number of intervals between subscription payments.
- [Subscription-LastPayment](https://docs.monei.com/apis/rest/schemas/subscription-lastpayment.md)
- [Subscription-NextPaymentAt](https://docs.monei.com/apis/rest/schemas/subscription-nextpaymentat.md): The date when the next payment will be made.
- [Subscription-PauseAtPeriodEnd](https://docs.monei.com/apis/rest/schemas/subscription-pauseatperiodend.md): If true, the subscription will be paused at the end of the current period.
- [Subscription-PauseIntervalCount](https://docs.monei.com/apis/rest/schemas/subscription-pauseintervalcount.md): Number of intervals when subscription will be paused before it activates again.
- [Subscription-PaymentCallbackUrl](https://docs.monei.com/apis/rest/schemas/subscription-paymentcallbackurl.md): The URL will be called each time subscription creates a new payments. You will receive the payment object in the body of the request.
- [Subscription-PaymentMethod](https://docs.monei.com/apis/rest/schemas/subscription-paymentmethod.md): Details about the payment method at the time of the transaction.
- [Subscription-PaymentMethodCard](https://docs.monei.com/apis/rest/schemas/subscription-paymentmethodcard.md): Details about the card used as payment method at the time of the transaction.
- [Subscription-PaymentMethods](https://docs.monei.com/apis/rest/schemas/subscription-paymentmethods.md): List of payment methods allowed for subscriptions.
- [Subscription-RetryCount](https://docs.monei.com/apis/rest/schemas/subscription-retrycount.md): Number of retries left for the subscription.
- [Subscription-RetrySchedule](https://docs.monei.com/apis/rest/schemas/subscription-retryschedule.md): Defines a custom schedule for retrying failed subscription payments. Each entry in the array specifies how long to wait before attempting the next payment retry.
- [Subscription-SkipIntervalCount](https://docs.monei.com/apis/rest/schemas/subscription-skipintervalcount.md): The number of intervals during which the subscription billing cycle will be skipped without altering the subscription status. This is useful when payment for a specific period is received through different methods.
- [Subscription-Status](https://docs.monei.com/apis/rest/schemas/subscription-status.md): The status of the subscription.
- [Subscription-TrialPeriodDays](https://docs.monei.com/apis/rest/schemas/subscription-trialperioddays.md): Number of days the trial period lasts.
- [Subscription-TrialPeriodEnd](https://docs.monei.com/apis/rest/schemas/subscription-trialperiodend.md): The end date of the trial period. Measured in seconds since the Unix epoch.
- [Subscription](https://docs.monei.com/apis/rest/schemas/subscription.md)
- [UnauthorizedError](https://docs.monei.com/apis/rest/schemas/unauthorizederror.md)
- [UnprocessableEntityError](https://docs.monei.com/apis/rest/schemas/unprocessableentityerror.md)
- [UpdateApplePayCertificateRequest](https://docs.monei.com/apis/rest/schemas/updateapplepaycertificaterequest.md)
- [UpdatedAt](https://docs.monei.com/apis/rest/schemas/updatedat.md): Time at which the resource updated last time. Measured in seconds since the Unix epoch.
- [UpdateSubscriptionRequest](https://docs.monei.com/apis/rest/schemas/updatesubscriptionrequest.md)
- [UserAgent](https://docs.monei.com/apis/rest/schemas/useragent.md): Full user agent string of the browser session.
- [ValidateBizumPhoneRequest](https://docs.monei.com/apis/rest/schemas/validatebizumphonerequest.md)
- [Activate Subscription](https://docs.monei.com/apis/rest/subscriptions-activate.md): Activates a subscription by attaching a payment method and initiating the billing cycle.
- [Cancel Subscription](https://docs.monei.com/apis/rest/subscriptions-cancel.md): Cancels an active subscription, permanently stopping the billing cycle.
- [Create Subscription](https://docs.monei.com/apis/rest/subscriptions-create.md): Creates a new subscription with the specified parameters.
- [Get Subscription](https://docs.monei.com/apis/rest/subscriptions-get.md): Retrieves the complete details of an existing subscription by its unique ID.
- [Pause Subscription](https://docs.monei.com/apis/rest/subscriptions-pause.md): Pauses an active subscription, temporarily halting the billing cycle.
- [Resume Subscription](https://docs.monei.com/apis/rest/subscriptions-resume.md): Resumes a previously paused subscription, reactivating the billing cycle.
- [Send Subscription Link](https://docs.monei.com/apis/rest/subscriptions-send-link.md): Sends a subscription activation link to the customer through their preferred communication channel.
- [Send Subscription Status](https://docs.monei.com/apis/rest/subscriptions-send-status.md): Sends subscription status information to the customer through their preferred communication channel.
- [Update Subscription](https://docs.monei.com/apis/rest/subscriptions-update.md): Updates the configuration of an existing subscription.
- [Subscriptions](https://docs.monei.com/apis/rest/subscriptions.md): Subscriptions

## channel-tokenization

- [Hotels Channel Managers](https://docs.monei.com/channel-tokenization.md): This document outlines the process of payment card tokenization, where card information is received.

## e-commerce

- [Adobe Commerce (Magento 2)](https://docs.monei.com/e-commerce/adobe-commerce.md): To accept payments through MONEI in your Adobe Commerce (Magento 2) store you simply need to install and configure MONEI Adobe Commerce Extension.
- [PrestaShop](https://docs.monei.com/e-commerce/prestashop.md): To accept payments through MONEI in your PrestaShop store you simply need to install and configure MONEI PrestaShop Module.
- [Salesforce Commerce Cloud](https://docs.monei.com/e-commerce/salesforce.md): To accept payments through MONEI in your SalesForce Commerce Cloud store you simply need to install and configure the MONEI SalesForce Plugin.
- [Hide Payment Methods by Country](https://docs.monei.com/e-commerce/shopify/hide-payment-methods.md): Learn how to hide payment methods on your Shopify checkout based on customer country location using Checkout Blocks (Shopify Plus) or Puco (standard Shopify).
- [MONEI Bizum](https://docs.monei.com/e-commerce/shopify/monei-bizum.md): Accept Bizum payments through MONEI in your Shopify store by installing and configuring the MONEI Pay · Bizum Shopify App.
- [MONEI MB Way](https://docs.monei.com/e-commerce/shopify/monei-mbway.md): Accept MB Way payments through MONEI in your Shopify store by installing and configuring the MONEI MB Way Shopify App.
- [MONEI Multibanco](https://docs.monei.com/e-commerce/shopify/monei-multibanco.md): Accept Multibanco payments through MONEI in your Shopify store by installing and configuring the MONEI Multibanco Shopify App.
- [MONEI Onsite](https://docs.monei.com/e-commerce/shopify/monei-onsite.md): Accept payments directly on your Shopify store by installing and configuring the MONEI Onsite Shopify App.
- [MONEI Payments](https://docs.monei.com/e-commerce/shopify/monei-payments.md): To accept payments through MONEI in your Shopify store you simply need to install and configure MONEI Payments Shopify App.
- [WIX](https://docs.monei.com/e-commerce/wix.md): To accept payments through MONEI in your WIX store you simply need to install MONEI in WIX App Market.
- [WooCommerce](https://docs.monei.com/e-commerce/woocommerce.md): To accept payments through MONEI in your WooCommerce store you simply need to install and configure MONEI WooCommerce Plugin.

## eurm-stablecoin

- [EURM Stablecoin](https://docs.monei.com/eurm-stablecoin.md): EURM is a euro-pegged stablecoin by MONEI built on Ethereum and Polygon for digital payments.

## getting-started

- [Getting started](https://docs.monei.com/getting-started.md): Find a guide to integrate MONEI into your system

## guides

- [Ethoca & Verifi Sync](https://docs.monei.com/guides/ethoca-verifi.md): Integrate Ethoca and Verifi services to reduce chargebacks and improve transaction oversight.
- [Managing Multiple Stores](https://docs.monei.com/guides/managing-stores.md): Manage multiple stores and points of sale within a single MONEI account.
- [Migrate your tokenized cards to MONEI](https://docs.monei.com/guides/migrate-tokens.md): Securely migrate tokenized cards from another payment processor to MONEI.
- [MONEI POD WiFi Setup](https://docs.monei.com/guides/monei-pod-wifi.md): Configure WiFi on your MONEI POD payment terminal.
- [Payouts (beta)](https://docs.monei.com/guides/payouts.md): Send money to individuals via Bizum or Cards using the MONEI Payouts API.
- [Save payment method](https://docs.monei.com/guides/save-payment-method.md): Tokenize and save payment methods for future use with MONEI.
- [Send cardholder name](https://docs.monei.com/guides/send-cardholder-name.md): Send cardholder name with transactions to comply with PSD2 and SCA requirements.
- [Verify signature](https://docs.monei.com/guides/verify-signature.md): Verify MONEI webhook signatures to ensure request authenticity.

## integrations

- [Build a custom checkout](https://docs.monei.com/integrations/build-custom-checkout.md): Use MONEI Components to build your custom checkout and securely accept Cards, PayPal, Bizum, Apple Pay, GooglePay, Click to Pay and other payment methods.
- [Pay By Link](https://docs.monei.com/integrations/pay-by-link.md): Use Pay By Link to send your customers a link to pay online in one click! Works with or without a website. Send payment links via email, WhatsApp or SMS.
- [Use payment modal](https://docs.monei.com/integrations/use-payment-modal.md): MONEI Payment Modal is the simplest way to securely collect payments from your customers without them leaving your website.
- [Use a prebuilt payment page](https://docs.monei.com/integrations/use-prebuilt-payment-page.md): MONEI Hosted payment page is the simplest way to securely collect payments from your customers with multiple payment methods like Cards, PayPal, Bizum, GooglePay, Apple Pay & Click to Pay among others.
- [Use QR code payments](https://docs.monei.com/integrations/use-qr-payments.md): Accept in-store contactless payments with QR codes using the MONEI Pay app, Dashboard Points of Sale, or the Payments API.

## monei-connect

- [MONEI Connect](https://docs.monei.com/monei-connect.md): Integrate payments into your platform or marketplace using MONEI Connect partner program.

## monei-js

- [MONEI Components](https://docs.monei.com/monei-js/overview.md): MONEI Components enable you to collect sensitive payment information using customizable Components.
- [Payment Request Component](https://docs.monei.com/monei-js/payment-request.md): Learn how to use PaymentRequest Component to accept Apple Pay and Google Pay payments with MONEI.
- [MONEI JS Reference](https://docs.monei.com/monei-js/reference.md): You can use monei.js’ APIs to tokenize customer information and collect sensitive card data using customizable MONEI Components.

## payment-methods

- [Apple Pay](https://docs.monei.com/payment-methods/apple-pay.md): Learn how to accept Apple Pay payments with MONEI.
- [Bizum](https://docs.monei.com/payment-methods/bizum.md): Learn how to accept Bizum payments with MONEI.
- [Cards](https://docs.monei.com/payment-methods/card.md): Learn how to accept Card payments with MONEI.
- [Click to Pay](https://docs.monei.com/payment-methods/click-to-pay.md): Accept Click to Pay payments to let your customers make secure payments in fewer clicks.
- [Google Pay](https://docs.monei.com/payment-methods/google-pay.md): Learn how to accept Google Pay payments with MONEI.
- [Payment Methods Overview](https://docs.monei.com/payment-methods/overview.md): Overview of all payment methods supported by MONEI including cards, digital wallets, and local payment methods.
- [PayPal](https://docs.monei.com/payment-methods/paypal.md): Learn how to accept PayPal payments with MONEI.
- [SEPA Request to Pay (SRTP)](https://docs.monei.com/payment-methods/sepa-request-to-pay.md): Create and accept payments using the SRTP scheme.

## subscriptions

- [Subscriptions integration](https://docs.monei.com/subscriptions/integration.md): Use MONEI subscriptions to charge the customer on a recurring basis.

## testing

- [Testing](https://docs.monei.com/testing.md): This page includes test card numbers and other information to make sure your integration works as planned.

## Optional
- [REST API OpenAPI](https://js.monei.com/api/v1/openapi.json): Official OpenAPI specification for MONEI API v1.
- [GraphQL Endpoint](https://graphql.monei.com/): GraphQL endpoint for schema introspection.
- [Postman Collection](https://postman.monei.com/): Prebuilt requests for testing the REST API.


---

# Full Documentation Content

[Skip to main content](#__docusaurus_skipToContent_fallback)

[![MONEI](https://assets.monei.com/images/logo.svg)![MONEI](https://assets.monei.com/images/logo.svg)](https://docs.monei.com/index.md)

[**MONEI**](https://docs.monei.com/index.md)

[Documentation](https://docs.monei.com/getting-started/.md)

[APIs](#)

* [REST API](https://docs.monei.com/apis/rest/.md)
* [GraphQL API](https://docs.monei.com/apis/graphql/.md)

[Support](https://support.monei.com)[Dashboard](https://dashboard.monei.com)

Search

# Search the documentation

Type your search here

Powered by[](https://www.algolia.com/)

Copyright © 2026 MONEI — [Winner of the AWS Startup Architecture Challenge 🏆](https://aws.amazon.com/es/blogs/startups/serverless-architecture-powers-moneis-fast-secure-and-scalable-digital-payment-solutions/)

MONEI DIGITAL PAYMENTS SL - ESB02660926 Palestina, 1, Entreplanta, 29007, Málaga, Spain BORME Registry Details: Registro Mercantil de MÁLAGA T 5998, L 4905, F 54, S 8,H MA158775, I/A 1 (14.01.21). MONEI is a Payments Institution regulated by Banco de España with license number: 6911, and a Swift member with BIC number: MDIPES22. MONEI is member of the European Payments Council under the SRTP group.


---

# Odoo

MONEI for Odoo is our official integration that allows you to process payments, manage transactions, and sync your Odoo orders with MONEI payments. The app provides a seamless experience for managing your payment operations directly from your Odoo interface.

![MONEI Odoo App Dashboard](/assets/images/dashboard-1eac8c4833eec862e587d44d2feaabdd.png)

## Features[​](#features "Direct link to Features")

* Process payments directly from Odoo
* View and manage all your MONEI transactions
* Filter and search payments
* Perform payment actions (capture, cancel, refund)
* Create new payments and payment links
* Manual order synchronization
* Detailed payment status tracking

## Installation[​](#installation "Direct link to Installation")

<!-- -->

* Odoo.sh Platform
* Self-Hosted Odoo

1. Go to your project on [Odoo.sh](https://odoo.sh)
2. Navigate to the "Repositories" tab
3. Click "Add a Repository" and select "Add a Git Repository"
4. Enter the repository URL: `https://github.com/MONEI/MONEI-Odoo`
5. Select the branch you want to deploy
6. Go to the "Branches" tab and activate the branch where you want MONEI installed
7. Wait for the deployment to complete (you can check status in "Builds")
8. Once deployed, go to Apps and search for "MONEI"
9. Click Install on the MONEI module

note

If you don't see the module in Apps after deployment:

* Enable developer mode (Settings → General Settings → Developer Tools → Activate the developer mode)
* Go to Apps → Update Apps List (menu in the top bar)
* Search for "MONEI" again

1. Download the module

2. Place the `monei` folder in your Odoo addons directory:

   <!-- -->

   * Linux: `/opt/odoo/addons/` or `/usr/lib/python3/dist-packages/odoo/addons/`
   * Windows: `C:\Program Files\Odoo\server\odoo\addons\`

3. Restart your Odoo server

4. Update the apps list in Odoo:

   <!-- -->

   * Enable developer mode
   * Go to Apps > Update Apps List

5. Search for "MONEI" and install the module

![MONEI App Installation](/assets/images/install-c2fc461d9fe5e1d7efba8bb09defa9ad.png)

### 2. Configuration[​](#2-configuration "Direct link to 2. Configuration")

1. In Odoo, go to **Settings > MONEI Configuration**
2. Enter your API Key. You can find your API Key in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api).
3. Save the configuration

![Odoo MONEI Configuration](/assets/images/configuration-3e0603696fbae5ae1bf7cf659ef1f6a9.png)

note

Make sure to use the correct API credentials based on your environment (test/live).

## Usage[​](#usage "Direct link to Usage")

### Managing Payments[​](#managing-payments "Direct link to Managing Payments")

#### View Payments[​](#view-payments "Direct link to View Payments")

1. Navigate to **MONEI > Payments**

2. View all your payments in a list with key information:

   <!-- -->

   * Payment ID
   * Amount
   * Status
   * Customer details
   * Order reference

3. Use filters to search by:

   <!-- -->

   * Date range
   * Payment status
   * Amount
   * Customer information

![Payment List View](/assets/images/payments-list-64b5b2560e36e9d7063798d37b98b84f.png)

#### Create a New Payment[​](#create-a-new-payment "Direct link to Create a New Payment")

1. Click on "Create" in the Payments view

2. Fill in the payment details:

   <!-- -->

   * Amount
   * Currency
   * Customer information
   * Description
   * Order reference (optional)

3. Click "Create Payment"

![Create Payment Form](/assets/images/create-dcf80eda23e8d95e67d7dd6e31acae8c.png)

#### Payment Actions[​](#payment-actions "Direct link to Payment Actions")

For each payment, you can:

* Capture authorized payments
* Cancel pending payments
* Issue refunds
* View detailed transaction information

### Order Integration[​](#order-integration "Direct link to Order Integration")

The integration allows you to manually synchronize your Odoo orders with MONEI payments:

1. Go to **MONEI > Payments**

2. Click the "Sync Payments" button to fetch the latest payments from MONEI

3. The system will:

   <!-- -->

   * Update existing payment statuses
   * Import new payments
   * Link payments to corresponding Odoo orders based on order reference

tip

Regular synchronization is recommended to keep your payment information up to date. Consider syncing at least once per day.

### Payment Links[​](#payment-links "Direct link to Payment Links")

To create a payment link:

1. Go to **MONEI > Payment Links**

2. Click "Create"

3. Set the payment details:

   <!-- -->

   * Amount
   * Currency
   * Description
   * Expiration date (optional)
   * Customer information (optional)

4. Click "Generate Link"

5. Share the generated link with your customer

![Create Payment Link](/assets/images/payment-link-0732c19a4446f46c95bcafa8965d6100.png)

### How Syncing Works[​](#how-syncing-works "Direct link to How Syncing Works")

1. **Initial Sync**

   * After configuring your API key, use the Sync button to import payments
   * Select a date range to import payments from that period
   * The module will import all MONEI payments within the selected dates

2. **Syncing Process**

   * Go to MONEI > Payments

   * Click the "Sync Payments" button

   * Select start and end dates for the sync

   * The module will:

     <!-- -->

     * Import new payments from the selected period
     * Update existing payment information
     * Show a summary of changes when complete

3. **Order Matching**

   * Payments are automatically linked to sale orders using the order reference
   * Each payment's order reference is matched to a sale order number
   * View linked payments directly from the sale order form

## Troubleshooting[​](#troubleshooting "Direct link to Troubleshooting")

If you encounter any issues:

1. Verify your API credentials are correct
2. Check your Odoo system logs
3. Ensure your Odoo instance can connect to MONEI's API
4. Try re-syncing your payments manually
5. Contact [MONEI support](https://support.monei.com) if issues persist

Common issues:

* **Sync button not working**: Verify your API credentials and internet connection
* **Payments not linking to orders**: Ensure order references match between systems

tip

Keep your app updated to the latest version to ensure you have all the latest features and security updates.


---

# MONEI GraphQL API

With MONEI GraphQL API you have full access to all MONEI features like analytics reports, payments, events, and much more. This API requires authentication and is intended to be used server side.

If you want to know how GraphQL API works, check out [How to GraphQL](https://www.howtographql.com/).

If you don't have a MONEI account already, you’ll need to [create](https://dashboard.monei.com/?action=signUp) one to use the GraphQL API.

## GraphQL API Explorer[​](#graphql-api-explorer "Direct link to GraphQL API Explorer")

If you want to start playing with the API immediately, you can do it in the [GraphQL API Explorer](https://dashboard.monei.com/api-explorer) of your MONEI account. You can run Queries and Mutations in the explorer to see what the MONEI GraphQL API can offer you. The API Explorer is available to all MONEI users.

note

**Heads up!** MONEI's GraphQL Explorer makes use of your real, live, production data.

## Authentication[​](#authentication "Direct link to Authentication")

The API uses API keys to authenticate requests. You can view and manage your API key in the [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api).

Your API key enables full access to all MONEI resources, so be sure to keep it secure! Do not share your secret API key in publicly accessible areas such as GitHub, client-side code, and so forth.

Include your API Key as an `Authorization` header in all your GraphQL requests.

## GraphQL API Endpoint[​](#graphql-api-endpoint "Direct link to GraphQL API Endpoint")

```
POST https://graphql.monei.com
```

## Query GraphQL API[​](#query-graphql-api "Direct link to Query GraphQL API")

You can access GraphQL API endpoint using cURL or any other HTTP client.

```
curl --request POST 'https://graphql.monei.com' \
--header 'Authorization: <YOUR_API_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{"query":"{account {name status}}"}'
```

note

You can explore GraphQL API Queries and Mutations in the interactive [GraphQL API Explorer](https://dashboard.monei.com/api-explorer) in you MONEI Dashboard.

## Example Queries[​](#example-queries "Direct link to Example Queries")

In GraphQL, queries are the equivalent of REST’s GET action verb. Even though a POST is being sent to the GraphQL endpoint, if the body only contains queries, data will only be retrieved and not modified.

#### Query the Contact by Address[​](#query-the-contact-by-address "Direct link to Query the Contact by Address")

```
query {
  charge(id: "bc8eb8588e175ce4c957212f17ca051a") {
    amount
    refundedAmount
    authorizationCode
    id
    description
    customer {
      email
      name
      phone
    }
    orderId
    paymentMethod {
      bank
      brand
      country
      last4
      method
      phoneNumber
      threeDSecure
      type
    }
    status
    statusCode
    statusMessage
    updatedAt
  }
}
```

## Example Mutations[​](#example-mutations "Direct link to Example Mutations")

Mutations are the equivalent of REST’s data-modifying action verbs.

```
mutation {
  refundCharge(input: {chargeId: "bc8eb8588e175ce4c957212f17ca051a", amount: 10}) {
    amount
    refundedAmount
    authorizationCode
    id
    description
    customer {
      email
      name
      phone
    }
    orderId
    paymentMethod {
      bank
      brand
      country
      last4
      method
      phoneNumber
      threeDSecure
      type
    }
    status
    statusCode
    statusMessage
    updatedAt
  }
}
```


---

# defer

This directive allows results to be deferred during execution

```
directive @defer on FIELD
```


---

# include

Directs the executor to include this field or fragment only when the `if` argument is true.

```
directive @include(
  if: Boolean!
) on 
  | FIELD
  | FRAGMENT_SPREAD
  | INLINE_FRAGMENT
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`include.if`](#) ● [`Boolean!`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) non-null scalar[​](#includeifboolean-- "Direct link to includeifboolean--")

Included when true.


---

# skip

Directs the executor to skip this field or fragment when the `if` argument is true.

```
directive @skip(
  if: Boolean!
) on 
  | FIELD
  | FRAGMENT_SPREAD
  | INLINE_FRAGMENT
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`skip.if`](#) ● [`Boolean!`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) non-null scalar[​](#skipifboolean-- "Direct link to skipifboolean--")

Skipped when true.


---

# activateAccount

Requests approval for the account

```
activateAccount(
  language: String
): ActivateAccount!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`activateAccount.language`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#activateaccountlanguagestring- "Direct link to activateaccountlanguagestring-")

### Type[​](#type "Direct link to Type")

#### [`ActivateAccount`](https://docs.monei.com/apis/graphql/types/objects/activate-account/.md) object[​](#activateaccount- "Direct link to activateaccount-")

Account activation response


---

# activateApplePayCert

Activate Custom Apple Pay certificate

```
activateApplePayCert(
  input: ActivateApplePayCertInput
): ApplePayCertificate!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`activateApplePayCert.input`](#) ● [`ActivateApplePayCertInput`](https://docs.monei.com/apis/graphql/types/inputs/activate-apple-pay-cert-input/.md) input[​](#activateapplepaycertinputactivateapplepaycertinput- "Direct link to activateapplepaycertinputactivateapplepaycertinput-")

### Type[​](#type "Direct link to Type")

#### [`ApplePayCertificate`](https://docs.monei.com/apis/graphql/types/objects/apple-pay-certificate/.md) object[​](#applepaycertificate- "Direct link to applepaycertificate-")

Custom Apple Pay Certificate needed to enable Apple Pay in the native iOS app. Apple only allows certificates that are created by developers to be used in the Apple Pay payment process. Register your custom Apple Pay certificate to allow MONEI to decrypt the payment data.


---

# activateSubscription

Active a subscription

```
activateSubscription(
  input: ActivateSubscriptionInput!
): Payment
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`activateSubscription.input`](#) ● [`ActivateSubscriptionInput!`](https://docs.monei.com/apis/graphql/types/inputs/activate-subscription-input/.md) non-null input[​](#activatesubscriptioninputactivatesubscriptioninput-- "Direct link to activatesubscriptioninputactivatesubscriptioninput--")

### Type[​](#type "Direct link to Type")

#### [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object[​](#payment- "Direct link to payment-")


---

# addBlacklistItem

Add a new item to the blacklist

```
addBlacklistItem(
  input: BlacklistItemInput!
): BlacklistItem
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`addBlacklistItem.input`](#) ● [`BlacklistItemInput!`](https://docs.monei.com/apis/graphql/types/inputs/blacklist-item-input/.md) non-null input[​](#addblacklistiteminputblacklistiteminput-- "Direct link to addblacklistiteminputblacklistiteminput--")

### Type[​](#type "Direct link to Type")

#### [`BlacklistItem`](https://docs.monei.com/apis/graphql/types/objects/blacklist-item/.md) object[​](#blacklistitem- "Direct link to blacklistitem-")

Blacklist item, e.g. email, phone, ip, card, bin, fingerprint. All payments with this value will be blocked.


---

# cancelPayment

Cancel a payment

```
cancelPayment(
  input: CancelPaymentInput!
): Payment
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`cancelPayment.input`](#) ● [`CancelPaymentInput!`](https://docs.monei.com/apis/graphql/types/inputs/cancel-payment-input/.md) non-null input[​](#cancelpaymentinputcancelpaymentinput-- "Direct link to cancelpaymentinputcancelpaymentinput--")

### Type[​](#type "Direct link to Type")

#### [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object[​](#payment- "Direct link to payment-")


---

# cancelSubscription

Schedule a subscription

```
cancelSubscription(
  input: CancelSubscriptionInput!
): Subscription!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`cancelSubscription.input`](#) ● [`CancelSubscriptionInput!`](https://docs.monei.com/apis/graphql/types/inputs/cancel-subscription-input/.md) non-null input[​](#cancelsubscriptioninputcancelsubscriptioninput-- "Direct link to cancelsubscriptioninputcancelsubscriptioninput--")

### Type[​](#type "Direct link to Type")

#### [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object[​](#subscription- "Direct link to subscription-")


---

# capturePayment

Capture a payment

```
capturePayment(
  input: CapturePaymentInput!
): Payment
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`capturePayment.input`](#) ● [`CapturePaymentInput!`](https://docs.monei.com/apis/graphql/types/inputs/capture-payment-input/.md) non-null input[​](#capturepaymentinputcapturepaymentinput-- "Direct link to capturepaymentinputcapturepaymentinput--")

### Type[​](#type "Direct link to Type")

#### [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object[​](#payment- "Direct link to payment-")


---

# connectMasterAccount

Connect master account

```
connectMasterAccount(
  promoCode: String!
  externalId: String
  externalHash: String
): Account!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`connectMasterAccount.promoCode`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#connectmasteraccountpromocodestring-- "Direct link to connectmasteraccountpromocodestring--")

#### [`connectMasterAccount.externalId`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#connectmasteraccountexternalidstring- "Direct link to connectmasteraccountexternalidstring-")

#### [`connectMasterAccount.externalHash`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#connectmasteraccountexternalhashstring- "Direct link to connectmasteraccountexternalhashstring-")

### Type[​](#type "Direct link to Type")

#### [`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object[​](#account- "Direct link to account-")

Account information


---

# connectShopifyShop

Connect a Shopify shop to an account

```
connectShopifyShop(
  input: ConnectShopifyShopInput!
): ConnectShopifyShopResult!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`connectShopifyShop.input`](#) ● [`ConnectShopifyShopInput!`](https://docs.monei.com/apis/graphql/types/inputs/connect-shopify-shop-input/.md) non-null input[​](#connectshopifyshopinputconnectshopifyshopinput-- "Direct link to connectshopifyshopinputconnectshopifyshopinput--")

### Type[​](#type "Direct link to Type")

#### [`ConnectShopifyShopResult`](https://docs.monei.com/apis/graphql/types/objects/connect-shopify-shop-result/.md) object[​](#connectshopifyshopresult- "Direct link to connectshopifyshopresult-")


---

# createAccount

Creates a new additional account attached to this account

```
createAccount(
  name: String!
  copyBusinessDetails: Boolean
): Boolean!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`createAccount.name`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#createaccountnamestring-- "Direct link to createaccountnamestring--")

#### [`createAccount.copyBusinessDetails`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#createaccountcopybusinessdetailsboolean- "Direct link to createaccountcopybusinessdetailsboolean-")

### Type[​](#type "Direct link to Type")

#### [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#boolean- "Direct link to boolean-")

The `Boolean` scalar type represents `true` or `false`.


---

# createApiKey

Generates the API Key to access REST and GraphQL APIs

```
createApiKey: String!
```

### Type[​](#type "Direct link to Type")

#### [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#string- "Direct link to string-")

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.


---

# createApplePayCert

Create Custom Apple Pay certificate

```
createApplePayCert: ApplePayCertificate!
```

### Type[​](#type "Direct link to Type")

#### [`ApplePayCertificate`](https://docs.monei.com/apis/graphql/types/objects/apple-pay-certificate/.md) object[​](#applepaycertificate- "Direct link to applepaycertificate-")

Custom Apple Pay Certificate needed to enable Apple Pay in the native iOS app. Apple only allows certificates that are created by developers to be used in the Apple Pay payment process. Register your custom Apple Pay certificate to allow MONEI to decrypt the payment data.


---

# createAuthorizedUser

Creates an authorized user

```
createAuthorizedUser(
  input: CreateAuthorizedUserInput!
): AuthorizedUser
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`createAuthorizedUser.input`](#) ● [`CreateAuthorizedUserInput!`](https://docs.monei.com/apis/graphql/types/inputs/create-authorized-user-input/.md) non-null input[​](#createauthorizeduserinputcreateauthorizeduserinput-- "Direct link to createauthorizeduserinputcreateauthorizeduserinput--")

### Type[​](#type "Direct link to Type")

#### [`AuthorizedUser`](https://docs.monei.com/apis/graphql/types/objects/authorized-user/.md) object[​](#authorizeduser- "Direct link to authorizeduser-")

An authorized user that can access the MONEI dashboard. One user can have access to multiple accounts with different access levels.


---

# createBankSession

Create a new bank session

```
createBankSession(
  bankId: ID!
): Session!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`createBankSession.bankId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#createbanksessionbankidid-- "Direct link to createbanksessionbankidid--")

### Type[​](#type "Direct link to Type")

#### [`Session`](https://docs.monei.com/apis/graphql/types/objects/session/.md) object[​](#session- "Direct link to session-")


---

# createCapitalEmbedToken

Create a MONEI Capital embed token to initialize their embedded UI

```
createCapitalEmbedToken: AWSJSON
```

### Type[​](#type "Direct link to Type")

#### [`AWSJSON`](https://docs.monei.com/apis/graphql/types/scalars/awsjson/.md) scalar[​](#awsjson- "Direct link to awsjson-")

The `AWSJSON` scalar type provided by AWS AppSync, represents a JSON string that complies with [RFC 8259](https://tools.ietf.org/html/rfc8259). Maps like "\*\*{\\"upvotes\\": 10}\*\*", lists like "\*\*\[1,2,3]\*\*", and scalar values like "\*\*\\"AWSJSON example string\\"\*\*", "\*\*1\*\*", and "\*\*true\*\*" are accepted as valid JSON and will automatically be parsed and loaded in the resolver mapping templates as Maps, Lists, or Scalar values rather than as the literal input strings. Invalid JSON strings like "\*\*{a: 1}\*\*", "\*\*{'a': 1}\*\*" and "\*\*Unquoted string\*\*" will throw GraphQL validation errors.


---

# createCapitalLead

Create a MONEI Capital loan application for an accepted offer

```
createCapitalLead: Boolean
```

### Type[​](#type "Direct link to Type")

#### [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#boolean- "Direct link to boolean-")

The `Boolean` scalar type represents `true` or `false`.


---

# createDocumentSession

Create a new document session

```
createDocumentSession: Session!
```

### Type[​](#type "Direct link to Type")

#### [`Session`](https://docs.monei.com/apis/graphql/types/objects/session/.md) object[​](#session- "Direct link to session-")


---

# createDocument

Create new document

```
createDocument(
  input: CreateDocumentInput!
): Document!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`createDocument.input`](#) ● [`CreateDocumentInput!`](https://docs.monei.com/apis/graphql/types/inputs/create-document-input/.md) non-null input[​](#createdocumentinputcreatedocumentinput-- "Direct link to createdocumentinputcreatedocumentinput--")

### Type[​](#type "Direct link to Type")

#### [`Document`](https://docs.monei.com/apis/graphql/types/objects/document/.md) object[​](#document- "Direct link to document-")


---

# createExportSftpConfig

Create a new SFTP config export

```
createExportSftpConfig(
  input: CreateExportSftpConfigInput!
): SftpConfigExport!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`createExportSftpConfig.input`](#) ● [`CreateExportSftpConfigInput!`](https://docs.monei.com/apis/graphql/types/inputs/create-export-sftp-config-input/.md) non-null input[​](#createexportsftpconfiginputcreateexportsftpconfiginput-- "Direct link to createexportsftpconfiginputcreateexportsftpconfiginput--")

### Type[​](#type "Direct link to Type")

#### [`SftpConfigExport`](https://docs.monei.com/apis/graphql/types/objects/sftp-config-export/.md) object[​](#sftpconfigexport- "Direct link to sftpconfigexport-")


---

# createIdSession

Creates Identity Verification Session

```
createIdSession(
  id: Int
): Session!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`createIdSession.id`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#createidsessionidint- "Direct link to createidsessionidint-")

### Type[​](#type "Direct link to Type")

#### [`Session`](https://docs.monei.com/apis/graphql/types/objects/session/.md) object[​](#session- "Direct link to session-")


---

# createPayPalLink

Creates a link to connect PayPal account

```
createPayPalLink: PayPalLink!
```

### Type[​](#type "Direct link to Type")

#### [`PayPalLink`](https://docs.monei.com/apis/graphql/types/objects/pay-pal-link/.md) object[​](#paypallink- "Direct link to paypallink-")


---

# createPaymentRule

Create a new payment rule

```
createPaymentRule(
  input: CreatePaymentRuleInput!
): PaymentRule!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`createPaymentRule.input`](#) ● [`CreatePaymentRuleInput!`](https://docs.monei.com/apis/graphql/types/inputs/create-payment-rule-input/.md) non-null input[​](#createpaymentruleinputcreatepaymentruleinput-- "Direct link to createpaymentruleinputcreatepaymentruleinput--")

### Type[​](#type "Direct link to Type")

#### [`PaymentRule`](https://docs.monei.com/apis/graphql/types/objects/payment-rule/.md) object[​](#paymentrule- "Direct link to paymentrule-")

Payment rule


---

# createPayment

Create a payment

```
createPayment(
  input: CreatePaymentInput!
): Payment
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`createPayment.input`](#) ● [`CreatePaymentInput!`](https://docs.monei.com/apis/graphql/types/inputs/create-payment-input/.md) non-null input[​](#createpaymentinputcreatepaymentinput-- "Direct link to createpaymentinputcreatepaymentinput--")

### Type[​](#type "Direct link to Type")

#### [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object[​](#payment- "Direct link to payment-")


---

# createPointOfSale

Creates a new point of sale

```
createPointOfSale(
  input: CreatePointOfSaleInput!
): PointOfSale!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`createPointOfSale.input`](#) ● [`CreatePointOfSaleInput!`](https://docs.monei.com/apis/graphql/types/inputs/create-point-of-sale-input/.md) non-null input[​](#createpointofsaleinputcreatepointofsaleinput-- "Direct link to createpointofsaleinputcreatepointofsaleinput--")

### Type[​](#type "Direct link to Type")

#### [`PointOfSale`](https://docs.monei.com/apis/graphql/types/objects/point-of-sale/.md) object[​](#pointofsale- "Direct link to pointofsale-")


---

# createProvider

Creates a new provider for the account

```
createProvider(
  input: CreateProviderInput!
): Provider!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`createProvider.input`](#) ● [`CreateProviderInput!`](https://docs.monei.com/apis/graphql/types/inputs/create-provider-input/.md) non-null input[​](#createproviderinputcreateproviderinput-- "Direct link to createproviderinputcreateproviderinput--")

### Type[​](#type "Direct link to Type")

#### [`Provider`](https://docs.monei.com/apis/graphql/types/objects/provider/.md) object[​](#provider- "Direct link to provider-")


---

# createStore

Creates a new store

```
createStore(
  input: CreateStoreInput!
): Store!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`createStore.input`](#) ● [`CreateStoreInput!`](https://docs.monei.com/apis/graphql/types/inputs/create-store-input/.md) non-null input[​](#createstoreinputcreatestoreinput-- "Direct link to createstoreinputcreatestoreinput--")

### Type[​](#type "Direct link to Type")

#### [`Store`](https://docs.monei.com/apis/graphql/types/objects/store/.md) object[​](#store- "Direct link to store-")


---

# createSubscription

Create a new subscription

```
createSubscription(
  input: CreateSubscriptionInput!
): Subscription!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`createSubscription.input`](#) ● [`CreateSubscriptionInput!`](https://docs.monei.com/apis/graphql/types/inputs/create-subscription-input/.md) non-null input[​](#createsubscriptioninputcreatesubscriptioninput-- "Direct link to createsubscriptioninputcreatesubscriptioninput--")

### Type[​](#type "Direct link to Type")

#### [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object[​](#subscription- "Direct link to subscription-")


---

# createWebhook

Create new webhook

```
createWebhook(
  input: CreateWebhookInput!
): Webhook!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`createWebhook.input`](#) ● [`CreateWebhookInput!`](https://docs.monei.com/apis/graphql/types/inputs/create-webhook-input/.md) non-null input[​](#createwebhookinputcreatewebhookinput-- "Direct link to createwebhookinputcreatewebhookinput--")

### Type[​](#type "Direct link to Type")

#### [`Webhook`](https://docs.monei.com/apis/graphql/types/objects/webhook/.md) object[​](#webhook- "Direct link to webhook-")


---

# deleteApiKey

Deletes the API Key

```
deleteApiKey: Boolean
```

### Type[​](#type "Direct link to Type")

#### [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#boolean- "Direct link to boolean-")

The `Boolean` scalar type represents `true` or `false`.


---

# deleteApplePayCert

Delete Custom Apple Pay certificate

```
deleteApplePayCert(
  id: ID!
): Boolean!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`deleteApplePayCert.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#deleteapplepaycertidid-- "Direct link to deleteapplepaycertidid--")

### Type[​](#type "Direct link to Type")

#### [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#boolean- "Direct link to boolean-")

The `Boolean` scalar type represents `true` or `false`.


---

# deleteAuthorizedUser

Deletes an authorized user

```
deleteAuthorizedUser(
  userEmail: String!
): Boolean!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`deleteAuthorizedUser.userEmail`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#deleteauthorizeduseruseremailstring-- "Direct link to deleteauthorizeduseruseremailstring--")

### Type[​](#type "Direct link to Type")

#### [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#boolean- "Direct link to boolean-")

The `Boolean` scalar type represents `true` or `false`.


---

# deleteBlacklistItem

Delete blacklist item

```
deleteBlacklistItem(
  value: String!
): Boolean!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`deleteBlacklistItem.value`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#deleteblacklistitemvaluestring-- "Direct link to deleteblacklistitemvaluestring--")

### Type[​](#type "Direct link to Type")

#### [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#boolean- "Direct link to boolean-")

The `Boolean` scalar type represents `true` or `false`.


---

# deleteCode

Deletes an existing code

```
deleteCode(
  id: ID!
): Boolean!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`deleteCode.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#deletecodeidid-- "Direct link to deletecodeidid--")

### Type[​](#type "Direct link to Type")

#### [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#boolean- "Direct link to boolean-")

The `Boolean` scalar type represents `true` or `false`.


---

# deleteDocument

Delete a document

```
deleteDocument(
  id: ID!
): Boolean!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`deleteDocument.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#deletedocumentidid-- "Direct link to deletedocumentidid--")

### Type[​](#type "Direct link to Type")

#### [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#boolean- "Direct link to boolean-")

The `Boolean` scalar type represents `true` or `false`.


---

# deleteExportSftpConfig

Delete a SFTP config export

```
deleteExportSftpConfig(
  id: ID!
): Boolean!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`deleteExportSftpConfig.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#deleteexportsftpconfigidid-- "Direct link to deleteexportsftpconfigidid--")

### Type[​](#type "Direct link to Type")

#### [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#boolean- "Direct link to boolean-")

The `Boolean` scalar type represents `true` or `false`.


---

# deletePaymentRule

Delete a payment rule

```
deletePaymentRule(
  id: ID!
): Boolean!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`deletePaymentRule.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#deletepaymentruleidid-- "Direct link to deletepaymentruleidid--")

### Type[​](#type "Direct link to Type")

#### [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#boolean- "Direct link to boolean-")

The `Boolean` scalar type represents `true` or `false`.


---

# deletePointOfSale

Deletes an existing point of sale

```
deletePointOfSale(
  id: ID!
): Boolean!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`deletePointOfSale.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#deletepointofsaleidid-- "Direct link to deletepointofsaleidid--")

### Type[​](#type "Direct link to Type")

#### [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#boolean- "Direct link to boolean-")

The `Boolean` scalar type represents `true` or `false`.


---

# deleteProvider

Deletes a provider

```
deleteProvider(
  id: ID!
): Provider!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`deleteProvider.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#deleteprovideridid-- "Direct link to deleteprovideridid--")

### Type[​](#type "Direct link to Type")

#### [`Provider`](https://docs.monei.com/apis/graphql/types/objects/provider/.md) object[​](#provider- "Direct link to provider-")


---

# deleteStore

Deletes a store

```
deleteStore(
  id: ID!
): Boolean!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`deleteStore.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#deletestoreidid-- "Direct link to deletestoreidid--")

### Type[​](#type "Direct link to Type")

#### [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#boolean- "Direct link to boolean-")

The `Boolean` scalar type represents `true` or `false`.


---

# deleteWebhook

Delete webhook

```
deleteWebhook(
  id: ID!
): Boolean!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`deleteWebhook.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#deletewebhookidid-- "Direct link to deletewebhookidid--")

### Type[​](#type "Direct link to Type")

#### [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#boolean- "Direct link to boolean-")

The `Boolean` scalar type represents `true` or `false`.


---

# disableCustomDomain

Deletes a custom domain

```
disableCustomDomain: Account!
```

### Type[​](#type "Direct link to Type")

#### [`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object[​](#account- "Direct link to account-")

Account information


---

# disableTokenizationMethod

Disable the selected tokenization method for the account

```
disableTokenizationMethod(
  method: TokenizationMethods!
): Account!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`disableTokenizationMethod.method`](#) ● [`TokenizationMethods!`](https://docs.monei.com/apis/graphql/types/enums/tokenization-methods/.md) non-null enum[​](#disabletokenizationmethodmethodtokenizationmethods-- "Direct link to disabletokenizationmethodmethodtokenizationmethods--")

### Type[​](#type "Direct link to Type")

#### [`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object[​](#account- "Direct link to account-")

Account information


---

# disconnectMasterAccount

Disconnect master account

```
disconnectMasterAccount: Account!
```

### Type[​](#type "Direct link to Type")

#### [`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object[​](#account- "Direct link to account-")

Account information


---

# downloadAccountInvoice

Downloads account invoice

```
downloadAccountInvoice(
  invoiceId: ID!
): DownloadFile
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`downloadAccountInvoice.invoiceId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#downloadaccountinvoiceinvoiceidid-- "Direct link to downloadaccountinvoiceinvoiceidid--")

### Type[​](#type "Direct link to Type")

#### [`DownloadFile`](https://docs.monei.com/apis/graphql/types/objects/download-file/.md) object[​](#downloadfile- "Direct link to downloadfile-")


---

# downloadContract

Downloads account contract

```
downloadContract: DownloadFile
```

### Type[​](#type "Direct link to Type")

#### [`DownloadFile`](https://docs.monei.com/apis/graphql/types/objects/download-file/.md) object[​](#downloadfile- "Direct link to downloadfile-")


---

# downloadDocument

Create a download url for a document

```
downloadDocument(
  id: ID!
): DownloadFile!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`downloadDocument.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#downloaddocumentidid-- "Direct link to downloaddocumentidid--")

### Type[​](#type "Direct link to Type")

#### [`DownloadFile`](https://docs.monei.com/apis/graphql/types/objects/download-file/.md) object[​](#downloadfile- "Direct link to downloadfile-")


---

# downloadExport

Download the export of a charges

```
downloadExport(
  id: ID!
): DownloadFile!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`downloadExport.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#downloadexportidid-- "Direct link to downloadexportidid--")

### Type[​](#type "Direct link to Type")

#### [`DownloadFile`](https://docs.monei.com/apis/graphql/types/objects/download-file/.md) object[​](#downloadfile- "Direct link to downloadfile-")


---

# downloadOperationsFile

Downloads a file with the fees per transaction of a settlement

```
downloadOperationsFile(
  settlementId: ID!
): DownloadFile
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`downloadOperationsFile.settlementId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#downloadoperationsfilesettlementidid-- "Direct link to downloadoperationsfilesettlementidid--")

### Type[​](#type "Direct link to Type")

#### [`DownloadFile`](https://docs.monei.com/apis/graphql/types/objects/download-file/.md) object[​](#downloadfile- "Direct link to downloadfile-")


---

# enableCustomDomain

Creates a custom domain

```
enableCustomDomain(
  domain: String!
): Account!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`enableCustomDomain.domain`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#enablecustomdomaindomainstring-- "Direct link to enablecustomdomaindomainstring--")

### Type[​](#type "Direct link to Type")

#### [`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object[​](#account- "Direct link to account-")

Account information


---

# enableProvider

Updates the status of an existing provider

```
enableProvider(
  id: ID!
  enabled: Boolean!
): Provider!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`enableProvider.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#enableprovideridid-- "Direct link to enableprovideridid--")

#### [`enableProvider.enabled`](#) ● [`Boolean!`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) non-null scalar[​](#enableproviderenabledboolean-- "Direct link to enableproviderenabledboolean--")

### Type[​](#type "Direct link to Type")

#### [`Provider`](https://docs.monei.com/apis/graphql/types/objects/provider/.md) object[​](#provider- "Direct link to provider-")


---

# enableTokenizationMethod

Enable the selected tokenization method for the account

```
enableTokenizationMethod(
  method: TokenizationMethods!
): Account!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`enableTokenizationMethod.method`](#) ● [`TokenizationMethods!`](https://docs.monei.com/apis/graphql/types/enums/tokenization-methods/.md) non-null enum[​](#enabletokenizationmethodmethodtokenizationmethods-- "Direct link to enabletokenizationmethodmethodtokenizationmethods--")

### Type[​](#type "Direct link to Type")

#### [`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object[​](#account- "Direct link to account-")

Account information


---

# exportCharges

Export a list of charges

```
exportCharges(
  filter: SearchableChargeFilterInput
  columns: [String!]
  timezone: String
): ExportCharges!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`exportCharges.filter`](#) ● [`SearchableChargeFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-charge-filter-input/.md) input[​](#exportchargesfiltersearchablechargefilterinput- "Direct link to exportchargesfiltersearchablechargefilterinput-")

#### [`exportCharges.columns`](#) ● [`[String!]`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) list scalar[​](#exportchargescolumnsstring-- "Direct link to exportchargescolumnsstring--")

#### [`exportCharges.timezone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#exportchargestimezonestring- "Direct link to exportchargestimezonestring-")

### Type[​](#type "Direct link to Type")

#### [`ExportCharges`](https://docs.monei.com/apis/graphql/types/objects/export-charges/.md) object[​](#exportcharges- "Direct link to exportcharges-")


---

# pauseSubscription

Pause a subscription

```
pauseSubscription(
  input: PauseSubscriptionInput!
): Subscription!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`pauseSubscription.input`](#) ● [`PauseSubscriptionInput!`](https://docs.monei.com/apis/graphql/types/inputs/pause-subscription-input/.md) non-null input[​](#pausesubscriptioninputpausesubscriptioninput-- "Direct link to pausesubscriptioninputpausesubscriptioninput--")

### Type[​](#type "Direct link to Type")

#### [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object[​](#subscription- "Direct link to subscription-")


---

# publishUpdateAccount

Private. For onUpdateAccount subscription.

```
publishUpdateAccount(
  accountId: ID!
): AccountLevelUpdate
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`publishUpdateAccount.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#publishupdateaccountaccountidid-- "Direct link to publishupdateaccountaccountidid--")

### Type[​](#type "Direct link to Type")

#### [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object[​](#accountlevelupdate- "Direct link to accountlevelupdate-")


---

# publishUpdateAnalytics

Private. For onUpdateAnalytics subscription.

```
publishUpdateAnalytics(
  accountId: ID!
): AccountLevelUpdate
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`publishUpdateAnalytics.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#publishupdateanalyticsaccountidid-- "Direct link to publishupdateanalyticsaccountidid--")

### Type[​](#type "Direct link to Type")

#### [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object[​](#accountlevelupdate- "Direct link to accountlevelupdate-")


---

# publishUpdateChargeEventsV2

Private. For onUpdateChargeEventsV2 subscription.

```
publishUpdateChargeEventsV2(
  accountId: ID!
  id: ID!
): ItemLevelUpdate
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`publishUpdateChargeEventsV2.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#publishupdatechargeeventsv2accountidid-- "Direct link to publishupdatechargeeventsv2accountidid--")

#### [`publishUpdateChargeEventsV2.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#publishupdatechargeeventsv2idid-- "Direct link to publishupdatechargeeventsv2idid--")

### Type[​](#type "Direct link to Type")

#### [`ItemLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/item-level-update/.md) object[​](#itemlevelupdate- "Direct link to itemlevelupdate-")


---

# publishUpdateChargeEvents

DEPRECATED

Use publishUpdateChargeEventsV2 instead

Private. For onUpdateChargeEvents subscription.

```
publishUpdateChargeEvents(
  accountId: ID!
  data: ChargeEventsChangeInput!
): ItemLevelUpdate @deprecated
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`publishUpdateChargeEvents.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#publishupdatechargeeventsaccountidid-- "Direct link to publishupdatechargeeventsaccountidid--")

#### [`publishUpdateChargeEvents.data`](#) ● [`ChargeEventsChangeInput!`](https://docs.monei.com/apis/graphql/types/inputs/charge-events-change-input/.md) non-null input[​](#publishupdatechargeeventsdatachargeeventschangeinput-- "Direct link to publishupdatechargeeventsdatachargeeventschangeinput--")

### Type[​](#type "Direct link to Type")

#### [`ItemLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/item-level-update/.md) object[​](#itemlevelupdate- "Direct link to itemlevelupdate-")


---

# publishUpdateChargeV2

Private. For onUpdateChargeV2 subscription.

```
publishUpdateChargeV2(
  accountId: ID!
  id: ID!
): ItemLevelUpdate
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`publishUpdateChargeV2.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#publishupdatechargev2accountidid-- "Direct link to publishupdatechargev2accountidid--")

#### [`publishUpdateChargeV2.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#publishupdatechargev2idid-- "Direct link to publishupdatechargev2idid--")

### Type[​](#type "Direct link to Type")

#### [`ItemLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/item-level-update/.md) object[​](#itemlevelupdate- "Direct link to itemlevelupdate-")


---

# publishUpdateCharge

DEPRECATED

Use publishUpdateChargeV2 instead

Private. For onUpdateCharge subscription.

```
publishUpdateCharge(
  accountId: ID!
  data: UpdateChargeInput!
): Charge @deprecated
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`publishUpdateCharge.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#publishupdatechargeaccountidid-- "Direct link to publishupdatechargeaccountidid--")

#### [`publishUpdateCharge.data`](#) ● [`UpdateChargeInput!`](https://docs.monei.com/apis/graphql/types/inputs/update-charge-input/.md) non-null input[​](#publishupdatechargedataupdatechargeinput-- "Direct link to publishupdatechargedataupdatechargeinput--")

### Type[​](#type "Direct link to Type")

#### [`Charge`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) object[​](#charge- "Direct link to charge-")


---

# publishUpdateCharges

Private. For onUpdateCharges subscription.

```
publishUpdateCharges(
  accountId: ID!
): AccountLevelUpdate
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`publishUpdateCharges.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#publishupdatechargesaccountidid-- "Direct link to publishupdatechargesaccountidid--")

### Type[​](#type "Direct link to Type")

#### [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object[​](#accountlevelupdate- "Direct link to accountlevelupdate-")


---

# publishUpdateDocuments

Private. For onUpdateDocuments subscription.

```
publishUpdateDocuments(
  accountId: ID!
): AccountLevelUpdate
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`publishUpdateDocuments.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#publishupdatedocumentsaccountidid-- "Direct link to publishupdatedocumentsaccountidid--")

### Type[​](#type "Direct link to Type")

#### [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object[​](#accountlevelupdate- "Direct link to accountlevelupdate-")


---

# publishUpdateEvents

Private. For onUpdateEvents subscription.

```
publishUpdateEvents(
  accountId: ID!
): AccountLevelUpdate
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`publishUpdateEvents.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#publishupdateeventsaccountidid-- "Direct link to publishupdateeventsaccountidid--")

### Type[​](#type "Direct link to Type")

#### [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object[​](#accountlevelupdate- "Direct link to accountlevelupdate-")


---

# publishUpdateSubscriptionEventsV2

Private. For onUpdateSubscriptionEventsV2 subscription.

```
publishUpdateSubscriptionEventsV2(
  accountId: ID!
  id: ID!
): ItemLevelUpdate
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`publishUpdateSubscriptionEventsV2.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#publishupdatesubscriptioneventsv2accountidid-- "Direct link to publishupdatesubscriptioneventsv2accountidid--")

#### [`publishUpdateSubscriptionEventsV2.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#publishupdatesubscriptioneventsv2idid-- "Direct link to publishupdatesubscriptioneventsv2idid--")

### Type[​](#type "Direct link to Type")

#### [`ItemLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/item-level-update/.md) object[​](#itemlevelupdate- "Direct link to itemlevelupdate-")


---

# publishUpdateSubscriptionEvents

DEPRECATED

Use publishUpdateSubscriptionEventsV2 instead

Private. For onUpdateSubscriptionEvents subscription.

```
publishUpdateSubscriptionEvents(
  accountId: ID!
  data: SubscriptionEventsChangeInput!
): ItemLevelUpdate @deprecated
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`publishUpdateSubscriptionEvents.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#publishupdatesubscriptioneventsaccountidid-- "Direct link to publishupdatesubscriptioneventsaccountidid--")

#### [`publishUpdateSubscriptionEvents.data`](#) ● [`SubscriptionEventsChangeInput!`](https://docs.monei.com/apis/graphql/types/inputs/subscription-events-change-input/.md) non-null input[​](#publishupdatesubscriptioneventsdatasubscriptioneventschangeinput-- "Direct link to publishupdatesubscriptioneventsdatasubscriptioneventschangeinput--")

### Type[​](#type "Direct link to Type")

#### [`ItemLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/item-level-update/.md) object[​](#itemlevelupdate- "Direct link to itemlevelupdate-")


---

# publishUpdateSubscription

Private. For onUpdateSubscriptionV2 subscription.

```
publishUpdateSubscription(
  accountId: ID!
  id: ID!
): ItemLevelUpdate
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`publishUpdateSubscription.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#publishupdatesubscriptionaccountidid-- "Direct link to publishupdatesubscriptionaccountidid--")

#### [`publishUpdateSubscription.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#publishupdatesubscriptionidid-- "Direct link to publishupdatesubscriptionidid--")

### Type[​](#type "Direct link to Type")

#### [`ItemLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/item-level-update/.md) object[​](#itemlevelupdate- "Direct link to itemlevelupdate-")


---

# publishUpdateSubscriptions

Private. For onUpdateSubscriptions subscription.

```
publishUpdateSubscriptions(
  accountId: ID!
): AccountLevelUpdate
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`publishUpdateSubscriptions.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#publishupdatesubscriptionsaccountidid-- "Direct link to publishupdatesubscriptionsaccountidid--")

### Type[​](#type "Direct link to Type")

#### [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object[​](#accountlevelupdate- "Direct link to accountlevelupdate-")


---

# publishUpdateWebReport

Private. For onUpdateWebReport subscription.

```
publishUpdateWebReport(
  accountId: ID!
): AccountLevelUpdate
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`publishUpdateWebReport.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#publishupdatewebreportaccountidid-- "Direct link to publishupdatewebreportaccountidid--")

### Type[​](#type "Direct link to Type")

#### [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object[​](#accountlevelupdate- "Direct link to accountlevelupdate-")


---

# refundPayment

Refund a payment

```
refundPayment(
  input: RefundPaymentInput!
): Payment
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`refundPayment.input`](#) ● [`RefundPaymentInput!`](https://docs.monei.com/apis/graphql/types/inputs/refund-payment-input/.md) non-null input[​](#refundpaymentinputrefundpaymentinput-- "Direct link to refundpaymentinputrefundpaymentinput--")

### Type[​](#type "Direct link to Type")

#### [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object[​](#payment- "Direct link to payment-")


---

# registerApplePayDomain

Register domain name for Apple Pay

```
registerApplePayDomain(
  input: RegisterApplePayDomainInput!
): RegisterApplePayDomain!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`registerApplePayDomain.input`](#) ● [`RegisterApplePayDomainInput!`](https://docs.monei.com/apis/graphql/types/inputs/register-apple-pay-domain-input/.md) non-null input[​](#registerapplepaydomaininputregisterapplepaydomaininput-- "Direct link to registerapplepaydomaininputregisterapplepaydomaininput--")

### Type[​](#type "Direct link to Type")

#### [`RegisterApplePayDomain`](https://docs.monei.com/apis/graphql/types/objects/register-apple-pay-domain/.md) object[​](#registerapplepaydomain- "Direct link to registerapplepaydomain-")


---

# registerCode

Registers a new code

```
registerCode(
  input: RegisterCodeInput!
): Code!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`registerCode.input`](#) ● [`RegisterCodeInput!`](https://docs.monei.com/apis/graphql/types/inputs/register-code-input/.md) non-null input[​](#registercodeinputregistercodeinput-- "Direct link to registercodeinputregistercodeinput--")

### Type[​](#type "Direct link to Type")

#### [`Code`](https://docs.monei.com/apis/graphql/types/objects/code/.md) object[​](#code- "Direct link to code-")


---

# requestAccountReview

Request for account review after additional information has been provided

```
requestAccountReview(
  note: String
): Account!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`requestAccountReview.note`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#requestaccountreviewnotestring- "Direct link to requestaccountreviewnotestring-")

### Type[​](#type "Direct link to Type")

#### [`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object[​](#account- "Direct link to account-")

Account information


---

# resumeSubscription

Resume a subscription

```
resumeSubscription(
  input: ResumeSubscriptionInput!
): Subscription!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`resumeSubscription.input`](#) ● [`ResumeSubscriptionInput!`](https://docs.monei.com/apis/graphql/types/inputs/resume-subscription-input/.md) non-null input[​](#resumesubscriptioninputresumesubscriptioninput-- "Direct link to resumesubscriptioninputresumesubscriptioninput--")

### Type[​](#type "Direct link to Type")

#### [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object[​](#subscription- "Direct link to subscription-")


---

# selectUserAccount

Selects user account

```
selectUserAccount(
  accountId: ID!
): Boolean!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`selectUserAccount.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#selectuseraccountaccountidid-- "Direct link to selectuseraccountaccountidid--")

### Type[​](#type "Direct link to Type")

#### [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#boolean- "Direct link to boolean-")

The `Boolean` scalar type represents `true` or `false`.


---

# sendPaymentLink

Send a payment link over email (or sms)

```
sendPaymentLink(
  input: SendPaymentMessageInput!
): Payment
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`sendPaymentLink.input`](#) ● [`SendPaymentMessageInput!`](https://docs.monei.com/apis/graphql/types/inputs/send-payment-message-input/.md) non-null input[​](#sendpaymentlinkinputsendpaymentmessageinput-- "Direct link to sendpaymentlinkinputsendpaymentmessageinput--")

### Type[​](#type "Direct link to Type")

#### [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object[​](#payment- "Direct link to payment-")


---

# sendPaymentReceipt

Send a payment receipt over email

```
sendPaymentReceipt(
  input: SendPaymentMessageInput!
): Payment
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`sendPaymentReceipt.input`](#) ● [`SendPaymentMessageInput!`](https://docs.monei.com/apis/graphql/types/inputs/send-payment-message-input/.md) non-null input[​](#sendpaymentreceiptinputsendpaymentmessageinput-- "Direct link to sendpaymentreceiptinputsendpaymentmessageinput--")

### Type[​](#type "Direct link to Type")

#### [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object[​](#payment- "Direct link to payment-")


---

# sendPaymentRequest

Send a request to pay

```
sendPaymentRequest(
  input: SendPaymentRequestInput!
): Payment
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`sendPaymentRequest.input`](#) ● [`SendPaymentRequestInput!`](https://docs.monei.com/apis/graphql/types/inputs/send-payment-request-input/.md) non-null input[​](#sendpaymentrequestinputsendpaymentrequestinput-- "Direct link to sendpaymentrequestinputsendpaymentrequestinput--")

### Type[​](#type "Direct link to Type")

#### [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object[​](#payment- "Direct link to payment-")


---

# sendSubscriptionLink

Send a subscription link over email (or sms)

```
sendSubscriptionLink(
  input: SendSubscriptionMessageInput!
): Subscription
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`sendSubscriptionLink.input`](#) ● [`SendSubscriptionMessageInput!`](https://docs.monei.com/apis/graphql/types/inputs/send-subscription-message-input/.md) non-null input[​](#sendsubscriptionlinkinputsendsubscriptionmessageinput-- "Direct link to sendsubscriptionlinkinputsendsubscriptionmessageinput--")

### Type[​](#type "Direct link to Type")

#### [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object[​](#subscription- "Direct link to subscription-")


---

# sendSubscriptionStatus

Send a subscription status over email (or sms)

```
sendSubscriptionStatus(
  input: SendSubscriptionMessageInput!
): Subscription
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`sendSubscriptionStatus.input`](#) ● [`SendSubscriptionMessageInput!`](https://docs.monei.com/apis/graphql/types/inputs/send-subscription-message-input/.md) non-null input[​](#sendsubscriptionstatusinputsendsubscriptionmessageinput-- "Direct link to sendsubscriptionstatusinputsendsubscriptionmessageinput--")

### Type[​](#type "Direct link to Type")

#### [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object[​](#subscription- "Direct link to subscription-")


---

# setDefaultCardProvider

Updates existing card provider to make it the only one enabled

```
setDefaultCardProvider(
  providerId: ID!
): Provider!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`setDefaultCardProvider.providerId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#setdefaultcardproviderprovideridid-- "Direct link to setdefaultcardproviderprovideridid--")

### Type[​](#type "Direct link to Type")

#### [`Provider`](https://docs.monei.com/apis/graphql/types/objects/provider/.md) object[​](#provider- "Direct link to provider-")


---

# setupAccount

Updates the account information during KYC process

```
setupAccount(
  input: SetupAccountInput!
): Account!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`setupAccount.input`](#) ● [`SetupAccountInput!`](https://docs.monei.com/apis/graphql/types/inputs/setup-account-input/.md) non-null input[​](#setupaccountinputsetupaccountinput-- "Direct link to setupaccountinputsetupaccountinput--")

### Type[​](#type "Direct link to Type")

#### [`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object[​](#account- "Direct link to account-")

Account information


---

# startCompanyLookup

Lookup company in the registry

```
startCompanyLookup(
  documentNumber: String!
): Account!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`startCompanyLookup.documentNumber`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#startcompanylookupdocumentnumberstring-- "Direct link to startcompanylookupdocumentnumberstring--")

### Type[​](#type "Direct link to Type")

#### [`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object[​](#account- "Direct link to account-")

Account information


---

# startExportCharges

Start the export of a list of charges

```
startExportCharges(
  filter: SearchableChargeFilterInput
  columns: [String!]
  timezone: String
): ChargesExport!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`startExportCharges.filter`](#) ● [`SearchableChargeFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-charge-filter-input/.md) input[​](#startexportchargesfiltersearchablechargefilterinput- "Direct link to startexportchargesfiltersearchablechargefilterinput-")

#### [`startExportCharges.columns`](#) ● [`[String!]`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) list scalar[​](#startexportchargescolumnsstring-- "Direct link to startexportchargescolumnsstring--")

#### [`startExportCharges.timezone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#startexportchargestimezonestring- "Direct link to startexportchargestimezonestring-")

### Type[​](#type "Direct link to Type")

#### [`ChargesExport`](https://docs.monei.com/apis/graphql/types/objects/charges-export/.md) object[​](#chargesexport- "Direct link to chargesexport-")


---

# updateAccount

Updates the account information

```
updateAccount(
  input: UpdateAccountInput!
): Account!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`updateAccount.input`](#) ● [`UpdateAccountInput!`](https://docs.monei.com/apis/graphql/types/inputs/update-account-input/.md) non-null input[​](#updateaccountinputupdateaccountinput-- "Direct link to updateaccountinputupdateaccountinput--")

### Type[​](#type "Direct link to Type")

#### [`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object[​](#account- "Direct link to account-")

Account information


---

# updateApplePayCert

Update Custom Apple Pay certificate

```
updateApplePayCert(
  input: UpdateApplePayCertInput
): ApplePayCertificate!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`updateApplePayCert.input`](#) ● [`UpdateApplePayCertInput`](https://docs.monei.com/apis/graphql/types/inputs/update-apple-pay-cert-input/.md) input[​](#updateapplepaycertinputupdateapplepaycertinput- "Direct link to updateapplepaycertinputupdateapplepaycertinput-")

### Type[​](#type "Direct link to Type")

#### [`ApplePayCertificate`](https://docs.monei.com/apis/graphql/types/objects/apple-pay-certificate/.md) object[​](#applepaycertificate- "Direct link to applepaycertificate-")

Custom Apple Pay Certificate needed to enable Apple Pay in the native iOS app. Apple only allows certificates that are created by developers to be used in the Apple Pay payment process. Register your custom Apple Pay certificate to allow MONEI to decrypt the payment data.


---

# updateAuthorizedUser

Updates an authorized user

```
updateAuthorizedUser(
  input: UpdateAuthorizedUserInput!
): AuthorizedUser
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`updateAuthorizedUser.input`](#) ● [`UpdateAuthorizedUserInput!`](https://docs.monei.com/apis/graphql/types/inputs/update-authorized-user-input/.md) non-null input[​](#updateauthorizeduserinputupdateauthorizeduserinput-- "Direct link to updateauthorizeduserinputupdateauthorizeduserinput--")

### Type[​](#type "Direct link to Type")

#### [`AuthorizedUser`](https://docs.monei.com/apis/graphql/types/objects/authorized-user/.md) object[​](#authorizeduser- "Direct link to authorizeduser-")

An authorized user that can access the MONEI dashboard. One user can have access to multiple accounts with different access levels.


---

# updateCode

Updates an existing code

```
updateCode(
  input: UpdateCodeInput!
): Code!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`updateCode.input`](#) ● [`UpdateCodeInput!`](https://docs.monei.com/apis/graphql/types/inputs/update-code-input/.md) non-null input[​](#updatecodeinputupdatecodeinput-- "Direct link to updatecodeinputupdatecodeinput--")

### Type[​](#type "Direct link to Type")

#### [`Code`](https://docs.monei.com/apis/graphql/types/objects/code/.md) object[​](#code- "Direct link to code-")


---

# updateExportSftpConfig

Update a SFTP config export

```
updateExportSftpConfig(
  input: UpdateExportSftpConfigInput!
): SftpConfigExport!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`updateExportSftpConfig.input`](#) ● [`UpdateExportSftpConfigInput!`](https://docs.monei.com/apis/graphql/types/inputs/update-export-sftp-config-input/.md) non-null input[​](#updateexportsftpconfiginputupdateexportsftpconfiginput-- "Direct link to updateexportsftpconfiginputupdateexportsftpconfiginput--")

### Type[​](#type "Direct link to Type")

#### [`SftpConfigExport`](https://docs.monei.com/apis/graphql/types/objects/sftp-config-export/.md) object[​](#sftpconfigexport- "Direct link to sftpconfigexport-")


---

# updatePaymentRule

Update a payment rule

```
updatePaymentRule(
  input: UpdatePaymentRuleInput!
): PaymentRule!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`updatePaymentRule.input`](#) ● [`UpdatePaymentRuleInput!`](https://docs.monei.com/apis/graphql/types/inputs/update-payment-rule-input/.md) non-null input[​](#updatepaymentruleinputupdatepaymentruleinput-- "Direct link to updatepaymentruleinputupdatepaymentruleinput--")

### Type[​](#type "Direct link to Type")

#### [`PaymentRule`](https://docs.monei.com/apis/graphql/types/objects/payment-rule/.md) object[​](#paymentrule- "Direct link to paymentrule-")

Payment rule


---

# updatePointOfSale

Updates an existing point of sale

```
updatePointOfSale(
  input: UpdatePointOfSaleInput!
): PointOfSale!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`updatePointOfSale.input`](#) ● [`UpdatePointOfSaleInput!`](https://docs.monei.com/apis/graphql/types/inputs/update-point-of-sale-input/.md) non-null input[​](#updatepointofsaleinputupdatepointofsaleinput-- "Direct link to updatepointofsaleinputupdatepointofsaleinput--")

### Type[​](#type "Direct link to Type")

#### [`PointOfSale`](https://docs.monei.com/apis/graphql/types/objects/point-of-sale/.md) object[​](#pointofsale- "Direct link to pointofsale-")


---

# updateProvider

Updates an existing provider

```
updateProvider(
  input: UpdateProviderInput!
): Provider!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`updateProvider.input`](#) ● [`UpdateProviderInput!`](https://docs.monei.com/apis/graphql/types/inputs/update-provider-input/.md) non-null input[​](#updateproviderinputupdateproviderinput-- "Direct link to updateproviderinputupdateproviderinput--")

### Type[​](#type "Direct link to Type")

#### [`Provider`](https://docs.monei.com/apis/graphql/types/objects/provider/.md) object[​](#provider- "Direct link to provider-")


---

# updateShopifyShopSettings

Update Shopify shop settings

```
updateShopifyShopSettings(
  input: UpdateShopifyShopSettingsInput!
): UpdateShopifyShopSettingsResult!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`updateShopifyShopSettings.input`](#) ● [`UpdateShopifyShopSettingsInput!`](https://docs.monei.com/apis/graphql/types/inputs/update-shopify-shop-settings-input/.md) non-null input[​](#updateshopifyshopsettingsinputupdateshopifyshopsettingsinput-- "Direct link to updateshopifyshopsettingsinputupdateshopifyshopsettingsinput--")

### Type[​](#type "Direct link to Type")

#### [`UpdateShopifyShopSettingsResult`](https://docs.monei.com/apis/graphql/types/objects/update-shopify-shop-settings-result/.md) object[​](#updateshopifyshopsettingsresult- "Direct link to updateshopifyshopsettingsresult-")


---

# updateStore

Updates an existing store

```
updateStore(
  input: UpdateStoreInput!
): Store!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`updateStore.input`](#) ● [`UpdateStoreInput!`](https://docs.monei.com/apis/graphql/types/inputs/update-store-input/.md) non-null input[​](#updatestoreinputupdatestoreinput-- "Direct link to updatestoreinputupdatestoreinput--")

### Type[​](#type "Direct link to Type")

#### [`Store`](https://docs.monei.com/apis/graphql/types/objects/store/.md) object[​](#store- "Direct link to store-")


---

# updateSubscription

Schedule a subscription

```
updateSubscription(
  input: UpdateSubscriptionInput!
): Subscription!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`updateSubscription.input`](#) ● [`UpdateSubscriptionInput!`](https://docs.monei.com/apis/graphql/types/inputs/update-subscription-input/.md) non-null input[​](#updatesubscriptioninputupdatesubscriptioninput-- "Direct link to updatesubscriptioninputupdatesubscriptioninput--")

### Type[​](#type "Direct link to Type")

#### [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object[​](#subscription- "Direct link to subscription-")


---

# updateWebhook

Update webhook

```
updateWebhook(
  input: UpdateWebhookInput!
): Webhook!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`updateWebhook.input`](#) ● [`UpdateWebhookInput!`](https://docs.monei.com/apis/graphql/types/inputs/update-webhook-input/.md) non-null input[​](#updatewebhookinputupdatewebhookinput-- "Direct link to updatewebhookinputupdatewebhookinput--")

### Type[​](#type "Direct link to Type")

#### [`Webhook`](https://docs.monei.com/apis/graphql/types/objects/webhook/.md) object[​](#webhook- "Direct link to webhook-")


---

# uploadDocument

Create an upload url for a document

```
uploadDocument(
  id: ID!
  contentType: String!
): UploadFile!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`uploadDocument.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#uploaddocumentidid-- "Direct link to uploaddocumentidid--")

#### [`uploadDocument.contentType`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#uploaddocumentcontenttypestring-- "Direct link to uploaddocumentcontenttypestring--")

### Type[​](#type "Direct link to Type")

#### [`UploadFile`](https://docs.monei.com/apis/graphql/types/objects/upload-file/.md) object[​](#uploadfile- "Direct link to uploadfile-")


---

# validateWebsite

Validate a website.

```
validateWebsite(
  website: String!
): WebReport
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`validateWebsite.website`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#validatewebsitewebsitestring-- "Direct link to validatewebsitewebsitestring--")

### Type[​](#type "Direct link to Type")

#### [`WebReport`](https://docs.monei.com/apis/graphql/types/objects/web-report/.md) object[​](#webreport- "Direct link to webreport-")

A web report is a report of the website.


---

# verifyBusinessDetails

Verifies information about the business and updates it

```
verifyBusinessDetails(
  input: SetupAccountInput!
): Account!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`verifyBusinessDetails.input`](#) ● [`SetupAccountInput!`](https://docs.monei.com/apis/graphql/types/inputs/setup-account-input/.md) non-null input[​](#verifybusinessdetailsinputsetupaccountinput-- "Direct link to verifybusinessdetailsinputsetupaccountinput--")

### Type[​](#type "Direct link to Type")

#### [`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object[​](#account- "Direct link to account-")

Account information


---

# verifyCustomDomain

Verifies a custom domain

```
verifyCustomDomain: Account!
```

### Type[​](#type "Direct link to Type")

#### [`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object[​](#account- "Direct link to account-")

Account information


---

# accountBalances

List of the account balances

```
accountBalances: AccountBalancesConnection!
```

### Type[​](#type "Direct link to Type")

#### [`AccountBalancesConnection`](https://docs.monei.com/apis/graphql/types/objects/account-balances-connection/.md) object[​](#accountbalancesconnection- "Direct link to accountbalancesconnection-")


---

# accountInvoice

A single account invoice

```
accountInvoice(
  id: ID!
): AccountInvoice
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`accountInvoice.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#accountinvoiceidid-- "Direct link to accountinvoiceidid--")

### Type[​](#type "Direct link to Type")

#### [`AccountInvoice`](https://docs.monei.com/apis/graphql/types/objects/account-invoice/.md) object[​](#accountinvoice- "Direct link to accountinvoice-")

Invoice that MONEI issues to the account, this invoice is generated based on the account transactions and includes all the fees for the given period


---

# accountInvoices

List of the account invoices

```
accountInvoices(
  filter: SearchableAccountInvoiceFilterInput
  size: Int
  from: Int
): AccountInvoicesConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`accountInvoices.filter`](#) ● [`SearchableAccountInvoiceFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-account-invoice-filter-input/.md) input[​](#accountinvoicesfiltersearchableaccountinvoicefilterinput- "Direct link to accountinvoicesfiltersearchableaccountinvoicefilterinput-")

#### [`accountInvoices.size`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#accountinvoicessizeint- "Direct link to accountinvoicessizeint-")

#### [`accountInvoices.from`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#accountinvoicesfromint- "Direct link to accountinvoicesfromint-")

### Type[​](#type "Direct link to Type")

#### [`AccountInvoicesConnection`](https://docs.monei.com/apis/graphql/types/objects/account-invoices-connection/.md) object[​](#accountinvoicesconnection- "Direct link to accountinvoicesconnection-")

Account invoices connection


---

# accountSettlement

A single account settlement

```
accountSettlement(
  id: ID!
): AccountSettlement
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`accountSettlement.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#accountsettlementidid-- "Direct link to accountsettlementidid--")

### Type[​](#type "Direct link to Type")

#### [`AccountSettlement`](https://docs.monei.com/apis/graphql/types/objects/account-settlement/.md) object[​](#accountsettlement- "Direct link to accountsettlement-")


---

# accountSettlements

List of the account settlements

```
accountSettlements(
  filter: SearchableAccountSettlementFilterInput
  size: Int
  from: Int
): AccountSettlementsConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`accountSettlements.filter`](#) ● [`SearchableAccountSettlementFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-account-settlement-filter-input/.md) input[​](#accountsettlementsfiltersearchableaccountsettlementfilterinput- "Direct link to accountsettlementsfiltersearchableaccountsettlementfilterinput-")

#### [`accountSettlements.size`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#accountsettlementssizeint- "Direct link to accountsettlementssizeint-")

#### [`accountSettlements.from`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#accountsettlementsfromint- "Direct link to accountsettlementsfromint-")

### Type[​](#type "Direct link to Type")

#### [`AccountSettlementsConnection`](https://docs.monei.com/apis/graphql/types/objects/account-settlements-connection/.md) object[​](#accountsettlementsconnection- "Direct link to accountsettlementsconnection-")


---

# account

Account information

```
account: Account!
```

### Type[​](#type "Direct link to Type")

#### [`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object[​](#account- "Direct link to account-")

Account information


---

# applePayCert

Get Custom Apple Pay certificate by ID

```
applePayCert(
  id: ID!
): ApplePayCertificate
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`applePayCert.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#applepaycertidid-- "Direct link to applepaycertidid--")

### Type[​](#type "Direct link to Type")

#### [`ApplePayCertificate`](https://docs.monei.com/apis/graphql/types/objects/apple-pay-certificate/.md) object[​](#applepaycertificate- "Direct link to applepaycertificate-")

Custom Apple Pay Certificate needed to enable Apple Pay in the native iOS app. Apple only allows certificates that are created by developers to be used in the Apple Pay payment process. Register your custom Apple Pay certificate to allow MONEI to decrypt the payment data.


---

# applePayCerts

List of Custom Apple Pay certificates

```
applePayCerts: [ApplePayCertificate!]
```

### Type[​](#type "Direct link to Type")

#### [`ApplePayCertificate`](https://docs.monei.com/apis/graphql/types/objects/apple-pay-certificate/.md) object[​](#applepaycertificate- "Direct link to applepaycertificate-")

Custom Apple Pay Certificate needed to enable Apple Pay in the native iOS app. Apple only allows certificates that are created by developers to be used in the Apple Pay payment process. Register your custom Apple Pay certificate to allow MONEI to decrypt the payment data.


---

# authorizedUsers

List of the authorized users

```
authorizedUsers(
  token: String
  pageSize: Int
): AuthorizedUsersConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`authorizedUsers.token`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#authorizeduserstokenstring- "Direct link to authorizeduserstokenstring-")

#### [`authorizedUsers.pageSize`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#authorizeduserspagesizeint- "Direct link to authorizeduserspagesizeint-")

### Type[​](#type "Direct link to Type")

#### [`AuthorizedUsersConnection`](https://docs.monei.com/apis/graphql/types/objects/authorized-users-connection/.md) object[​](#authorizedusersconnection- "Direct link to authorizedusersconnection-")


---

# availablePaymentMethods

Lists all the available payment methods

```
availablePaymentMethods: [AvailablePaymentMethod!]
```

### Type[​](#type "Direct link to Type")

#### [`AvailablePaymentMethod`](https://docs.monei.com/apis/graphql/types/objects/available-payment-method/.md) object[​](#availablepaymentmethod- "Direct link to availablepaymentmethod-")


---

# availableProcessors

Lists all the available processors for the payment method

```
availableProcessors(
  paymentMethod: PaymentMethods!
): [AvailableProcessor!]
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`availableProcessors.paymentMethod`](#) ● [`PaymentMethods!`](https://docs.monei.com/apis/graphql/types/enums/payment-methods/.md) non-null enum[​](#availableprocessorspaymentmethodpaymentmethods-- "Direct link to availableprocessorspaymentmethodpaymentmethods--")

### Type[​](#type "Direct link to Type")

#### [`AvailableProcessor`](https://docs.monei.com/apis/graphql/types/objects/available-processor/.md) object[​](#availableprocessor- "Direct link to availableprocessor-")


---

# banks

List of available banks for Bank Account Verification

```
banks(
  country: String!
): [Bank!]!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`banks.country`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#bankscountrystring-- "Direct link to bankscountrystring--")

### Type[​](#type "Direct link to Type")

#### [`Bank`](https://docs.monei.com/apis/graphql/types/objects/bank/.md) object[​](#bank- "Direct link to bank-")


---

# blacklistItem

Get blacklist item by value

```
blacklistItem(
  value: String!
): BlacklistItem
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`blacklistItem.value`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#blacklistitemvaluestring-- "Direct link to blacklistitemvaluestring--")

### Type[​](#type "Direct link to Type")

#### [`BlacklistItem`](https://docs.monei.com/apis/graphql/types/objects/blacklist-item/.md) object[​](#blacklistitem- "Direct link to blacklistitem-")

Blacklist item, e.g. email, phone, ip, card, bin, fingerprint. All payments with this value will be blocked.


---

# blacklistItems

List of the blacklist items

```
blacklistItems(
  token: String
  pageSize: Int
  type: BlacklistItemType
): BlacklistItemsConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`blacklistItems.token`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#blacklistitemstokenstring- "Direct link to blacklistitemstokenstring-")

#### [`blacklistItems.pageSize`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#blacklistitemspagesizeint- "Direct link to blacklistitemspagesizeint-")

#### [`blacklistItems.type`](#) ● [`BlacklistItemType`](https://docs.monei.com/apis/graphql/types/enums/blacklist-item-type/.md) enum[​](#blacklistitemstypeblacklistitemtype- "Direct link to blacklistitemstypeblacklistitemtype-")

### Type[​](#type "Direct link to Type")

#### [`BlacklistItemsConnection`](https://docs.monei.com/apis/graphql/types/objects/blacklist-items-connection/.md) object[​](#blacklistitemsconnection- "Direct link to blacklistitemsconnection-")


---

# chargeEvents

List of the charge events

```
chargeEvents(
  chargeId: ID!
  size: Int
  from: Int
): ChargeEventsConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`chargeEvents.chargeId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#chargeeventschargeidid-- "Direct link to chargeeventschargeidid--")

#### [`chargeEvents.size`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#chargeeventssizeint- "Direct link to chargeeventssizeint-")

#### [`chargeEvents.from`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#chargeeventsfromint- "Direct link to chargeeventsfromint-")

### Type[​](#type "Direct link to Type")

#### [`ChargeEventsConnection`](https://docs.monei.com/apis/graphql/types/objects/charge-events-connection/.md) object[​](#chargeeventsconnection- "Direct link to chargeeventsconnection-")


---

# chargeSources

List of possible charge sources

```
chargeSources: [String!]!
```

### Type[​](#type "Direct link to Type")

#### [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#string- "Direct link to string-")

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.


---

# charge

A single charge

```
charge(
  id: ID!
): Charge
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`charge.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#chargeidid-- "Direct link to chargeidid--")

### Type[​](#type "Direct link to Type")

#### [`Charge`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) object[​](#charge- "Direct link to charge-")


---

# chargesDateRangeKPI

Get charges KPI for a date range

```
chargesDateRangeKPI(
  start: Int
  end: Int
  interval: Interval
  timezone: String
  storeId: ID
  pointOfSaleId: ID
  currency: Currencies
): ChargesDateRangeKPI!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`chargesDateRangeKPI.start`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#chargesdaterangekpistartint- "Direct link to chargesdaterangekpistartint-")

#### [`chargesDateRangeKPI.end`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#chargesdaterangekpiendint- "Direct link to chargesdaterangekpiendint-")

#### [`chargesDateRangeKPI.interval`](#) ● [`Interval`](https://docs.monei.com/apis/graphql/types/enums/interval/.md) enum[​](#chargesdaterangekpiintervalinterval- "Direct link to chargesdaterangekpiintervalinterval-")

#### [`chargesDateRangeKPI.timezone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#chargesdaterangekpitimezonestring- "Direct link to chargesdaterangekpitimezonestring-")

#### [`chargesDateRangeKPI.storeId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#chargesdaterangekpistoreidid- "Direct link to chargesdaterangekpistoreidid-")

#### [`chargesDateRangeKPI.pointOfSaleId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#chargesdaterangekpipointofsaleidid- "Direct link to chargesdaterangekpipointofsaleidid-")

#### [`chargesDateRangeKPI.currency`](#) ● [`Currencies`](https://docs.monei.com/apis/graphql/types/enums/currencies/.md) enum[​](#chargesdaterangekpicurrencycurrencies- "Direct link to chargesdaterangekpicurrencycurrencies-")

### Type[​](#type "Direct link to Type")

#### [`ChargesDateRangeKPI`](https://docs.monei.com/apis/graphql/types/objects/charges-date-range-kpi/.md) object[​](#chargesdaterangekpi- "Direct link to chargesdaterangekpi-")


---

# chargesExport

No description

```
chargesExport(
  id: ID!
): ChargesExport
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`chargesExport.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#chargesexportidid-- "Direct link to chargesexportidid--")

### Type[​](#type "Direct link to Type")

#### [`ChargesExport`](https://docs.monei.com/apis/graphql/types/objects/charges-export/.md) object[​](#chargesexport- "Direct link to chargesexport-")


---

# chargesExports

No description

```
chargesExports(
  token: String
  pageSize: Int
): ChargesExportsConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`chargesExports.token`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#chargesexportstokenstring- "Direct link to chargesexportstokenstring-")

#### [`chargesExports.pageSize`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#chargesexportspagesizeint- "Direct link to chargesexportspagesizeint-")

### Type[​](#type "Direct link to Type")

#### [`ChargesExportsConnection`](https://docs.monei.com/apis/graphql/types/objects/charges-exports-connection/.md) object[​](#chargesexportsconnection- "Direct link to chargesexportsconnection-")


---

# charges

List of the charges

```
charges(
  filter: SearchableChargeFilterInput
  size: Int
  from: Int
): ChargesConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`charges.filter`](#) ● [`SearchableChargeFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-charge-filter-input/.md) input[​](#chargesfiltersearchablechargefilterinput- "Direct link to chargesfiltersearchablechargefilterinput-")

#### [`charges.size`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#chargessizeint- "Direct link to chargessizeint-")

#### [`charges.from`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#chargesfromint- "Direct link to chargesfromint-")

### Type[​](#type "Direct link to Type")

#### [`ChargesConnection`](https://docs.monei.com/apis/graphql/types/objects/charges-connection/.md) object[​](#chargesconnection- "Direct link to chargesconnection-")


---

# code

A single code

```
code(
  id: ID!
): Code
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`code.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#codeidid-- "Direct link to codeidid--")

### Type[​](#type "Direct link to Type")

#### [`Code`](https://docs.monei.com/apis/graphql/types/objects/code/.md) object[​](#code- "Direct link to code-")


---

# codes

Lists all the codes of the account

```
codes(
  pointOfSaleId: ID
): [Code!]!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`codes.pointOfSaleId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#codespointofsaleidid- "Direct link to codespointofsaleidid-")

### Type[​](#type "Direct link to Type")

#### [`Code`](https://docs.monei.com/apis/graphql/types/objects/code/.md) object[​](#code- "Direct link to code-")


---

# countries

Returns all the countries and the user's current country

```
countries: Countries!
```

### Type[​](#type "Direct link to Type")

#### [`Countries`](https://docs.monei.com/apis/graphql/types/objects/countries/.md) object[​](#countries- "Direct link to countries-")


---

# document

No description

```
document(
  id: ID!
): Document
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`document.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#documentidid-- "Direct link to documentidid--")

### Type[​](#type "Direct link to Type")

#### [`Document`](https://docs.monei.com/apis/graphql/types/objects/document/.md) object[​](#document- "Direct link to document-")


---

# documents

No description

```
documents(
  token: String
  pageSize: Int
): DocumentsConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`documents.token`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#documentstokenstring- "Direct link to documentstokenstring-")

#### [`documents.pageSize`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#documentspagesizeint- "Direct link to documentspagesizeint-")

### Type[​](#type "Direct link to Type")

#### [`DocumentsConnection`](https://docs.monei.com/apis/graphql/types/objects/documents-connection/.md) object[​](#documentsconnection- "Direct link to documentsconnection-")


---

# events

List of application events

```
events(
  filter: SearchableEventFilterInput
  size: Int
  from: Int
): ChargeEventsConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`events.filter`](#) ● [`SearchableEventFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-event-filter-input/.md) input[​](#eventsfiltersearchableeventfilterinput- "Direct link to eventsfiltersearchableeventfilterinput-")

#### [`events.size`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#eventssizeint- "Direct link to eventssizeint-")

#### [`events.from`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#eventsfromint- "Direct link to eventsfromint-")

### Type[​](#type "Direct link to Type")

#### [`ChargeEventsConnection`](https://docs.monei.com/apis/graphql/types/objects/charge-events-connection/.md) object[​](#chargeeventsconnection- "Direct link to chargeeventsconnection-")


---

# exportSftpConfig

No description

```
exportSftpConfig(
  id: ID!
): SftpConfigExport!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`exportSftpConfig.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#exportsftpconfigidid-- "Direct link to exportsftpconfigidid--")

### Type[​](#type "Direct link to Type")

#### [`SftpConfigExport`](https://docs.monei.com/apis/graphql/types/objects/sftp-config-export/.md) object[​](#sftpconfigexport- "Direct link to sftpconfigexport-")


---

# exportSftpConfigs

No description

```
exportSftpConfigs: SftpConfigExportsConnection!
```

### Type[​](#type "Direct link to Type")

#### [`SftpConfigExportsConnection`](https://docs.monei.com/apis/graphql/types/objects/sftp-config-exports-connection/.md) object[​](#sftpconfigexportsconnection- "Direct link to sftpconfigexportsconnection-")


---

# getCapitalDataByAccount

Get MONEI Capital data (offer and lead) for an account

```
getCapitalDataByAccount: CapitalAccountData
```

### Type[​](#type "Direct link to Type")

#### [`CapitalAccountData`](https://docs.monei.com/apis/graphql/types/objects/capital-account-data/.md) object[​](#capitalaccountdata- "Direct link to capitalaccountdata-")

MONEI Capital account data containing offer and optional lead information


---

# getCapitalLoanDocument

Get a MONEI Capital loan document

```
getCapitalLoanDocument(
  loanId: ID!
  documentId: ID!
): CapitalLoanDocument
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`getCapitalLoanDocument.loanId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#getcapitalloandocumentloanidid-- "Direct link to getcapitalloandocumentloanidid--")

#### [`getCapitalLoanDocument.documentId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#getcapitalloandocumentdocumentidid-- "Direct link to getcapitalloandocumentdocumentidid--")

### Type[​](#type "Direct link to Type")

#### [`CapitalLoanDocument`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-document/.md) object[​](#capitalloandocument- "Direct link to capitalloandocument-")

MONEI Capital loan document


---

# getCapitalLoanRepayments

Get MONEI Capital loan repayments

```
getCapitalLoanRepayments(
  loanId: ID!
): CapitalLoanRepaymentsConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`getCapitalLoanRepayments.loanId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#getcapitalloanrepaymentsloanidid-- "Direct link to getcapitalloanrepaymentsloanidid--")

### Type[​](#type "Direct link to Type")

#### [`CapitalLoanRepaymentsConnection`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-repayments-connection/.md) object[​](#capitalloanrepaymentsconnection- "Direct link to capitalloanrepaymentsconnection-")

MONEI Capital loan repayments connection


---

# getCapitalLoan

Get a specific MONEI Capital loan by ID

```
getCapitalLoan(
  loanId: ID!
): CapitalLoanDetails
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`getCapitalLoan.loanId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#getcapitalloanloanidid-- "Direct link to getcapitalloanloanidid--")

### Type[​](#type "Direct link to Type")

#### [`CapitalLoanDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-details/.md) object[​](#capitalloandetails- "Direct link to capitalloandetails-")

MONEI Capital loan details


---

# getCapitalLoans

Get MONEI Capital loans for an account

```
getCapitalLoans: CapitalLoansConnection!
```

### Type[​](#type "Direct link to Type")

#### [`CapitalLoansConnection`](https://docs.monei.com/apis/graphql/types/objects/capital-loans-connection/.md) object[​](#capitalloansconnection- "Direct link to capitalloansconnection-")

MONEI Capital loans connection


---

# getShopifyShopSettings

Get Shopify shop settings

```
getShopifyShopSettings(
  input: GetShopifyShopSettingsInput!
): ShopifyShopSettings!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`getShopifyShopSettings.input`](#) ● [`GetShopifyShopSettingsInput!`](https://docs.monei.com/apis/graphql/types/inputs/get-shopify-shop-settings-input/.md) non-null input[​](#getshopifyshopsettingsinputgetshopifyshopsettingsinput-- "Direct link to getshopifyshopsettingsinputgetshopifyshopsettingsinput--")

### Type[​](#type "Direct link to Type")

#### [`ShopifyShopSettings`](https://docs.monei.com/apis/graphql/types/objects/shopify-shop-settings/.md) object[​](#shopifyshopsettings- "Direct link to shopifyshopsettings-")


---

# liveAccount

Live account information, returns production account regardless of the environment

```
liveAccount: Account!
```

### Type[​](#type "Direct link to Type")

#### [`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object[​](#account- "Direct link to account-")

Account information


---

# notificationsPortalUrl

Link to account notifications preferences

```
notificationsPortalUrl: Redirect
```

### Type[​](#type "Direct link to Type")

#### [`Redirect`](https://docs.monei.com/apis/graphql/types/objects/redirect/.md) object[​](#redirect- "Direct link to redirect-")


---

# paymentEmailPreview

DEPRECATED

Use previewPaymentEmail instead

No description

```
paymentEmailPreview(
  paymentId: ID!
  emailType: PaymentEmailType
  language: String
): String @deprecated
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`paymentEmailPreview.paymentId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#paymentemailpreviewpaymentidid-- "Direct link to paymentemailpreviewpaymentidid--")

#### [`paymentEmailPreview.emailType`](#) ● [`PaymentEmailType`](https://docs.monei.com/apis/graphql/types/enums/payment-email-type/.md) enum[​](#paymentemailpreviewemailtypepaymentemailtype- "Direct link to paymentemailpreviewemailtypepaymentemailtype-")

#### [`paymentEmailPreview.language`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentemailpreviewlanguagestring- "Direct link to paymentemailpreviewlanguagestring-")

### Type[​](#type "Direct link to Type")

#### [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#string- "Direct link to string-")

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.


---

# paymentRule

Get payment rule by ID

```
paymentRule(
  id: ID!
): PaymentRule
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`paymentRule.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#paymentruleidid-- "Direct link to paymentruleidid--")

### Type[​](#type "Direct link to Type")

#### [`PaymentRule`](https://docs.monei.com/apis/graphql/types/objects/payment-rule/.md) object[​](#paymentrule- "Direct link to paymentrule-")

Payment rule


---

# paymentRules

List payment rules filtered by account and rule type

```
paymentRules(
  token: String
  pageSize: Int
): PaymentRulesConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`paymentRules.token`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentrulestokenstring- "Direct link to paymentrulestokenstring-")

#### [`paymentRules.pageSize`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#paymentrulespagesizeint- "Direct link to paymentrulespagesizeint-")

### Type[​](#type "Direct link to Type")

#### [`PaymentRulesConnection`](https://docs.monei.com/apis/graphql/types/objects/payment-rules-connection/.md) object[​](#paymentrulesconnection- "Direct link to paymentrulesconnection-")

Connection type for paginated payment rules


---

# pointOfSale

A single point of sale

```
pointOfSale(
  id: ID!
): PointOfSale
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`pointOfSale.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#pointofsaleidid-- "Direct link to pointofsaleidid--")

### Type[​](#type "Direct link to Type")

#### [`PointOfSale`](https://docs.monei.com/apis/graphql/types/objects/point-of-sale/.md) object[​](#pointofsale- "Direct link to pointofsale-")


---

# pointsOfSale

Lists all the points of sale of the account or store

```
pointsOfSale(
  storeId: ID
  token: String
  pageSize: Int
): PointsOfSaleConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`pointsOfSale.storeId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#pointsofsalestoreidid- "Direct link to pointsofsalestoreidid-")

#### [`pointsOfSale.token`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#pointsofsaletokenstring- "Direct link to pointsofsaletokenstring-")

#### [`pointsOfSale.pageSize`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#pointsofsalepagesizeint- "Direct link to pointsofsalepagesizeint-")

### Type[​](#type "Direct link to Type")

#### [`PointsOfSaleConnection`](https://docs.monei.com/apis/graphql/types/objects/points-of-sale-connection/.md) object[​](#pointsofsaleconnection- "Direct link to pointsofsaleconnection-")


---

# posAuthToken

No description

```
posAuthToken: String
```

### Type[​](#type "Direct link to Type")

#### [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#string- "Direct link to string-")

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.


---

# previewPaymentEmail

Preview payment email

```
previewPaymentEmail(
  paymentId: ID!
  emailType: PaymentEmailType
  language: String
): String
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`previewPaymentEmail.paymentId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#previewpaymentemailpaymentidid-- "Direct link to previewpaymentemailpaymentidid--")

#### [`previewPaymentEmail.emailType`](#) ● [`PaymentEmailType`](https://docs.monei.com/apis/graphql/types/enums/payment-email-type/.md) enum[​](#previewpaymentemailemailtypepaymentemailtype- "Direct link to previewpaymentemailemailtypepaymentemailtype-")

#### [`previewPaymentEmail.language`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#previewpaymentemaillanguagestring- "Direct link to previewpaymentemaillanguagestring-")

### Type[​](#type "Direct link to Type")

#### [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#string- "Direct link to string-")

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.


---

# previewSubscriptionEmail

Preview subscription email

```
previewSubscriptionEmail(
  subscriptionId: ID!
  emailType: SubscriptionEmailType
  language: String
): String
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`previewSubscriptionEmail.subscriptionId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#previewsubscriptionemailsubscriptionidid-- "Direct link to previewsubscriptionemailsubscriptionidid--")

#### [`previewSubscriptionEmail.emailType`](#) ● [`SubscriptionEmailType`](https://docs.monei.com/apis/graphql/types/enums/subscription-email-type/.md) enum[​](#previewsubscriptionemailemailtypesubscriptionemailtype- "Direct link to previewsubscriptionemailemailtypesubscriptionemailtype-")

#### [`previewSubscriptionEmail.language`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#previewsubscriptionemaillanguagestring- "Direct link to previewsubscriptionemaillanguagestring-")

### Type[​](#type "Direct link to Type")

#### [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#string- "Direct link to string-")

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.


---

# providerConfig

Returns the configuration options for the provider

```
providerConfig(
  paymentMethod: PaymentMethods!
  processor: Processor!
): ProviderConfig
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`providerConfig.paymentMethod`](#) ● [`PaymentMethods!`](https://docs.monei.com/apis/graphql/types/enums/payment-methods/.md) non-null enum[​](#providerconfigpaymentmethodpaymentmethods-- "Direct link to providerconfigpaymentmethodpaymentmethods--")

#### [`providerConfig.processor`](#) ● [`Processor!`](https://docs.monei.com/apis/graphql/types/enums/processor/.md) non-null enum[​](#providerconfigprocessorprocessor-- "Direct link to providerconfigprocessorprocessor--")

### Type[​](#type "Direct link to Type")

#### [`ProviderConfig`](https://docs.monei.com/apis/graphql/types/objects/provider-config/.md) object[​](#providerconfig- "Direct link to providerconfig-")


---

# provider

A single provider

```
provider(
  id: ID!
): Provider
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`provider.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#provideridid-- "Direct link to provideridid--")

### Type[​](#type "Direct link to Type")

#### [`Provider`](https://docs.monei.com/apis/graphql/types/objects/provider/.md) object[​](#provider- "Direct link to provider-")


---

# providers

Lists all the providers of the account

```
providers: [Provider!]
```

### Type[​](#type "Direct link to Type")

#### [`Provider`](https://docs.monei.com/apis/graphql/types/objects/provider/.md) object[​](#provider- "Direct link to provider-")


---

# settlementEvents

Events timeline of a settlement

```
settlementEvents(
  settlementId: ID!
  size: Int
  from: Int
): SettlementEventsConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`settlementEvents.settlementId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#settlementeventssettlementidid-- "Direct link to settlementeventssettlementidid--")

#### [`settlementEvents.size`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#settlementeventssizeint- "Direct link to settlementeventssizeint-")

#### [`settlementEvents.from`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#settlementeventsfromint- "Direct link to settlementeventsfromint-")

### Type[​](#type "Direct link to Type")

#### [`SettlementEventsConnection`](https://docs.monei.com/apis/graphql/types/objects/settlement-events-connection/.md) object[​](#settlementeventsconnection- "Direct link to settlementeventsconnection-")


---

# shopifyStores

Lists all Shopify stores for the account

```
shopifyStores(
  token: String
  pageSize: Int
): ShopifyStoresConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`shopifyStores.token`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#shopifystorestokenstring- "Direct link to shopifystorestokenstring-")

#### [`shopifyStores.pageSize`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#shopifystorespagesizeint- "Direct link to shopifystorespagesizeint-")

### Type[​](#type "Direct link to Type")

#### [`ShopifyStoresConnection`](https://docs.monei.com/apis/graphql/types/objects/shopify-stores-connection/.md) object[​](#shopifystoresconnection- "Direct link to shopifystoresconnection-")


---

# store

A single store

```
store(
  id: ID!
): Store
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`store.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#storeidid-- "Direct link to storeidid--")

### Type[​](#type "Direct link to Type")

#### [`Store`](https://docs.monei.com/apis/graphql/types/objects/store/.md) object[​](#store- "Direct link to store-")


---

# stores

Lists all the stores of the account

```
stores(
  token: String
  pageSize: Int
): StoresConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`stores.token`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#storestokenstring- "Direct link to storestokenstring-")

#### [`stores.pageSize`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#storespagesizeint- "Direct link to storespagesizeint-")

### Type[​](#type "Direct link to Type")

#### [`StoresConnection`](https://docs.monei.com/apis/graphql/types/objects/stores-connection/.md) object[​](#storesconnection- "Direct link to storesconnection-")


---

# subscriptionEmailPreview

DEPRECATED

Use previewSubscriptionEmail instead

No description

```
subscriptionEmailPreview(
  subscriptionId: ID!
  emailType: SubscriptionEmailType
  language: String
): String @deprecated
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`subscriptionEmailPreview.subscriptionId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#subscriptionemailpreviewsubscriptionidid-- "Direct link to subscriptionemailpreviewsubscriptionidid--")

#### [`subscriptionEmailPreview.emailType`](#) ● [`SubscriptionEmailType`](https://docs.monei.com/apis/graphql/types/enums/subscription-email-type/.md) enum[​](#subscriptionemailpreviewemailtypesubscriptionemailtype- "Direct link to subscriptionemailpreviewemailtypesubscriptionemailtype-")

#### [`subscriptionEmailPreview.language`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#subscriptionemailpreviewlanguagestring- "Direct link to subscriptionemailpreviewlanguagestring-")

### Type[​](#type "Direct link to Type")

#### [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#string- "Direct link to string-")

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.


---

# subscriptionEvents

List of the subscriptions events

```
subscriptionEvents(
  subscriptionId: ID!
  size: Int
  from: Int
): SubscriptionEventsConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`subscriptionEvents.subscriptionId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#subscriptioneventssubscriptionidid-- "Direct link to subscriptioneventssubscriptionidid--")

#### [`subscriptionEvents.size`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#subscriptioneventssizeint- "Direct link to subscriptioneventssizeint-")

#### [`subscriptionEvents.from`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#subscriptioneventsfromint- "Direct link to subscriptioneventsfromint-")

### Type[​](#type "Direct link to Type")

#### [`SubscriptionEventsConnection`](https://docs.monei.com/apis/graphql/types/objects/subscription-events-connection/.md) object[​](#subscriptioneventsconnection- "Direct link to subscriptioneventsconnection-")


---

# subscription

A single subscription

```
subscription(
  id: ID!
): Subscription
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`subscription.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#subscriptionidid-- "Direct link to subscriptionidid--")

### Type[​](#type "Direct link to Type")

#### [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object[​](#subscription- "Direct link to subscription-")


---

# subscriptions

List of the subscriptions

```
subscriptions(
  filter: SearchableSubscriptionFilterInput
  size: Int
  from: Int
): SubscriptionsConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`subscriptions.filter`](#) ● [`SearchableSubscriptionFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-subscription-filter-input/.md) input[​](#subscriptionsfiltersearchablesubscriptionfilterinput- "Direct link to subscriptionsfiltersearchablesubscriptionfilterinput-")

#### [`subscriptions.size`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#subscriptionssizeint- "Direct link to subscriptionssizeint-")

#### [`subscriptions.from`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#subscriptionsfromint- "Direct link to subscriptionsfromint-")

### Type[​](#type "Direct link to Type")

#### [`SubscriptionsConnection`](https://docs.monei.com/apis/graphql/types/objects/subscriptions-connection/.md) object[​](#subscriptionsconnection- "Direct link to subscriptionsconnection-")


---

# userAccounts

List of user accounts

```
userAccounts(
  token: String
  pageSize: Int
): UserAccountsConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`userAccounts.token`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#useraccountstokenstring- "Direct link to useraccountstokenstring-")

#### [`userAccounts.pageSize`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#useraccountspagesizeint- "Direct link to useraccountspagesizeint-")

### Type[​](#type "Direct link to Type")

#### [`UserAccountsConnection`](https://docs.monei.com/apis/graphql/types/objects/user-accounts-connection/.md) object[​](#useraccountsconnection- "Direct link to useraccountsconnection-")


---

# userEvents

List of the user events

```
userEvents(
  input: UserEventsInput!
): UserEventsConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`userEvents.input`](#) ● [`UserEventsInput!`](https://docs.monei.com/apis/graphql/types/inputs/user-events-input/.md) non-null input[​](#usereventsinputusereventsinput-- "Direct link to usereventsinputusereventsinput--")

### Type[​](#type "Direct link to Type")

#### [`UserEventsConnection`](https://docs.monei.com/apis/graphql/types/objects/user-events-connection/.md) object[​](#usereventsconnection- "Direct link to usereventsconnection-")


---

# userPointOfSale

Point of sale attached to the logged in user

```
userPointOfSale: PointOfSale
```

### Type[​](#type "Direct link to Type")

#### [`PointOfSale`](https://docs.monei.com/apis/graphql/types/objects/point-of-sale/.md) object[​](#pointofsale- "Direct link to pointofsale-")


---

# userStore

Store attached to the logged in user

```
userStore: Store
```

### Type[​](#type "Direct link to Type")

#### [`Store`](https://docs.monei.com/apis/graphql/types/objects/store/.md) object[​](#store- "Direct link to store-")


---

# webReport

Get a web report.

```
webReport: WebReport
```

### Type[​](#type "Direct link to Type")

#### [`WebReport`](https://docs.monei.com/apis/graphql/types/objects/web-report/.md) object[​](#webreport- "Direct link to webreport-")

A web report is a report of the website.


---

# webhook

No description

```
webhook(
  id: ID!
): Webhook
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`webhook.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#webhookidid-- "Direct link to webhookidid--")

### Type[​](#type "Direct link to Type")

#### [`Webhook`](https://docs.monei.com/apis/graphql/types/objects/webhook/.md) object[​](#webhook- "Direct link to webhook-")


---

# webhooks

No description

```
webhooks(
  token: String
  pageSize: Int
): WebhooksConnection!
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`webhooks.token`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#webhookstokenstring- "Direct link to webhookstokenstring-")

#### [`webhooks.pageSize`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#webhookspagesizeint- "Direct link to webhookspagesizeint-")

### Type[​](#type "Direct link to Type")

#### [`WebhooksConnection`](https://docs.monei.com/apis/graphql/types/objects/webhooks-connection/.md) object[​](#webhooksconnection- "Direct link to webhooksconnection-")


---

# zendeskAuthToken

No description

```
zendeskAuthToken: String
```

### Type[​](#type "Direct link to Type")

#### [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#string- "Direct link to string-")

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.


---

# onUpdateAccountV2

Notifies about Account updates

```
onUpdateAccountV2: AccountLevelUpdate
```

### Type[​](#type "Direct link to Type")

#### [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object[​](#accountlevelupdate- "Direct link to accountlevelupdate-")


---

# onUpdateAccount

DEPRECATED

Use onUpdateAccountV2 instead

Notifies about Account updates

```
onUpdateAccount(
  accountId: ID!
): AccountLevelUpdate @deprecated
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`onUpdateAccount.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#onupdateaccountaccountidid-- "Direct link to onupdateaccountaccountidid--")

### Type[​](#type "Direct link to Type")

#### [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object[​](#accountlevelupdate- "Direct link to accountlevelupdate-")


---

# onUpdateAnalyticsV2

Notifies new Analytics

```
onUpdateAnalyticsV2: AccountLevelUpdate
```

### Type[​](#type "Direct link to Type")

#### [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object[​](#accountlevelupdate- "Direct link to accountlevelupdate-")


---

# onUpdateAnalytics

DEPRECATED

Use onUpdateAnalyticsV2 instead

Notifies new Analytics

```
onUpdateAnalytics(
  accountId: ID!
): AccountLevelUpdate @deprecated
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`onUpdateAnalytics.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#onupdateanalyticsaccountidid-- "Direct link to onupdateanalyticsaccountidid--")

### Type[​](#type "Direct link to Type")

#### [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object[​](#accountlevelupdate- "Direct link to accountlevelupdate-")


---

# onUpdateChargeEventsV2

Notifies new Events for one Charge

```
onUpdateChargeEventsV2(
  id: ID!
): ItemLevelUpdate
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`onUpdateChargeEventsV2.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#onupdatechargeeventsv2idid-- "Direct link to onupdatechargeeventsv2idid--")

### Type[​](#type "Direct link to Type")

#### [`ItemLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/item-level-update/.md) object[​](#itemlevelupdate- "Direct link to itemlevelupdate-")


---

# onUpdateChargeEvents

DEPRECATED

Use onUpdateChargeEventsV2 instead

Notifies new Events for one Charge

```
onUpdateChargeEvents(
  accountId: ID!
  id: ID!
): ItemLevelUpdate @deprecated
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`onUpdateChargeEvents.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#onupdatechargeeventsaccountidid-- "Direct link to onupdatechargeeventsaccountidid--")

#### [`onUpdateChargeEvents.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#onupdatechargeeventsidid-- "Direct link to onupdatechargeeventsidid--")

### Type[​](#type "Direct link to Type")

#### [`ItemLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/item-level-update/.md) object[​](#itemlevelupdate- "Direct link to itemlevelupdate-")


---

# onUpdateChargeV2

Notifies updates for one Charge

```
onUpdateChargeV2(
  id: ID!
): ItemLevelUpdate
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`onUpdateChargeV2.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#onupdatechargev2idid-- "Direct link to onupdatechargev2idid--")

### Type[​](#type "Direct link to Type")

#### [`ItemLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/item-level-update/.md) object[​](#itemlevelupdate- "Direct link to itemlevelupdate-")


---

# onUpdateCharge

DEPRECATED

Use onUpdateChargeV2 instead

Notifies updates for one Charge

```
onUpdateCharge(
  accountId: ID!
  id: ID!
): Charge @deprecated
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`onUpdateCharge.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#onupdatechargeaccountidid-- "Direct link to onupdatechargeaccountidid--")

#### [`onUpdateCharge.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#onupdatechargeidid-- "Direct link to onupdatechargeidid--")

### Type[​](#type "Direct link to Type")

#### [`Charge`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) object[​](#charge- "Direct link to charge-")


---

# onUpdateChargesV2

Notifies creations and updates of Charges

```
onUpdateChargesV2: AccountLevelUpdate
```

### Type[​](#type "Direct link to Type")

#### [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object[​](#accountlevelupdate- "Direct link to accountlevelupdate-")


---

# onUpdateCharges

DEPRECATED

Use onUpdateChargesV2 instead

Notifies creations and updates of Charges

```
onUpdateCharges(
  accountId: ID!
): AccountLevelUpdate @deprecated
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`onUpdateCharges.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#onupdatechargesaccountidid-- "Direct link to onupdatechargesaccountidid--")

### Type[​](#type "Direct link to Type")

#### [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object[​](#accountlevelupdate- "Direct link to accountlevelupdate-")


---

# onUpdateDocumentsV2

Notifies about Documents updates

```
onUpdateDocumentsV2: AccountLevelUpdate
```

### Type[​](#type "Direct link to Type")

#### [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object[​](#accountlevelupdate- "Direct link to accountlevelupdate-")


---

# onUpdateDocuments

DEPRECATED

Use onUpdateDocumentsV2 instead

Notifies about Documents updates

```
onUpdateDocuments(
  accountId: ID!
): AccountLevelUpdate @deprecated
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`onUpdateDocuments.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#onupdatedocumentsaccountidid-- "Direct link to onupdatedocumentsaccountidid--")

### Type[​](#type "Direct link to Type")

#### [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object[​](#accountlevelupdate- "Direct link to accountlevelupdate-")


---

# onUpdateEventsV2

Notifies new Events

```
onUpdateEventsV2: AccountLevelUpdate
```

### Type[​](#type "Direct link to Type")

#### [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object[​](#accountlevelupdate- "Direct link to accountlevelupdate-")


---

# onUpdateEvents

DEPRECATED

Use onUpdateEventsV2 instead

Notifies new Events

```
onUpdateEvents(
  accountId: ID!
): AccountLevelUpdate @deprecated
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`onUpdateEvents.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#onupdateeventsaccountidid-- "Direct link to onupdateeventsaccountidid--")

### Type[​](#type "Direct link to Type")

#### [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object[​](#accountlevelupdate- "Direct link to accountlevelupdate-")


---

# onUpdateSubscriptionEventsV2

Notifies new Events for one Subscription

```
onUpdateSubscriptionEventsV2(
  id: ID!
): ItemLevelUpdate
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`onUpdateSubscriptionEventsV2.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#onupdatesubscriptioneventsv2idid-- "Direct link to onupdatesubscriptioneventsv2idid--")

### Type[​](#type "Direct link to Type")

#### [`ItemLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/item-level-update/.md) object[​](#itemlevelupdate- "Direct link to itemlevelupdate-")


---

# onUpdateSubscriptionEvents

DEPRECATED

Use onUpdateSubscriptionEventsV2 instead

Notifies new Events for one Subscription

```
onUpdateSubscriptionEvents(
  accountId: ID!
  id: ID!
): ItemLevelUpdate @deprecated
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`onUpdateSubscriptionEvents.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#onupdatesubscriptioneventsaccountidid-- "Direct link to onupdatesubscriptioneventsaccountidid--")

#### [`onUpdateSubscriptionEvents.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#onupdatesubscriptioneventsidid-- "Direct link to onupdatesubscriptioneventsidid--")

### Type[​](#type "Direct link to Type")

#### [`ItemLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/item-level-update/.md) object[​](#itemlevelupdate- "Direct link to itemlevelupdate-")


---

# onUpdateSubscription

Notifies updates for one Subscription

```
onUpdateSubscription(
  id: ID!
): ItemLevelUpdate
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`onUpdateSubscription.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#onupdatesubscriptionidid-- "Direct link to onupdatesubscriptionidid--")

### Type[​](#type "Direct link to Type")

#### [`ItemLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/item-level-update/.md) object[​](#itemlevelupdate- "Direct link to itemlevelupdate-")


---

# onUpdateSubscriptions

Notifies about Subscriptions updates

```
onUpdateSubscriptions: AccountLevelUpdate
```

### Type[​](#type "Direct link to Type")

#### [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object[​](#accountlevelupdate- "Direct link to accountlevelupdate-")


---

# onUpdateWebReport

Notifies creations and updates of Website Report

```
onUpdateWebReport: AccountLevelUpdate
```

### Type[​](#type "Direct link to Type")

#### [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object[​](#accountlevelupdate- "Direct link to accountlevelupdate-")


---

# aws\_api\_key

Tells the service this field/object has access authorized by an API key.

```
directive @aws_api_key on 
  | OBJECT
  | FIELD_DEFINITION
```


---

# aws\_auth

Directs the schema to enforce authorization on a field

```
directive @aws_auth(
  cognito_groups: [String]
) on FIELD_DEFINITION
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`aws_auth.cognito_groups`](#) ● [`[String]`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) list scalar[​](#aws_authcognito_groupsstring-- "Direct link to aws_authcognito_groupsstring--")

List of cognito user pool groups which have access on this field


---

# aws\_cognito\_user\_pools

Tells the service this field/object has access authorized by a Cognito User Pools token.

```
directive @aws_cognito_user_pools(
  cognito_groups: [String]
) on 
  | OBJECT
  | FIELD_DEFINITION
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`aws_cognito_user_pools.cognito_groups`](#) ● [`[String]`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) list scalar[​](#aws_cognito_user_poolscognito_groupsstring-- "Direct link to aws_cognito_user_poolscognito_groupsstring--")

List of cognito user pool groups which have access on this field


---

# aws\_iam

Tells the service this field/object has access authorized by sigv4 signing.

```
directive @aws_iam on 
  | OBJECT
  | FIELD_DEFINITION
```


---

# aws\_lambda

Tells the service this field/object has access authorized by a Lambda Authorizer.

```
directive @aws_lambda on 
  | OBJECT
  | FIELD_DEFINITION
```


---

# aws\_oidc

Tells the service this field/object has access authorized by an OIDC token.

```
directive @aws_oidc on 
  | OBJECT
  | FIELD_DEFINITION
```


---

# aws\_publish

Tells the service which subscriptions will be published to when this mutation is called. This directive is deprecated use @aws\_susbscribe directive instead.

```
directive @aws_publish(
  subscriptions: [String]
) on FIELD_DEFINITION
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`aws_publish.subscriptions`](#) ● [`[String]`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) list scalar[​](#aws_publishsubscriptionsstring-- "Direct link to aws_publishsubscriptionsstring--")

List of subscriptions which will be published to when this mutation is called.


---

# aws\_subscribe

Tells the service which mutation triggers this subscription.

```
directive @aws_subscribe(
  mutations: [String]
) on FIELD_DEFINITION
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`aws_subscribe.mutations`](#) ● [`[String]`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) list scalar[​](#aws_subscribemutationsstring-- "Direct link to aws_subscribemutationsstring--")

List of mutations which will trigger this subscription when they are called.


---

# deprecated

Marks an element of a GraphQL schema as no longer supported.

```
directive @deprecated(
  reason: String = "No longer supported"
) on 
  | FIELD_DEFINITION
  | ARGUMENT_DEFINITION
  | INPUT_FIELD_DEFINITION
  | ENUM_VALUE
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`deprecated.reason`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#deprecatedreasonstring- "Direct link to deprecatedreasonstring-")

Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted using the Markdown syntax, as specified by [CommonMark](https://commonmark.org/).


---

# oneOf

Indicates exactly one field must be supplied and this field must not be `null`.

```
directive @oneOf on INPUT_OBJECT
```


---

# specifiedBy

Exposes a URL that specifies the behavior of this scalar.

```
directive @specifiedBy(
  url: String!
) on SCALAR
```

### Arguments[​](#arguments "Direct link to Arguments")

#### [`specifiedBy.url`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#specifiedbyurlstring-- "Direct link to specifiedbyurlstring--")

The URL that specifies the behavior of this scalar.


---

# AccountInvoicePaymentMethod

Account invoice payment method

```
enum AccountInvoicePaymentMethod {
  bank_transfer
  direct_debit
}
```

### Values[​](#values "Direct link to Values")

#### [`AccountInvoicePaymentMethod.bank_transfer`](#)[​](#accountinvoicepaymentmethodbank_transfer "Direct link to accountinvoicepaymentmethodbank_transfer")

#### [`AccountInvoicePaymentMethod.direct_debit`](#)[​](#accountinvoicepaymentmethoddirect_debit "Direct link to accountinvoicepaymentmethoddirect_debit")

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountInvoice`](https://docs.monei.com/apis/graphql/types/objects/account-invoice/.md) object


---

# AccountInvoiceStatus

Account invoice status

```
enum AccountInvoiceStatus {
  PENDING
  PAST_DUE
  PAID
  UNPAID
}
```

### Values[​](#values "Direct link to Values")

#### [`AccountInvoiceStatus.PENDING`](#)[​](#accountinvoicestatuspending "Direct link to accountinvoicestatuspending")

#### [`AccountInvoiceStatus.PAST_DUE`](#)[​](#accountinvoicestatuspast_due "Direct link to accountinvoicestatuspast_due")

#### [`AccountInvoiceStatus.PAID`](#)[​](#accountinvoicestatuspaid "Direct link to accountinvoicestatuspaid")

#### [`AccountInvoiceStatus.UNPAID`](#)[​](#accountinvoicestatusunpaid "Direct link to accountinvoicestatusunpaid")

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountInvoice`](https://docs.monei.com/apis/graphql/types/objects/account-invoice/.md) object


---

# AccountStatus

Account status

* ACTIVE: Account is active and payments are being processed
* PENDING\_CONTRACT: Account is pending contract signature
* PENDING\_APPROVAL: Account is pending approval
* APPROVED: Account is approved
* NOT\_CONFIGURED: Account needs additional information or documents to be configured, see `statusReason` for more details
* SUSPENDED: Account is suspended
* REJECTED: Account is rejected
* DELETED: Account is deleted

```
enum AccountStatus {
  ACTIVE
  PENDING_CONTRACT
  PENDING_APPROVAL
  APPROVED
  NOT_CONFIGURED
  SUSPENDED
  REJECTED
  DELETED
  PENDING_REVIEW
}
```

### Values[​](#values "Direct link to Values")

#### [`AccountStatus.ACTIVE`](#)[​](#accountstatusactive "Direct link to accountstatusactive")

#### [`AccountStatus.PENDING_CONTRACT`](#)[​](#accountstatuspending_contract "Direct link to accountstatuspending_contract")

#### [`AccountStatus.PENDING_APPROVAL`](#)[​](#accountstatuspending_approval "Direct link to accountstatuspending_approval")

#### [`AccountStatus.APPROVED`](#)[​](#accountstatusapproved "Direct link to accountstatusapproved")

#### [`AccountStatus.NOT_CONFIGURED`](#)[​](#accountstatusnot_configured "Direct link to accountstatusnot_configured")

#### [`AccountStatus.SUSPENDED`](#)[​](#accountstatussuspended "Direct link to accountstatussuspended")

#### [`AccountStatus.REJECTED`](#)[​](#accountstatusrejected "Direct link to accountstatusrejected")

#### [`AccountStatus.DELETED`](#)[​](#accountstatusdeleted "Direct link to accountstatusdeleted")

#### [`AccountStatus.PENDING_REVIEW`](#)[​](#accountstatuspending_review "Direct link to accountstatuspending_review")

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object


---

# Acquirer

No description

```
enum Acquirer {
  CUSTOM
  ADYEN
  STRIPE
  MONEI_X
  PAYPAL
  PAYCOMET
  ABANCA
  BANCAMARCH
  BANKIA
  BANKINTER
  BBVA
  CAJALABORAL
  CAJAMAR
  CAJARURAL
  CAJASUR
  COMERCIAGLOBALPAY
  CREDITANDORRA
  KUTXABANK
  SABADELL
  SANTANDER
  UNICAJA
  DEUTSCHE_BANK
}
```

### Values[​](#values "Direct link to Values")

#### [`Acquirer.CUSTOM`](#)[​](#acquirercustom "Direct link to acquirercustom")

#### [`Acquirer.ADYEN`](#)[​](#acquireradyen "Direct link to acquireradyen")

#### [`Acquirer.STRIPE`](#)[​](#acquirerstripe "Direct link to acquirerstripe")

#### [`Acquirer.MONEI_X`](#)[​](#acquirermonei_x "Direct link to acquirermonei_x")

#### [`Acquirer.PAYPAL`](#)[​](#acquirerpaypal "Direct link to acquirerpaypal")

#### [`Acquirer.PAYCOMET`](#)[​](#acquirerpaycomet "Direct link to acquirerpaycomet")

#### [`Acquirer.ABANCA`](#)[​](#acquirerabanca "Direct link to acquirerabanca")

#### [`Acquirer.BANCAMARCH`](#)[​](#acquirerbancamarch "Direct link to acquirerbancamarch")

#### [`Acquirer.BANKIA`](#)[​](#acquirerbankia "Direct link to acquirerbankia")

#### [`Acquirer.BANKINTER`](#)[​](#acquirerbankinter "Direct link to acquirerbankinter")

#### [`Acquirer.BBVA`](#)[​](#acquirerbbva "Direct link to acquirerbbva")

#### [`Acquirer.CAJALABORAL`](#)[​](#acquirercajalaboral "Direct link to acquirercajalaboral")

#### [`Acquirer.CAJAMAR`](#)[​](#acquirercajamar "Direct link to acquirercajamar")

#### [`Acquirer.CAJARURAL`](#)[​](#acquirercajarural "Direct link to acquirercajarural")

#### [`Acquirer.CAJASUR`](#)[​](#acquirercajasur "Direct link to acquirercajasur")

#### [`Acquirer.COMERCIAGLOBALPAY`](#)[​](#acquirercomerciaglobalpay "Direct link to acquirercomerciaglobalpay")

#### [`Acquirer.CREDITANDORRA`](#)[​](#acquirercreditandorra "Direct link to acquirercreditandorra")

#### [`Acquirer.KUTXABANK`](#)[​](#acquirerkutxabank "Direct link to acquirerkutxabank")

#### [`Acquirer.SABADELL`](#)[​](#acquirersabadell "Direct link to acquirersabadell")

#### [`Acquirer.SANTANDER`](#)[​](#acquirersantander "Direct link to acquirersantander")

#### [`Acquirer.UNICAJA`](#)[​](#acquirerunicaja "Direct link to acquirerunicaja")

#### [`Acquirer.DEUTSCHE_BANK`](#)[​](#acquirerdeutsche_bank "Direct link to acquirerdeutsche_bank")

### Member Of[​](#member-of "Direct link to Member Of")

[`CreateProviderInput`](https://docs.monei.com/apis/graphql/types/inputs/create-provider-input/.md) input ● [`Provider`](https://docs.monei.com/apis/graphql/types/objects/provider/.md) object ● [`ProviderConfig`](https://docs.monei.com/apis/graphql/types/objects/provider-config/.md) object ● [`UpdateProviderInput`](https://docs.monei.com/apis/graphql/types/inputs/update-provider-input/.md) input


---

# AuthPaymentMethodKlarna

No description

```
enum AuthPaymentMethodKlarna {
  invoice
  fixed_amount
  pix
  base_account
  deferred_interest
  direct_debit
  direct_bank_transfer
  b2b_invoice
  card
  slice_it_by_card
}
```

### Values[​](#values "Direct link to Values")

#### [`AuthPaymentMethodKlarna.invoice`](#)[​](#authpaymentmethodklarnainvoice "Direct link to authpaymentmethodklarnainvoice")

#### [`AuthPaymentMethodKlarna.fixed_amount`](#)[​](#authpaymentmethodklarnafixed_amount "Direct link to authpaymentmethodklarnafixed_amount")

#### [`AuthPaymentMethodKlarna.pix`](#)[​](#authpaymentmethodklarnapix "Direct link to authpaymentmethodklarnapix")

#### [`AuthPaymentMethodKlarna.base_account`](#)[​](#authpaymentmethodklarnabase_account "Direct link to authpaymentmethodklarnabase_account")

#### [`AuthPaymentMethodKlarna.deferred_interest`](#)[​](#authpaymentmethodklarnadeferred_interest "Direct link to authpaymentmethodklarnadeferred_interest")

#### [`AuthPaymentMethodKlarna.direct_debit`](#)[​](#authpaymentmethodklarnadirect_debit "Direct link to authpaymentmethodklarnadirect_debit")

#### [`AuthPaymentMethodKlarna.direct_bank_transfer`](#)[​](#authpaymentmethodklarnadirect_bank_transfer "Direct link to authpaymentmethodklarnadirect_bank_transfer")

#### [`AuthPaymentMethodKlarna.b2b_invoice`](#)[​](#authpaymentmethodklarnab2b_invoice "Direct link to authpaymentmethodklarnab2b_invoice")

#### [`AuthPaymentMethodKlarna.card`](#)[​](#authpaymentmethodklarnacard "Direct link to authpaymentmethodklarnacard")

#### [`AuthPaymentMethodKlarna.slice_it_by_card`](#)[​](#authpaymentmethodklarnaslice_it_by_card "Direct link to authpaymentmethodklarnaslice_it_by_card")

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethodKlarna`](https://docs.monei.com/apis/graphql/types/objects/payment-method-klarna/.md) object


---

# AuthorizedUserAccessLevel

Access level for the authorized user

* READ\_ACCESS: Read only access, user will not be able to create payments, do refunds, etc.
* WRITE\_ACCESS: Write access, user will be able to create payments, do refunds, but will not have access to admin settings
* ADMIN\_ACCESS: Admin access, user will have access to all settings

```
enum AuthorizedUserAccessLevel {
  READ_ACCESS
  WRITE_ACCESS
  ADMIN_ACCESS
}
```

### Values[​](#values "Direct link to Values")

#### [`AuthorizedUserAccessLevel.READ_ACCESS`](#)[​](#authorizeduseraccesslevelread_access "Direct link to authorizeduseraccesslevelread_access")

#### [`AuthorizedUserAccessLevel.WRITE_ACCESS`](#)[​](#authorizeduseraccesslevelwrite_access "Direct link to authorizeduseraccesslevelwrite_access")

#### [`AuthorizedUserAccessLevel.ADMIN_ACCESS`](#)[​](#authorizeduseraccessleveladmin_access "Direct link to authorizeduseraccessleveladmin_access")

### Member Of[​](#member-of "Direct link to Member Of")

[`AuthorizedUser`](https://docs.monei.com/apis/graphql/types/objects/authorized-user/.md) object ● [`CreateAuthorizedUserInput`](https://docs.monei.com/apis/graphql/types/inputs/create-authorized-user-input/.md) input ● [`UpdateAuthorizedUserInput`](https://docs.monei.com/apis/graphql/types/inputs/update-authorized-user-input/.md) input ● [`UserAccount`](https://docs.monei.com/apis/graphql/types/objects/user-account/.md) object


---

# AuthorizedUserStatus

A status of the authorized user

```
enum AuthorizedUserStatus {
  UNCONFIRMED
  CONFIRMED
  ARCHIVED
  COMPROMISED
  UNKNOWN
  RESET_REQUIRED
  FORCE_CHANGE_PASSWORD
}
```

### Values[​](#values "Direct link to Values")

#### [`AuthorizedUserStatus.UNCONFIRMED`](#)[​](#authorizeduserstatusunconfirmed "Direct link to authorizeduserstatusunconfirmed")

#### [`AuthorizedUserStatus.CONFIRMED`](#)[​](#authorizeduserstatusconfirmed "Direct link to authorizeduserstatusconfirmed")

#### [`AuthorizedUserStatus.ARCHIVED`](#)[​](#authorizeduserstatusarchived "Direct link to authorizeduserstatusarchived")

#### [`AuthorizedUserStatus.COMPROMISED`](#)[​](#authorizeduserstatuscompromised "Direct link to authorizeduserstatuscompromised")

#### [`AuthorizedUserStatus.UNKNOWN`](#)[​](#authorizeduserstatusunknown "Direct link to authorizeduserstatusunknown")

#### [`AuthorizedUserStatus.RESET_REQUIRED`](#)[​](#authorizeduserstatusreset_required "Direct link to authorizeduserstatusreset_required")

#### [`AuthorizedUserStatus.FORCE_CHANGE_PASSWORD`](#)[​](#authorizeduserstatusforce_change_password "Direct link to authorizeduserstatusforce_change_password")

### Member Of[​](#member-of "Direct link to Member Of")

[`AuthorizedUser`](https://docs.monei.com/apis/graphql/types/objects/authorized-user/.md) object


---

# BankAccountStatus

Bank account status

```
enum BankAccountStatus {
  enabled
  deleted
  blocked
  pending
}
```

### Values[​](#values "Direct link to Values")

#### [`BankAccountStatus.enabled`](#)[​](#bankaccountstatusenabled "Direct link to bankaccountstatusenabled")

#### [`BankAccountStatus.deleted`](#)[​](#bankaccountstatusdeleted "Direct link to bankaccountstatusdeleted")

#### [`BankAccountStatus.blocked`](#)[​](#bankaccountstatusblocked "Direct link to bankaccountstatusblocked")

#### [`BankAccountStatus.pending`](#)[​](#bankaccountstatuspending "Direct link to bankaccountstatuspending")

### Member Of[​](#member-of "Direct link to Member Of")

[`BankAccount`](https://docs.monei.com/apis/graphql/types/objects/bank-account/.md) object


---

# BillingCategoryKlarna

No description

```
enum BillingCategoryKlarna {
  PAY_IN_PARTS
  PAY_LATER
  PAY_NOW
  SLICE_IT
  SLICE_IT_BY_CARD
}
```

### Values[​](#values "Direct link to Values")

#### [`BillingCategoryKlarna.PAY_IN_PARTS`](#)[​](#billingcategoryklarnapay_in_parts "Direct link to billingcategoryklarnapay_in_parts")

#### [`BillingCategoryKlarna.PAY_LATER`](#)[​](#billingcategoryklarnapay_later "Direct link to billingcategoryklarnapay_later")

#### [`BillingCategoryKlarna.PAY_NOW`](#)[​](#billingcategoryklarnapay_now "Direct link to billingcategoryklarnapay_now")

#### [`BillingCategoryKlarna.SLICE_IT`](#)[​](#billingcategoryklarnaslice_it "Direct link to billingcategoryklarnaslice_it")

#### [`BillingCategoryKlarna.SLICE_IT_BY_CARD`](#)[​](#billingcategoryklarnaslice_it_by_card "Direct link to billingcategoryklarnaslice_it_by_card")

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethodKlarna`](https://docs.monei.com/apis/graphql/types/objects/payment-method-klarna/.md) object


---

# BillingPlans

MONEI Billing Plans

```
enum BillingPlans {
  MONEI_PLUS
  MONEI_POS
  MONEI_X
}
```

### Values[​](#values "Direct link to Values")

#### [`BillingPlans.MONEI_PLUS`](#)[​](#billingplansmonei_plus "Direct link to billingplansmonei_plus")

#### [`BillingPlans.MONEI_POS`](#)[​](#billingplansmonei_pos "Direct link to billingplansmonei_pos")

#### [`BillingPlans.MONEI_X`](#)[​](#billingplansmonei_x "Direct link to billingplansmonei_x")

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object ● [`Charge`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) object ● [`ChargeEventObject`](https://docs.monei.com/apis/graphql/types/objects/charge-event-object/.md) object ● [`SetupAccountInput`](https://docs.monei.com/apis/graphql/types/inputs/setup-account-input/.md) input ● [`UpdateChargeInput`](https://docs.monei.com/apis/graphql/types/inputs/update-charge-input/.md) input


---

# BlacklistItemType

The type of the blacklist item

```
enum BlacklistItemType {
  email
  phone
  ip
  card
  bin
  fingerprint
}
```

### Values[​](#values "Direct link to Values")

#### [`BlacklistItemType.email`](#)[​](#blacklistitemtypeemail "Direct link to blacklistitemtypeemail")

#### [`BlacklistItemType.phone`](#)[​](#blacklistitemtypephone "Direct link to blacklistitemtypephone")

#### [`BlacklistItemType.ip`](#)[​](#blacklistitemtypeip "Direct link to blacklistitemtypeip")

#### [`BlacklistItemType.card`](#)[​](#blacklistitemtypecard "Direct link to blacklistitemtypecard")

#### [`BlacklistItemType.bin`](#)[​](#blacklistitemtypebin "Direct link to blacklistitemtypebin")

#### [`BlacklistItemType.fingerprint`](#)[​](#blacklistitemtypefingerprint "Direct link to blacklistitemtypefingerprint")

### Member Of[​](#member-of "Direct link to Member Of")

[`BlacklistItem`](https://docs.monei.com/apis/graphql/types/objects/blacklist-item/.md) object ● [`BlacklistItemInput`](https://docs.monei.com/apis/graphql/types/inputs/blacklist-item-input/.md) input ● [`blacklistItems`](https://docs.monei.com/apis/graphql/operations/queries/blacklist-items/.md) query


---

# BusinessStatus

Account business status

* active: Business is verified to be active
* under\_review: Business requires manual review
* inactive: Business is inactive
* dissolved: Business is dissolved
* renamed: Business is renamed
* transformed: Business is transformed
* processing: Business is in the process of verification
* not\_found: Business is not found
* resubmission\_requested: Business details require resubmission

```
enum BusinessStatus {
  active
  under_review
  inactive
  dissolved
  renamed
  transformed
  processing
  not_found
  resubmission_requested
}
```

### Values[​](#values "Direct link to Values")

#### [`BusinessStatus.active`](#)[​](#businessstatusactive "Direct link to businessstatusactive")

#### [`BusinessStatus.under_review`](#)[​](#businessstatusunder_review "Direct link to businessstatusunder_review")

#### [`BusinessStatus.inactive`](#)[​](#businessstatusinactive "Direct link to businessstatusinactive")

#### [`BusinessStatus.dissolved`](#)[​](#businessstatusdissolved "Direct link to businessstatusdissolved")

#### [`BusinessStatus.renamed`](#)[​](#businessstatusrenamed "Direct link to businessstatusrenamed")

#### [`BusinessStatus.transformed`](#)[​](#businessstatustransformed "Direct link to businessstatustransformed")

#### [`BusinessStatus.processing`](#)[​](#businessstatusprocessing "Direct link to businessstatusprocessing")

#### [`BusinessStatus.not_found`](#)[​](#businessstatusnot_found "Direct link to businessstatusnot_found")

#### [`BusinessStatus.resubmission_requested`](#)[​](#businessstatusresubmission_requested "Direct link to businessstatusresubmission_requested")

### Member Of[​](#member-of "Direct link to Member Of")

[`BusinessData`](https://docs.monei.com/apis/graphql/types/objects/business-data/.md) object


---

# CallbackStatus

No description

```
enum CallbackStatus {
  PENDING
  EXECUTED
  FAILED
}
```

### Values[​](#values "Direct link to Values")

#### [`CallbackStatus.PENDING`](#)[​](#callbackstatuspending "Direct link to callbackstatuspending")

#### [`CallbackStatus.EXECUTED`](#)[​](#callbackstatusexecuted "Direct link to callbackstatusexecuted")

#### [`CallbackStatus.FAILED`](#)[​](#callbackstatusfailed "Direct link to callbackstatusfailed")

### Member Of[​](#member-of "Direct link to Member Of")

[`CallbackData`](https://docs.monei.com/apis/graphql/types/objects/callback-data/.md) object


---

# CancellationReason

No description

```
enum CancellationReason {
  duplicated
  fraudulent
  requested_by_customer
  order_canceled
}
```

### Values[​](#values "Direct link to Values")

#### [`CancellationReason.duplicated`](#)[​](#cancellationreasonduplicated "Direct link to cancellationreasonduplicated")

#### [`CancellationReason.fraudulent`](#)[​](#cancellationreasonfraudulent "Direct link to cancellationreasonfraudulent")

#### [`CancellationReason.requested_by_customer`](#)[​](#cancellationreasonrequested_by_customer "Direct link to cancellationreasonrequested_by_customer")

#### [`CancellationReason.order_canceled`](#)[​](#cancellationreasonorder_canceled "Direct link to cancellationreasonorder_canceled")

### Member Of[​](#member-of "Direct link to Member Of")

[`CancelPaymentInput`](https://docs.monei.com/apis/graphql/types/inputs/cancel-payment-input/.md) input ● [`Charge`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) object ● [`ChargeEventObject`](https://docs.monei.com/apis/graphql/types/objects/charge-event-object/.md) object ● [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object ● [`UpdateChargeInput`](https://docs.monei.com/apis/graphql/types/inputs/update-charge-input/.md) input


---

# CapitalLoanStatus

MONEI Capital loan status

```
enum CapitalLoanStatus {
  Defaulted
  DiscountedSettlement
  Funded
  FundedPendingSettlement
  PartiallyFunded
  Repaid
  RequestedFunding
  Unfunded
  WrittenOff
}
```

### Values[​](#values "Direct link to Values")

#### [`CapitalLoanStatus.Defaulted`](#)[​](#capitalloanstatusdefaulted "Direct link to capitalloanstatusdefaulted")

#### [`CapitalLoanStatus.DiscountedSettlement`](#)[​](#capitalloanstatusdiscountedsettlement "Direct link to capitalloanstatusdiscountedsettlement")

#### [`CapitalLoanStatus.Funded`](#)[​](#capitalloanstatusfunded "Direct link to capitalloanstatusfunded")

#### [`CapitalLoanStatus.FundedPendingSettlement`](#)[​](#capitalloanstatusfundedpendingsettlement "Direct link to capitalloanstatusfundedpendingsettlement")

#### [`CapitalLoanStatus.PartiallyFunded`](#)[​](#capitalloanstatuspartiallyfunded "Direct link to capitalloanstatuspartiallyfunded")

#### [`CapitalLoanStatus.Repaid`](#)[​](#capitalloanstatusrepaid "Direct link to capitalloanstatusrepaid")

#### [`CapitalLoanStatus.RequestedFunding`](#)[​](#capitalloanstatusrequestedfunding "Direct link to capitalloanstatusrequestedfunding")

#### [`CapitalLoanStatus.Unfunded`](#)[​](#capitalloanstatusunfunded "Direct link to capitalloanstatusunfunded")

#### [`CapitalLoanStatus.WrittenOff`](#)[​](#capitalloanstatuswrittenoff "Direct link to capitalloanstatuswrittenoff")

### Member Of[​](#member-of "Direct link to Member Of")

[`CapitalLoan`](https://docs.monei.com/apis/graphql/types/objects/capital-loan/.md) object ● [`CapitalLoanDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-details/.md) object


---

# CapitalLoanType

MONEI Capital loan type

```
enum CapitalLoanType {
  Initial
  Renewal
  EarlyRenewal
}
```

### Values[​](#values "Direct link to Values")

#### [`CapitalLoanType.Initial`](#)[​](#capitalloantypeinitial "Direct link to capitalloantypeinitial")

#### [`CapitalLoanType.Renewal`](#)[​](#capitalloantyperenewal "Direct link to capitalloantyperenewal")

#### [`CapitalLoanType.EarlyRenewal`](#)[​](#capitalloantypeearlyrenewal "Direct link to capitalloantypeearlyrenewal")

### Member Of[​](#member-of "Direct link to Member Of")

[`CapitalLoan`](https://docs.monei.com/apis/graphql/types/objects/capital-loan/.md) object ● [`CapitalLoanDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-details/.md) object


---

# CapitalOnboardingStatus

MONEI Capital onboarding status

```
enum CapitalOnboardingStatus {
  NOT_STARTED
  IN_PROGRESS
  COMPLETED
}
```

### Values[​](#values "Direct link to Values")

#### [`CapitalOnboardingStatus.NOT_STARTED`](#)[​](#capitalonboardingstatusnot_started "Direct link to capitalonboardingstatusnot_started")

#### [`CapitalOnboardingStatus.IN_PROGRESS`](#)[​](#capitalonboardingstatusin_progress "Direct link to capitalonboardingstatusin_progress")

#### [`CapitalOnboardingStatus.COMPLETED`](#)[​](#capitalonboardingstatuscompleted "Direct link to capitalonboardingstatuscompleted")

### Member Of[​](#member-of "Direct link to Member Of")

[`CapitalLead`](https://docs.monei.com/apis/graphql/types/objects/capital-lead/.md) object


---

# CardBrand

Possible card brands

```
enum CardBrand {
  visa
  mastercard
  diners
  unknown
  amex
  jcb
  unionpay
  discover
}
```

### Values[​](#values "Direct link to Values")

#### [`CardBrand.visa`](#)[​](#cardbrandvisa "Direct link to cardbrandvisa")

#### [`CardBrand.mastercard`](#)[​](#cardbrandmastercard "Direct link to cardbrandmastercard")

#### [`CardBrand.diners`](#)[​](#cardbranddiners "Direct link to cardbranddiners")

#### [`CardBrand.unknown`](#)[​](#cardbrandunknown "Direct link to cardbrandunknown")

#### [`CardBrand.amex`](#)[​](#cardbrandamex "Direct link to cardbrandamex")

#### [`CardBrand.jcb`](#)[​](#cardbrandjcb "Direct link to cardbrandjcb")

#### [`CardBrand.unionpay`](#)[​](#cardbrandunionpay "Direct link to cardbrandunionpay")

#### [`CardBrand.discover`](#)[​](#cardbranddiscover "Direct link to cardbranddiscover")

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethodCard`](https://docs.monei.com/apis/graphql/types/objects/payment-method-card/.md) object ● [`PaymentMethodCardInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-card-input/.md) input ● [`PaymentMethodCardPresent`](https://docs.monei.com/apis/graphql/types/objects/payment-method-card-present/.md) object ● [`PaymentMethodCardPresentInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-card-present-input/.md) input


---

# CardRoutingActionType

Card routing action type

```
enum CardRoutingActionType {
  ROUTE_TO
  FORCE_CHALLENGE
  SKIP_CHALLENGE
  DECLINE
}
```

### Values[​](#values "Direct link to Values")

#### [`CardRoutingActionType.ROUTE_TO`](#)[​](#cardroutingactiontyperoute_to "Direct link to cardroutingactiontyperoute_to")

#### [`CardRoutingActionType.FORCE_CHALLENGE`](#)[​](#cardroutingactiontypeforce_challenge "Direct link to cardroutingactiontypeforce_challenge")

#### [`CardRoutingActionType.SKIP_CHALLENGE`](#)[​](#cardroutingactiontypeskip_challenge "Direct link to cardroutingactiontypeskip_challenge")

#### [`CardRoutingActionType.DECLINE`](#)[​](#cardroutingactiontypedecline "Direct link to cardroutingactiontypedecline")


---

# CardType

Possible device types

```
enum CardType {
  debit
  credit
}
```

### Values[​](#values "Direct link to Values")

#### [`CardType.debit`](#)[​](#cardtypedebit "Direct link to cardtypedebit")

#### [`CardType.credit`](#)[​](#cardtypecredit "Direct link to cardtypecredit")

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethodCard`](https://docs.monei.com/apis/graphql/types/objects/payment-method-card/.md) object ● [`PaymentMethodCardInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-card-input/.md) input ● [`PaymentMethodCardPresent`](https://docs.monei.com/apis/graphql/types/objects/payment-method-card-present/.md) object ● [`PaymentMethodCardPresentInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-card-present-input/.md) input


---

# ChargeStatus

Charge status

```
enum ChargeStatus {
  SUCCEEDED
  PENDING
  PENDING_PROCESSING
  FAILED
  CANCELED
  REFUNDED
  PARTIALLY_REFUNDED
  AUTHORIZED
  EXPIRED
  PAID_OUT
}
```

### Values[​](#values "Direct link to Values")

#### [`ChargeStatus.SUCCEEDED`](#)[​](#chargestatussucceeded "Direct link to chargestatussucceeded")

#### [`ChargeStatus.PENDING`](#)[​](#chargestatuspending "Direct link to chargestatuspending")

#### [`ChargeStatus.PENDING_PROCESSING`](#)[​](#chargestatuspending_processing "Direct link to chargestatuspending_processing")

#### [`ChargeStatus.FAILED`](#)[​](#chargestatusfailed "Direct link to chargestatusfailed")

#### [`ChargeStatus.CANCELED`](#)[​](#chargestatuscanceled "Direct link to chargestatuscanceled")

#### [`ChargeStatus.REFUNDED`](#)[​](#chargestatusrefunded "Direct link to chargestatusrefunded")

#### [`ChargeStatus.PARTIALLY_REFUNDED`](#)[​](#chargestatuspartially_refunded "Direct link to chargestatuspartially_refunded")

#### [`ChargeStatus.AUTHORIZED`](#)[​](#chargestatusauthorized "Direct link to chargestatusauthorized")

#### [`ChargeStatus.EXPIRED`](#)[​](#chargestatusexpired "Direct link to chargestatusexpired")

#### [`ChargeStatus.PAID_OUT`](#)[​](#chargestatuspaid_out "Direct link to chargestatuspaid_out")

### Member Of[​](#member-of "Direct link to Member Of")

[`Charge`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) object ● [`ChargeEventObject`](https://docs.monei.com/apis/graphql/types/objects/charge-event-object/.md) object ● [`UpdateChargeInput`](https://docs.monei.com/apis/graphql/types/inputs/update-charge-input/.md) input


---

# CodeTypes

No description

```
enum CodeTypes {
  POINT_OF_SALE
}
```

### Values[​](#values "Direct link to Values")

#### [`CodeTypes.POINT_OF_SALE`](#)[​](#codetypespoint_of_sale "Direct link to codetypespoint_of_sale")

### Member Of[​](#member-of "Direct link to Member Of")

[`Code`](https://docs.monei.com/apis/graphql/types/objects/code/.md) object


---

# CombinatorType

Combinator type for conditions

```
enum CombinatorType {
  AND
  OR
}
```

### Values[​](#values "Direct link to Values")

#### [`CombinatorType.AND`](#)[​](#combinatortypeand "Direct link to combinatortypeand")

#### [`CombinatorType.OR`](#)[​](#combinatortypeor "Direct link to combinatortypeor")

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentConditions`](https://docs.monei.com/apis/graphql/types/objects/payment-conditions/.md) object ● [`PaymentConditionsInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-conditions-input/.md) input


---

# ContractStatus

Account contract status

```
enum ContractStatus {
  completed
  created
  declined
  delivered
  sent
  signed
  voided
}
```

### Values[​](#values "Direct link to Values")

#### [`ContractStatus.completed`](#)[​](#contractstatuscompleted "Direct link to contractstatuscompleted")

#### [`ContractStatus.created`](#)[​](#contractstatuscreated "Direct link to contractstatuscreated")

#### [`ContractStatus.declined`](#)[​](#contractstatusdeclined "Direct link to contractstatusdeclined")

#### [`ContractStatus.delivered`](#)[​](#contractstatusdelivered "Direct link to contractstatusdelivered")

#### [`ContractStatus.sent`](#)[​](#contractstatussent "Direct link to contractstatussent")

#### [`ContractStatus.signed`](#)[​](#contractstatussigned "Direct link to contractstatussigned")

#### [`ContractStatus.voided`](#)[​](#contractstatusvoided "Direct link to contractstatusvoided")

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountContract`](https://docs.monei.com/apis/graphql/types/objects/account-contract/.md) object


---

# Currencies

Possible currencies

```
enum Currencies {
  EUR
  USD
  GBP
  JPY
  CHF
  SEK
  DKK
  JOD
  PLN
}
```

### Values[​](#values "Direct link to Values")

#### [`Currencies.EUR`](#)[​](#currencieseur "Direct link to currencieseur")

#### [`Currencies.USD`](#)[​](#currenciesusd "Direct link to currenciesusd")

#### [`Currencies.GBP`](#)[​](#currenciesgbp "Direct link to currenciesgbp")

#### [`Currencies.JPY`](#)[​](#currenciesjpy "Direct link to currenciesjpy")

#### [`Currencies.CHF`](#)[​](#currencieschf "Direct link to currencieschf")

#### [`Currencies.SEK`](#)[​](#currenciessek "Direct link to currenciessek")

#### [`Currencies.DKK`](#)[​](#currenciesdkk "Direct link to currenciesdkk")

#### [`Currencies.JOD`](#)[​](#currenciesjod "Direct link to currenciesjod")

#### [`Currencies.PLN`](#)[​](#currenciespln "Direct link to currenciespln")

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object ● [`AccountInvoice`](https://docs.monei.com/apis/graphql/types/objects/account-invoice/.md) object ● [`AccountInvoiceLineItem`](https://docs.monei.com/apis/graphql/types/objects/account-invoice-line-item/.md) object ● [`CapitalLoan`](https://docs.monei.com/apis/graphql/types/objects/capital-loan/.md) object ● [`CapitalLoanDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-details/.md) object ● [`CapitalOffer`](https://docs.monei.com/apis/graphql/types/objects/capital-offer/.md) object ● [`chargesDateRangeKPI`](https://docs.monei.com/apis/graphql/operations/queries/charges-date-range-kpi/.md) query ● [`ChargesDateRangeKPI`](https://docs.monei.com/apis/graphql/types/objects/charges-date-range-kpi/.md) object ● [`CreatePaymentInput`](https://docs.monei.com/apis/graphql/types/inputs/create-payment-input/.md) input ● [`CreatePointOfSaleInput`](https://docs.monei.com/apis/graphql/types/inputs/create-point-of-sale-input/.md) input ● [`CreateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/create-subscription-input/.md) input ● [`PointOfSale`](https://docs.monei.com/apis/graphql/types/objects/point-of-sale/.md) object ● [`Provider`](https://docs.monei.com/apis/graphql/types/objects/provider/.md) object ● [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object ● [`UpdatePointOfSaleInput`](https://docs.monei.com/apis/graphql/types/inputs/update-point-of-sale-input/.md) input


---

# CustomDomainStatus

No description

```
enum CustomDomainStatus {
  FAILED
  PENDING_DELETION
  PENDING_VALIDATION
  SUCCESS
}
```

### Values[​](#values "Direct link to Values")

#### [`CustomDomainStatus.FAILED`](#)[​](#customdomainstatusfailed "Direct link to customdomainstatusfailed")

#### [`CustomDomainStatus.PENDING_DELETION`](#)[​](#customdomainstatuspending_deletion "Direct link to customdomainstatuspending_deletion")

#### [`CustomDomainStatus.PENDING_VALIDATION`](#)[​](#customdomainstatuspending_validation "Direct link to customdomainstatuspending_validation")

#### [`CustomDomainStatus.SUCCESS`](#)[​](#customdomainstatussuccess "Direct link to customdomainstatussuccess")

### Member Of[​](#member-of "Direct link to Member Of")

[`CustomDomainConfig`](https://docs.monei.com/apis/graphql/types/objects/custom-domain-config/.md) object


---

# DeviceType

No description

```
enum DeviceType {
  desktop
  mobile
  smartTV
  tablet
}
```

### Values[​](#values "Direct link to Values")

#### [`DeviceType.desktop`](#)[​](#devicetypedesktop "Direct link to devicetypedesktop")

#### [`DeviceType.mobile`](#)[​](#devicetypemobile "Direct link to devicetypemobile")

#### [`DeviceType.smartTV`](#)[​](#devicetypesmarttv "Direct link to devicetypesmarttv")

#### [`DeviceType.tablet`](#)[​](#devicetypetablet "Direct link to devicetypetablet")

### Member Of[​](#member-of "Direct link to Member Of")

[`SessionDetails`](https://docs.monei.com/apis/graphql/types/objects/session-details/.md) object ● [`SessionDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/session-details-input/.md) input ● [`TraceDetails`](https://docs.monei.com/apis/graphql/types/objects/trace-details/.md) object ● [`TraceDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/trace-details-input/.md) input


---

# DocumentStatus

No description

```
enum DocumentStatus {
  PENDING
  PROCESSING
  APPROVAL_REQUIRED
  APPROVED
  REJECTED
  EXPIRED
}
```

### Values[​](#values "Direct link to Values")

#### [`DocumentStatus.PENDING`](#)[​](#documentstatuspending "Direct link to documentstatuspending")

#### [`DocumentStatus.PROCESSING`](#)[​](#documentstatusprocessing "Direct link to documentstatusprocessing")

#### [`DocumentStatus.APPROVAL_REQUIRED`](#)[​](#documentstatusapproval_required "Direct link to documentstatusapproval_required")

#### [`DocumentStatus.APPROVED`](#)[​](#documentstatusapproved "Direct link to documentstatusapproved")

#### [`DocumentStatus.REJECTED`](#)[​](#documentstatusrejected "Direct link to documentstatusrejected")

#### [`DocumentStatus.EXPIRED`](#)[​](#documentstatusexpired "Direct link to documentstatusexpired")

### Member Of[​](#member-of "Direct link to Member Of")

[`Document`](https://docs.monei.com/apis/graphql/types/objects/document/.md) object


---

# DocumentType

No description

```
enum DocumentType {
  CENSUS_CERT
  GIPUZKOA_CENSUS_CERT
  NAVARRA_CENSUS_CERT
  BIZKAIA_CENSUS_CERT
  ALAVA_CENSUS_CERT
  BANK_OWNERSHIP_CERT
  CONTRACT
  PASSPORT
  ID_CARD
  COMPANY_TAX_ID
  RESIDENCE_PERMIT
  DRIVERS_LICENSE
  DEED_OF_INCORPORATION
  BENEFICIAL_OWNERSHIP_REPORT
  DEED_OF_COMPANY_REPRESENTATIVE
  POWER_OF_ATTORNEY
  OTHER
}
```

### Values[​](#values "Direct link to Values")

#### [`DocumentType.CENSUS_CERT`](#)[​](#documenttypecensus_cert "Direct link to documenttypecensus_cert")

#### [`DocumentType.GIPUZKOA_CENSUS_CERT`](#)[​](#documenttypegipuzkoa_census_cert "Direct link to documenttypegipuzkoa_census_cert")

#### [`DocumentType.NAVARRA_CENSUS_CERT`](#)[​](#documenttypenavarra_census_cert "Direct link to documenttypenavarra_census_cert")

#### [`DocumentType.BIZKAIA_CENSUS_CERT`](#)[​](#documenttypebizkaia_census_cert "Direct link to documenttypebizkaia_census_cert")

#### [`DocumentType.ALAVA_CENSUS_CERT`](#)[​](#documenttypealava_census_cert "Direct link to documenttypealava_census_cert")

#### [`DocumentType.BANK_OWNERSHIP_CERT`](#)[​](#documenttypebank_ownership_cert "Direct link to documenttypebank_ownership_cert")

#### [`DocumentType.CONTRACT`](#)[​](#documenttypecontract "Direct link to documenttypecontract")

#### [`DocumentType.PASSPORT`](#)[​](#documenttypepassport "Direct link to documenttypepassport")

#### [`DocumentType.ID_CARD`](#)[​](#documenttypeid_card "Direct link to documenttypeid_card")

#### [`DocumentType.COMPANY_TAX_ID`](#)[​](#documenttypecompany_tax_id "Direct link to documenttypecompany_tax_id")

#### [`DocumentType.RESIDENCE_PERMIT`](#)[​](#documenttyperesidence_permit "Direct link to documenttyperesidence_permit")

#### [`DocumentType.DRIVERS_LICENSE`](#)[​](#documenttypedrivers_license "Direct link to documenttypedrivers_license")

#### [`DocumentType.DEED_OF_INCORPORATION`](#)[​](#documenttypedeed_of_incorporation "Direct link to documenttypedeed_of_incorporation")

#### [`DocumentType.BENEFICIAL_OWNERSHIP_REPORT`](#)[​](#documenttypebeneficial_ownership_report "Direct link to documenttypebeneficial_ownership_report")

#### [`DocumentType.DEED_OF_COMPANY_REPRESENTATIVE`](#)[​](#documenttypedeed_of_company_representative "Direct link to documenttypedeed_of_company_representative")

#### [`DocumentType.POWER_OF_ATTORNEY`](#)[​](#documenttypepower_of_attorney "Direct link to documenttypepower_of_attorney")

#### [`DocumentType.OTHER`](#)[​](#documenttypeother "Direct link to documenttypeother")

### Member Of[​](#member-of "Direct link to Member Of")

[`CreateDocumentInput`](https://docs.monei.com/apis/graphql/types/inputs/create-document-input/.md) input ● [`Document`](https://docs.monei.com/apis/graphql/types/objects/document/.md) object


---

# ExportStatus

No description

```
enum ExportStatus {
  PENDING
  COMPLETED
  FAILED
}
```

### Values[​](#values "Direct link to Values")

#### [`ExportStatus.PENDING`](#)[​](#exportstatuspending "Direct link to exportstatuspending")

#### [`ExportStatus.COMPLETED`](#)[​](#exportstatuscompleted "Direct link to exportstatuscompleted")

#### [`ExportStatus.FAILED`](#)[​](#exportstatusfailed "Direct link to exportstatusfailed")

### Member Of[​](#member-of "Direct link to Member Of")

[`ChargesExport`](https://docs.monei.com/apis/graphql/types/objects/charges-export/.md) object


---

# IdVerificationStatus

Identity verification status

```
enum IdVerificationStatus {
  submitted
  approved
  resubmission_requested
  declined
  expired
  abandoned
}
```

### Values[​](#values "Direct link to Values")

#### [`IdVerificationStatus.submitted`](#)[​](#idverificationstatussubmitted "Direct link to idverificationstatussubmitted")

#### [`IdVerificationStatus.approved`](#)[​](#idverificationstatusapproved "Direct link to idverificationstatusapproved")

#### [`IdVerificationStatus.resubmission_requested`](#)[​](#idverificationstatusresubmission_requested "Direct link to idverificationstatusresubmission_requested")

#### [`IdVerificationStatus.declined`](#)[​](#idverificationstatusdeclined "Direct link to idverificationstatusdeclined")

#### [`IdVerificationStatus.expired`](#)[​](#idverificationstatusexpired "Direct link to idverificationstatusexpired")

#### [`IdVerificationStatus.abandoned`](#)[​](#idverificationstatusabandoned "Direct link to idverificationstatusabandoned")

### Member Of[​](#member-of "Direct link to Member Of")

[`Representative`](https://docs.monei.com/apis/graphql/types/objects/representative/.md) object


---

# Industries

Company industry

```
enum Industries {
  ECOMMERCE
}
```

### Values[​](#values "Direct link to Values")

#### [`Industries.ECOMMERCE`](#)[​](#industriesecommerce "Direct link to industriesecommerce")

### Member Of[​](#member-of "Direct link to Member Of")

[`BusinessData`](https://docs.monei.com/apis/graphql/types/objects/business-data/.md) object ● [`BusinessDataInput`](https://docs.monei.com/apis/graphql/types/inputs/business-data-input/.md) input


---

# IntervalInput

Subscription interval can only be set to minute and hour in test mode

```
enum IntervalInput {
  minute
  hour
  day
  week
  month
  quarter
  year
}
```

### Values[​](#values "Direct link to Values")

#### [`IntervalInput.minute`](#)[​](#intervalinputminute "Direct link to intervalinputminute")

#### [`IntervalInput.hour`](#)[​](#intervalinputhour "Direct link to intervalinputhour")

#### [`IntervalInput.day`](#)[​](#intervalinputday "Direct link to intervalinputday")

#### [`IntervalInput.week`](#)[​](#intervalinputweek "Direct link to intervalinputweek")

#### [`IntervalInput.month`](#)[​](#intervalinputmonth "Direct link to intervalinputmonth")

#### [`IntervalInput.quarter`](#)[​](#intervalinputquarter "Direct link to intervalinputquarter")

#### [`IntervalInput.year`](#)[​](#intervalinputyear "Direct link to intervalinputyear")

### Member Of[​](#member-of "Direct link to Member Of")

[`CreateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/create-subscription-input/.md) input ● [`UpdateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/update-subscription-input/.md) input


---

# Interval

No description

```
enum Interval {
  minute
  hour
  day
  week
  month
  quarter
  year
}
```

### Values[​](#values "Direct link to Values")

#### [`Interval.minute`](#)[​](#intervalminute "Direct link to intervalminute")

#### [`Interval.hour`](#)[​](#intervalhour "Direct link to intervalhour")

#### [`Interval.day`](#)[​](#intervalday "Direct link to intervalday")

#### [`Interval.week`](#)[​](#intervalweek "Direct link to intervalweek")

#### [`Interval.month`](#)[​](#intervalmonth "Direct link to intervalmonth")

#### [`Interval.quarter`](#)[​](#intervalquarter "Direct link to intervalquarter")

#### [`Interval.year`](#)[​](#intervalyear "Direct link to intervalyear")

### Member Of[​](#member-of "Direct link to Member Of")

[`chargesDateRangeKPI`](https://docs.monei.com/apis/graphql/operations/queries/charges-date-range-kpi/.md) query ● [`RetrySchedule`](https://docs.monei.com/apis/graphql/types/objects/retry-schedule/.md) object ● [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object ● [`SubscriptionEventObject`](https://docs.monei.com/apis/graphql/types/objects/subscription-event-object/.md) object


---

# LegalForm

Business legal form

* INDIVIDUAL: deprecated, use FREELANCE instead
* FREELANCE: Individual entrepreneur, self-employed
* COMPANY: Legal entity

```
enum LegalForm {
  INDIVIDUAL
  FREELANCE
  COMPANY
}
```

### Values[​](#values "Direct link to Values")

#### [`LegalForm.INDIVIDUAL`](#)[​](#legalformindividual "Direct link to legalformindividual")

#### [`LegalForm.FREELANCE`](#)[​](#legalformfreelance "Direct link to legalformfreelance")

#### [`LegalForm.COMPANY`](#)[​](#legalformcompany "Direct link to legalformcompany")

### Member Of[​](#member-of "Direct link to Member Of")

[`BusinessData`](https://docs.monei.com/apis/graphql/types/objects/business-data/.md) object ● [`BusinessDataInput`](https://docs.monei.com/apis/graphql/types/inputs/business-data-input/.md) input


---

# MessageChannel

Available channels to send messages

```
enum MessageChannel {
  EMAIL
  SMS
  WHATSAPP
}
```

### Values[​](#values "Direct link to Values")

#### [`MessageChannel.EMAIL`](#)[​](#messagechannelemail "Direct link to messagechannelemail")

#### [`MessageChannel.SMS`](#)[​](#messagechannelsms "Direct link to messagechannelsms")

#### [`MessageChannel.WHATSAPP`](#)[​](#messagechannelwhatsapp "Direct link to messagechannelwhatsapp")

### Member Of[​](#member-of "Direct link to Member Of")

[`SendPaymentMessageInput`](https://docs.monei.com/apis/graphql/types/inputs/send-payment-message-input/.md) input ● [`SendSubscriptionMessageInput`](https://docs.monei.com/apis/graphql/types/inputs/send-subscription-message-input/.md) input


---

# MetadataItemType

No description

```
enum MetadataItemType {
  STRING
  NUMBER
  BOOLEAN
  STRING_ARRAY
  NUMBER_ARRAY
}
```

### Values[​](#values "Direct link to Values")

#### [`MetadataItemType.STRING`](#)[​](#metadataitemtypestring "Direct link to metadataitemtypestring")

#### [`MetadataItemType.NUMBER`](#)[​](#metadataitemtypenumber "Direct link to metadataitemtypenumber")

#### [`MetadataItemType.BOOLEAN`](#)[​](#metadataitemtypeboolean "Direct link to metadataitemtypeboolean")

#### [`MetadataItemType.STRING_ARRAY`](#)[​](#metadataitemtypestring_array "Direct link to metadataitemtypestring_array")

#### [`MetadataItemType.NUMBER_ARRAY`](#)[​](#metadataitemtypenumber_array "Direct link to metadataitemtypenumber_array")

### Member Of[​](#member-of "Direct link to Member Of")

[`MetadataConfigItem`](https://docs.monei.com/apis/graphql/types/objects/metadata-config-item/.md) object ● [`MetadataItem`](https://docs.monei.com/apis/graphql/types/objects/metadata-item/.md) object


---

# NextActionTypes

Next action types

* `CONFIRM` - Your customer needs to be redirected to a [hosted payment page](https://docs.monei.com/docs/use-prebuilt-payment-page) or confirm payment using [payment token](https://docs.monei.com/docs/accept-card-payment#3-submitting-the-payment-to-monei-client-side). 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.

```
enum NextActionTypes {
  CONFIRM
  CHALLENGE
  COMPLETE
  FRICTIONLESS_CHALLENGE
  BIZUM_CHALLENGE
}
```

### Values[​](#values "Direct link to Values")

#### [`NextActionTypes.CONFIRM`](#)[​](#nextactiontypesconfirm "Direct link to nextactiontypesconfirm")

#### [`NextActionTypes.CHALLENGE`](#)[​](#nextactiontypeschallenge "Direct link to nextactiontypeschallenge")

#### [`NextActionTypes.COMPLETE`](#)[​](#nextactiontypescomplete "Direct link to nextactiontypescomplete")

#### [`NextActionTypes.FRICTIONLESS_CHALLENGE`](#)[​](#nextactiontypesfrictionless_challenge "Direct link to nextactiontypesfrictionless_challenge")

#### [`NextActionTypes.BIZUM_CHALLENGE`](#)[​](#nextactiontypesbizum_challenge "Direct link to nextactiontypesbizum_challenge")

### Member Of[​](#member-of "Direct link to Member Of")

[`NextAction`](https://docs.monei.com/apis/graphql/types/objects/next-action/.md) object


---

# NotConfiguredReason

No description

```
enum NotConfiguredReason {
  REAL_HOLDERS_DOCS
  NON_COMMERCIAL_COMPANY_DOCS
  NON_COMPLIANT_WEBSITE
  OTHER_COMPANY_WEBSITE
  HIGH_RISK_GOODS
  JOINT_OWNERSHIP
  REPEAT_ONBOARDING
  CBD_PRODUCTS
  OTHER
}
```

### Values[​](#values "Direct link to Values")

#### [`NotConfiguredReason.REAL_HOLDERS_DOCS`](#)[​](#notconfiguredreasonreal_holders_docs "Direct link to notconfiguredreasonreal_holders_docs")

#### [`NotConfiguredReason.NON_COMMERCIAL_COMPANY_DOCS`](#)[​](#notconfiguredreasonnon_commercial_company_docs "Direct link to notconfiguredreasonnon_commercial_company_docs")

#### [`NotConfiguredReason.NON_COMPLIANT_WEBSITE`](#)[​](#notconfiguredreasonnon_compliant_website "Direct link to notconfiguredreasonnon_compliant_website")

#### [`NotConfiguredReason.OTHER_COMPANY_WEBSITE`](#)[​](#notconfiguredreasonother_company_website "Direct link to notconfiguredreasonother_company_website")

#### [`NotConfiguredReason.HIGH_RISK_GOODS`](#)[​](#notconfiguredreasonhigh_risk_goods "Direct link to notconfiguredreasonhigh_risk_goods")

#### [`NotConfiguredReason.JOINT_OWNERSHIP`](#)[​](#notconfiguredreasonjoint_ownership "Direct link to notconfiguredreasonjoint_ownership")

#### [`NotConfiguredReason.REPEAT_ONBOARDING`](#)[​](#notconfiguredreasonrepeat_onboarding "Direct link to notconfiguredreasonrepeat_onboarding")

#### [`NotConfiguredReason.CBD_PRODUCTS`](#)[​](#notconfiguredreasoncbd_products "Direct link to notconfiguredreasoncbd_products")

#### [`NotConfiguredReason.OTHER`](#)[​](#notconfiguredreasonother "Direct link to notconfiguredreasonother")

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object


---

# PaymentEmailType

No description

```
enum PaymentEmailType {
  PAYMENT_LINK
  RECEIPT
}
```

### Values[​](#values "Direct link to Values")

#### [`PaymentEmailType.PAYMENT_LINK`](#)[​](#paymentemailtypepayment_link "Direct link to paymentemailtypepayment_link")

#### [`PaymentEmailType.RECEIPT`](#)[​](#paymentemailtypereceipt "Direct link to paymentemailtypereceipt")

### Member Of[​](#member-of "Direct link to Member Of")

[`paymentEmailPreview`](https://docs.monei.com/apis/graphql/operations/queries/payment-email-preview/.md) query ● [`previewPaymentEmail`](https://docs.monei.com/apis/graphql/operations/queries/preview-payment-email/.md) query


---

# PaymentMethodVisibilityActionType

Payment method visibility action type

```
enum PaymentMethodVisibilityActionType {
  HIDE
  SHOW
}
```

### Values[​](#values "Direct link to Values")

#### [`PaymentMethodVisibilityActionType.HIDE`](#)[​](#paymentmethodvisibilityactiontypehide "Direct link to paymentmethodvisibilityactiontypehide")

#### [`PaymentMethodVisibilityActionType.SHOW`](#)[​](#paymentmethodvisibilityactiontypeshow "Direct link to paymentmethodvisibilityactiontypeshow")


---

# PaymentMethods

Possible payment methods

```
enum PaymentMethods {
  alipay
  card
  cardPresent
  bizum
  paypal
  googlePay
  applePay
  clickToPay
  mbway
  multibanco
  iDeal
  bancontact
  sofort
  trustly
  sepa
  klarna
  giropay
  srtp
  eps
  blik
}
```

### Values[​](#values "Direct link to Values")

#### [`PaymentMethods.alipay`](#)[​](#paymentmethodsalipay "Direct link to paymentmethodsalipay")

#### [`PaymentMethods.card`](#)[​](#paymentmethodscard "Direct link to paymentmethodscard")

#### [`PaymentMethods.cardPresent`](#)[​](#paymentmethodscardpresent "Direct link to paymentmethodscardpresent")

#### [`PaymentMethods.bizum`](#)[​](#paymentmethodsbizum "Direct link to paymentmethodsbizum")

#### [`PaymentMethods.paypal`](#)[​](#paymentmethodspaypal "Direct link to paymentmethodspaypal")

#### [`PaymentMethods.googlePay`](#)[​](#paymentmethodsgooglepay "Direct link to paymentmethodsgooglepay")

#### [`PaymentMethods.applePay`](#)[​](#paymentmethodsapplepay "Direct link to paymentmethodsapplepay")

#### [`PaymentMethods.clickToPay`](#)[​](#paymentmethodsclicktopay "Direct link to paymentmethodsclicktopay")

#### [`PaymentMethods.mbway`](#)[​](#paymentmethodsmbway "Direct link to paymentmethodsmbway")

#### [`PaymentMethods.multibanco`](#)[​](#paymentmethodsmultibanco "Direct link to paymentmethodsmultibanco")

#### [`PaymentMethods.iDeal`](#)[​](#paymentmethodsideal "Direct link to paymentmethodsideal")

#### [`PaymentMethods.bancontact`](#)[​](#paymentmethodsbancontact "Direct link to paymentmethodsbancontact")

#### [`PaymentMethods.sofort`](#)[​](#paymentmethodssofort "Direct link to paymentmethodssofort")

#### [`PaymentMethods.trustly`](#)[​](#paymentmethodstrustly "Direct link to paymentmethodstrustly")

#### [`PaymentMethods.sepa`](#)[​](#paymentmethodssepa "Direct link to paymentmethodssepa")

#### [`PaymentMethods.klarna`](#)[​](#paymentmethodsklarna "Direct link to paymentmethodsklarna")

#### [`PaymentMethods.giropay`](#)[​](#paymentmethodsgiropay "Direct link to paymentmethodsgiropay")

#### [`PaymentMethods.srtp`](#)[​](#paymentmethodssrtp "Direct link to paymentmethodssrtp")

#### [`PaymentMethods.eps`](#)[​](#paymentmethodseps "Direct link to paymentmethodseps")

#### [`PaymentMethods.blik`](#)[​](#paymentmethodsblik "Direct link to paymentmethodsblik")

### Member Of[​](#member-of "Direct link to Member Of")

[`AvailablePaymentMethod`](https://docs.monei.com/apis/graphql/types/objects/available-payment-method/.md) object ● [`AvailableProcessor`](https://docs.monei.com/apis/graphql/types/objects/available-processor/.md) object ● [`availableProcessors`](https://docs.monei.com/apis/graphql/operations/queries/available-processors/.md) query ● [`CreatePaymentInput`](https://docs.monei.com/apis/graphql/types/inputs/create-payment-input/.md) input ● [`CreatePointOfSaleInput`](https://docs.monei.com/apis/graphql/types/inputs/create-point-of-sale-input/.md) input ● [`CreateProviderInput`](https://docs.monei.com/apis/graphql/types/inputs/create-provider-input/.md) input ● [`PaymentMethod`](https://docs.monei.com/apis/graphql/types/objects/payment-method/.md) object ● [`PaymentMethodInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-input/.md) input ● [`PointOfSale`](https://docs.monei.com/apis/graphql/types/objects/point-of-sale/.md) object ● [`Provider`](https://docs.monei.com/apis/graphql/types/objects/provider/.md) object ● [`providerConfig`](https://docs.monei.com/apis/graphql/operations/queries/provider-config/.md) query ● [`ProviderConfig`](https://docs.monei.com/apis/graphql/types/objects/provider-config/.md) object ● [`UpdatePointOfSaleInput`](https://docs.monei.com/apis/graphql/types/inputs/update-point-of-sale-input/.md) input


---

# PaymentRuleType

Type of payment rule

* CARD\_ROUTING: Rule to determine which card routing to use for a payment
* PAYMENT\_METHOD\_VISIBILITY: Rule to determine which payment methods are visible to the customer

```
enum PaymentRuleType {
  CARD_ROUTING
  PAYMENT_METHOD_VISIBILITY
}
```

### Values[​](#values "Direct link to Values")

#### [`PaymentRuleType.CARD_ROUTING`](#)[​](#paymentruletypecard_routing "Direct link to paymentruletypecard_routing")

#### [`PaymentRuleType.PAYMENT_METHOD_VISIBILITY`](#)[​](#paymentruletypepayment_method_visibility "Direct link to paymentruletypepayment_method_visibility")

### Member Of[​](#member-of "Direct link to Member Of")

[`CreatePaymentRuleInput`](https://docs.monei.com/apis/graphql/types/inputs/create-payment-rule-input/.md) input ● [`PaymentRule`](https://docs.monei.com/apis/graphql/types/objects/payment-rule/.md) object ● [`UpdatePaymentRuleInput`](https://docs.monei.com/apis/graphql/types/inputs/update-payment-rule-input/.md) input


---

# PaymentStatus

No description

```
enum PaymentStatus {
  SUCCEEDED
  PENDING
  PENDING_PROCESSING
  FAILED
  CANCELED
  REFUNDED
  PARTIALLY_REFUNDED
  AUTHORIZED
  EXPIRED
  PAID_OUT
}
```

### Values[​](#values "Direct link to Values")

#### [`PaymentStatus.SUCCEEDED`](#)[​](#paymentstatussucceeded "Direct link to paymentstatussucceeded")

#### [`PaymentStatus.PENDING`](#)[​](#paymentstatuspending "Direct link to paymentstatuspending")

#### [`PaymentStatus.PENDING_PROCESSING`](#)[​](#paymentstatuspending_processing "Direct link to paymentstatuspending_processing")

#### [`PaymentStatus.FAILED`](#)[​](#paymentstatusfailed "Direct link to paymentstatusfailed")

#### [`PaymentStatus.CANCELED`](#)[​](#paymentstatuscanceled "Direct link to paymentstatuscanceled")

#### [`PaymentStatus.REFUNDED`](#)[​](#paymentstatusrefunded "Direct link to paymentstatusrefunded")

#### [`PaymentStatus.PARTIALLY_REFUNDED`](#)[​](#paymentstatuspartially_refunded "Direct link to paymentstatuspartially_refunded")

#### [`PaymentStatus.AUTHORIZED`](#)[​](#paymentstatusauthorized "Direct link to paymentstatusauthorized")

#### [`PaymentStatus.EXPIRED`](#)[​](#paymentstatusexpired "Direct link to paymentstatusexpired")

#### [`PaymentStatus.PAID_OUT`](#)[​](#paymentstatuspaid_out "Direct link to paymentstatuspaid_out")

### Member Of[​](#member-of "Direct link to Member Of")

[`LastPayment`](https://docs.monei.com/apis/graphql/types/objects/last-payment/.md) object ● [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object


---

# PointOfSaleType

Type of Point of Sale determining its capabilities and purpose.

* `VIRTUAL` - \*\*Default\*\*. For grouping transactions and restricting user access. No payment hardware required. Payments inherit this POS ID when created by assigned users via API or MONEI Pay app.
* `QR_CODE` - Generates QR codes for accepting payments at physical locations. Supports fixed or manual amounts, custom payment methods, and customer requirements.
* `MONEI_PAY` - Tap-to-phone payments using the MONEI Pay app on Android or iOS devices.
* `MONEI_POD` - Bizum MONEI POD physical device for Bizum QR payments.

```
enum PointOfSaleType {
  MONEI_POD
  MONEI_PAY
  QR_CODE
  VIRTUAL
}
```

### Values[​](#values "Direct link to Values")

#### [`PointOfSaleType.MONEI_POD`](#)[​](#pointofsaletypemonei_pod "Direct link to pointofsaletypemonei_pod")

#### [`PointOfSaleType.MONEI_PAY`](#)[​](#pointofsaletypemonei_pay "Direct link to pointofsaletypemonei_pay")

#### [`PointOfSaleType.QR_CODE`](#)[​](#pointofsaletypeqr_code "Direct link to pointofsaletypeqr_code")

#### [`PointOfSaleType.VIRTUAL`](#)[​](#pointofsaletypevirtual "Direct link to pointofsaletypevirtual")

### Member Of[​](#member-of "Direct link to Member Of")

[`CreatePointOfSaleInput`](https://docs.monei.com/apis/graphql/types/inputs/create-point-of-sale-input/.md) input ● [`PointOfSale`](https://docs.monei.com/apis/graphql/types/objects/point-of-sale/.md) object


---

# Processor

No description

```
enum Processor {
  ADYEN
  MONEI_REDSYS
  MONEIX_F
  MONEIX_G
  MONEIX_GNET
  MONEIX_P
  PAYPAL
  REDSYS
  STRIPE
}
```

### Values[​](#values "Direct link to Values")

#### [`Processor.ADYEN`](#)[​](#processoradyen "Direct link to processoradyen")

#### [`Processor.MONEI_REDSYS`](#)[​](#processormonei_redsys "Direct link to processormonei_redsys")

#### [`Processor.MONEIX_F`](#)[​](#processormoneix_f "Direct link to processormoneix_f")

#### [`Processor.MONEIX_G`](#)[​](#processormoneix_g "Direct link to processormoneix_g")

#### [`Processor.MONEIX_GNET`](#)[​](#processormoneix_gnet "Direct link to processormoneix_gnet")

#### [`Processor.MONEIX_P`](#)[​](#processormoneix_p "Direct link to processormoneix_p")

#### [`Processor.PAYPAL`](#)[​](#processorpaypal "Direct link to processorpaypal")

#### [`Processor.REDSYS`](#)[​](#processorredsys "Direct link to processorredsys")

#### [`Processor.STRIPE`](#)[​](#processorstripe "Direct link to processorstripe")

### Member Of[​](#member-of "Direct link to Member Of")

[`AvailableProcessor`](https://docs.monei.com/apis/graphql/types/objects/available-processor/.md) object ● [`CreateProviderInput`](https://docs.monei.com/apis/graphql/types/inputs/create-provider-input/.md) input ● [`Provider`](https://docs.monei.com/apis/graphql/types/objects/provider/.md) object ● [`providerConfig`](https://docs.monei.com/apis/graphql/operations/queries/provider-config/.md) query ● [`ProviderConfig`](https://docs.monei.com/apis/graphql/types/objects/provider-config/.md) object


---

# RefundReason

No description

```
enum RefundReason {
  duplicated
  fraudulent
  requested_by_customer
  order_canceled
}
```

### Values[​](#values "Direct link to Values")

#### [`RefundReason.duplicated`](#)[​](#refundreasonduplicated "Direct link to refundreasonduplicated")

#### [`RefundReason.fraudulent`](#)[​](#refundreasonfraudulent "Direct link to refundreasonfraudulent")

#### [`RefundReason.requested_by_customer`](#)[​](#refundreasonrequested_by_customer "Direct link to refundreasonrequested_by_customer")

#### [`RefundReason.order_canceled`](#)[​](#refundreasonorder_canceled "Direct link to refundreasonorder_canceled")

### Member Of[​](#member-of "Direct link to Member Of")

[`Charge`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) object ● [`ChargeEventObject`](https://docs.monei.com/apis/graphql/types/objects/charge-event-object/.md) object ● [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object ● [`RefundPaymentInput`](https://docs.monei.com/apis/graphql/types/inputs/refund-payment-input/.md) input ● [`UpdateChargeInput`](https://docs.monei.com/apis/graphql/types/inputs/update-charge-input/.md) input


---

# RejectedReason

No description

```
enum RejectedReason {
  INCOMPLETE_DOCS
  NOT_COMPLIANT
  RESTRICTED_CATEGORY
  OTHER
}
```

### Values[​](#values "Direct link to Values")

#### [`RejectedReason.INCOMPLETE_DOCS`](#)[​](#rejectedreasonincomplete_docs "Direct link to rejectedreasonincomplete_docs")

#### [`RejectedReason.NOT_COMPLIANT`](#)[​](#rejectedreasonnot_compliant "Direct link to rejectedreasonnot_compliant")

#### [`RejectedReason.RESTRICTED_CATEGORY`](#)[​](#rejectedreasonrestricted_category "Direct link to rejectedreasonrestricted_category")

#### [`RejectedReason.OTHER`](#)[​](#rejectedreasonother "Direct link to rejectedreasonother")

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object


---

# RetryIntervalInput

Subscription retry interval can only be set to minute and hour in test mode

```
enum RetryIntervalInput {
  minute
  hour
  day
  week
  month
  quarter
  year
}
```

### Values[​](#values "Direct link to Values")

#### [`RetryIntervalInput.minute`](#)[​](#retryintervalinputminute "Direct link to retryintervalinputminute")

#### [`RetryIntervalInput.hour`](#)[​](#retryintervalinputhour "Direct link to retryintervalinputhour")

#### [`RetryIntervalInput.day`](#)[​](#retryintervalinputday "Direct link to retryintervalinputday")

#### [`RetryIntervalInput.week`](#)[​](#retryintervalinputweek "Direct link to retryintervalinputweek")

#### [`RetryIntervalInput.month`](#)[​](#retryintervalinputmonth "Direct link to retryintervalinputmonth")

#### [`RetryIntervalInput.quarter`](#)[​](#retryintervalinputquarter "Direct link to retryintervalinputquarter")

#### [`RetryIntervalInput.year`](#)[​](#retryintervalinputyear "Direct link to retryintervalinputyear")

### Member Of[​](#member-of "Direct link to Member Of")

[`RetryScheduleInput`](https://docs.monei.com/apis/graphql/types/inputs/retry-schedule-input/.md) input


---

# SettlementPayMethods

No description

```
enum SettlementPayMethods {
  bizum
  card
}
```

### Values[​](#values "Direct link to Values")

#### [`SettlementPayMethods.bizum`](#)[​](#settlementpaymethodsbizum "Direct link to settlementpaymethodsbizum")

#### [`SettlementPayMethods.card`](#)[​](#settlementpaymethodscard "Direct link to settlementpaymethodscard")

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountSettlement`](https://docs.monei.com/apis/graphql/types/objects/account-settlement/.md) object ● [`SettlementEventObject`](https://docs.monei.com/apis/graphql/types/objects/settlement-event-object/.md) object


---

# SettlementStatus

No description

```
enum SettlementStatus {
  COMPLETED
  PENDING
  SUSPENDED
}
```

### Values[​](#values "Direct link to Values")

#### [`SettlementStatus.COMPLETED`](#)[​](#settlementstatuscompleted "Direct link to settlementstatuscompleted")

#### [`SettlementStatus.PENDING`](#)[​](#settlementstatuspending "Direct link to settlementstatuspending")

#### [`SettlementStatus.SUSPENDED`](#)[​](#settlementstatussuspended "Direct link to settlementstatussuspended")

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountSettlement`](https://docs.monei.com/apis/graphql/types/objects/account-settlement/.md) object ● [`SettlementEventObject`](https://docs.monei.com/apis/graphql/types/objects/settlement-event-object/.md) object


---

# StatusReason

The reason why the account status was changed

* REAL\_HOLDERS\_DOCS: Real holders documents are required
* NON\_COMMERCIAL\_COMPANY\_DOCS: Non-commercial company documents are required
* NON\_COMPLIANT\_WEBSITE: Website is not compliant
* OTHER\_COMPANY\_WEBSITE: Other company website is required
* HIGH\_RISK\_GOODS: High risk goods
* JOINT\_OWNERSHIP: Joint ownership, additional documents are required
* REPEAT\_ONBOARDING: Repeat onboarding
* CBD\_PRODUCTS: CBD products
* INCOMPLETE\_DOCS: Incomplete documents
* NOT\_COMPLIANT\_BUSINESS: Business is not compliant
* RESTRICTED\_CATEGORY: Restricted category
* UPDATE\_BILLING\_INFO: Update billing information
* SUSPICIOUS\_ACTIVITY: Suspicious activity
* CUSTOMER\_COMPLAINTS: Customer complaints
* CHARGEBACKS: Chargebacks
* OTHER: Other

```
enum StatusReason {
  BANK_OWNERSHIP_CERT_REQUIRED
  REAL_HOLDERS_DOCS
  NON_COMMERCIAL_COMPANY_DOCS
  NON_COMPLIANT_WEBSITE
  OTHER_COMPANY_WEBSITE
  HIGH_RISK_GOODS
  JOINT_OWNERSHIP
  REPEAT_ONBOARDING
  CBD_PRODUCTS
  ID_VERIFICATION_REQUIRED
  CENSUS_CERT_REQUIRED
  INCOMPLETE_DOCS
  NOT_COMPLIANT_BUSINESS
  RESTRICTED_CATEGORY
  UPDATE_BILLING_INFO
  SUSPICIOUS_ACTIVITY
  CUSTOMER_COMPLAINTS
  CHARGEBACKS
  OTHER
}
```

### Values[​](#values "Direct link to Values")

#### [`StatusReason.BANK_OWNERSHIP_CERT_REQUIRED`](#)[​](#statusreasonbank_ownership_cert_required "Direct link to statusreasonbank_ownership_cert_required")

#### [`StatusReason.REAL_HOLDERS_DOCS`](#)[​](#statusreasonreal_holders_docs "Direct link to statusreasonreal_holders_docs")

#### [`StatusReason.NON_COMMERCIAL_COMPANY_DOCS`](#)[​](#statusreasonnon_commercial_company_docs "Direct link to statusreasonnon_commercial_company_docs")

#### [`StatusReason.NON_COMPLIANT_WEBSITE`](#)[​](#statusreasonnon_compliant_website "Direct link to statusreasonnon_compliant_website")

#### [`StatusReason.OTHER_COMPANY_WEBSITE`](#)[​](#statusreasonother_company_website "Direct link to statusreasonother_company_website")

#### [`StatusReason.HIGH_RISK_GOODS`](#)[​](#statusreasonhigh_risk_goods "Direct link to statusreasonhigh_risk_goods")

#### [`StatusReason.JOINT_OWNERSHIP`](#)[​](#statusreasonjoint_ownership "Direct link to statusreasonjoint_ownership")

#### [`StatusReason.REPEAT_ONBOARDING`](#)[​](#statusreasonrepeat_onboarding "Direct link to statusreasonrepeat_onboarding")

#### [`StatusReason.CBD_PRODUCTS`](#)[​](#statusreasoncbd_products "Direct link to statusreasoncbd_products")

#### [`StatusReason.ID_VERIFICATION_REQUIRED`](#)[​](#statusreasonid_verification_required "Direct link to statusreasonid_verification_required")

#### [`StatusReason.CENSUS_CERT_REQUIRED`](#)[​](#statusreasoncensus_cert_required "Direct link to statusreasoncensus_cert_required")

#### [`StatusReason.INCOMPLETE_DOCS`](#)[​](#statusreasonincomplete_docs "Direct link to statusreasonincomplete_docs")

#### [`StatusReason.NOT_COMPLIANT_BUSINESS`](#)[​](#statusreasonnot_compliant_business "Direct link to statusreasonnot_compliant_business")

#### [`StatusReason.RESTRICTED_CATEGORY`](#)[​](#statusreasonrestricted_category "Direct link to statusreasonrestricted_category")

#### [`StatusReason.UPDATE_BILLING_INFO`](#)[​](#statusreasonupdate_billing_info "Direct link to statusreasonupdate_billing_info")

#### [`StatusReason.SUSPICIOUS_ACTIVITY`](#)[​](#statusreasonsuspicious_activity "Direct link to statusreasonsuspicious_activity")

#### [`StatusReason.CUSTOMER_COMPLAINTS`](#)[​](#statusreasoncustomer_complaints "Direct link to statusreasoncustomer_complaints")

#### [`StatusReason.CHARGEBACKS`](#)[​](#statusreasonchargebacks "Direct link to statusreasonchargebacks")

#### [`StatusReason.OTHER`](#)[​](#statusreasonother "Direct link to statusreasonother")

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object


---

# SubscriptionEmailType

No description

```
enum SubscriptionEmailType {
  SUBSCRIPTION_LINK
  SUBSCRIPTION_STATUS
}
```

### Values[​](#values "Direct link to Values")

#### [`SubscriptionEmailType.SUBSCRIPTION_LINK`](#)[​](#subscriptionemailtypesubscription_link "Direct link to subscriptionemailtypesubscription_link")

#### [`SubscriptionEmailType.SUBSCRIPTION_STATUS`](#)[​](#subscriptionemailtypesubscription_status "Direct link to subscriptionemailtypesubscription_status")

### Member Of[​](#member-of "Direct link to Member Of")

[`previewSubscriptionEmail`](https://docs.monei.com/apis/graphql/operations/queries/preview-subscription-email/.md) query ● [`subscriptionEmailPreview`](https://docs.monei.com/apis/graphql/operations/queries/subscription-email-preview/.md) query


---

# SubscriptionPaymentMethods

No description

```
enum SubscriptionPaymentMethods {
  card
  bizum
}
```

### Values[​](#values "Direct link to Values")

#### [`SubscriptionPaymentMethods.card`](#)[​](#subscriptionpaymentmethodscard "Direct link to subscriptionpaymentmethodscard")

#### [`SubscriptionPaymentMethods.bizum`](#)[​](#subscriptionpaymentmethodsbizum "Direct link to subscriptionpaymentmethodsbizum")

### Member Of[​](#member-of "Direct link to Member Of")

[`ActivateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/activate-subscription-input/.md) input ● [`CreateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/create-subscription-input/.md) input ● [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object ● [`SubscriptionEventObject`](https://docs.monei.com/apis/graphql/types/objects/subscription-event-object/.md) object ● [`UpdateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/update-subscription-input/.md) input


---

# SubscriptionStatus

No description

```
enum SubscriptionStatus {
  PENDING
  EXPIRED
  TRIALING
  ACTIVE
  PAST_DUE
  PAUSED
  CANCELED
}
```

### Values[​](#values "Direct link to Values")

#### [`SubscriptionStatus.PENDING`](#)[​](#subscriptionstatuspending "Direct link to subscriptionstatuspending")

#### [`SubscriptionStatus.EXPIRED`](#)[​](#subscriptionstatusexpired "Direct link to subscriptionstatusexpired")

#### [`SubscriptionStatus.TRIALING`](#)[​](#subscriptionstatustrialing "Direct link to subscriptionstatustrialing")

#### [`SubscriptionStatus.ACTIVE`](#)[​](#subscriptionstatusactive "Direct link to subscriptionstatusactive")

#### [`SubscriptionStatus.PAST_DUE`](#)[​](#subscriptionstatuspast_due "Direct link to subscriptionstatuspast_due")

#### [`SubscriptionStatus.PAUSED`](#)[​](#subscriptionstatuspaused "Direct link to subscriptionstatuspaused")

#### [`SubscriptionStatus.CANCELED`](#)[​](#subscriptionstatuscanceled "Direct link to subscriptionstatuscanceled")

### Member Of[​](#member-of "Direct link to Member Of")

[`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object ● [`SubscriptionEventObject`](https://docs.monei.com/apis/graphql/types/objects/subscription-event-object/.md) object


---

# ThreeDSecureFlow

3D Secure flows

```
enum ThreeDSecureFlow {
  CHALLENGE
  FRICTIONLESS
  FRICTIONLESS_CHALLENGE
  DIRECT
}
```

### Values[​](#values "Direct link to Values")

#### [`ThreeDSecureFlow.CHALLENGE`](#)[​](#threedsecureflowchallenge "Direct link to threedsecureflowchallenge")

#### [`ThreeDSecureFlow.FRICTIONLESS`](#)[​](#threedsecureflowfrictionless "Direct link to threedsecureflowfrictionless")

#### [`ThreeDSecureFlow.FRICTIONLESS_CHALLENGE`](#)[​](#threedsecureflowfrictionless_challenge "Direct link to threedsecureflowfrictionless_challenge")

#### [`ThreeDSecureFlow.DIRECT`](#)[​](#threedsecureflowdirect "Direct link to threedsecureflowdirect")

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethodCard`](https://docs.monei.com/apis/graphql/types/objects/payment-method-card/.md) object


---

# TokenizationMethods

Possible tokenization methods for card payments

```
enum TokenizationMethods {
  googlePay
  applePay
  clickToPay
}
```

### Values[​](#values "Direct link to Values")

#### [`TokenizationMethods.googlePay`](#)[​](#tokenizationmethodsgooglepay "Direct link to tokenizationmethodsgooglepay")

#### [`TokenizationMethods.applePay`](#)[​](#tokenizationmethodsapplepay "Direct link to tokenizationmethodsapplepay")

#### [`TokenizationMethods.clickToPay`](#)[​](#tokenizationmethodsclicktopay "Direct link to tokenizationmethodsclicktopay")

### Member Of[​](#member-of "Direct link to Member Of")

[`disableTokenizationMethod`](https://docs.monei.com/apis/graphql/operations/mutations/disable-tokenization-method/.md) mutation ● [`enableTokenizationMethod`](https://docs.monei.com/apis/graphql/operations/mutations/enable-tokenization-method/.md) mutation ● [`PaymentMethodCard`](https://docs.monei.com/apis/graphql/types/objects/payment-method-card/.md) object ● [`PaymentMethodCardInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-card-input/.md) input


---

# TransactionTypes

Controls when the funds will be captured.

* `SALE` - \*\*Default\*\*. MONEI automatically captures funds when the customer authorizes the payment.
* `AUTH` - Place a hold on the funds when the customer authorizes the payment, but don’t capture the funds until later.
* `PAYOUT` - Send funds to the customer
* `VERIF` - Verify the card without placing a hold or capturing funds.

```
enum TransactionTypes {
  AUTH
  SALE
  REFUND
  CAPTURE
  CANCEL
  PAYOUT
}
```

### Values[​](#values "Direct link to Values")

#### [`TransactionTypes.AUTH`](#)[​](#transactiontypesauth "Direct link to transactiontypesauth")

#### [`TransactionTypes.SALE`](#)[​](#transactiontypessale "Direct link to transactiontypessale")

#### [`TransactionTypes.REFUND`](#)[​](#transactiontypesrefund "Direct link to transactiontypesrefund")

#### [`TransactionTypes.CAPTURE`](#)[​](#transactiontypescapture "Direct link to transactiontypescapture")

#### [`TransactionTypes.CANCEL`](#)[​](#transactiontypescancel "Direct link to transactiontypescancel")

#### [`TransactionTypes.PAYOUT`](#)[​](#transactiontypespayout "Direct link to transactiontypespayout")

### Member Of[​](#member-of "Direct link to Member Of")

[`CreatePaymentInput`](https://docs.monei.com/apis/graphql/types/inputs/create-payment-input/.md) input ● [`CreatePointOfSaleInput`](https://docs.monei.com/apis/graphql/types/inputs/create-point-of-sale-input/.md) input ● [`PointOfSale`](https://docs.monei.com/apis/graphql/types/objects/point-of-sale/.md) object ● [`UpdatePointOfSaleInput`](https://docs.monei.com/apis/graphql/types/inputs/update-point-of-sale-input/.md) input


---

# UnitType

Invoice line item unit type

```
enum UnitType {
  money
  percent
}
```

### Values[​](#values "Direct link to Values")

#### [`UnitType.money`](#)[​](#unittypemoney "Direct link to unittypemoney")

#### [`UnitType.percent`](#)[​](#unittypepercent "Direct link to unittypepercent")

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountInvoiceLineItem`](https://docs.monei.com/apis/graphql/types/objects/account-invoice-line-item/.md) object


---

# WebReportStatus

No description

```
enum WebReportStatus {
  PROCESSING
  SUCCEEDED
  FAILED
}
```

### Values[​](#values "Direct link to Values")

#### [`WebReportStatus.PROCESSING`](#)[​](#webreportstatusprocessing "Direct link to webreportstatusprocessing")

#### [`WebReportStatus.SUCCEEDED`](#)[​](#webreportstatussucceeded "Direct link to webreportstatussucceeded")

#### [`WebReportStatus.FAILED`](#)[​](#webreportstatusfailed "Direct link to webreportstatusfailed")

### Member Of[​](#member-of "Direct link to Member Of")

[`WebReport`](https://docs.monei.com/apis/graphql/types/objects/web-report/.md) object


---

# WebhookEventType

No description

```
enum WebhookEventType {
  CHARGE_PENDING
  CHARGE_PENDING_PROCESSING
  CHARGE_UPDATED
  CHARGE_AUTHORIZED
  CHARGE_REFUNDED
  CHARGE_PARTIALLY_REFUNDED
  CHARGE_CAPTURED
  CHARGE_CANCELED
  CHARGE_SUCCEEDED
  CHARGE_FAILED
  CHARGE_EXPIRED
  CHARGE_CHARGEBACK
  CHARGE_PAID_OUT
  SETTLEMENT_COMPLETED
  SETTLEMENT_PENDING
  SETTLEMENT_SUSPENDED
  SUBSCRIPTION_PENDING
  SUBSCRIPTION_EXPIRED
  SUBSCRIPTION_TRIALING
  SUBSCRIPTION_ACTIVATED
  SUBSCRIPTION_CANCELED
  SUBSCRIPTION_PAUSED
  SUBSCRIPTION_PAST_DUE
  SUBSCRIPTION_UPDATED
  ACCOUNT_INVOICE_PAID
  ACCOUNT_INVOICE_UNPAID
  ACCOUNT_INVOICE_PENDING
  ACCOUNT_INVOICE_PAST_DUE
}
```

### Values[​](#values "Direct link to Values")

#### [`WebhookEventType.CHARGE_PENDING`](#)[​](#webhookeventtypecharge_pending "Direct link to webhookeventtypecharge_pending")

#### [`WebhookEventType.CHARGE_PENDING_PROCESSING`](#)[​](#webhookeventtypecharge_pending_processing "Direct link to webhookeventtypecharge_pending_processing")

#### [`WebhookEventType.CHARGE_UPDATED`](#)[​](#webhookeventtypecharge_updated "Direct link to webhookeventtypecharge_updated")

#### [`WebhookEventType.CHARGE_AUTHORIZED`](#)[​](#webhookeventtypecharge_authorized "Direct link to webhookeventtypecharge_authorized")

#### [`WebhookEventType.CHARGE_REFUNDED`](#)[​](#webhookeventtypecharge_refunded "Direct link to webhookeventtypecharge_refunded")

#### [`WebhookEventType.CHARGE_PARTIALLY_REFUNDED`](#)[​](#webhookeventtypecharge_partially_refunded "Direct link to webhookeventtypecharge_partially_refunded")

#### [`WebhookEventType.CHARGE_CAPTURED`](#)[​](#webhookeventtypecharge_captured "Direct link to webhookeventtypecharge_captured")

#### [`WebhookEventType.CHARGE_CANCELED`](#)[​](#webhookeventtypecharge_canceled "Direct link to webhookeventtypecharge_canceled")

#### [`WebhookEventType.CHARGE_SUCCEEDED`](#)[​](#webhookeventtypecharge_succeeded "Direct link to webhookeventtypecharge_succeeded")

#### [`WebhookEventType.CHARGE_FAILED`](#)[​](#webhookeventtypecharge_failed "Direct link to webhookeventtypecharge_failed")

#### [`WebhookEventType.CHARGE_EXPIRED`](#)[​](#webhookeventtypecharge_expired "Direct link to webhookeventtypecharge_expired")

#### [`WebhookEventType.CHARGE_CHARGEBACK`](#)[​](#webhookeventtypecharge_chargeback "Direct link to webhookeventtypecharge_chargeback")

#### [`WebhookEventType.CHARGE_PAID_OUT`](#)[​](#webhookeventtypecharge_paid_out "Direct link to webhookeventtypecharge_paid_out")

#### [`WebhookEventType.SETTLEMENT_COMPLETED`](#)[​](#webhookeventtypesettlement_completed "Direct link to webhookeventtypesettlement_completed")

#### [`WebhookEventType.SETTLEMENT_PENDING`](#)[​](#webhookeventtypesettlement_pending "Direct link to webhookeventtypesettlement_pending")

#### [`WebhookEventType.SETTLEMENT_SUSPENDED`](#)[​](#webhookeventtypesettlement_suspended "Direct link to webhookeventtypesettlement_suspended")

#### [`WebhookEventType.SUBSCRIPTION_PENDING`](#)[​](#webhookeventtypesubscription_pending "Direct link to webhookeventtypesubscription_pending")

#### [`WebhookEventType.SUBSCRIPTION_EXPIRED`](#)[​](#webhookeventtypesubscription_expired "Direct link to webhookeventtypesubscription_expired")

#### [`WebhookEventType.SUBSCRIPTION_TRIALING`](#)[​](#webhookeventtypesubscription_trialing "Direct link to webhookeventtypesubscription_trialing")

#### [`WebhookEventType.SUBSCRIPTION_ACTIVATED`](#)[​](#webhookeventtypesubscription_activated "Direct link to webhookeventtypesubscription_activated")

#### [`WebhookEventType.SUBSCRIPTION_CANCELED`](#)[​](#webhookeventtypesubscription_canceled "Direct link to webhookeventtypesubscription_canceled")

#### [`WebhookEventType.SUBSCRIPTION_PAUSED`](#)[​](#webhookeventtypesubscription_paused "Direct link to webhookeventtypesubscription_paused")

#### [`WebhookEventType.SUBSCRIPTION_PAST_DUE`](#)[​](#webhookeventtypesubscription_past_due "Direct link to webhookeventtypesubscription_past_due")

#### [`WebhookEventType.SUBSCRIPTION_UPDATED`](#)[​](#webhookeventtypesubscription_updated "Direct link to webhookeventtypesubscription_updated")

#### [`WebhookEventType.ACCOUNT_INVOICE_PAID`](#)[​](#webhookeventtypeaccount_invoice_paid "Direct link to webhookeventtypeaccount_invoice_paid")

#### [`WebhookEventType.ACCOUNT_INVOICE_UNPAID`](#)[​](#webhookeventtypeaccount_invoice_unpaid "Direct link to webhookeventtypeaccount_invoice_unpaid")

#### [`WebhookEventType.ACCOUNT_INVOICE_PENDING`](#)[​](#webhookeventtypeaccount_invoice_pending "Direct link to webhookeventtypeaccount_invoice_pending")

#### [`WebhookEventType.ACCOUNT_INVOICE_PAST_DUE`](#)[​](#webhookeventtypeaccount_invoice_past_due "Direct link to webhookeventtypeaccount_invoice_past_due")

### Member Of[​](#member-of "Direct link to Member Of")

[`CreateWebhookInput`](https://docs.monei.com/apis/graphql/types/inputs/create-webhook-input/.md) input ● [`UpdateWebhookInput`](https://docs.monei.com/apis/graphql/types/inputs/update-webhook-input/.md) input ● [`Webhook`](https://docs.monei.com/apis/graphql/types/objects/webhook/.md) object


---

# AccountBrandingInput

Account branding input

```
input AccountBrandingInput {
  accentColor: String
  bgColor: String
  logoUrl: String
  iconUrl: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountBrandingInput.accentColor`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountbrandinginputaccentcolorstring- "Direct link to accountbrandinginputaccentcolorstring-")

Accent color, used on the payment page

#### [`AccountBrandingInput.bgColor`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountbrandinginputbgcolorstring- "Direct link to accountbrandinginputbgcolorstring-")

Background color, used on the payment page

#### [`AccountBrandingInput.logoUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountbrandinginputlogourlstring- "Direct link to accountbrandinginputlogourlstring-")

Logo URL, the logo will be displayed on the payment page

#### [`AccountBrandingInput.iconUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountbrandinginputiconurlstring- "Direct link to accountbrandinginputiconurlstring-")

icon URL, the icon will be used as an icon for the payment page

### Member Of[​](#member-of "Direct link to Member Of")

[`UpdateAccountInput`](https://docs.monei.com/apis/graphql/types/inputs/update-account-input/.md) input


---

# AccountNotificationsInput

Account notifications input

```
input AccountNotificationsInput {
  emailCustomerOnRefund: Boolean
  emailCustomerOnSuccess: Boolean
  emailCustomerOnSubscription: Boolean
  emailAdminOnSuccess: Boolean
  emailAdminOnSubscription: Boolean
  adminEmails: [String!]
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountNotificationsInput.emailCustomerOnRefund`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accountnotificationsinputemailcustomeronrefundboolean- "Direct link to accountnotificationsinputemailcustomeronrefundboolean-")

Whether to send an email to the customer on refund

#### [`AccountNotificationsInput.emailCustomerOnSuccess`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accountnotificationsinputemailcustomeronsuccessboolean- "Direct link to accountnotificationsinputemailcustomeronsuccessboolean-")

Whether to send an email to the customer on successful payment

#### [`AccountNotificationsInput.emailCustomerOnSubscription`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accountnotificationsinputemailcustomeronsubscriptionboolean- "Direct link to accountnotificationsinputemailcustomeronsubscriptionboolean-")

Whether to send an email to the customer on successful subscription

#### [`AccountNotificationsInput.emailAdminOnSuccess`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accountnotificationsinputemailadminonsuccessboolean- "Direct link to accountnotificationsinputemailadminonsuccessboolean-")

Whether to send an email to the admin on every successful payment

#### [`AccountNotificationsInput.emailAdminOnSubscription`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accountnotificationsinputemailadminonsubscriptionboolean- "Direct link to accountnotificationsinputemailadminonsubscriptionboolean-")

Whether to send an email to the admin on every successful subscription

#### [`AccountNotificationsInput.adminEmails`](#) ● [`[String!]`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) list scalar[​](#accountnotificationsinputadminemailsstring-- "Direct link to accountnotificationsinputadminemailsstring--")

List of admin emails to send notifications

### Member Of[​](#member-of "Direct link to Member Of")

[`UpdateAccountInput`](https://docs.monei.com/apis/graphql/types/inputs/update-account-input/.md) input


---

# AccountPublicBusinessDetailsInput

Account public business details input

```
input AccountPublicBusinessDetailsInput {
  companyName: String
  website: String
  phone: String
  address: AddressInput
  supportWebsite: String
  supportEmail: String
  supportPhone: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountPublicBusinessDetailsInput.companyName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountpublicbusinessdetailsinputcompanynamestring- "Direct link to accountpublicbusinessdetailsinputcompanynamestring-")

Company name

#### [`AccountPublicBusinessDetailsInput.website`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountpublicbusinessdetailsinputwebsitestring- "Direct link to accountpublicbusinessdetailsinputwebsitestring-")

Website

#### [`AccountPublicBusinessDetailsInput.phone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountpublicbusinessdetailsinputphonestring- "Direct link to accountpublicbusinessdetailsinputphonestring-")

Phone number, E.164 format, e.g. +34666777888

#### [`AccountPublicBusinessDetailsInput.address`](#) ● [`AddressInput`](https://docs.monei.com/apis/graphql/types/inputs/address-input/.md) input[​](#accountpublicbusinessdetailsinputaddressaddressinput- "Direct link to accountpublicbusinessdetailsinputaddressaddressinput-")

Full address

#### [`AccountPublicBusinessDetailsInput.supportWebsite`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountpublicbusinessdetailsinputsupportwebsitestring- "Direct link to accountpublicbusinessdetailsinputsupportwebsitestring-")

Support website

#### [`AccountPublicBusinessDetailsInput.supportEmail`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountpublicbusinessdetailsinputsupportemailstring- "Direct link to accountpublicbusinessdetailsinputsupportemailstring-")

Support email

#### [`AccountPublicBusinessDetailsInput.supportPhone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountpublicbusinessdetailsinputsupportphonestring- "Direct link to accountpublicbusinessdetailsinputsupportphonestring-")

Support phone, E.164 format, e.g. +34666777888

### Member Of[​](#member-of "Direct link to Member Of")

[`UpdateAccountInput`](https://docs.monei.com/apis/graphql/types/inputs/update-account-input/.md) input


---

# ActivateApplePayCertInput

No description

```
input ActivateApplePayCertInput {
  id: ID!
  cert: String!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ActivateApplePayCertInput.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#activateapplepaycertinputidid-- "Direct link to activateapplepaycertinputidid--")

Apple Pay certificate ID

#### [`ActivateApplePayCertInput.cert`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#activateapplepaycertinputcertstring-- "Direct link to activateapplepaycertinputcertstring--")

Base64 encoded PEM certificate downloaded from Apple Developer Portal

### Member Of[​](#member-of "Direct link to Member Of")

[`activateApplePayCert`](https://docs.monei.com/apis/graphql/operations/mutations/activate-apple-pay-cert/.md) mutation


---

# ActivateSubscriptionInput

No description

```
input ActivateSubscriptionInput {
  paymentToken: String
  addAmount: Int
  allowedPaymentMethods: [SubscriptionPaymentMethods]
  sequenceId: ID
  sessionId: ID
  completeUrl: String
  cancelUrl: String
  failUrl: String
  id: ID!
  metadata: [KeyValueInput!]
  expireAt: AWSTimestamp
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ActivateSubscriptionInput.paymentToken`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#activatesubscriptioninputpaymenttokenstring- "Direct link to activatesubscriptioninputpaymenttokenstring-")

#### [`ActivateSubscriptionInput.addAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#activatesubscriptioninputaddamountint- "Direct link to activatesubscriptioninputaddamountint-")

#### [`ActivateSubscriptionInput.allowedPaymentMethods`](#) ● [`[SubscriptionPaymentMethods]`](https://docs.monei.com/apis/graphql/types/enums/subscription-payment-methods/.md) list enum[​](#activatesubscriptioninputallowedpaymentmethodssubscriptionpaymentmethods-- "Direct link to activatesubscriptioninputallowedpaymentmethodssubscriptionpaymentmethods--")

#### [`ActivateSubscriptionInput.sequenceId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#activatesubscriptioninputsequenceidid- "Direct link to activatesubscriptioninputsequenceidid-")

#### [`ActivateSubscriptionInput.sessionId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#activatesubscriptioninputsessionidid- "Direct link to activatesubscriptioninputsessionidid-")

#### [`ActivateSubscriptionInput.completeUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#activatesubscriptioninputcompleteurlstring- "Direct link to activatesubscriptioninputcompleteurlstring-")

#### [`ActivateSubscriptionInput.cancelUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#activatesubscriptioninputcancelurlstring- "Direct link to activatesubscriptioninputcancelurlstring-")

#### [`ActivateSubscriptionInput.failUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#activatesubscriptioninputfailurlstring- "Direct link to activatesubscriptioninputfailurlstring-")

#### [`ActivateSubscriptionInput.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#activatesubscriptioninputidid-- "Direct link to activatesubscriptioninputidid--")

#### [`ActivateSubscriptionInput.metadata`](#) ● [`[KeyValueInput!]`](https://docs.monei.com/apis/graphql/types/inputs/key-value-input/.md) list input[​](#activatesubscriptioninputmetadatakeyvalueinput-- "Direct link to activatesubscriptioninputmetadatakeyvalueinput--")

#### [`ActivateSubscriptionInput.expireAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#activatesubscriptioninputexpireatawstimestamp- "Direct link to activatesubscriptioninputexpireatawstimestamp-")

### Member Of[​](#member-of "Direct link to Member Of")

[`activateSubscription`](https://docs.monei.com/apis/graphql/operations/mutations/activate-subscription/.md) mutation


---

# AddressInput

No description

```
input AddressInput {
  city: String
  country: String
  line1: String
  line2: String
  zip: String
  state: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AddressInput.city`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#addressinputcitystring- "Direct link to addressinputcitystring-")

#### [`AddressInput.country`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#addressinputcountrystring- "Direct link to addressinputcountrystring-")

#### [`AddressInput.line1`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#addressinputline1string- "Direct link to addressinputline1string-")

#### [`AddressInput.line2`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#addressinputline2string- "Direct link to addressinputline2string-")

#### [`AddressInput.zip`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#addressinputzipstring- "Direct link to addressinputzipstring-")

#### [`AddressInput.state`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#addressinputstatestring- "Direct link to addressinputstatestring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountPublicBusinessDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/account-public-business-details-input/.md) input ● [`BusinessDataInput`](https://docs.monei.com/apis/graphql/types/inputs/business-data-input/.md) input ● [`ContactDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/contact-details-input/.md) input ● [`CreateStoreInput`](https://docs.monei.com/apis/graphql/types/inputs/create-store-input/.md) input ● [`PaymentMethodSepaInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-sepa-input/.md) input ● [`RepresentativeInput`](https://docs.monei.com/apis/graphql/types/inputs/representative-input/.md) input ● [`UpdateStoreInput`](https://docs.monei.com/apis/graphql/types/inputs/update-store-input/.md) input


---

# BlacklistItemInput

No description

```
input BlacklistItemInput {
  type: BlacklistItemType!
  value: String!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`BlacklistItemInput.type`](#) ● [`BlacklistItemType!`](https://docs.monei.com/apis/graphql/types/enums/blacklist-item-type/.md) non-null enum[​](#blacklistiteminputtypeblacklistitemtype-- "Direct link to blacklistiteminputtypeblacklistitemtype--")

The type of the blacklist item

#### [`BlacklistItemInput.value`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#blacklistiteminputvaluestring-- "Direct link to blacklistiteminputvaluestring--")

The value of the blacklist item, e.g. email, phone, ip, card, bin, fingerprint

### Member Of[​](#member-of "Direct link to Member Of")

[`addBlacklistItem`](https://docs.monei.com/apis/graphql/operations/mutations/add-blacklist-item/.md) mutation


---

# BusinessDataInput

Business data input

```
input BusinessDataInput {
  country: String
  legalForm: LegalForm!
  legalName: String
  companyName: String
  address: AddressInput
  documentNumber: String
  creationDate: String
  email: String
  phone: String
  website: String
  monthlyVolume: Int
  confirmWebsite: Boolean
  industry: Industries
  mcc: String
  servicesDescription: String
  confirmServicesDescription: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`BusinessDataInput.country`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#businessdatainputcountrystring- "Direct link to businessdatainputcountrystring-")

Country code, ISO 3166-1 alpha-2 code

#### [`BusinessDataInput.legalForm`](#) ● [`LegalForm!`](https://docs.monei.com/apis/graphql/types/enums/legal-form/.md) non-null enum[​](#businessdatainputlegalformlegalform-- "Direct link to businessdatainputlegalformlegalform--")

Legal form

#### [`BusinessDataInput.legalName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#businessdatainputlegalnamestring- "Direct link to businessdatainputlegalnamestring-")

Legal name

#### [`BusinessDataInput.companyName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#businessdatainputcompanynamestring- "Direct link to businessdatainputcompanynamestring-")

Company name

#### [`BusinessDataInput.address`](#) ● [`AddressInput`](https://docs.monei.com/apis/graphql/types/inputs/address-input/.md) input[​](#businessdatainputaddressaddressinput- "Direct link to businessdatainputaddressaddressinput-")

Full address

#### [`BusinessDataInput.documentNumber`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#businessdatainputdocumentnumberstring- "Direct link to businessdatainputdocumentnumberstring-")

Company's tax ID (CIF/NIF)

#### [`BusinessDataInput.creationDate`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#businessdatainputcreationdatestring- "Direct link to businessdatainputcreationdatestring-")

The constitution date (beginning of activities)

#### [`BusinessDataInput.email`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#businessdatainputemailstring- "Direct link to businessdatainputemailstring-")

Email address

#### [`BusinessDataInput.phone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#businessdatainputphonestring- "Direct link to businessdatainputphonestring-")

Phone number, E.164 format, e.g. +34666777888

#### [`BusinessDataInput.website`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#businessdatainputwebsitestring- "Direct link to businessdatainputwebsitestring-")

Website

#### [`BusinessDataInput.monthlyVolume`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#businessdatainputmonthlyvolumeint- "Direct link to businessdatainputmonthlyvolumeint-")

Expected monthly volume in EUR

#### [`BusinessDataInput.confirmWebsite`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#businessdatainputconfirmwebsiteboolean- "Direct link to businessdatainputconfirmwebsiteboolean-")

Confirms that website complies with requirements

#### [`BusinessDataInput.industry`](#) ● [`Industries`](https://docs.monei.com/apis/graphql/types/enums/industries/.md) enum[​](#businessdatainputindustryindustries- "Direct link to businessdatainputindustryindustries-")

Company Industry

#### [`BusinessDataInput.mcc`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#businessdatainputmccstring- "Direct link to businessdatainputmccstring-")

Merchant Category Code (MCC) in ISO 18245:2003 format

#### [`BusinessDataInput.servicesDescription`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#businessdatainputservicesdescriptionstring- "Direct link to businessdatainputservicesdescriptionstring-")

A description of the products or services it provides

#### [`BusinessDataInput.confirmServicesDescription`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#businessdatainputconfirmservicesdescriptionboolean- "Direct link to businessdatainputconfirmservicesdescriptionboolean-")

Confirms that service complies with requirements

### Member Of[​](#member-of "Direct link to Member Of")

[`SetupAccountInput`](https://docs.monei.com/apis/graphql/types/inputs/setup-account-input/.md) input


---

# CancelPaymentInput

No description

```
input CancelPaymentInput {
  paymentId: ID!
  cancellationReason: CancellationReason
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CancelPaymentInput.paymentId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#cancelpaymentinputpaymentidid-- "Direct link to cancelpaymentinputpaymentidid--")

The ID of the payment to be canceled

#### [`CancelPaymentInput.cancellationReason`](#) ● [`CancellationReason`](https://docs.monei.com/apis/graphql/types/enums/cancellation-reason/.md) enum[​](#cancelpaymentinputcancellationreasoncancellationreason- "Direct link to cancelpaymentinputcancellationreasoncancellationreason-")

The reason why the payment is being canceled

### Member Of[​](#member-of "Direct link to Member Of")

[`cancelPayment`](https://docs.monei.com/apis/graphql/operations/mutations/cancel-payment/.md) mutation


---

# CancelSubscriptionInput

No description

```
input CancelSubscriptionInput {
  cancelAtPeriodEnd: Boolean
  id: ID!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CancelSubscriptionInput.cancelAtPeriodEnd`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#cancelsubscriptioninputcancelatperiodendboolean- "Direct link to cancelsubscriptioninputcancelatperiodendboolean-")

#### [`CancelSubscriptionInput.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#cancelsubscriptioninputidid-- "Direct link to cancelsubscriptioninputidid--")

### Member Of[​](#member-of "Direct link to Member Of")

[`cancelSubscription`](https://docs.monei.com/apis/graphql/operations/mutations/cancel-subscription/.md) mutation


---

# CapturePaymentInput

No description

```
input CapturePaymentInput {
  paymentId: ID!
  amount: Int
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CapturePaymentInput.paymentId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#capturepaymentinputpaymentidid-- "Direct link to capturepaymentinputpaymentidid--")

The ID of the payment to be captured

#### [`CapturePaymentInput.amount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#capturepaymentinputamountint- "Direct link to capturepaymentinputamountint-")

The amount to be captured (for example 1075 for 10.75€)

### Member Of[​](#member-of "Direct link to Member Of")

[`capturePayment`](https://docs.monei.com/apis/graphql/operations/mutations/capture-payment/.md) mutation


---

# ChargeEventsChangeInput

No description

```
input ChargeEventsChangeInput {
  id: ID!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ChargeEventsChangeInput.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#chargeeventschangeinputidid-- "Direct link to chargeeventschangeinputidid--")

### Member Of[​](#member-of "Direct link to Member Of")

[`publishUpdateChargeEvents`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-charge-events/.md) mutation


---

# ConnectShopifyShopInput

No description

```
input ConnectShopifyShopInput {
  shop: String!
  paymentMethod: String!
  token: String!
  accountId: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ConnectShopifyShopInput.shop`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#connectshopifyshopinputshopstring-- "Direct link to connectshopifyshopinputshopstring--")

#### [`ConnectShopifyShopInput.paymentMethod`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#connectshopifyshopinputpaymentmethodstring-- "Direct link to connectshopifyshopinputpaymentmethodstring--")

#### [`ConnectShopifyShopInput.token`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#connectshopifyshopinputtokenstring-- "Direct link to connectshopifyshopinputtokenstring--")

#### [`ConnectShopifyShopInput.accountId`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#connectshopifyshopinputaccountidstring- "Direct link to connectshopifyshopinputaccountidstring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`connectShopifyShop`](https://docs.monei.com/apis/graphql/operations/mutations/connect-shopify-shop/.md) mutation


---

# ContactDetailsInput

No description

```
input ContactDetailsInput {
  email: String
  name: String
  company: String
  phone: String
  address: AddressInput
  taxId: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ContactDetailsInput.email`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#contactdetailsinputemailstring- "Direct link to contactdetailsinputemailstring-")

#### [`ContactDetailsInput.name`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#contactdetailsinputnamestring- "Direct link to contactdetailsinputnamestring-")

#### [`ContactDetailsInput.company`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#contactdetailsinputcompanystring- "Direct link to contactdetailsinputcompanystring-")

#### [`ContactDetailsInput.phone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#contactdetailsinputphonestring- "Direct link to contactdetailsinputphonestring-")

#### [`ContactDetailsInput.address`](#) ● [`AddressInput`](https://docs.monei.com/apis/graphql/types/inputs/address-input/.md) input[​](#contactdetailsinputaddressaddressinput- "Direct link to contactdetailsinputaddressaddressinput-")

#### [`ContactDetailsInput.taxId`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#contactdetailsinputtaxidstring- "Direct link to contactdetailsinputtaxidstring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`CreatePaymentInput`](https://docs.monei.com/apis/graphql/types/inputs/create-payment-input/.md) input ● [`CreateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/create-subscription-input/.md) input ● [`UpdateChargeInput`](https://docs.monei.com/apis/graphql/types/inputs/update-charge-input/.md) input ● [`UpdateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/update-subscription-input/.md) input


---

# CountryStoreInput

No description

```
input CountryStoreInput {
  countryCode: String!
  storeId: String!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CountryStoreInput.countryCode`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#countrystoreinputcountrycodestring-- "Direct link to countrystoreinputcountrycodestring--")

#### [`CountryStoreInput.storeId`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#countrystoreinputstoreidstring-- "Direct link to countrystoreinputstoreidstring--")

### Member Of[​](#member-of "Direct link to Member Of")

[`UpdateShopifyShopSettingsInput`](https://docs.monei.com/apis/graphql/types/inputs/update-shopify-shop-settings-input/.md) input


---

# CreateAuthorizedUserInput

No description

```
input CreateAuthorizedUserInput {
  userEmail: String!
  accessLevel: AuthorizedUserAccessLevel
  storeId: ID
  pointOfSaleId: ID
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CreateAuthorizedUserInput.userEmail`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#createauthorizeduserinputuseremailstring-- "Direct link to createauthorizeduserinputuseremailstring--")

Email address of the authorized user to be created

#### [`CreateAuthorizedUserInput.accessLevel`](#) ● [`AuthorizedUserAccessLevel`](https://docs.monei.com/apis/graphql/types/enums/authorized-user-access-level/.md) enum[​](#createauthorizeduserinputaccesslevelauthorizeduseraccesslevel- "Direct link to createauthorizeduserinputaccesslevelauthorizeduseraccesslevel-")

Access level for the authorized user granted by the authorizer

#### [`CreateAuthorizedUserInput.storeId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#createauthorizeduserinputstoreidid- "Direct link to createauthorizeduserinputstoreidid-")

Limit access to a specific store

#### [`CreateAuthorizedUserInput.pointOfSaleId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#createauthorizeduserinputpointofsaleidid- "Direct link to createauthorizeduserinputpointofsaleidid-")

Limit access to a specific point of sale

### Member Of[​](#member-of "Direct link to Member Of")

[`createAuthorizedUser`](https://docs.monei.com/apis/graphql/operations/mutations/create-authorized-user/.md) mutation


---

# CreateDocumentInput

No description

```
input CreateDocumentInput {
  type: DocumentType!
  name: String
  note: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CreateDocumentInput.type`](#) ● [`DocumentType!`](https://docs.monei.com/apis/graphql/types/enums/document-type/.md) non-null enum[​](#createdocumentinputtypedocumenttype-- "Direct link to createdocumentinputtypedocumenttype--")

#### [`CreateDocumentInput.name`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createdocumentinputnamestring- "Direct link to createdocumentinputnamestring-")

#### [`CreateDocumentInput.note`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createdocumentinputnotestring- "Direct link to createdocumentinputnotestring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`createDocument`](https://docs.monei.com/apis/graphql/operations/mutations/create-document/.md) mutation


---

# CreateExportSftpConfigInput

No description

```
input CreateExportSftpConfigInput {
  host: String!
  port: Int!
  username: String!
  password: String!
  path: String!
  columns: [String!]
  timezone: String
  enabled: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CreateExportSftpConfigInput.host`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#createexportsftpconfiginputhoststring-- "Direct link to createexportsftpconfiginputhoststring--")

#### [`CreateExportSftpConfigInput.port`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#createexportsftpconfiginputportint-- "Direct link to createexportsftpconfiginputportint--")

#### [`CreateExportSftpConfigInput.username`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#createexportsftpconfiginputusernamestring-- "Direct link to createexportsftpconfiginputusernamestring--")

#### [`CreateExportSftpConfigInput.password`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#createexportsftpconfiginputpasswordstring-- "Direct link to createexportsftpconfiginputpasswordstring--")

#### [`CreateExportSftpConfigInput.path`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#createexportsftpconfiginputpathstring-- "Direct link to createexportsftpconfiginputpathstring--")

#### [`CreateExportSftpConfigInput.columns`](#) ● [`[String!]`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) list scalar[​](#createexportsftpconfiginputcolumnsstring-- "Direct link to createexportsftpconfiginputcolumnsstring--")

#### [`CreateExportSftpConfigInput.timezone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createexportsftpconfiginputtimezonestring- "Direct link to createexportsftpconfiginputtimezonestring-")

#### [`CreateExportSftpConfigInput.enabled`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#createexportsftpconfiginputenabledboolean- "Direct link to createexportsftpconfiginputenabledboolean-")

### Member Of[​](#member-of "Direct link to Member Of")

[`createExportSftpConfig`](https://docs.monei.com/apis/graphql/operations/mutations/create-export-sftp-config/.md) mutation


---

# CreatePaymentInput

No description

```
input CreatePaymentInput {
  id: ID
  amount: Int!
  orderId: ID
  storeId: ID
  pointOfSaleId: ID
  description: String
  descriptor: String
  customer: CustomerInput
  billingDetails: ContactDetailsInput
  shippingDetails: ContactDetailsInput
  currency: Currencies
  allowedPaymentMethods: [PaymentMethods]
  transactionType: TransactionTypes
  completeUrl: String
  callbackUrl: String
  cancelUrl: String
  failUrl: String
  expireAt: AWSTimestamp
  metadata: [KeyValueInput!]
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CreatePaymentInput.id`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#createpaymentinputidid- "Direct link to createpaymentinputidid-")

The ID of the payment to be created

#### [`CreatePaymentInput.amount`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#createpaymentinputamountint-- "Direct link to createpaymentinputamountint--")

The amount to be charged (for example 1075 for 10.75€)

#### [`CreatePaymentInput.orderId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#createpaymentinputorderidid- "Direct link to createpaymentinputorderidid-")

The order ID in your platform (eg: the invoice number). If not present, MONEI will generate a unique one

#### [`CreatePaymentInput.storeId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#createpaymentinputstoreidid- "Direct link to createpaymentinputstoreidid-")

The ID of the store

#### [`CreatePaymentInput.pointOfSaleId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#createpaymentinputpointofsaleidid- "Direct link to createpaymentinputpointofsaleidid-")

The ID of the Point of Sale this payment will be associated to

#### [`CreatePaymentInput.description`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createpaymentinputdescriptionstring- "Direct link to createpaymentinputdescriptionstring-")

The payment description

#### [`CreatePaymentInput.descriptor`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createpaymentinputdescriptorstring- "Direct link to createpaymentinputdescriptorstring-")

The payment descriptor

#### [`CreatePaymentInput.customer`](#) ● [`CustomerInput`](https://docs.monei.com/apis/graphql/types/inputs/customer-input/.md) input[​](#createpaymentinputcustomercustomerinput- "Direct link to createpaymentinputcustomercustomerinput-")

Basic information about the customer

#### [`CreatePaymentInput.billingDetails`](#) ● [`ContactDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/contact-details-input/.md) input[​](#createpaymentinputbillingdetailscontactdetailsinput- "Direct link to createpaymentinputbillingdetailscontactdetailsinput-")

Billing information

#### [`CreatePaymentInput.shippingDetails`](#) ● [`ContactDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/contact-details-input/.md) input[​](#createpaymentinputshippingdetailscontactdetailsinput- "Direct link to createpaymentinputshippingdetailscontactdetailsinput-")

Shipping details

#### [`CreatePaymentInput.currency`](#) ● [`Currencies`](https://docs.monei.com/apis/graphql/types/enums/currencies/.md) enum[​](#createpaymentinputcurrencycurrencies- "Direct link to createpaymentinputcurrencycurrencies-")

The currency of the payment

#### [`CreatePaymentInput.allowedPaymentMethods`](#) ● [`[PaymentMethods]`](https://docs.monei.com/apis/graphql/types/enums/payment-methods/.md) list enum[​](#createpaymentinputallowedpaymentmethodspaymentmethods-- "Direct link to createpaymentinputallowedpaymentmethodspaymentmethods--")

Which payment methods are allowed

#### [`CreatePaymentInput.transactionType`](#) ● [`TransactionTypes`](https://docs.monei.com/apis/graphql/types/enums/transaction-types/.md) enum[​](#createpaymentinputtransactiontypetransactiontypes- "Direct link to createpaymentinputtransactiontypetransactiontypes-")

Transaction type

#### [`CreatePaymentInput.completeUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createpaymentinputcompleteurlstring- "Direct link to createpaymentinputcompleteurlstring-")

The URL where to send the user when the payment has finished

#### [`CreatePaymentInput.callbackUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createpaymentinputcallbackurlstring- "Direct link to createpaymentinputcallbackurlstring-")

The URL where to notify a success payment (server-to-server HTTP POST request)

#### [`CreatePaymentInput.cancelUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createpaymentinputcancelurlstring- "Direct link to createpaymentinputcancelurlstring-")

The URL where to send the user when he/she requests to cancel the payment

#### [`CreatePaymentInput.failUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createpaymentinputfailurlstring- "Direct link to createpaymentinputfailurlstring-")

The URL where to send the user when the payment has failed

#### [`CreatePaymentInput.expireAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#createpaymentinputexpireatawstimestamp- "Direct link to createpaymentinputexpireatawstimestamp-")

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

#### [`CreatePaymentInput.metadata`](#) ● [`[KeyValueInput!]`](https://docs.monei.com/apis/graphql/types/inputs/key-value-input/.md) list input[​](#createpaymentinputmetadatakeyvalueinput-- "Direct link to createpaymentinputmetadatakeyvalueinput--")

The payment metadata

### Member Of[​](#member-of "Direct link to Member Of")

[`createPayment`](https://docs.monei.com/apis/graphql/operations/mutations/create-payment/.md) mutation


---

# CreatePaymentRuleInput

Input for creating a payment rule

```
input CreatePaymentRuleInput {
  ruleType: PaymentRuleType!
  conditions: PaymentConditionsInput!
  action: PaymentActionInput!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CreatePaymentRuleInput.ruleType`](#) ● [`PaymentRuleType!`](https://docs.monei.com/apis/graphql/types/enums/payment-rule-type/.md) non-null enum[​](#createpaymentruleinputruletypepaymentruletype-- "Direct link to createpaymentruleinputruletypepaymentruletype--")

Type of payment rule

#### [`CreatePaymentRuleInput.conditions`](#) ● [`PaymentConditionsInput!`](https://docs.monei.com/apis/graphql/types/inputs/payment-conditions-input/.md) non-null input[​](#createpaymentruleinputconditionspaymentconditionsinput-- "Direct link to createpaymentruleinputconditionspaymentconditionsinput--")

The conditions that must be met for this rule to apply

#### [`CreatePaymentRuleInput.action`](#) ● [`PaymentActionInput!`](https://docs.monei.com/apis/graphql/types/inputs/payment-action-input/.md) non-null input[​](#createpaymentruleinputactionpaymentactioninput-- "Direct link to createpaymentruleinputactionpaymentactioninput--")

The action to take when conditions are met

### Member Of[​](#member-of "Direct link to Member Of")

[`createPaymentRule`](https://docs.monei.com/apis/graphql/operations/mutations/create-payment-rule/.md) mutation


---

# CreatePointOfSaleInput

No description

```
input CreatePointOfSaleInput {
  storeId: ID
  name: String
  description: String
  manualAmount: Boolean
  requireEmail: Boolean
  requireTaxId: Boolean
  fixedAmount: Int
  fixedCurrency: Currencies
  enabled: Boolean
  includeQRCode: Boolean
  qrCodeText: String
  paymentCallbackUrl: String
  type: PointOfSaleType!
  transactionType: TransactionTypes
  paymentMethods: [PaymentMethods!]
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CreatePointOfSaleInput.storeId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#createpointofsaleinputstoreidid- "Direct link to createpointofsaleinputstoreidid-")

Store's ID where this point of sale belongs

#### [`CreatePointOfSaleInput.name`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createpointofsaleinputnamestring- "Direct link to createpointofsaleinputnamestring-")

A name that represents the point of sale

#### [`CreatePointOfSaleInput.description`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createpointofsaleinputdescriptionstring- "Direct link to createpointofsaleinputdescriptionstring-")

The description of the point of sale

#### [`CreatePointOfSaleInput.manualAmount`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#createpointofsaleinputmanualamountboolean- "Direct link to createpointofsaleinputmanualamountboolean-")

Whether the user can manually enter the amount or not

#### [`CreatePointOfSaleInput.requireEmail`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#createpointofsaleinputrequireemailboolean- "Direct link to createpointofsaleinputrequireemailboolean-")

Whether the user must provide an email address or not

#### [`CreatePointOfSaleInput.requireTaxId`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#createpointofsaleinputrequiretaxidboolean- "Direct link to createpointofsaleinputrequiretaxidboolean-")

Whether the user must provide a tax ID or not

#### [`CreatePointOfSaleInput.fixedAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#createpointofsaleinputfixedamountint- "Direct link to createpointofsaleinputfixedamountint-")

Fixed amount to be charged

#### [`CreatePointOfSaleInput.fixedCurrency`](#) ● [`Currencies`](https://docs.monei.com/apis/graphql/types/enums/currencies/.md) enum[​](#createpointofsaleinputfixedcurrencycurrencies- "Direct link to createpointofsaleinputfixedcurrencycurrencies-")

Fixed currency to be charged

#### [`CreatePointOfSaleInput.enabled`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#createpointofsaleinputenabledboolean- "Direct link to createpointofsaleinputenabledboolean-")

Whether the point of sale is enabled or not

#### [`CreatePointOfSaleInput.includeQRCode`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#createpointofsaleinputincludeqrcodeboolean- "Direct link to createpointofsaleinputincludeqrcodeboolean-")

Whether the user must provide a fixed amount or not

#### [`CreatePointOfSaleInput.qrCodeText`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createpointofsaleinputqrcodetextstring- "Direct link to createpointofsaleinputqrcodetextstring-")

QR code text

#### [`CreatePointOfSaleInput.paymentCallbackUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createpointofsaleinputpaymentcallbackurlstring- "Direct link to createpointofsaleinputpaymentcallbackurlstring-")

The URL where to notify a success payment (server-to-server HTTP POST request)

#### [`CreatePointOfSaleInput.type`](#) ● [`PointOfSaleType!`](https://docs.monei.com/apis/graphql/types/enums/point-of-sale-type/.md) non-null enum[​](#createpointofsaleinputtypepointofsaletype-- "Direct link to createpointofsaleinputtypepointofsaletype--")

The type of the point of sale

#### [`CreatePointOfSaleInput.transactionType`](#) ● [`TransactionTypes`](https://docs.monei.com/apis/graphql/types/enums/transaction-types/.md) enum[​](#createpointofsaleinputtransactiontypetransactiontypes- "Direct link to createpointofsaleinputtransactiontypetransactiontypes-")

The type of the transaction

#### [`CreatePointOfSaleInput.paymentMethods`](#) ● [`[PaymentMethods!]`](https://docs.monei.com/apis/graphql/types/enums/payment-methods/.md) list enum[​](#createpointofsaleinputpaymentmethodspaymentmethods-- "Direct link to createpointofsaleinputpaymentmethodspaymentmethods--")

The payment methods allowed for the point of sale

### Member Of[​](#member-of "Direct link to Member Of")

[`createPointOfSale`](https://docs.monei.com/apis/graphql/operations/mutations/create-point-of-sale/.md) mutation


---

# CreateProviderInput

No description

```
input CreateProviderInput {
  processor: Processor!
  enabled: Boolean
  acquirer: Acquirer!
  paymentMethod: PaymentMethods!
  metadata: [MetadataItemInput!]
  rules: ProviderRulesInput
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CreateProviderInput.processor`](#) ● [`Processor!`](https://docs.monei.com/apis/graphql/types/enums/processor/.md) non-null enum[​](#createproviderinputprocessorprocessor-- "Direct link to createproviderinputprocessorprocessor--")

The integrated processor

#### [`CreateProviderInput.enabled`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#createproviderinputenabledboolean- "Direct link to createproviderinputenabledboolean-")

Whether the provider is enabled since creation or not

#### [`CreateProviderInput.acquirer`](#) ● [`Acquirer!`](https://docs.monei.com/apis/graphql/types/enums/acquirer/.md) non-null enum[​](#createproviderinputacquireracquirer-- "Direct link to createproviderinputacquireracquirer--")

The acquirer

#### [`CreateProviderInput.paymentMethod`](#) ● [`PaymentMethods!`](https://docs.monei.com/apis/graphql/types/enums/payment-methods/.md) non-null enum[​](#createproviderinputpaymentmethodpaymentmethods-- "Direct link to createproviderinputpaymentmethodpaymentmethods--")

The payment method for the provider

#### [`CreateProviderInput.metadata`](#) ● [`[MetadataItemInput!]`](https://docs.monei.com/apis/graphql/types/inputs/metadata-item-input/.md) list input[​](#createproviderinputmetadatametadataiteminput-- "Direct link to createproviderinputmetadatametadataiteminput--")

Metadata

#### [`CreateProviderInput.rules`](#) ● [`ProviderRulesInput`](https://docs.monei.com/apis/graphql/types/inputs/provider-rules-input/.md) input[​](#createproviderinputrulesproviderrulesinput- "Direct link to createproviderinputrulesproviderrulesinput-")

Rules for the provider

### Member Of[​](#member-of "Direct link to Member Of")

[`createProvider`](https://docs.monei.com/apis/graphql/operations/mutations/create-provider/.md) mutation


---

# CreateStoreInput

No description

```
input CreateStoreInput {
  name: String
  address: AddressInput
  phone: String
  email: String
  website: String
  metadata: [KeyValueInput!]
  blocked: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CreateStoreInput.name`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createstoreinputnamestring- "Direct link to createstoreinputnamestring-")

A name that represents the store

#### [`CreateStoreInput.address`](#) ● [`AddressInput`](https://docs.monei.com/apis/graphql/types/inputs/address-input/.md) input[​](#createstoreinputaddressaddressinput- "Direct link to createstoreinputaddressaddressinput-")

The store's address

#### [`CreateStoreInput.phone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createstoreinputphonestring- "Direct link to createstoreinputphonestring-")

The store's phone number

#### [`CreateStoreInput.email`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createstoreinputemailstring- "Direct link to createstoreinputemailstring-")

The store's email address

#### [`CreateStoreInput.website`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createstoreinputwebsitestring- "Direct link to createstoreinputwebsitestring-")

The store's website

#### [`CreateStoreInput.metadata`](#) ● [`[KeyValueInput!]`](https://docs.monei.com/apis/graphql/types/inputs/key-value-input/.md) list input[​](#createstoreinputmetadatakeyvalueinput-- "Direct link to createstoreinputmetadatakeyvalueinput--")

Metadata

#### [`CreateStoreInput.blocked`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#createstoreinputblockedboolean- "Direct link to createstoreinputblockedboolean-")

Whether the store is blocked or not

### Member Of[​](#member-of "Direct link to Member Of")

[`createStore`](https://docs.monei.com/apis/graphql/operations/mutations/create-store/.md) mutation


---

# CreateSubscriptionInput

No description

```
input CreateSubscriptionInput {
  amount: Int!
  trialAmount: Int
  currency: Currencies
  allowedPaymentMethods: [SubscriptionPaymentMethods]
  description: String
  descriptor: String
  customer: CustomerInput
  billingDetails: ContactDetailsInput
  shippingDetails: ContactDetailsInput
  interval: IntervalInput
  intervalCount: Int
  trialPeriodDays: Int
  trialPeriodEnd: AWSTimestamp
  callbackUrl: String
  paymentCallbackUrl: String
  storeId: ID
  retrySchedule: [RetryScheduleInput!]
  metadata: [KeyValueInput!]
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CreateSubscriptionInput.amount`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#createsubscriptioninputamountint-- "Direct link to createsubscriptioninputamountint--")

The amount to be charged

#### [`CreateSubscriptionInput.trialAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#createsubscriptioninputtrialamountint- "Direct link to createsubscriptioninputtrialamountint-")

The amount to be charged during the trial period

#### [`CreateSubscriptionInput.currency`](#) ● [`Currencies`](https://docs.monei.com/apis/graphql/types/enums/currencies/.md) enum[​](#createsubscriptioninputcurrencycurrencies- "Direct link to createsubscriptioninputcurrencycurrencies-")

The currency of the payment

#### [`CreateSubscriptionInput.allowedPaymentMethods`](#) ● [`[SubscriptionPaymentMethods]`](https://docs.monei.com/apis/graphql/types/enums/subscription-payment-methods/.md) list enum[​](#createsubscriptioninputallowedpaymentmethodssubscriptionpaymentmethods-- "Direct link to createsubscriptioninputallowedpaymentmethodssubscriptionpaymentmethods--")

Which payment methods are allowed

#### [`CreateSubscriptionInput.description`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createsubscriptioninputdescriptionstring- "Direct link to createsubscriptioninputdescriptionstring-")

The payment description

#### [`CreateSubscriptionInput.descriptor`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createsubscriptioninputdescriptorstring- "Direct link to createsubscriptioninputdescriptorstring-")

The payment descriptor

#### [`CreateSubscriptionInput.customer`](#) ● [`CustomerInput`](https://docs.monei.com/apis/graphql/types/inputs/customer-input/.md) input[​](#createsubscriptioninputcustomercustomerinput- "Direct link to createsubscriptioninputcustomercustomerinput-")

Basic information about the customer

#### [`CreateSubscriptionInput.billingDetails`](#) ● [`ContactDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/contact-details-input/.md) input[​](#createsubscriptioninputbillingdetailscontactdetailsinput- "Direct link to createsubscriptioninputbillingdetailscontactdetailsinput-")

Billing information

#### [`CreateSubscriptionInput.shippingDetails`](#) ● [`ContactDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/contact-details-input/.md) input[​](#createsubscriptioninputshippingdetailscontactdetailsinput- "Direct link to createsubscriptioninputshippingdetailscontactdetailsinput-")

Shipping details

#### [`CreateSubscriptionInput.interval`](#) ● [`IntervalInput`](https://docs.monei.com/apis/graphql/types/enums/interval-input/.md) enum[​](#createsubscriptioninputintervalintervalinput- "Direct link to createsubscriptioninputintervalintervalinput-")

Subscription interval

#### [`CreateSubscriptionInput.intervalCount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#createsubscriptioninputintervalcountint- "Direct link to createsubscriptioninputintervalcountint-")

Number of intervals between subscription payments

#### [`CreateSubscriptionInput.trialPeriodDays`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#createsubscriptioninputtrialperioddaysint- "Direct link to createsubscriptioninputtrialperioddaysint-")

Number of days the trial period lasts

#### [`CreateSubscriptionInput.trialPeriodEnd`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#createsubscriptioninputtrialperiodendawstimestamp- "Direct link to createsubscriptioninputtrialperiodendawstimestamp-")

The end date of the trial period. Measured in seconds since the Unix epoch

#### [`CreateSubscriptionInput.callbackUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createsubscriptioninputcallbackurlstring- "Direct link to createsubscriptioninputcallbackurlstring-")

The URL where to notify a success payment

#### [`CreateSubscriptionInput.paymentCallbackUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#createsubscriptioninputpaymentcallbackurlstring- "Direct link to createsubscriptioninputpaymentcallbackurlstring-")

The URL will be called each time subscription creates a new payments

#### [`CreateSubscriptionInput.storeId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#createsubscriptioninputstoreidid- "Direct link to createsubscriptioninputstoreidid-")

Related Store

#### [`CreateSubscriptionInput.retrySchedule`](#) ● [`[RetryScheduleInput!]`](https://docs.monei.com/apis/graphql/types/inputs/retry-schedule-input/.md) list input[​](#createsubscriptioninputretryscheduleretryscheduleinput-- "Direct link to createsubscriptioninputretryscheduleretryscheduleinput--")

Custom retry schedule

#### [`CreateSubscriptionInput.metadata`](#) ● [`[KeyValueInput!]`](https://docs.monei.com/apis/graphql/types/inputs/key-value-input/.md) list input[​](#createsubscriptioninputmetadatakeyvalueinput-- "Direct link to createsubscriptioninputmetadatakeyvalueinput--")

Custom metadata

### Member Of[​](#member-of "Direct link to Member Of")

[`createSubscription`](https://docs.monei.com/apis/graphql/operations/mutations/create-subscription/.md) mutation


---

# CreateWebhookInput

No description

```
input CreateWebhookInput {
  url: String!
  eventTypes: [WebhookEventType!]!
  enabled: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CreateWebhookInput.url`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#createwebhookinputurlstring-- "Direct link to createwebhookinputurlstring--")

#### [`CreateWebhookInput.eventTypes`](#) ● [`[WebhookEventType!]!`](https://docs.monei.com/apis/graphql/types/enums/webhook-event-type/.md) non-null enum[​](#createwebhookinputeventtypeswebhookeventtype-- "Direct link to createwebhookinputeventtypeswebhookeventtype--")

#### [`CreateWebhookInput.enabled`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#createwebhookinputenabledboolean- "Direct link to createwebhookinputenabledboolean-")

### Member Of[​](#member-of "Direct link to Member Of")

[`createWebhook`](https://docs.monei.com/apis/graphql/operations/mutations/create-webhook/.md) mutation


---

# CustomerInput

No description

```
input CustomerInput {
  email: String
  name: String
  phone: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CustomerInput.email`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#customerinputemailstring- "Direct link to customerinputemailstring-")

#### [`CustomerInput.name`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#customerinputnamestring- "Direct link to customerinputnamestring-")

#### [`CustomerInput.phone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#customerinputphonestring- "Direct link to customerinputphonestring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`CreatePaymentInput`](https://docs.monei.com/apis/graphql/types/inputs/create-payment-input/.md) input ● [`CreateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/create-subscription-input/.md) input ● [`UpdateChargeInput`](https://docs.monei.com/apis/graphql/types/inputs/update-charge-input/.md) input ● [`UpdateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/update-subscription-input/.md) input


---

# GetShopifyShopSettingsInput

No description

```
input GetShopifyShopSettingsInput {
  shop: String!
  paymentMethod: String!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`GetShopifyShopSettingsInput.shop`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#getshopifyshopsettingsinputshopstring-- "Direct link to getshopifyshopsettingsinputshopstring--")

#### [`GetShopifyShopSettingsInput.paymentMethod`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#getshopifyshopsettingsinputpaymentmethodstring-- "Direct link to getshopifyshopsettingsinputpaymentmethodstring--")

### Member Of[​](#member-of "Direct link to Member Of")

[`getShopifyShopSettings`](https://docs.monei.com/apis/graphql/operations/queries/get-shopify-shop-settings/.md) query


---

# KeyValueInput

No description

```
input KeyValueInput {
  key: String!
  value: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`KeyValueInput.key`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#keyvalueinputkeystring-- "Direct link to keyvalueinputkeystring--")

#### [`KeyValueInput.value`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#keyvalueinputvaluestring- "Direct link to keyvalueinputvaluestring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`ActivateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/activate-subscription-input/.md) input ● [`CreatePaymentInput`](https://docs.monei.com/apis/graphql/types/inputs/create-payment-input/.md) input ● [`CreateStoreInput`](https://docs.monei.com/apis/graphql/types/inputs/create-store-input/.md) input ● [`CreateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/create-subscription-input/.md) input ● [`UpdateChargeInput`](https://docs.monei.com/apis/graphql/types/inputs/update-charge-input/.md) input ● [`UpdateStoreInput`](https://docs.monei.com/apis/graphql/types/inputs/update-store-input/.md) input ● [`UpdateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/update-subscription-input/.md) input


---

# MetadataItemInput

No description

```
input MetadataItemInput {
  key: String!
  value: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`MetadataItemInput.key`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#metadataiteminputkeystring-- "Direct link to metadataiteminputkeystring--")

#### [`MetadataItemInput.value`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#metadataiteminputvaluestring- "Direct link to metadataiteminputvaluestring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`CreateProviderInput`](https://docs.monei.com/apis/graphql/types/inputs/create-provider-input/.md) input ● [`UpdateProviderInput`](https://docs.monei.com/apis/graphql/types/inputs/update-provider-input/.md) input


---

# PauseSubscriptionInput

No description

```
input PauseSubscriptionInput {
  pauseIntervalCount: Int!
  pauseAtPeriodEnd: Boolean
  id: ID!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PauseSubscriptionInput.pauseIntervalCount`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#pausesubscriptioninputpauseintervalcountint-- "Direct link to pausesubscriptioninputpauseintervalcountint--")

#### [`PauseSubscriptionInput.pauseAtPeriodEnd`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#pausesubscriptioninputpauseatperiodendboolean- "Direct link to pausesubscriptioninputpauseatperiodendboolean-")

#### [`PauseSubscriptionInput.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#pausesubscriptioninputidid-- "Direct link to pausesubscriptioninputidid--")

### Member Of[​](#member-of "Direct link to Member Of")

[`pauseSubscription`](https://docs.monei.com/apis/graphql/operations/mutations/pause-subscription/.md) mutation


---

# PaymentActionInput

Input for payment action

```
input PaymentActionInput {
  type: String!
  providerId: ID
  percentage: Int
  paymentMethod: String
  tokenizationMethod: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentActionInput.type`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#paymentactioninputtypestring-- "Direct link to paymentactioninputtypestring--")

Action type (route\_to, force\_challenge, skip\_challenge, decline, hide, show)

#### [`PaymentActionInput.providerId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#paymentactioninputprovideridid- "Direct link to paymentactioninputprovideridid-")

Provider ID (for route\_to action)

#### [`PaymentActionInput.percentage`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#paymentactioninputpercentageint- "Direct link to paymentactioninputpercentageint-")

Percentage (for route\_to action, 1-100)

#### [`PaymentActionInput.paymentMethod`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentactioninputpaymentmethodstring- "Direct link to paymentactioninputpaymentmethodstring-")

Payment method (for hide/show actions)

#### [`PaymentActionInput.tokenizationMethod`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentactioninputtokenizationmethodstring- "Direct link to paymentactioninputtokenizationmethodstring-")

Tokenization method (for hide/show actions)

### Member Of[​](#member-of "Direct link to Member Of")

[`CreatePaymentRuleInput`](https://docs.monei.com/apis/graphql/types/inputs/create-payment-rule-input/.md) input ● [`UpdatePaymentRuleInput`](https://docs.monei.com/apis/graphql/types/inputs/update-payment-rule-input/.md) input


---

# PaymentConditionInput

Input for a single condition

```
input PaymentConditionInput {
  id: ID!
  field: String!
  operator: String!
  value: String
  valueSource: String!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentConditionInput.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#paymentconditioninputidid-- "Direct link to paymentconditioninputidid--")

Condition ID (UUID)

#### [`PaymentConditionInput.field`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#paymentconditioninputfieldstring-- "Direct link to paymentconditioninputfieldstring--")

Field to evaluate

#### [`PaymentConditionInput.operator`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#paymentconditioninputoperatorstring-- "Direct link to paymentconditioninputoperatorstring--")

Operator to use (=, !=, <, >, <=, >=, in)

#### [`PaymentConditionInput.value`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentconditioninputvaluestring- "Direct link to paymentconditioninputvaluestring-")

Value to compare against

#### [`PaymentConditionInput.valueSource`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#paymentconditioninputvaluesourcestring-- "Direct link to paymentconditioninputvaluesourcestring--")

Source of the value

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentConditionsInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-conditions-input/.md) input


---

# PaymentConditionsInput

Input for payment conditions

```
input PaymentConditionsInput {
  combinator: CombinatorType!
  rules: [PaymentConditionInput!]!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentConditionsInput.combinator`](#) ● [`CombinatorType!`](https://docs.monei.com/apis/graphql/types/enums/combinator-type/.md) non-null enum[​](#paymentconditionsinputcombinatorcombinatortype-- "Direct link to paymentconditionsinputcombinatorcombinatortype--")

Combinator for conditions (and/or)

#### [`PaymentConditionsInput.rules`](#) ● [`[PaymentConditionInput!]!`](https://docs.monei.com/apis/graphql/types/inputs/payment-condition-input/.md) non-null input[​](#paymentconditionsinputrulespaymentconditioninput-- "Direct link to paymentconditionsinputrulespaymentconditioninput--")

List of rules/conditions

### Member Of[​](#member-of "Direct link to Member Of")

[`CreatePaymentRuleInput`](https://docs.monei.com/apis/graphql/types/inputs/create-payment-rule-input/.md) input ● [`UpdatePaymentRuleInput`](https://docs.monei.com/apis/graphql/types/inputs/update-payment-rule-input/.md) input


---

# PaymentMethodBizumInput

No description

```
input PaymentMethodBizumInput {
  phoneNumber: String
  integrationType: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentMethodBizumInput.phoneNumber`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodbizuminputphonenumberstring- "Direct link to paymentmethodbizuminputphonenumberstring-")

#### [`PaymentMethodBizumInput.integrationType`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodbizuminputintegrationtypestring- "Direct link to paymentmethodbizuminputintegrationtypestring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethodInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-input/.md) input


---

# PaymentMethodCardInput

No description

```
input PaymentMethodCardInput {
  brand: CardBrand
  country: String
  type: CardType
  threeDSecure: Boolean
  threeDSecureVersion: String
  last4: String
  fingerprint: String
  cardholderName: String
  cardholderEmail: String
  bank: String
  tokenizationMethod: TokenizationMethods
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentMethodCardInput.brand`](#) ● [`CardBrand`](https://docs.monei.com/apis/graphql/types/enums/card-brand/.md) enum[​](#paymentmethodcardinputbrandcardbrand- "Direct link to paymentmethodcardinputbrandcardbrand-")

#### [`PaymentMethodCardInput.country`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardinputcountrystring- "Direct link to paymentmethodcardinputcountrystring-")

#### [`PaymentMethodCardInput.type`](#) ● [`CardType`](https://docs.monei.com/apis/graphql/types/enums/card-type/.md) enum[​](#paymentmethodcardinputtypecardtype- "Direct link to paymentmethodcardinputtypecardtype-")

#### [`PaymentMethodCardInput.threeDSecure`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#paymentmethodcardinputthreedsecureboolean- "Direct link to paymentmethodcardinputthreedsecureboolean-")

#### [`PaymentMethodCardInput.threeDSecureVersion`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardinputthreedsecureversionstring- "Direct link to paymentmethodcardinputthreedsecureversionstring-")

#### [`PaymentMethodCardInput.last4`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardinputlast4string- "Direct link to paymentmethodcardinputlast4string-")

#### [`PaymentMethodCardInput.fingerprint`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardinputfingerprintstring- "Direct link to paymentmethodcardinputfingerprintstring-")

#### [`PaymentMethodCardInput.cardholderName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardinputcardholdernamestring- "Direct link to paymentmethodcardinputcardholdernamestring-")

#### [`PaymentMethodCardInput.cardholderEmail`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardinputcardholderemailstring- "Direct link to paymentmethodcardinputcardholderemailstring-")

#### [`PaymentMethodCardInput.bank`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardinputbankstring- "Direct link to paymentmethodcardinputbankstring-")

#### [`PaymentMethodCardInput.tokenizationMethod`](#) ● [`TokenizationMethods`](https://docs.monei.com/apis/graphql/types/enums/tokenization-methods/.md) enum[​](#paymentmethodcardinputtokenizationmethodtokenizationmethods- "Direct link to paymentmethodcardinputtokenizationmethodtokenizationmethods-")

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethodInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-input/.md) input


---

# PaymentMethodCardPresentInput

No description

```
input PaymentMethodCardPresentInput {
  brand: CardBrand
  country: String
  type: CardType
  bin: String
  last4: String
  fingerprint: String
  cardholderName: String
  cardholderEmail: String
  expiration: Long
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentMethodCardPresentInput.brand`](#) ● [`CardBrand`](https://docs.monei.com/apis/graphql/types/enums/card-brand/.md) enum[​](#paymentmethodcardpresentinputbrandcardbrand- "Direct link to paymentmethodcardpresentinputbrandcardbrand-")

#### [`PaymentMethodCardPresentInput.country`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardpresentinputcountrystring- "Direct link to paymentmethodcardpresentinputcountrystring-")

#### [`PaymentMethodCardPresentInput.type`](#) ● [`CardType`](https://docs.monei.com/apis/graphql/types/enums/card-type/.md) enum[​](#paymentmethodcardpresentinputtypecardtype- "Direct link to paymentmethodcardpresentinputtypecardtype-")

#### [`PaymentMethodCardPresentInput.bin`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardpresentinputbinstring- "Direct link to paymentmethodcardpresentinputbinstring-")

#### [`PaymentMethodCardPresentInput.last4`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardpresentinputlast4string- "Direct link to paymentmethodcardpresentinputlast4string-")

#### [`PaymentMethodCardPresentInput.fingerprint`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardpresentinputfingerprintstring- "Direct link to paymentmethodcardpresentinputfingerprintstring-")

#### [`PaymentMethodCardPresentInput.cardholderName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardpresentinputcardholdernamestring- "Direct link to paymentmethodcardpresentinputcardholdernamestring-")

#### [`PaymentMethodCardPresentInput.cardholderEmail`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardpresentinputcardholderemailstring- "Direct link to paymentmethodcardpresentinputcardholderemailstring-")

#### [`PaymentMethodCardPresentInput.expiration`](#) ● [`Long`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) scalar[​](#paymentmethodcardpresentinputexpirationlong- "Direct link to paymentmethodcardpresentinputexpirationlong-")

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethodInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-input/.md) input


---

# PaymentMethodInput

No description

```
input PaymentMethodInput {
  method: PaymentMethods
  bizum: PaymentMethodBizumInput
  card: PaymentMethodCardInput
  cardPresent: PaymentMethodCardPresentInput
  paypal: PaymentMethodPaypalInput
  sepa: PaymentMethodSepaInput
  trustly: PaymentMethodTrustlyInput
  klarna: PaymentMethodKlarnaInput
  mbway: PaymentMethodMBWayInput
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentMethodInput.method`](#) ● [`PaymentMethods`](https://docs.monei.com/apis/graphql/types/enums/payment-methods/.md) enum[​](#paymentmethodinputmethodpaymentmethods- "Direct link to paymentmethodinputmethodpaymentmethods-")

#### [`PaymentMethodInput.bizum`](#) ● [`PaymentMethodBizumInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-bizum-input/.md) input[​](#paymentmethodinputbizumpaymentmethodbizuminput- "Direct link to paymentmethodinputbizumpaymentmethodbizuminput-")

#### [`PaymentMethodInput.card`](#) ● [`PaymentMethodCardInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-card-input/.md) input[​](#paymentmethodinputcardpaymentmethodcardinput- "Direct link to paymentmethodinputcardpaymentmethodcardinput-")

#### [`PaymentMethodInput.cardPresent`](#) ● [`PaymentMethodCardPresentInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-card-present-input/.md) input[​](#paymentmethodinputcardpresentpaymentmethodcardpresentinput- "Direct link to paymentmethodinputcardpresentpaymentmethodcardpresentinput-")

#### [`PaymentMethodInput.paypal`](#) ● [`PaymentMethodPaypalInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-paypal-input/.md) input[​](#paymentmethodinputpaypalpaymentmethodpaypalinput- "Direct link to paymentmethodinputpaypalpaymentmethodpaypalinput-")

#### [`PaymentMethodInput.sepa`](#) ● [`PaymentMethodSepaInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-sepa-input/.md) input[​](#paymentmethodinputsepapaymentmethodsepainput- "Direct link to paymentmethodinputsepapaymentmethodsepainput-")

#### [`PaymentMethodInput.trustly`](#) ● [`PaymentMethodTrustlyInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-trustly-input/.md) input[​](#paymentmethodinputtrustlypaymentmethodtrustlyinput- "Direct link to paymentmethodinputtrustlypaymentmethodtrustlyinput-")

#### [`PaymentMethodInput.klarna`](#) ● [`PaymentMethodKlarnaInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-klarna-input/.md) input[​](#paymentmethodinputklarnapaymentmethodklarnainput- "Direct link to paymentmethodinputklarnapaymentmethodklarnainput-")

#### [`PaymentMethodInput.mbway`](#) ● [`PaymentMethodMBWayInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-mbway-input/.md) input[​](#paymentmethodinputmbwaypaymentmethodmbwayinput- "Direct link to paymentmethodinputmbwaypaymentmethodmbwayinput-")

### Member Of[​](#member-of "Direct link to Member Of")

[`UpdateChargeInput`](https://docs.monei.com/apis/graphql/types/inputs/update-charge-input/.md) input


---

# PaymentMethodKlarnaInput

No description

```
input PaymentMethodKlarnaInput {
  billingCategory: String
  authPaymentMethod: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentMethodKlarnaInput.billingCategory`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodklarnainputbillingcategorystring- "Direct link to paymentmethodklarnainputbillingcategorystring-")

#### [`PaymentMethodKlarnaInput.authPaymentMethod`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodklarnainputauthpaymentmethodstring- "Direct link to paymentmethodklarnainputauthpaymentmethodstring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethodInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-input/.md) input


---

# PaymentMethodMBWayInput

No description

```
input PaymentMethodMBWayInput {
  phoneNumber: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentMethodMBWayInput.phoneNumber`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodmbwayinputphonenumberstring- "Direct link to paymentmethodmbwayinputphonenumberstring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethodInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-input/.md) input


---

# PaymentMethodPaypalInput

No description

```
input PaymentMethodPaypalInput {
  orderId: ID
  payerId: ID
  email: String
  name: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentMethodPaypalInput.orderId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#paymentmethodpaypalinputorderidid- "Direct link to paymentmethodpaypalinputorderidid-")

#### [`PaymentMethodPaypalInput.payerId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#paymentmethodpaypalinputpayeridid- "Direct link to paymentmethodpaypalinputpayeridid-")

#### [`PaymentMethodPaypalInput.email`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodpaypalinputemailstring- "Direct link to paymentmethodpaypalinputemailstring-")

#### [`PaymentMethodPaypalInput.name`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodpaypalinputnamestring- "Direct link to paymentmethodpaypalinputnamestring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethodInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-input/.md) input


---

# PaymentMethodSepaInput

No description

```
input PaymentMethodSepaInput {
  accountholderAddress: AddressInput
  accountholderEmail: String
  accountholderName: String
  countryCode: String
  bankAddress: String
  bankCode: String
  bankName: String
  bic: String
  last4: String
  fingerprint: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentMethodSepaInput.accountholderAddress`](#) ● [`AddressInput`](https://docs.monei.com/apis/graphql/types/inputs/address-input/.md) input[​](#paymentmethodsepainputaccountholderaddressaddressinput- "Direct link to paymentmethodsepainputaccountholderaddressaddressinput-")

#### [`PaymentMethodSepaInput.accountholderEmail`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodsepainputaccountholderemailstring- "Direct link to paymentmethodsepainputaccountholderemailstring-")

#### [`PaymentMethodSepaInput.accountholderName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodsepainputaccountholdernamestring- "Direct link to paymentmethodsepainputaccountholdernamestring-")

#### [`PaymentMethodSepaInput.countryCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodsepainputcountrycodestring- "Direct link to paymentmethodsepainputcountrycodestring-")

#### [`PaymentMethodSepaInput.bankAddress`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodsepainputbankaddressstring- "Direct link to paymentmethodsepainputbankaddressstring-")

#### [`PaymentMethodSepaInput.bankCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodsepainputbankcodestring- "Direct link to paymentmethodsepainputbankcodestring-")

#### [`PaymentMethodSepaInput.bankName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodsepainputbanknamestring- "Direct link to paymentmethodsepainputbanknamestring-")

#### [`PaymentMethodSepaInput.bic`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodsepainputbicstring- "Direct link to paymentmethodsepainputbicstring-")

#### [`PaymentMethodSepaInput.last4`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodsepainputlast4string- "Direct link to paymentmethodsepainputlast4string-")

#### [`PaymentMethodSepaInput.fingerprint`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodsepainputfingerprintstring- "Direct link to paymentmethodsepainputfingerprintstring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethodInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-input/.md) input


---

# PaymentMethodTrustlyInput

No description

```
input PaymentMethodTrustlyInput {
  customerId: ID
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentMethodTrustlyInput.customerId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#paymentmethodtrustlyinputcustomeridid- "Direct link to paymentmethodtrustlyinputcustomeridid-")

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethodInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-input/.md) input


---

# ProviderRulesInput

No description

```
input ProviderRulesInput {
  minAmount: Int
  maxAmount: Int
  shopNameLike: String
  descriptionLike: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ProviderRulesInput.minAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#providerrulesinputminamountint- "Direct link to providerrulesinputminamountint-")

Minimum amount for this provider

#### [`ProviderRulesInput.maxAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#providerrulesinputmaxamountint- "Direct link to providerrulesinputmaxamountint-")

Maximum amount for this provider

#### [`ProviderRulesInput.shopNameLike`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#providerrulesinputshopnamelikestring- "Direct link to providerrulesinputshopnamelikestring-")

Shop name regular expression

#### [`ProviderRulesInput.descriptionLike`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#providerrulesinputdescriptionlikestring- "Direct link to providerrulesinputdescriptionlikestring-")

Description regular expression

### Member Of[​](#member-of "Direct link to Member Of")

[`CreateProviderInput`](https://docs.monei.com/apis/graphql/types/inputs/create-provider-input/.md) input ● [`UpdateProviderInput`](https://docs.monei.com/apis/graphql/types/inputs/update-provider-input/.md) input


---

# RefundPaymentInput

No description

```
input RefundPaymentInput {
  paymentId: ID!
  amount: Int!
  refundReason: RefundReason
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`RefundPaymentInput.paymentId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#refundpaymentinputpaymentidid-- "Direct link to refundpaymentinputpaymentidid--")

The ID of the payment to be refunded

#### [`RefundPaymentInput.amount`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#refundpaymentinputamountint-- "Direct link to refundpaymentinputamountint--")

The amount to be refunded (for example 1075 for 10.75€)

#### [`RefundPaymentInput.refundReason`](#) ● [`RefundReason`](https://docs.monei.com/apis/graphql/types/enums/refund-reason/.md) enum[​](#refundpaymentinputrefundreasonrefundreason- "Direct link to refundpaymentinputrefundreasonrefundreason-")

The reason why the payment is being refunded

### Member Of[​](#member-of "Direct link to Member Of")

[`refundPayment`](https://docs.monei.com/apis/graphql/operations/mutations/refund-payment/.md) mutation


---

# RegisterApplePayDomainInput

No description

```
input RegisterApplePayDomainInput {
  domainName: String!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`RegisterApplePayDomainInput.domainName`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#registerapplepaydomaininputdomainnamestring-- "Direct link to registerapplepaydomaininputdomainnamestring--")

The domain Name

### Member Of[​](#member-of "Direct link to Member Of")

[`registerApplePayDomain`](https://docs.monei.com/apis/graphql/operations/mutations/register-apple-pay-domain/.md) mutation


---

# RegisterCodeInput

No description

```
input RegisterCodeInput {
  codeId: ID
  pointOfSaleId: ID
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`RegisterCodeInput.codeId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#registercodeinputcodeidid- "Direct link to registercodeinputcodeidid-")

The ID of the code to register

#### [`RegisterCodeInput.pointOfSaleId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#registercodeinputpointofsaleidid- "Direct link to registercodeinputpointofsaleidid-")

The ID of the Point of Sale this code will be associated to

### Member Of[​](#member-of "Direct link to Member Of")

[`registerCode`](https://docs.monei.com/apis/graphql/operations/mutations/register-code/.md) mutation


---

# RepresentativeInput

Legal Representative input

```
input RepresentativeInput {
  firstName: String
  lastName: String
  address: AddressInput
  email: String
  phone: String
  documentNumber: String
  stocksPercentage: Float
  hasNoPublicActivity: Boolean
  nationality: String
  citizenship: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`RepresentativeInput.firstName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#representativeinputfirstnamestring- "Direct link to representativeinputfirstnamestring-")

First name

#### [`RepresentativeInput.lastName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#representativeinputlastnamestring- "Direct link to representativeinputlastnamestring-")

Last name

#### [`RepresentativeInput.address`](#) ● [`AddressInput`](https://docs.monei.com/apis/graphql/types/inputs/address-input/.md) input[​](#representativeinputaddressaddressinput- "Direct link to representativeinputaddressaddressinput-")

Address

#### [`RepresentativeInput.email`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#representativeinputemailstring- "Direct link to representativeinputemailstring-")

Email

#### [`RepresentativeInput.phone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#representativeinputphonestring- "Direct link to representativeinputphonestring-")

Phone number in E.164 format, e.g. +34666777888

#### [`RepresentativeInput.documentNumber`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#representativeinputdocumentnumberstring- "Direct link to representativeinputdocumentnumberstring-")

Document number (DNI/NIE)

#### [`RepresentativeInput.stocksPercentage`](#) ● [`Float`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) scalar[​](#representativeinputstockspercentagefloat- "Direct link to representativeinputstockspercentagefloat-")

Stock percentage (100% if it's an individual or freelancer)

#### [`RepresentativeInput.hasNoPublicActivity`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#representativeinputhasnopublicactivityboolean- "Direct link to representativeinputhasnopublicactivityboolean-")

Confirms that the representative is not a PEP (Politically Exposed Person)

#### [`RepresentativeInput.nationality`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#representativeinputnationalitystring- "Direct link to representativeinputnationalitystring-")

Nationality, ISO 3166-1 alpha-2 code

#### [`RepresentativeInput.citizenship`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#representativeinputcitizenshipstring- "Direct link to representativeinputcitizenshipstring-")

Citizenship, ISO 3166-1 alpha-2 code

### Member Of[​](#member-of "Direct link to Member Of")

[`SetupAccountInput`](https://docs.monei.com/apis/graphql/types/inputs/setup-account-input/.md) input


---

# ResumeSubscriptionInput

No description

```
input ResumeSubscriptionInput {
  id: ID!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ResumeSubscriptionInput.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#resumesubscriptioninputidid-- "Direct link to resumesubscriptioninputidid--")

### Member Of[​](#member-of "Direct link to Member Of")

[`resumeSubscription`](https://docs.monei.com/apis/graphql/operations/mutations/resume-subscription/.md) mutation


---

# RetryScheduleInput

No description

```
input RetryScheduleInput {
  interval: RetryIntervalInput!
  intervalCount: Int!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`RetryScheduleInput.interval`](#) ● [`RetryIntervalInput!`](https://docs.monei.com/apis/graphql/types/enums/retry-interval-input/.md) non-null enum[​](#retryscheduleinputintervalretryintervalinput-- "Direct link to retryscheduleinputintervalretryintervalinput--")

#### [`RetryScheduleInput.intervalCount`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#retryscheduleinputintervalcountint-- "Direct link to retryscheduleinputintervalcountint--")

### Member Of[​](#member-of "Direct link to Member Of")

[`CreateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/create-subscription-input/.md) input ● [`UpdateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/update-subscription-input/.md) input


---

# SearchableAccountInvoiceFilterInput

Filter for account invoices, currently only supports `createdAt` the creation date of the account invoice as a unix timestamp

```
input SearchableAccountInvoiceFilterInput {
  createdAt: SearchableIntFilterInput
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SearchableAccountInvoiceFilterInput.createdAt`](#) ● [`SearchableIntFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-int-filter-input/.md) input[​](#searchableaccountinvoicefilterinputcreatedatsearchableintfilterinput- "Direct link to searchableaccountinvoicefilterinputcreatedatsearchableintfilterinput-")

### Member Of[​](#member-of "Direct link to Member Of")

[`accountInvoices`](https://docs.monei.com/apis/graphql/operations/queries/account-invoices/.md) query


---

# SearchableAccountSettlementFilterInput

No description

```
input SearchableAccountSettlementFilterInput {
  createdAt: SearchableIntFilterInput
  storeId: SearchableStringFilterInput
  and: [SearchableAccountSettlementFilterInput]
  or: [SearchableAccountSettlementFilterInput]
  not: SearchableAccountSettlementFilterInput
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SearchableAccountSettlementFilterInput.createdAt`](#) ● [`SearchableIntFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-int-filter-input/.md) input[​](#searchableaccountsettlementfilterinputcreatedatsearchableintfilterinput- "Direct link to searchableaccountsettlementfilterinputcreatedatsearchableintfilterinput-")

#### [`SearchableAccountSettlementFilterInput.storeId`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableaccountsettlementfilterinputstoreidsearchablestringfilterinput- "Direct link to searchableaccountsettlementfilterinputstoreidsearchablestringfilterinput-")

#### [`SearchableAccountSettlementFilterInput.and`](#) ● [`[SearchableAccountSettlementFilterInput]`](https://docs.monei.com/apis/graphql/types/inputs/searchable-account-settlement-filter-input/.md) list input[​](#searchableaccountsettlementfilterinputandsearchableaccountsettlementfilterinput-- "Direct link to searchableaccountsettlementfilterinputandsearchableaccountsettlementfilterinput--")

#### [`SearchableAccountSettlementFilterInput.or`](#) ● [`[SearchableAccountSettlementFilterInput]`](https://docs.monei.com/apis/graphql/types/inputs/searchable-account-settlement-filter-input/.md) list input[​](#searchableaccountsettlementfilterinputorsearchableaccountsettlementfilterinput-- "Direct link to searchableaccountsettlementfilterinputorsearchableaccountsettlementfilterinput--")

#### [`SearchableAccountSettlementFilterInput.not`](#) ● [`SearchableAccountSettlementFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-account-settlement-filter-input/.md) input[​](#searchableaccountsettlementfilterinputnotsearchableaccountsettlementfilterinput- "Direct link to searchableaccountsettlementfilterinputnotsearchableaccountsettlementfilterinput-")

### Member Of[​](#member-of "Direct link to Member Of")

[`accountSettlements`](https://docs.monei.com/apis/graphql/operations/queries/account-settlements/.md) query ● [`SearchableAccountSettlementFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-account-settlement-filter-input/.md) input


---

# SearchableBooleanFilterInput

No description

```
input SearchableBooleanFilterInput {
  eq: Boolean
  ne: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SearchableBooleanFilterInput.eq`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#searchablebooleanfilterinputeqboolean- "Direct link to searchablebooleanfilterinputeqboolean-")

#### [`SearchableBooleanFilterInput.ne`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#searchablebooleanfilterinputneboolean- "Direct link to searchablebooleanfilterinputneboolean-")

### Member Of[​](#member-of "Direct link to Member Of")

[`SearchableChargeFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-charge-filter-input/.md) input ● [`SearchableEventFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-event-filter-input/.md) input ● [`SearchableSubscriptionFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-subscription-filter-input/.md) input


---

# SearchableChargeFilterInput

No description

```
input SearchableChargeFilterInput {
  id: SearchableIDFilterInput
  checkoutId: SearchableIDFilterInput
  providerInternalId: SearchableStringFilterInput
  providerReferenceId: SearchableStringFilterInput
  createdAt: SearchableIntFilterInput
  updatedAt: SearchableIntFilterInput
  amount: SearchableIntFilterInput
  authorizationCode: SearchableStringFilterInput
  currency: SearchableStringFilterInput
  description: SearchableStringFilterInput
  descriptor: SearchableStringFilterInput
  orderId: SearchableStringFilterInput
  storeId: SearchableStringFilterInput
  pointOfSaleId: SearchableStringFilterInput
  sequenceId: SearchableStringFilterInput
  subscriptionId: SearchableStringFilterInput
  refundedAmount: SearchableIntFilterInput
  status: SearchableStringFilterInput
  statusCode: SearchableStringFilterInput
  statusMessage: SearchableStringFilterInput
  customerEmail: SearchableStringFilterInput
  customerName: SearchableStringFilterInput
  customerPhone: SearchableStringFilterInput
  paymentMethodMethod: SearchableStringFilterInput
  paymentMethodCardBrand: SearchableStringFilterInput
  paymentMethodCardLast4: SearchableStringFilterInput
  paymentMethodCardType: SearchableStringFilterInput
  paymentMethodCardThreeDSecure: SearchableBooleanFilterInput
  paymentMethodCardThreeDSecureVersion: SearchableStringFilterInput
  paymentMethodCardTokenizationMethod: SearchableStringFilterInput
  paymentMethodCardFingerprint: SearchableStringFilterInput
  shopCountry: SearchableStringFilterInput
  shopName: SearchableStringFilterInput
  sessionIp: SearchableStringFilterInput
  sessionCountry: SearchableStringFilterInput
  traceDetailsSource: SearchableStringFilterInput
  fraudDetectorScore: SearchableIntFilterInput
  and: [SearchableChargeFilterInput]
  or: [SearchableChargeFilterInput]
  not: SearchableChargeFilterInput
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SearchableChargeFilterInput.id`](#) ● [`SearchableIDFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-idfilter-input/.md) input[​](#searchablechargefilterinputidsearchableidfilterinput- "Direct link to searchablechargefilterinputidsearchableidfilterinput-")

#### [`SearchableChargeFilterInput.checkoutId`](#) ● [`SearchableIDFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-idfilter-input/.md) input[​](#searchablechargefilterinputcheckoutidsearchableidfilterinput- "Direct link to searchablechargefilterinputcheckoutidsearchableidfilterinput-")

#### [`SearchableChargeFilterInput.providerInternalId`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputproviderinternalidsearchablestringfilterinput- "Direct link to searchablechargefilterinputproviderinternalidsearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.providerReferenceId`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputproviderreferenceidsearchablestringfilterinput- "Direct link to searchablechargefilterinputproviderreferenceidsearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.createdAt`](#) ● [`SearchableIntFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-int-filter-input/.md) input[​](#searchablechargefilterinputcreatedatsearchableintfilterinput- "Direct link to searchablechargefilterinputcreatedatsearchableintfilterinput-")

#### [`SearchableChargeFilterInput.updatedAt`](#) ● [`SearchableIntFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-int-filter-input/.md) input[​](#searchablechargefilterinputupdatedatsearchableintfilterinput- "Direct link to searchablechargefilterinputupdatedatsearchableintfilterinput-")

#### [`SearchableChargeFilterInput.amount`](#) ● [`SearchableIntFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-int-filter-input/.md) input[​](#searchablechargefilterinputamountsearchableintfilterinput- "Direct link to searchablechargefilterinputamountsearchableintfilterinput-")

#### [`SearchableChargeFilterInput.authorizationCode`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputauthorizationcodesearchablestringfilterinput- "Direct link to searchablechargefilterinputauthorizationcodesearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.currency`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputcurrencysearchablestringfilterinput- "Direct link to searchablechargefilterinputcurrencysearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.description`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputdescriptionsearchablestringfilterinput- "Direct link to searchablechargefilterinputdescriptionsearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.descriptor`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputdescriptorsearchablestringfilterinput- "Direct link to searchablechargefilterinputdescriptorsearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.orderId`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputorderidsearchablestringfilterinput- "Direct link to searchablechargefilterinputorderidsearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.storeId`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputstoreidsearchablestringfilterinput- "Direct link to searchablechargefilterinputstoreidsearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.pointOfSaleId`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputpointofsaleidsearchablestringfilterinput- "Direct link to searchablechargefilterinputpointofsaleidsearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.sequenceId`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputsequenceidsearchablestringfilterinput- "Direct link to searchablechargefilterinputsequenceidsearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.subscriptionId`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputsubscriptionidsearchablestringfilterinput- "Direct link to searchablechargefilterinputsubscriptionidsearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.refundedAmount`](#) ● [`SearchableIntFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-int-filter-input/.md) input[​](#searchablechargefilterinputrefundedamountsearchableintfilterinput- "Direct link to searchablechargefilterinputrefundedamountsearchableintfilterinput-")

#### [`SearchableChargeFilterInput.status`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputstatussearchablestringfilterinput- "Direct link to searchablechargefilterinputstatussearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.statusCode`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputstatuscodesearchablestringfilterinput- "Direct link to searchablechargefilterinputstatuscodesearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.statusMessage`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputstatusmessagesearchablestringfilterinput- "Direct link to searchablechargefilterinputstatusmessagesearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.customerEmail`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputcustomeremailsearchablestringfilterinput- "Direct link to searchablechargefilterinputcustomeremailsearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.customerName`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputcustomernamesearchablestringfilterinput- "Direct link to searchablechargefilterinputcustomernamesearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.customerPhone`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputcustomerphonesearchablestringfilterinput- "Direct link to searchablechargefilterinputcustomerphonesearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.paymentMethodMethod`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputpaymentmethodmethodsearchablestringfilterinput- "Direct link to searchablechargefilterinputpaymentmethodmethodsearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.paymentMethodCardBrand`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputpaymentmethodcardbrandsearchablestringfilterinput- "Direct link to searchablechargefilterinputpaymentmethodcardbrandsearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.paymentMethodCardLast4`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputpaymentmethodcardlast4searchablestringfilterinput- "Direct link to searchablechargefilterinputpaymentmethodcardlast4searchablestringfilterinput-")

#### [`SearchableChargeFilterInput.paymentMethodCardType`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputpaymentmethodcardtypesearchablestringfilterinput- "Direct link to searchablechargefilterinputpaymentmethodcardtypesearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.paymentMethodCardThreeDSecure`](#) ● [`SearchableBooleanFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-boolean-filter-input/.md) input[​](#searchablechargefilterinputpaymentmethodcardthreedsecuresearchablebooleanfilterinput- "Direct link to searchablechargefilterinputpaymentmethodcardthreedsecuresearchablebooleanfilterinput-")

#### [`SearchableChargeFilterInput.paymentMethodCardThreeDSecureVersion`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputpaymentmethodcardthreedsecureversionsearchablestringfilterinput- "Direct link to searchablechargefilterinputpaymentmethodcardthreedsecureversionsearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.paymentMethodCardTokenizationMethod`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputpaymentmethodcardtokenizationmethodsearchablestringfilterinput- "Direct link to searchablechargefilterinputpaymentmethodcardtokenizationmethodsearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.paymentMethodCardFingerprint`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputpaymentmethodcardfingerprintsearchablestringfilterinput- "Direct link to searchablechargefilterinputpaymentmethodcardfingerprintsearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.shopCountry`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputshopcountrysearchablestringfilterinput- "Direct link to searchablechargefilterinputshopcountrysearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.shopName`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputshopnamesearchablestringfilterinput- "Direct link to searchablechargefilterinputshopnamesearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.sessionIp`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputsessionipsearchablestringfilterinput- "Direct link to searchablechargefilterinputsessionipsearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.sessionCountry`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputsessioncountrysearchablestringfilterinput- "Direct link to searchablechargefilterinputsessioncountrysearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.traceDetailsSource`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablechargefilterinputtracedetailssourcesearchablestringfilterinput- "Direct link to searchablechargefilterinputtracedetailssourcesearchablestringfilterinput-")

#### [`SearchableChargeFilterInput.fraudDetectorScore`](#) ● [`SearchableIntFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-int-filter-input/.md) input[​](#searchablechargefilterinputfrauddetectorscoresearchableintfilterinput- "Direct link to searchablechargefilterinputfrauddetectorscoresearchableintfilterinput-")

#### [`SearchableChargeFilterInput.and`](#) ● [`[SearchableChargeFilterInput]`](https://docs.monei.com/apis/graphql/types/inputs/searchable-charge-filter-input/.md) list input[​](#searchablechargefilterinputandsearchablechargefilterinput-- "Direct link to searchablechargefilterinputandsearchablechargefilterinput--")

#### [`SearchableChargeFilterInput.or`](#) ● [`[SearchableChargeFilterInput]`](https://docs.monei.com/apis/graphql/types/inputs/searchable-charge-filter-input/.md) list input[​](#searchablechargefilterinputorsearchablechargefilterinput-- "Direct link to searchablechargefilterinputorsearchablechargefilterinput--")

#### [`SearchableChargeFilterInput.not`](#) ● [`SearchableChargeFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-charge-filter-input/.md) input[​](#searchablechargefilterinputnotsearchablechargefilterinput- "Direct link to searchablechargefilterinputnotsearchablechargefilterinput-")

### Member Of[​](#member-of "Direct link to Member Of")

[`charges`](https://docs.monei.com/apis/graphql/operations/queries/charges/.md) query ● [`exportCharges`](https://docs.monei.com/apis/graphql/operations/mutations/export-charges/.md) mutation ● [`SearchableChargeFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-charge-filter-input/.md) input ● [`startExportCharges`](https://docs.monei.com/apis/graphql/operations/mutations/start-export-charges/.md) mutation


---

# SearchableEventFilterInput

No description

```
input SearchableEventFilterInput {
  id: SearchableIDFilterInput
  objectId: SearchableIDFilterInput
  type: SearchableStringFilterInput
  createdAt: SearchableIntFilterInput
  checkoutId: SearchableIDFilterInput
  providerInternalId: SearchableStringFilterInput
  providerReferenceId: SearchableStringFilterInput
  amount: SearchableIntFilterInput
  authorizationCode: SearchableStringFilterInput
  currency: SearchableStringFilterInput
  description: SearchableStringFilterInput
  descriptor: SearchableStringFilterInput
  orderId: SearchableStringFilterInput
  storeId: SearchableStringFilterInput
  pointOfSaleId: SearchableStringFilterInput
  sequenceId: SearchableStringFilterInput
  subscriptionId: SearchableStringFilterInput
  refundedAmount: SearchableIntFilterInput
  status: SearchableStringFilterInput
  statusCode: SearchableStringFilterInput
  statusMessage: SearchableStringFilterInput
  customerEmail: SearchableStringFilterInput
  customerPhone: SearchableStringFilterInput
  customerName: SearchableStringFilterInput
  paymentMethodMethod: SearchableStringFilterInput
  paymentMethodCardBrand: SearchableStringFilterInput
  paymentMethodCardLast4: SearchableStringFilterInput
  paymentMethodCardType: SearchableStringFilterInput
  paymentMethodCardThreeDSecure: SearchableBooleanFilterInput
  paymentMethodCardThreeDSecureVersion: SearchableStringFilterInput
  paymentMethodCardTokenizationMethod: SearchableStringFilterInput
  paymentMethodCardFingerprint: SearchableStringFilterInput
  shopCountry: SearchableStringFilterInput
  shopName: SearchableStringFilterInput
  sessionIp: SearchableStringFilterInput
  sessionCountry: SearchableStringFilterInput
  fraudDetectorScore: SearchableIntFilterInput
  and: [SearchableEventFilterInput]
  or: [SearchableEventFilterInput]
  not: SearchableEventFilterInput
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SearchableEventFilterInput.id`](#) ● [`SearchableIDFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-idfilter-input/.md) input[​](#searchableeventfilterinputidsearchableidfilterinput- "Direct link to searchableeventfilterinputidsearchableidfilterinput-")

#### [`SearchableEventFilterInput.objectId`](#) ● [`SearchableIDFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-idfilter-input/.md) input[​](#searchableeventfilterinputobjectidsearchableidfilterinput- "Direct link to searchableeventfilterinputobjectidsearchableidfilterinput-")

#### [`SearchableEventFilterInput.type`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputtypesearchablestringfilterinput- "Direct link to searchableeventfilterinputtypesearchablestringfilterinput-")

#### [`SearchableEventFilterInput.createdAt`](#) ● [`SearchableIntFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-int-filter-input/.md) input[​](#searchableeventfilterinputcreatedatsearchableintfilterinput- "Direct link to searchableeventfilterinputcreatedatsearchableintfilterinput-")

#### [`SearchableEventFilterInput.checkoutId`](#) ● [`SearchableIDFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-idfilter-input/.md) input[​](#searchableeventfilterinputcheckoutidsearchableidfilterinput- "Direct link to searchableeventfilterinputcheckoutidsearchableidfilterinput-")

#### [`SearchableEventFilterInput.providerInternalId`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputproviderinternalidsearchablestringfilterinput- "Direct link to searchableeventfilterinputproviderinternalidsearchablestringfilterinput-")

#### [`SearchableEventFilterInput.providerReferenceId`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputproviderreferenceidsearchablestringfilterinput- "Direct link to searchableeventfilterinputproviderreferenceidsearchablestringfilterinput-")

#### [`SearchableEventFilterInput.amount`](#) ● [`SearchableIntFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-int-filter-input/.md) input[​](#searchableeventfilterinputamountsearchableintfilterinput- "Direct link to searchableeventfilterinputamountsearchableintfilterinput-")

#### [`SearchableEventFilterInput.authorizationCode`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputauthorizationcodesearchablestringfilterinput- "Direct link to searchableeventfilterinputauthorizationcodesearchablestringfilterinput-")

#### [`SearchableEventFilterInput.currency`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputcurrencysearchablestringfilterinput- "Direct link to searchableeventfilterinputcurrencysearchablestringfilterinput-")

#### [`SearchableEventFilterInput.description`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputdescriptionsearchablestringfilterinput- "Direct link to searchableeventfilterinputdescriptionsearchablestringfilterinput-")

#### [`SearchableEventFilterInput.descriptor`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputdescriptorsearchablestringfilterinput- "Direct link to searchableeventfilterinputdescriptorsearchablestringfilterinput-")

#### [`SearchableEventFilterInput.orderId`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputorderidsearchablestringfilterinput- "Direct link to searchableeventfilterinputorderidsearchablestringfilterinput-")

#### [`SearchableEventFilterInput.storeId`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputstoreidsearchablestringfilterinput- "Direct link to searchableeventfilterinputstoreidsearchablestringfilterinput-")

#### [`SearchableEventFilterInput.pointOfSaleId`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputpointofsaleidsearchablestringfilterinput- "Direct link to searchableeventfilterinputpointofsaleidsearchablestringfilterinput-")

#### [`SearchableEventFilterInput.sequenceId`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputsequenceidsearchablestringfilterinput- "Direct link to searchableeventfilterinputsequenceidsearchablestringfilterinput-")

#### [`SearchableEventFilterInput.subscriptionId`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputsubscriptionidsearchablestringfilterinput- "Direct link to searchableeventfilterinputsubscriptionidsearchablestringfilterinput-")

#### [`SearchableEventFilterInput.refundedAmount`](#) ● [`SearchableIntFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-int-filter-input/.md) input[​](#searchableeventfilterinputrefundedamountsearchableintfilterinput- "Direct link to searchableeventfilterinputrefundedamountsearchableintfilterinput-")

#### [`SearchableEventFilterInput.status`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputstatussearchablestringfilterinput- "Direct link to searchableeventfilterinputstatussearchablestringfilterinput-")

#### [`SearchableEventFilterInput.statusCode`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputstatuscodesearchablestringfilterinput- "Direct link to searchableeventfilterinputstatuscodesearchablestringfilterinput-")

#### [`SearchableEventFilterInput.statusMessage`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputstatusmessagesearchablestringfilterinput- "Direct link to searchableeventfilterinputstatusmessagesearchablestringfilterinput-")

#### [`SearchableEventFilterInput.customerEmail`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputcustomeremailsearchablestringfilterinput- "Direct link to searchableeventfilterinputcustomeremailsearchablestringfilterinput-")

#### [`SearchableEventFilterInput.customerPhone`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputcustomerphonesearchablestringfilterinput- "Direct link to searchableeventfilterinputcustomerphonesearchablestringfilterinput-")

#### [`SearchableEventFilterInput.customerName`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputcustomernamesearchablestringfilterinput- "Direct link to searchableeventfilterinputcustomernamesearchablestringfilterinput-")

#### [`SearchableEventFilterInput.paymentMethodMethod`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputpaymentmethodmethodsearchablestringfilterinput- "Direct link to searchableeventfilterinputpaymentmethodmethodsearchablestringfilterinput-")

#### [`SearchableEventFilterInput.paymentMethodCardBrand`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputpaymentmethodcardbrandsearchablestringfilterinput- "Direct link to searchableeventfilterinputpaymentmethodcardbrandsearchablestringfilterinput-")

#### [`SearchableEventFilterInput.paymentMethodCardLast4`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputpaymentmethodcardlast4searchablestringfilterinput- "Direct link to searchableeventfilterinputpaymentmethodcardlast4searchablestringfilterinput-")

#### [`SearchableEventFilterInput.paymentMethodCardType`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputpaymentmethodcardtypesearchablestringfilterinput- "Direct link to searchableeventfilterinputpaymentmethodcardtypesearchablestringfilterinput-")

#### [`SearchableEventFilterInput.paymentMethodCardThreeDSecure`](#) ● [`SearchableBooleanFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-boolean-filter-input/.md) input[​](#searchableeventfilterinputpaymentmethodcardthreedsecuresearchablebooleanfilterinput- "Direct link to searchableeventfilterinputpaymentmethodcardthreedsecuresearchablebooleanfilterinput-")

#### [`SearchableEventFilterInput.paymentMethodCardThreeDSecureVersion`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputpaymentmethodcardthreedsecureversionsearchablestringfilterinput- "Direct link to searchableeventfilterinputpaymentmethodcardthreedsecureversionsearchablestringfilterinput-")

#### [`SearchableEventFilterInput.paymentMethodCardTokenizationMethod`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputpaymentmethodcardtokenizationmethodsearchablestringfilterinput- "Direct link to searchableeventfilterinputpaymentmethodcardtokenizationmethodsearchablestringfilterinput-")

#### [`SearchableEventFilterInput.paymentMethodCardFingerprint`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputpaymentmethodcardfingerprintsearchablestringfilterinput- "Direct link to searchableeventfilterinputpaymentmethodcardfingerprintsearchablestringfilterinput-")

#### [`SearchableEventFilterInput.shopCountry`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputshopcountrysearchablestringfilterinput- "Direct link to searchableeventfilterinputshopcountrysearchablestringfilterinput-")

#### [`SearchableEventFilterInput.shopName`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputshopnamesearchablestringfilterinput- "Direct link to searchableeventfilterinputshopnamesearchablestringfilterinput-")

#### [`SearchableEventFilterInput.sessionIp`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputsessionipsearchablestringfilterinput- "Direct link to searchableeventfilterinputsessionipsearchablestringfilterinput-")

#### [`SearchableEventFilterInput.sessionCountry`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchableeventfilterinputsessioncountrysearchablestringfilterinput- "Direct link to searchableeventfilterinputsessioncountrysearchablestringfilterinput-")

#### [`SearchableEventFilterInput.fraudDetectorScore`](#) ● [`SearchableIntFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-int-filter-input/.md) input[​](#searchableeventfilterinputfrauddetectorscoresearchableintfilterinput- "Direct link to searchableeventfilterinputfrauddetectorscoresearchableintfilterinput-")

#### [`SearchableEventFilterInput.and`](#) ● [`[SearchableEventFilterInput]`](https://docs.monei.com/apis/graphql/types/inputs/searchable-event-filter-input/.md) list input[​](#searchableeventfilterinputandsearchableeventfilterinput-- "Direct link to searchableeventfilterinputandsearchableeventfilterinput--")

#### [`SearchableEventFilterInput.or`](#) ● [`[SearchableEventFilterInput]`](https://docs.monei.com/apis/graphql/types/inputs/searchable-event-filter-input/.md) list input[​](#searchableeventfilterinputorsearchableeventfilterinput-- "Direct link to searchableeventfilterinputorsearchableeventfilterinput--")

#### [`SearchableEventFilterInput.not`](#) ● [`SearchableEventFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-event-filter-input/.md) input[​](#searchableeventfilterinputnotsearchableeventfilterinput- "Direct link to searchableeventfilterinputnotsearchableeventfilterinput-")

### Member Of[​](#member-of "Direct link to Member Of")

[`events`](https://docs.monei.com/apis/graphql/operations/queries/events/.md) query ● [`SearchableEventFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-event-filter-input/.md) input


---

# SearchableFloatFilterInput

No description

```
input SearchableFloatFilterInput {
  ne: Float
  gt: Float
  lt: Float
  gte: Float
  lte: Float
  eq: Float
  range: [Float]
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SearchableFloatFilterInput.ne`](#) ● [`Float`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) scalar[​](#searchablefloatfilterinputnefloat- "Direct link to searchablefloatfilterinputnefloat-")

#### [`SearchableFloatFilterInput.gt`](#) ● [`Float`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) scalar[​](#searchablefloatfilterinputgtfloat- "Direct link to searchablefloatfilterinputgtfloat-")

#### [`SearchableFloatFilterInput.lt`](#) ● [`Float`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) scalar[​](#searchablefloatfilterinputltfloat- "Direct link to searchablefloatfilterinputltfloat-")

#### [`SearchableFloatFilterInput.gte`](#) ● [`Float`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) scalar[​](#searchablefloatfilterinputgtefloat- "Direct link to searchablefloatfilterinputgtefloat-")

#### [`SearchableFloatFilterInput.lte`](#) ● [`Float`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) scalar[​](#searchablefloatfilterinputltefloat- "Direct link to searchablefloatfilterinputltefloat-")

#### [`SearchableFloatFilterInput.eq`](#) ● [`Float`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) scalar[​](#searchablefloatfilterinputeqfloat- "Direct link to searchablefloatfilterinputeqfloat-")

#### [`SearchableFloatFilterInput.range`](#) ● [`[Float]`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) list scalar[​](#searchablefloatfilterinputrangefloat-- "Direct link to searchablefloatfilterinputrangefloat--")


---

# SearchableIDFilterInput

No description

```
input SearchableIDFilterInput {
  ne: ID
  eq: ID
  match: ID
  matchPhrase: ID
  matchPhrasePrefix: ID
  exists: Boolean
  wildcard: ID
  regexp: ID
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SearchableIDFilterInput.ne`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#searchableidfilterinputneid- "Direct link to searchableidfilterinputneid-")

#### [`SearchableIDFilterInput.eq`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#searchableidfilterinputeqid- "Direct link to searchableidfilterinputeqid-")

#### [`SearchableIDFilterInput.match`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#searchableidfilterinputmatchid- "Direct link to searchableidfilterinputmatchid-")

#### [`SearchableIDFilterInput.matchPhrase`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#searchableidfilterinputmatchphraseid- "Direct link to searchableidfilterinputmatchphraseid-")

#### [`SearchableIDFilterInput.matchPhrasePrefix`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#searchableidfilterinputmatchphraseprefixid- "Direct link to searchableidfilterinputmatchphraseprefixid-")

#### [`SearchableIDFilterInput.exists`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#searchableidfilterinputexistsboolean- "Direct link to searchableidfilterinputexistsboolean-")

#### [`SearchableIDFilterInput.wildcard`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#searchableidfilterinputwildcardid- "Direct link to searchableidfilterinputwildcardid-")

#### [`SearchableIDFilterInput.regexp`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#searchableidfilterinputregexpid- "Direct link to searchableidfilterinputregexpid-")

### Member Of[​](#member-of "Direct link to Member Of")

[`SearchableChargeFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-charge-filter-input/.md) input ● [`SearchableEventFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-event-filter-input/.md) input ● [`SearchableSubscriptionFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-subscription-filter-input/.md) input


---

# SearchableIntFilterInput

No description

```
input SearchableIntFilterInput {
  ne: Int
  gt: Int
  lt: Int
  gte: Int
  lte: Int
  eq: Int
  range: [Int]
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SearchableIntFilterInput.ne`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#searchableintfilterinputneint- "Direct link to searchableintfilterinputneint-")

#### [`SearchableIntFilterInput.gt`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#searchableintfilterinputgtint- "Direct link to searchableintfilterinputgtint-")

#### [`SearchableIntFilterInput.lt`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#searchableintfilterinputltint- "Direct link to searchableintfilterinputltint-")

#### [`SearchableIntFilterInput.gte`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#searchableintfilterinputgteint- "Direct link to searchableintfilterinputgteint-")

#### [`SearchableIntFilterInput.lte`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#searchableintfilterinputlteint- "Direct link to searchableintfilterinputlteint-")

#### [`SearchableIntFilterInput.eq`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#searchableintfilterinputeqint- "Direct link to searchableintfilterinputeqint-")

#### [`SearchableIntFilterInput.range`](#) ● [`[Int]`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) list scalar[​](#searchableintfilterinputrangeint-- "Direct link to searchableintfilterinputrangeint--")

### Member Of[​](#member-of "Direct link to Member Of")

[`SearchableAccountInvoiceFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-account-invoice-filter-input/.md) input ● [`SearchableAccountSettlementFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-account-settlement-filter-input/.md) input ● [`SearchableChargeFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-charge-filter-input/.md) input ● [`SearchableEventFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-event-filter-input/.md) input ● [`SearchableSubscriptionFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-subscription-filter-input/.md) input


---

# SearchableStringFilterInput

No description

```
input SearchableStringFilterInput {
  ne: String
  eq: String
  match: String
  matchPhrase: String
  matchPhrasePrefix: String
  exists: Boolean
  wildcard: String
  regexp: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SearchableStringFilterInput.ne`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#searchablestringfilterinputnestring- "Direct link to searchablestringfilterinputnestring-")

#### [`SearchableStringFilterInput.eq`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#searchablestringfilterinputeqstring- "Direct link to searchablestringfilterinputeqstring-")

#### [`SearchableStringFilterInput.match`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#searchablestringfilterinputmatchstring- "Direct link to searchablestringfilterinputmatchstring-")

#### [`SearchableStringFilterInput.matchPhrase`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#searchablestringfilterinputmatchphrasestring- "Direct link to searchablestringfilterinputmatchphrasestring-")

#### [`SearchableStringFilterInput.matchPhrasePrefix`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#searchablestringfilterinputmatchphraseprefixstring- "Direct link to searchablestringfilterinputmatchphraseprefixstring-")

#### [`SearchableStringFilterInput.exists`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#searchablestringfilterinputexistsboolean- "Direct link to searchablestringfilterinputexistsboolean-")

#### [`SearchableStringFilterInput.wildcard`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#searchablestringfilterinputwildcardstring- "Direct link to searchablestringfilterinputwildcardstring-")

#### [`SearchableStringFilterInput.regexp`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#searchablestringfilterinputregexpstring- "Direct link to searchablestringfilterinputregexpstring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`SearchableAccountSettlementFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-account-settlement-filter-input/.md) input ● [`SearchableChargeFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-charge-filter-input/.md) input ● [`SearchableEventFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-event-filter-input/.md) input ● [`SearchableSubscriptionFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-subscription-filter-input/.md) input


---

# SearchableSubscriptionFilterInput

No description

```
input SearchableSubscriptionFilterInput {
  id: SearchableIDFilterInput
  createdAt: SearchableIntFilterInput
  updatedAt: SearchableIntFilterInput
  amount: SearchableIntFilterInput
  currency: SearchableStringFilterInput
  description: SearchableStringFilterInput
  descriptor: SearchableStringFilterInput
  lastOrderId: SearchableStringFilterInput
  sequenceId: SearchableStringFilterInput
  status: SearchableStringFilterInput
  interval: SearchableStringFilterInput
  intervalCount: SearchableIntFilterInput
  lastPaymentId: SearchableIDFilterInput
  lastPaymentStatus: SearchableStringFilterInput
  lastPaymentStatusCode: SearchableStringFilterInput
  customerEmail: SearchableStringFilterInput
  customerName: SearchableStringFilterInput
  customerPhone: SearchableStringFilterInput
  paymentMethodMethod: SearchableStringFilterInput
  paymentMethodCardBrand: SearchableStringFilterInput
  paymentMethodCardLast4: SearchableStringFilterInput
  paymentMethodCardType: SearchableStringFilterInput
  paymentMethodCardThreeDSecure: SearchableBooleanFilterInput
  paymentMethodCardThreeDSecureVersion: SearchableStringFilterInput
  paymentMethodCardThreeDSecureFlow: SearchableStringFilterInput
  paymentMethodCardTokenizationMethod: SearchableStringFilterInput
  traceDetailsSource: SearchableStringFilterInput
  storeId: SearchableStringFilterInput
  and: [SearchableSubscriptionFilterInput]
  or: [SearchableSubscriptionFilterInput]
  not: SearchableSubscriptionFilterInput
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SearchableSubscriptionFilterInput.id`](#) ● [`SearchableIDFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-idfilter-input/.md) input[​](#searchablesubscriptionfilterinputidsearchableidfilterinput- "Direct link to searchablesubscriptionfilterinputidsearchableidfilterinput-")

#### [`SearchableSubscriptionFilterInput.createdAt`](#) ● [`SearchableIntFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-int-filter-input/.md) input[​](#searchablesubscriptionfilterinputcreatedatsearchableintfilterinput- "Direct link to searchablesubscriptionfilterinputcreatedatsearchableintfilterinput-")

#### [`SearchableSubscriptionFilterInput.updatedAt`](#) ● [`SearchableIntFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-int-filter-input/.md) input[​](#searchablesubscriptionfilterinputupdatedatsearchableintfilterinput- "Direct link to searchablesubscriptionfilterinputupdatedatsearchableintfilterinput-")

#### [`SearchableSubscriptionFilterInput.amount`](#) ● [`SearchableIntFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-int-filter-input/.md) input[​](#searchablesubscriptionfilterinputamountsearchableintfilterinput- "Direct link to searchablesubscriptionfilterinputamountsearchableintfilterinput-")

#### [`SearchableSubscriptionFilterInput.currency`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputcurrencysearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputcurrencysearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.description`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputdescriptionsearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputdescriptionsearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.descriptor`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputdescriptorsearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputdescriptorsearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.lastOrderId`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputlastorderidsearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputlastorderidsearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.sequenceId`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputsequenceidsearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputsequenceidsearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.status`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputstatussearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputstatussearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.interval`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputintervalsearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputintervalsearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.intervalCount`](#) ● [`SearchableIntFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-int-filter-input/.md) input[​](#searchablesubscriptionfilterinputintervalcountsearchableintfilterinput- "Direct link to searchablesubscriptionfilterinputintervalcountsearchableintfilterinput-")

#### [`SearchableSubscriptionFilterInput.lastPaymentId`](#) ● [`SearchableIDFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-idfilter-input/.md) input[​](#searchablesubscriptionfilterinputlastpaymentidsearchableidfilterinput- "Direct link to searchablesubscriptionfilterinputlastpaymentidsearchableidfilterinput-")

#### [`SearchableSubscriptionFilterInput.lastPaymentStatus`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputlastpaymentstatussearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputlastpaymentstatussearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.lastPaymentStatusCode`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputlastpaymentstatuscodesearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputlastpaymentstatuscodesearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.customerEmail`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputcustomeremailsearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputcustomeremailsearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.customerName`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputcustomernamesearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputcustomernamesearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.customerPhone`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputcustomerphonesearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputcustomerphonesearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.paymentMethodMethod`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputpaymentmethodmethodsearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputpaymentmethodmethodsearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.paymentMethodCardBrand`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputpaymentmethodcardbrandsearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputpaymentmethodcardbrandsearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.paymentMethodCardLast4`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputpaymentmethodcardlast4searchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputpaymentmethodcardlast4searchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.paymentMethodCardType`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputpaymentmethodcardtypesearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputpaymentmethodcardtypesearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.paymentMethodCardThreeDSecure`](#) ● [`SearchableBooleanFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-boolean-filter-input/.md) input[​](#searchablesubscriptionfilterinputpaymentmethodcardthreedsecuresearchablebooleanfilterinput- "Direct link to searchablesubscriptionfilterinputpaymentmethodcardthreedsecuresearchablebooleanfilterinput-")

#### [`SearchableSubscriptionFilterInput.paymentMethodCardThreeDSecureVersion`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputpaymentmethodcardthreedsecureversionsearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputpaymentmethodcardthreedsecureversionsearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.paymentMethodCardThreeDSecureFlow`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputpaymentmethodcardthreedsecureflowsearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputpaymentmethodcardthreedsecureflowsearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.paymentMethodCardTokenizationMethod`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputpaymentmethodcardtokenizationmethodsearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputpaymentmethodcardtokenizationmethodsearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.traceDetailsSource`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputtracedetailssourcesearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputtracedetailssourcesearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.storeId`](#) ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input[​](#searchablesubscriptionfilterinputstoreidsearchablestringfilterinput- "Direct link to searchablesubscriptionfilterinputstoreidsearchablestringfilterinput-")

#### [`SearchableSubscriptionFilterInput.and`](#) ● [`[SearchableSubscriptionFilterInput]`](https://docs.monei.com/apis/graphql/types/inputs/searchable-subscription-filter-input/.md) list input[​](#searchablesubscriptionfilterinputandsearchablesubscriptionfilterinput-- "Direct link to searchablesubscriptionfilterinputandsearchablesubscriptionfilterinput--")

#### [`SearchableSubscriptionFilterInput.or`](#) ● [`[SearchableSubscriptionFilterInput]`](https://docs.monei.com/apis/graphql/types/inputs/searchable-subscription-filter-input/.md) list input[​](#searchablesubscriptionfilterinputorsearchablesubscriptionfilterinput-- "Direct link to searchablesubscriptionfilterinputorsearchablesubscriptionfilterinput--")

#### [`SearchableSubscriptionFilterInput.not`](#) ● [`SearchableSubscriptionFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-subscription-filter-input/.md) input[​](#searchablesubscriptionfilterinputnotsearchablesubscriptionfilterinput- "Direct link to searchablesubscriptionfilterinputnotsearchablesubscriptionfilterinput-")

### Member Of[​](#member-of "Direct link to Member Of")

[`SearchableSubscriptionFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-subscription-filter-input/.md) input ● [`subscriptions`](https://docs.monei.com/apis/graphql/operations/queries/subscriptions/.md) query


---

# SendPaymentMessageInput

No description

```
input SendPaymentMessageInput {
  channel: MessageChannel
  customerEmail: AWSEmail
  customerPhone: AWSPhone
  language: String
  paymentId: ID!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SendPaymentMessageInput.channel`](#) ● [`MessageChannel`](https://docs.monei.com/apis/graphql/types/enums/message-channel/.md) enum[​](#sendpaymentmessageinputchannelmessagechannel- "Direct link to sendpaymentmessageinputchannelmessagechannel-")

#### [`SendPaymentMessageInput.customerEmail`](#) ● [`AWSEmail`](https://docs.monei.com/apis/graphql/types/scalars/awsemail/.md) scalar[​](#sendpaymentmessageinputcustomeremailawsemail- "Direct link to sendpaymentmessageinputcustomeremailawsemail-")

#### [`SendPaymentMessageInput.customerPhone`](#) ● [`AWSPhone`](https://docs.monei.com/apis/graphql/types/scalars/awsphone/.md) scalar[​](#sendpaymentmessageinputcustomerphoneawsphone- "Direct link to sendpaymentmessageinputcustomerphoneawsphone-")

#### [`SendPaymentMessageInput.language`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sendpaymentmessageinputlanguagestring- "Direct link to sendpaymentmessageinputlanguagestring-")

#### [`SendPaymentMessageInput.paymentId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#sendpaymentmessageinputpaymentidid-- "Direct link to sendpaymentmessageinputpaymentidid--")

### Member Of[​](#member-of "Direct link to Member Of")

[`sendPaymentLink`](https://docs.monei.com/apis/graphql/operations/mutations/send-payment-link/.md) mutation ● [`sendPaymentReceipt`](https://docs.monei.com/apis/graphql/operations/mutations/send-payment-receipt/.md) mutation


---

# SendPaymentRequestInput

No description

```
input SendPaymentRequestInput {
  paymentId: ID!
  phoneNumber: String!
  language: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SendPaymentRequestInput.paymentId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#sendpaymentrequestinputpaymentidid-- "Direct link to sendpaymentrequestinputpaymentidid--")

#### [`SendPaymentRequestInput.phoneNumber`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#sendpaymentrequestinputphonenumberstring-- "Direct link to sendpaymentrequestinputphonenumberstring--")

#### [`SendPaymentRequestInput.language`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sendpaymentrequestinputlanguagestring- "Direct link to sendpaymentrequestinputlanguagestring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`sendPaymentRequest`](https://docs.monei.com/apis/graphql/operations/mutations/send-payment-request/.md) mutation


---

# SendSubscriptionMessageInput

No description

```
input SendSubscriptionMessageInput {
  channel: MessageChannel
  customerEmail: AWSEmail
  customerPhone: AWSPhone
  language: String
  subscriptionId: ID!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SendSubscriptionMessageInput.channel`](#) ● [`MessageChannel`](https://docs.monei.com/apis/graphql/types/enums/message-channel/.md) enum[​](#sendsubscriptionmessageinputchannelmessagechannel- "Direct link to sendsubscriptionmessageinputchannelmessagechannel-")

#### [`SendSubscriptionMessageInput.customerEmail`](#) ● [`AWSEmail`](https://docs.monei.com/apis/graphql/types/scalars/awsemail/.md) scalar[​](#sendsubscriptionmessageinputcustomeremailawsemail- "Direct link to sendsubscriptionmessageinputcustomeremailawsemail-")

#### [`SendSubscriptionMessageInput.customerPhone`](#) ● [`AWSPhone`](https://docs.monei.com/apis/graphql/types/scalars/awsphone/.md) scalar[​](#sendsubscriptionmessageinputcustomerphoneawsphone- "Direct link to sendsubscriptionmessageinputcustomerphoneawsphone-")

#### [`SendSubscriptionMessageInput.language`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sendsubscriptionmessageinputlanguagestring- "Direct link to sendsubscriptionmessageinputlanguagestring-")

#### [`SendSubscriptionMessageInput.subscriptionId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#sendsubscriptionmessageinputsubscriptionidid-- "Direct link to sendsubscriptionmessageinputsubscriptionidid--")

### Member Of[​](#member-of "Direct link to Member Of")

[`sendSubscriptionLink`](https://docs.monei.com/apis/graphql/operations/mutations/send-subscription-link/.md) mutation ● [`sendSubscriptionStatus`](https://docs.monei.com/apis/graphql/operations/mutations/send-subscription-status/.md) mutation


---

# SessionDetailsInput

No description

```
input SessionDetailsInput {
  ip: AWSIPAddress
  userAgent: String
  countryCode: String
  lang: String
  deviceType: DeviceType
  deviceModel: String
  browser: String
  browserVersion: String
  browserAccept: String
  browserColorDepth: String
  browserScreenHeight: String
  browserScreenWidth: String
  browserTimezoneOffset: String
  os: String
  osVersion: String
  source: String
  sourceVersion: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SessionDetailsInput.ip`](#) ● [`AWSIPAddress`](https://docs.monei.com/apis/graphql/types/scalars/awsipaddress/.md) scalar[​](#sessiondetailsinputipawsipaddress- "Direct link to sessiondetailsinputipawsipaddress-")

#### [`SessionDetailsInput.userAgent`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsinputuseragentstring- "Direct link to sessiondetailsinputuseragentstring-")

#### [`SessionDetailsInput.countryCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsinputcountrycodestring- "Direct link to sessiondetailsinputcountrycodestring-")

#### [`SessionDetailsInput.lang`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsinputlangstring- "Direct link to sessiondetailsinputlangstring-")

#### [`SessionDetailsInput.deviceType`](#) ● [`DeviceType`](https://docs.monei.com/apis/graphql/types/enums/device-type/.md) enum[​](#sessiondetailsinputdevicetypedevicetype- "Direct link to sessiondetailsinputdevicetypedevicetype-")

#### [`SessionDetailsInput.deviceModel`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsinputdevicemodelstring- "Direct link to sessiondetailsinputdevicemodelstring-")

#### [`SessionDetailsInput.browser`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsinputbrowserstring- "Direct link to sessiondetailsinputbrowserstring-")

#### [`SessionDetailsInput.browserVersion`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsinputbrowserversionstring- "Direct link to sessiondetailsinputbrowserversionstring-")

#### [`SessionDetailsInput.browserAccept`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsinputbrowseracceptstring- "Direct link to sessiondetailsinputbrowseracceptstring-")

#### [`SessionDetailsInput.browserColorDepth`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsinputbrowsercolordepthstring- "Direct link to sessiondetailsinputbrowsercolordepthstring-")

#### [`SessionDetailsInput.browserScreenHeight`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsinputbrowserscreenheightstring- "Direct link to sessiondetailsinputbrowserscreenheightstring-")

#### [`SessionDetailsInput.browserScreenWidth`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsinputbrowserscreenwidthstring- "Direct link to sessiondetailsinputbrowserscreenwidthstring-")

#### [`SessionDetailsInput.browserTimezoneOffset`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsinputbrowsertimezoneoffsetstring- "Direct link to sessiondetailsinputbrowsertimezoneoffsetstring-")

#### [`SessionDetailsInput.os`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsinputosstring- "Direct link to sessiondetailsinputosstring-")

#### [`SessionDetailsInput.osVersion`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsinputosversionstring- "Direct link to sessiondetailsinputosversionstring-")

#### [`SessionDetailsInput.source`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsinputsourcestring- "Direct link to sessiondetailsinputsourcestring-")

#### [`SessionDetailsInput.sourceVersion`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsinputsourceversionstring- "Direct link to sessiondetailsinputsourceversionstring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`UpdateChargeInput`](https://docs.monei.com/apis/graphql/types/inputs/update-charge-input/.md) input


---

# SetupAccountInput

Setup account input

```
input SetupAccountInput {
  language: String
  business: BusinessDataInput
  representatives: [RepresentativeInput!]
  iban: String
  billingPlan: BillingPlans
  userNote: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SetupAccountInput.language`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#setupaccountinputlanguagestring- "Direct link to setupaccountinputlanguagestring-")

The preferred account language

#### [`SetupAccountInput.business`](#) ● [`BusinessDataInput`](https://docs.monei.com/apis/graphql/types/inputs/business-data-input/.md) input[​](#setupaccountinputbusinessbusinessdatainput- "Direct link to setupaccountinputbusinessbusinessdatainput-")

Business data

#### [`SetupAccountInput.representatives`](#) ● [`[RepresentativeInput!]`](https://docs.monei.com/apis/graphql/types/inputs/representative-input/.md) list input[​](#setupaccountinputrepresentativesrepresentativeinput-- "Direct link to setupaccountinputrepresentativesrepresentativeinput--")

Legal representatives

#### [`SetupAccountInput.iban`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#setupaccountinputibanstring- "Direct link to setupaccountinputibanstring-")

IBAN number to receive payments

#### [`SetupAccountInput.billingPlan`](#) ● [`BillingPlans`](https://docs.monei.com/apis/graphql/types/enums/billing-plans/.md) enum[​](#setupaccountinputbillingplanbillingplans- "Direct link to setupaccountinputbillingplanbillingplans-")

Billing plan

#### [`SetupAccountInput.userNote`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#setupaccountinputusernotestring- "Direct link to setupaccountinputusernotestring-")

User provided note

### Member Of[​](#member-of "Direct link to Member Of")

[`setupAccount`](https://docs.monei.com/apis/graphql/operations/mutations/setup-account/.md) mutation ● [`verifyBusinessDetails`](https://docs.monei.com/apis/graphql/operations/mutations/verify-business-details/.md) mutation


---

# ShopInput

No description

```
input ShopInput {
  name: String
  country: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ShopInput.name`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#shopinputnamestring- "Direct link to shopinputnamestring-")

#### [`ShopInput.country`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#shopinputcountrystring- "Direct link to shopinputcountrystring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`UpdateChargeInput`](https://docs.monei.com/apis/graphql/types/inputs/update-charge-input/.md) input


---

# SubscriptionEventsChangeInput

No description

```
input SubscriptionEventsChangeInput {
  id: ID!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SubscriptionEventsChangeInput.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#subscriptioneventschangeinputidid-- "Direct link to subscriptioneventschangeinputidid--")

### Member Of[​](#member-of "Direct link to Member Of")

[`publishUpdateSubscriptionEvents`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-subscription-events/.md) mutation


---

# TraceDetailsInput

No description

```
input TraceDetailsInput {
  ip: AWSIPAddress
  userAgent: String
  countryCode: String
  lang: String
  deviceType: DeviceType
  deviceModel: String
  browser: String
  browserVersion: String
  browserAccept: String
  os: String
  osVersion: String
  source: String
  sourceVersion: String
  userId: ID
  userEmail: String
  userName: String
  comment: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`TraceDetailsInput.ip`](#) ● [`AWSIPAddress`](https://docs.monei.com/apis/graphql/types/scalars/awsipaddress/.md) scalar[​](#tracedetailsinputipawsipaddress- "Direct link to tracedetailsinputipawsipaddress-")

#### [`TraceDetailsInput.userAgent`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsinputuseragentstring- "Direct link to tracedetailsinputuseragentstring-")

#### [`TraceDetailsInput.countryCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsinputcountrycodestring- "Direct link to tracedetailsinputcountrycodestring-")

#### [`TraceDetailsInput.lang`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsinputlangstring- "Direct link to tracedetailsinputlangstring-")

#### [`TraceDetailsInput.deviceType`](#) ● [`DeviceType`](https://docs.monei.com/apis/graphql/types/enums/device-type/.md) enum[​](#tracedetailsinputdevicetypedevicetype- "Direct link to tracedetailsinputdevicetypedevicetype-")

#### [`TraceDetailsInput.deviceModel`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsinputdevicemodelstring- "Direct link to tracedetailsinputdevicemodelstring-")

#### [`TraceDetailsInput.browser`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsinputbrowserstring- "Direct link to tracedetailsinputbrowserstring-")

#### [`TraceDetailsInput.browserVersion`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsinputbrowserversionstring- "Direct link to tracedetailsinputbrowserversionstring-")

#### [`TraceDetailsInput.browserAccept`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsinputbrowseracceptstring- "Direct link to tracedetailsinputbrowseracceptstring-")

#### [`TraceDetailsInput.os`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsinputosstring- "Direct link to tracedetailsinputosstring-")

#### [`TraceDetailsInput.osVersion`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsinputosversionstring- "Direct link to tracedetailsinputosversionstring-")

#### [`TraceDetailsInput.source`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsinputsourcestring- "Direct link to tracedetailsinputsourcestring-")

#### [`TraceDetailsInput.sourceVersion`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsinputsourceversionstring- "Direct link to tracedetailsinputsourceversionstring-")

#### [`TraceDetailsInput.userId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#tracedetailsinputuseridid- "Direct link to tracedetailsinputuseridid-")

#### [`TraceDetailsInput.userEmail`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsinputuseremailstring- "Direct link to tracedetailsinputuseremailstring-")

#### [`TraceDetailsInput.userName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsinputusernamestring- "Direct link to tracedetailsinputusernamestring-")

#### [`TraceDetailsInput.comment`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsinputcommentstring- "Direct link to tracedetailsinputcommentstring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`UpdateChargeInput`](https://docs.monei.com/apis/graphql/types/inputs/update-charge-input/.md) input


---

# UpdateAccountInput

Update account input

```
input UpdateAccountInput {
  branding: AccountBrandingInput
  publicBusinessDetails: AccountPublicBusinessDetailsInput
  timezone: String
  language: String
  notifications: AccountNotificationsInput
  name: String
  fraudDetectorThreshold: Int
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UpdateAccountInput.branding`](#) ● [`AccountBrandingInput`](https://docs.monei.com/apis/graphql/types/inputs/account-branding-input/.md) input[​](#updateaccountinputbrandingaccountbrandinginput- "Direct link to updateaccountinputbrandingaccountbrandinginput-")

branding information

#### [`UpdateAccountInput.publicBusinessDetails`](#) ● [`AccountPublicBusinessDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/account-public-business-details-input/.md) input[​](#updateaccountinputpublicbusinessdetailsaccountpublicbusinessdetailsinput- "Direct link to updateaccountinputpublicbusinessdetailsaccountpublicbusinessdetailsinput-")

Public business information

#### [`UpdateAccountInput.timezone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updateaccountinputtimezonestring- "Direct link to updateaccountinputtimezonestring-")

The account default timezone

#### [`UpdateAccountInput.language`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updateaccountinputlanguagestring- "Direct link to updateaccountinputlanguagestring-")

The preferred account language

#### [`UpdateAccountInput.notifications`](#) ● [`AccountNotificationsInput`](https://docs.monei.com/apis/graphql/types/inputs/account-notifications-input/.md) input[​](#updateaccountinputnotificationsaccountnotificationsinput- "Direct link to updateaccountinputnotificationsaccountnotificationsinput-")

Account notifications

#### [`UpdateAccountInput.name`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updateaccountinputnamestring- "Direct link to updateaccountinputnamestring-")

Account name

#### [`UpdateAccountInput.fraudDetectorThreshold`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#updateaccountinputfrauddetectorthresholdint- "Direct link to updateaccountinputfrauddetectorthresholdint-")

Fraud detector threshold is a number between 0 and 1000, 0 is the lowest risk and 1000 is the highest risk

### Member Of[​](#member-of "Direct link to Member Of")

[`updateAccount`](https://docs.monei.com/apis/graphql/operations/mutations/update-account/.md) mutation


---

# UpdateApplePayCertInput

No description

```
input UpdateApplePayCertInput {
  id: ID!
  active: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UpdateApplePayCertInput.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#updateapplepaycertinputidid-- "Direct link to updateapplepaycertinputidid--")

Apple Pay certificate ID

#### [`UpdateApplePayCertInput.active`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#updateapplepaycertinputactiveboolean- "Direct link to updateapplepaycertinputactiveboolean-")

Whether the certificate is active or not

### Member Of[​](#member-of "Direct link to Member Of")

[`updateApplePayCert`](https://docs.monei.com/apis/graphql/operations/mutations/update-apple-pay-cert/.md) mutation


---

# UpdateAuthorizedUserInput

No description

```
input UpdateAuthorizedUserInput {
  userEmail: String!
  accessLevel: AuthorizedUserAccessLevel
  storeId: ID
  pointOfSaleId: ID
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UpdateAuthorizedUserInput.userEmail`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#updateauthorizeduserinputuseremailstring-- "Direct link to updateauthorizeduserinputuseremailstring--")

Email address of the authorized user to be updated

#### [`UpdateAuthorizedUserInput.accessLevel`](#) ● [`AuthorizedUserAccessLevel`](https://docs.monei.com/apis/graphql/types/enums/authorized-user-access-level/.md) enum[​](#updateauthorizeduserinputaccesslevelauthorizeduseraccesslevel- "Direct link to updateauthorizeduserinputaccesslevelauthorizeduseraccesslevel-")

Access level for the authorized user granted by the authorizer

#### [`UpdateAuthorizedUserInput.storeId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#updateauthorizeduserinputstoreidid- "Direct link to updateauthorizeduserinputstoreidid-")

Limit access to a specific store

#### [`UpdateAuthorizedUserInput.pointOfSaleId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#updateauthorizeduserinputpointofsaleidid- "Direct link to updateauthorizeduserinputpointofsaleidid-")

Limit access to a specific point of sale

### Member Of[​](#member-of "Direct link to Member Of")

[`updateAuthorizedUser`](https://docs.monei.com/apis/graphql/operations/mutations/update-authorized-user/.md) mutation


---

# UpdateChargeInput

No description

```
input UpdateChargeInput {
  id: ID!
  accountId: ID!
  providerId: ID
  checkoutId: ID!
  providerInternalId: ID
  providerReferenceId: ID
  subscriptionId: ID
  createdAt: AWSTimestamp
  updatedAt: AWSTimestamp
  amount: Int
  authorizationCode: String
  billingDetails: ContactDetailsInput
  billingPlan: BillingPlans
  currency: String!
  customer: CustomerInput
  description: String
  descriptor: String
  livemode: Boolean
  orderId: ID
  storeId: ID
  pointOfSaleId: ID
  terminalId: ID
  sequenceId: ID
  paymentMethod: PaymentMethodInput
  cancellationReason: CancellationReason
  lastRefundAmount: Int
  lastRefundReason: RefundReason
  refundedAmount: Int
  shippingDetails: ContactDetailsInput
  shop: ShopInput
  status: ChargeStatus!
  statusCode: String
  statusMessage: String
  sessionDetails: SessionDetailsInput
  traceDetails: TraceDetailsInput
  pageOpenedAt: AWSTimestamp
  metadata: [KeyValueInput!]
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UpdateChargeInput.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#updatechargeinputidid-- "Direct link to updatechargeinputidid--")

#### [`UpdateChargeInput.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#updatechargeinputaccountidid-- "Direct link to updatechargeinputaccountidid--")

#### [`UpdateChargeInput.providerId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#updatechargeinputprovideridid- "Direct link to updatechargeinputprovideridid-")

#### [`UpdateChargeInput.checkoutId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#updatechargeinputcheckoutidid-- "Direct link to updatechargeinputcheckoutidid--")

#### [`UpdateChargeInput.providerInternalId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#updatechargeinputproviderinternalidid- "Direct link to updatechargeinputproviderinternalidid-")

#### [`UpdateChargeInput.providerReferenceId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#updatechargeinputproviderreferenceidid- "Direct link to updatechargeinputproviderreferenceidid-")

#### [`UpdateChargeInput.subscriptionId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#updatechargeinputsubscriptionidid- "Direct link to updatechargeinputsubscriptionidid-")

#### [`UpdateChargeInput.createdAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#updatechargeinputcreatedatawstimestamp- "Direct link to updatechargeinputcreatedatawstimestamp-")

#### [`UpdateChargeInput.updatedAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#updatechargeinputupdatedatawstimestamp- "Direct link to updatechargeinputupdatedatawstimestamp-")

#### [`UpdateChargeInput.amount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#updatechargeinputamountint- "Direct link to updatechargeinputamountint-")

#### [`UpdateChargeInput.authorizationCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updatechargeinputauthorizationcodestring- "Direct link to updatechargeinputauthorizationcodestring-")

#### [`UpdateChargeInput.billingDetails`](#) ● [`ContactDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/contact-details-input/.md) input[​](#updatechargeinputbillingdetailscontactdetailsinput- "Direct link to updatechargeinputbillingdetailscontactdetailsinput-")

#### [`UpdateChargeInput.billingPlan`](#) ● [`BillingPlans`](https://docs.monei.com/apis/graphql/types/enums/billing-plans/.md) enum[​](#updatechargeinputbillingplanbillingplans- "Direct link to updatechargeinputbillingplanbillingplans-")

#### [`UpdateChargeInput.currency`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#updatechargeinputcurrencystring-- "Direct link to updatechargeinputcurrencystring--")

#### [`UpdateChargeInput.customer`](#) ● [`CustomerInput`](https://docs.monei.com/apis/graphql/types/inputs/customer-input/.md) input[​](#updatechargeinputcustomercustomerinput- "Direct link to updatechargeinputcustomercustomerinput-")

#### [`UpdateChargeInput.description`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updatechargeinputdescriptionstring- "Direct link to updatechargeinputdescriptionstring-")

#### [`UpdateChargeInput.descriptor`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updatechargeinputdescriptorstring- "Direct link to updatechargeinputdescriptorstring-")

#### [`UpdateChargeInput.livemode`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#updatechargeinputlivemodeboolean- "Direct link to updatechargeinputlivemodeboolean-")

#### [`UpdateChargeInput.orderId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#updatechargeinputorderidid- "Direct link to updatechargeinputorderidid-")

#### [`UpdateChargeInput.storeId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#updatechargeinputstoreidid- "Direct link to updatechargeinputstoreidid-")

#### [`UpdateChargeInput.pointOfSaleId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#updatechargeinputpointofsaleidid- "Direct link to updatechargeinputpointofsaleidid-")

#### [`UpdateChargeInput.terminalId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#updatechargeinputterminalidid- "Direct link to updatechargeinputterminalidid-")

#### [`UpdateChargeInput.sequenceId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#updatechargeinputsequenceidid- "Direct link to updatechargeinputsequenceidid-")

#### [`UpdateChargeInput.paymentMethod`](#) ● [`PaymentMethodInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-input/.md) input[​](#updatechargeinputpaymentmethodpaymentmethodinput- "Direct link to updatechargeinputpaymentmethodpaymentmethodinput-")

#### [`UpdateChargeInput.cancellationReason`](#) ● [`CancellationReason`](https://docs.monei.com/apis/graphql/types/enums/cancellation-reason/.md) enum[​](#updatechargeinputcancellationreasoncancellationreason- "Direct link to updatechargeinputcancellationreasoncancellationreason-")

#### [`UpdateChargeInput.lastRefundAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#updatechargeinputlastrefundamountint- "Direct link to updatechargeinputlastrefundamountint-")

#### [`UpdateChargeInput.lastRefundReason`](#) ● [`RefundReason`](https://docs.monei.com/apis/graphql/types/enums/refund-reason/.md) enum[​](#updatechargeinputlastrefundreasonrefundreason- "Direct link to updatechargeinputlastrefundreasonrefundreason-")

#### [`UpdateChargeInput.refundedAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#updatechargeinputrefundedamountint- "Direct link to updatechargeinputrefundedamountint-")

#### [`UpdateChargeInput.shippingDetails`](#) ● [`ContactDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/contact-details-input/.md) input[​](#updatechargeinputshippingdetailscontactdetailsinput- "Direct link to updatechargeinputshippingdetailscontactdetailsinput-")

#### [`UpdateChargeInput.shop`](#) ● [`ShopInput`](https://docs.monei.com/apis/graphql/types/inputs/shop-input/.md) input[​](#updatechargeinputshopshopinput- "Direct link to updatechargeinputshopshopinput-")

#### [`UpdateChargeInput.status`](#) ● [`ChargeStatus!`](https://docs.monei.com/apis/graphql/types/enums/charge-status/.md) non-null enum[​](#updatechargeinputstatuschargestatus-- "Direct link to updatechargeinputstatuschargestatus--")

#### [`UpdateChargeInput.statusCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updatechargeinputstatuscodestring- "Direct link to updatechargeinputstatuscodestring-")

#### [`UpdateChargeInput.statusMessage`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updatechargeinputstatusmessagestring- "Direct link to updatechargeinputstatusmessagestring-")

#### [`UpdateChargeInput.sessionDetails`](#) ● [`SessionDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/session-details-input/.md) input[​](#updatechargeinputsessiondetailssessiondetailsinput- "Direct link to updatechargeinputsessiondetailssessiondetailsinput-")

#### [`UpdateChargeInput.traceDetails`](#) ● [`TraceDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/trace-details-input/.md) input[​](#updatechargeinputtracedetailstracedetailsinput- "Direct link to updatechargeinputtracedetailstracedetailsinput-")

#### [`UpdateChargeInput.pageOpenedAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#updatechargeinputpageopenedatawstimestamp- "Direct link to updatechargeinputpageopenedatawstimestamp-")

#### [`UpdateChargeInput.metadata`](#) ● [`[KeyValueInput!]`](https://docs.monei.com/apis/graphql/types/inputs/key-value-input/.md) list input[​](#updatechargeinputmetadatakeyvalueinput-- "Direct link to updatechargeinputmetadatakeyvalueinput--")

### Member Of[​](#member-of "Direct link to Member Of")

[`publishUpdateCharge`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-charge/.md) mutation


---

# UpdateCodeInput

No description

```
input UpdateCodeInput {
  id: ID!
  enabled: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UpdateCodeInput.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#updatecodeinputidid-- "Direct link to updatecodeinputidid--")

The Code ID

#### [`UpdateCodeInput.enabled`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#updatecodeinputenabledboolean- "Direct link to updatecodeinputenabledboolean-")

Whether the code is enabled or not

### Member Of[​](#member-of "Direct link to Member Of")

[`updateCode`](https://docs.monei.com/apis/graphql/operations/mutations/update-code/.md) mutation


---

# UpdateExportSftpConfigInput

No description

```
input UpdateExportSftpConfigInput {
  id: ID!
  host: String
  port: Int
  username: String
  password: String
  path: String
  columns: [String!]
  timezone: String
  enabled: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UpdateExportSftpConfigInput.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#updateexportsftpconfiginputidid-- "Direct link to updateexportsftpconfiginputidid--")

#### [`UpdateExportSftpConfigInput.host`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updateexportsftpconfiginputhoststring- "Direct link to updateexportsftpconfiginputhoststring-")

#### [`UpdateExportSftpConfigInput.port`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#updateexportsftpconfiginputportint- "Direct link to updateexportsftpconfiginputportint-")

#### [`UpdateExportSftpConfigInput.username`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updateexportsftpconfiginputusernamestring- "Direct link to updateexportsftpconfiginputusernamestring-")

#### [`UpdateExportSftpConfigInput.password`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updateexportsftpconfiginputpasswordstring- "Direct link to updateexportsftpconfiginputpasswordstring-")

#### [`UpdateExportSftpConfigInput.path`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updateexportsftpconfiginputpathstring- "Direct link to updateexportsftpconfiginputpathstring-")

#### [`UpdateExportSftpConfigInput.columns`](#) ● [`[String!]`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) list scalar[​](#updateexportsftpconfiginputcolumnsstring-- "Direct link to updateexportsftpconfiginputcolumnsstring--")

#### [`UpdateExportSftpConfigInput.timezone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updateexportsftpconfiginputtimezonestring- "Direct link to updateexportsftpconfiginputtimezonestring-")

#### [`UpdateExportSftpConfigInput.enabled`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#updateexportsftpconfiginputenabledboolean- "Direct link to updateexportsftpconfiginputenabledboolean-")

### Member Of[​](#member-of "Direct link to Member Of")

[`updateExportSftpConfig`](https://docs.monei.com/apis/graphql/operations/mutations/update-export-sftp-config/.md) mutation


---

# UpdatePaymentRuleInput

Input for updating a payment rule

```
input UpdatePaymentRuleInput {
  id: ID!
  ruleType: PaymentRuleType
  conditions: PaymentConditionsInput
  action: PaymentActionInput
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UpdatePaymentRuleInput.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#updatepaymentruleinputidid-- "Direct link to updatepaymentruleinputidid--")

Rule ID to update

#### [`UpdatePaymentRuleInput.ruleType`](#) ● [`PaymentRuleType`](https://docs.monei.com/apis/graphql/types/enums/payment-rule-type/.md) enum[​](#updatepaymentruleinputruletypepaymentruletype- "Direct link to updatepaymentruleinputruletypepaymentruletype-")

Type of payment rule

#### [`UpdatePaymentRuleInput.conditions`](#) ● [`PaymentConditionsInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-conditions-input/.md) input[​](#updatepaymentruleinputconditionspaymentconditionsinput- "Direct link to updatepaymentruleinputconditionspaymentconditionsinput-")

The conditions that must be met for this rule to apply

#### [`UpdatePaymentRuleInput.action`](#) ● [`PaymentActionInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-action-input/.md) input[​](#updatepaymentruleinputactionpaymentactioninput- "Direct link to updatepaymentruleinputactionpaymentactioninput-")

The action to take when conditions are met

### Member Of[​](#member-of "Direct link to Member Of")

[`updatePaymentRule`](https://docs.monei.com/apis/graphql/operations/mutations/update-payment-rule/.md) mutation


---

# UpdatePointOfSaleInput

No description

```
input UpdatePointOfSaleInput {
  id: ID!
  storeId: ID
  name: String
  description: String
  manualAmount: Boolean
  requireEmail: Boolean
  requireTaxId: Boolean
  fixedAmount: Int
  fixedCurrency: Currencies
  enabled: Boolean
  includeQRCode: Boolean
  qrCodeText: String
  paymentCallbackUrl: String
  transactionType: TransactionTypes
  paymentMethods: [PaymentMethods!]
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UpdatePointOfSaleInput.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#updatepointofsaleinputidid-- "Direct link to updatepointofsaleinputidid--")

The ID of the point of sale

#### [`UpdatePointOfSaleInput.storeId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#updatepointofsaleinputstoreidid- "Direct link to updatepointofsaleinputstoreidid-")

Store's ID where this point of sale belongs

#### [`UpdatePointOfSaleInput.name`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updatepointofsaleinputnamestring- "Direct link to updatepointofsaleinputnamestring-")

A name that represents the point of sale

#### [`UpdatePointOfSaleInput.description`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updatepointofsaleinputdescriptionstring- "Direct link to updatepointofsaleinputdescriptionstring-")

The description of the point of sale

#### [`UpdatePointOfSaleInput.manualAmount`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#updatepointofsaleinputmanualamountboolean- "Direct link to updatepointofsaleinputmanualamountboolean-")

Whether the user can manually enter the amount or not

#### [`UpdatePointOfSaleInput.requireEmail`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#updatepointofsaleinputrequireemailboolean- "Direct link to updatepointofsaleinputrequireemailboolean-")

Whether the user must provide an email address or not

#### [`UpdatePointOfSaleInput.requireTaxId`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#updatepointofsaleinputrequiretaxidboolean- "Direct link to updatepointofsaleinputrequiretaxidboolean-")

Whether the user must provide a tax ID or not

#### [`UpdatePointOfSaleInput.fixedAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#updatepointofsaleinputfixedamountint- "Direct link to updatepointofsaleinputfixedamountint-")

Fixed amount to be charged

#### [`UpdatePointOfSaleInput.fixedCurrency`](#) ● [`Currencies`](https://docs.monei.com/apis/graphql/types/enums/currencies/.md) enum[​](#updatepointofsaleinputfixedcurrencycurrencies- "Direct link to updatepointofsaleinputfixedcurrencycurrencies-")

Fixed currency to be charged

#### [`UpdatePointOfSaleInput.enabled`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#updatepointofsaleinputenabledboolean- "Direct link to updatepointofsaleinputenabledboolean-")

Whether the point of sale is enabled or not

#### [`UpdatePointOfSaleInput.includeQRCode`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#updatepointofsaleinputincludeqrcodeboolean- "Direct link to updatepointofsaleinputincludeqrcodeboolean-")

Whether the user must provide a fixed amount or not

#### [`UpdatePointOfSaleInput.qrCodeText`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updatepointofsaleinputqrcodetextstring- "Direct link to updatepointofsaleinputqrcodetextstring-")

QR code text

#### [`UpdatePointOfSaleInput.paymentCallbackUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updatepointofsaleinputpaymentcallbackurlstring- "Direct link to updatepointofsaleinputpaymentcallbackurlstring-")

The URL where to notify a success payment (server-to-server HTTP POST request)

#### [`UpdatePointOfSaleInput.transactionType`](#) ● [`TransactionTypes`](https://docs.monei.com/apis/graphql/types/enums/transaction-types/.md) enum[​](#updatepointofsaleinputtransactiontypetransactiontypes- "Direct link to updatepointofsaleinputtransactiontypetransactiontypes-")

The type of the transaction

#### [`UpdatePointOfSaleInput.paymentMethods`](#) ● [`[PaymentMethods!]`](https://docs.monei.com/apis/graphql/types/enums/payment-methods/.md) list enum[​](#updatepointofsaleinputpaymentmethodspaymentmethods-- "Direct link to updatepointofsaleinputpaymentmethodspaymentmethods--")

The payment methods allowed for the point of sale

### Member Of[​](#member-of "Direct link to Member Of")

[`updatePointOfSale`](https://docs.monei.com/apis/graphql/operations/mutations/update-point-of-sale/.md) mutation


---

# UpdateProviderInput

No description

```
input UpdateProviderInput {
  id: ID!
  enabled: Boolean
  acquirer: Acquirer
  metadata: [MetadataItemInput!]
  rules: ProviderRulesInput
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UpdateProviderInput.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#updateproviderinputidid-- "Direct link to updateproviderinputidid--")

The Provider ID

#### [`UpdateProviderInput.enabled`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#updateproviderinputenabledboolean- "Direct link to updateproviderinputenabledboolean-")

Whether the provider is enabled or not

#### [`UpdateProviderInput.acquirer`](#) ● [`Acquirer`](https://docs.monei.com/apis/graphql/types/enums/acquirer/.md) enum[​](#updateproviderinputacquireracquirer- "Direct link to updateproviderinputacquireracquirer-")

The acquirer

#### [`UpdateProviderInput.metadata`](#) ● [`[MetadataItemInput!]`](https://docs.monei.com/apis/graphql/types/inputs/metadata-item-input/.md) list input[​](#updateproviderinputmetadatametadataiteminput-- "Direct link to updateproviderinputmetadatametadataiteminput--")

Metadata

#### [`UpdateProviderInput.rules`](#) ● [`ProviderRulesInput`](https://docs.monei.com/apis/graphql/types/inputs/provider-rules-input/.md) input[​](#updateproviderinputrulesproviderrulesinput- "Direct link to updateproviderinputrulesproviderrulesinput-")

Rules for the provider

### Member Of[​](#member-of "Direct link to Member Of")

[`updateProvider`](https://docs.monei.com/apis/graphql/operations/mutations/update-provider/.md) mutation


---

# UpdateShopifyShopSettingsInput

No description

```
input UpdateShopifyShopSettingsInput {
  shop: String!
  paymentMethod: String!
  countryStores: [CountryStoreInput!]
  testMode: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UpdateShopifyShopSettingsInput.shop`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#updateshopifyshopsettingsinputshopstring-- "Direct link to updateshopifyshopsettingsinputshopstring--")

#### [`UpdateShopifyShopSettingsInput.paymentMethod`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#updateshopifyshopsettingsinputpaymentmethodstring-- "Direct link to updateshopifyshopsettingsinputpaymentmethodstring--")

#### [`UpdateShopifyShopSettingsInput.countryStores`](#) ● [`[CountryStoreInput!]`](https://docs.monei.com/apis/graphql/types/inputs/country-store-input/.md) list input[​](#updateshopifyshopsettingsinputcountrystorescountrystoreinput-- "Direct link to updateshopifyshopsettingsinputcountrystorescountrystoreinput--")

#### [`UpdateShopifyShopSettingsInput.testMode`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#updateshopifyshopsettingsinputtestmodeboolean- "Direct link to updateshopifyshopsettingsinputtestmodeboolean-")

### Member Of[​](#member-of "Direct link to Member Of")

[`updateShopifyShopSettings`](https://docs.monei.com/apis/graphql/operations/mutations/update-shopify-shop-settings/.md) mutation


---

# UpdateStoreInput

No description

```
input UpdateStoreInput {
  id: ID!
  name: String
  address: AddressInput
  phone: String
  email: String
  website: String
  metadata: [KeyValueInput!]
  blocked: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UpdateStoreInput.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#updatestoreinputidid-- "Direct link to updatestoreinputidid--")

The Store's ID

#### [`UpdateStoreInput.name`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updatestoreinputnamestring- "Direct link to updatestoreinputnamestring-")

A name that represents the store

#### [`UpdateStoreInput.address`](#) ● [`AddressInput`](https://docs.monei.com/apis/graphql/types/inputs/address-input/.md) input[​](#updatestoreinputaddressaddressinput- "Direct link to updatestoreinputaddressaddressinput-")

The store's address

#### [`UpdateStoreInput.phone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updatestoreinputphonestring- "Direct link to updatestoreinputphonestring-")

The store's phone number

#### [`UpdateStoreInput.email`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updatestoreinputemailstring- "Direct link to updatestoreinputemailstring-")

The store's email address

#### [`UpdateStoreInput.website`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updatestoreinputwebsitestring- "Direct link to updatestoreinputwebsitestring-")

The store's website

#### [`UpdateStoreInput.metadata`](#) ● [`[KeyValueInput!]`](https://docs.monei.com/apis/graphql/types/inputs/key-value-input/.md) list input[​](#updatestoreinputmetadatakeyvalueinput-- "Direct link to updatestoreinputmetadatakeyvalueinput--")

Metadata

#### [`UpdateStoreInput.blocked`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#updatestoreinputblockedboolean- "Direct link to updatestoreinputblockedboolean-")

Whether the store is blocked or not

### Member Of[​](#member-of "Direct link to Member Of")

[`updateStore`](https://docs.monei.com/apis/graphql/operations/mutations/update-store/.md) mutation


---

# UpdateSubscriptionInput

No description

```
input UpdateSubscriptionInput {
  amount: Int
  intervalCount: Int
  interval: IntervalInput
  allowedPaymentMethods: [SubscriptionPaymentMethods]
  description: String
  descriptor: String
  callbackUrl: String
  paymentCallbackUrl: String
  customer: CustomerInput
  billingDetails: ContactDetailsInput
  shippingDetails: ContactDetailsInput
  nextPaymentAt: AWSTimestamp
  trialPeriodEnd: AWSTimestamp
  cancelAtPeriodEnd: Boolean
  pauseIntervalCount: Int
  pauseAtPeriodEnd: Boolean
  skipIntervalCount: Int
  id: ID!
  retrySchedule: [RetryScheduleInput!]
  metadata: [KeyValueInput!]
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UpdateSubscriptionInput.amount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#updatesubscriptioninputamountint- "Direct link to updatesubscriptioninputamountint-")

#### [`UpdateSubscriptionInput.intervalCount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#updatesubscriptioninputintervalcountint- "Direct link to updatesubscriptioninputintervalcountint-")

#### [`UpdateSubscriptionInput.interval`](#) ● [`IntervalInput`](https://docs.monei.com/apis/graphql/types/enums/interval-input/.md) enum[​](#updatesubscriptioninputintervalintervalinput- "Direct link to updatesubscriptioninputintervalintervalinput-")

#### [`UpdateSubscriptionInput.allowedPaymentMethods`](#) ● [`[SubscriptionPaymentMethods]`](https://docs.monei.com/apis/graphql/types/enums/subscription-payment-methods/.md) list enum[​](#updatesubscriptioninputallowedpaymentmethodssubscriptionpaymentmethods-- "Direct link to updatesubscriptioninputallowedpaymentmethodssubscriptionpaymentmethods--")

#### [`UpdateSubscriptionInput.description`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updatesubscriptioninputdescriptionstring- "Direct link to updatesubscriptioninputdescriptionstring-")

#### [`UpdateSubscriptionInput.descriptor`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updatesubscriptioninputdescriptorstring- "Direct link to updatesubscriptioninputdescriptorstring-")

#### [`UpdateSubscriptionInput.callbackUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updatesubscriptioninputcallbackurlstring- "Direct link to updatesubscriptioninputcallbackurlstring-")

#### [`UpdateSubscriptionInput.paymentCallbackUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updatesubscriptioninputpaymentcallbackurlstring- "Direct link to updatesubscriptioninputpaymentcallbackurlstring-")

#### [`UpdateSubscriptionInput.customer`](#) ● [`CustomerInput`](https://docs.monei.com/apis/graphql/types/inputs/customer-input/.md) input[​](#updatesubscriptioninputcustomercustomerinput- "Direct link to updatesubscriptioninputcustomercustomerinput-")

#### [`UpdateSubscriptionInput.billingDetails`](#) ● [`ContactDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/contact-details-input/.md) input[​](#updatesubscriptioninputbillingdetailscontactdetailsinput- "Direct link to updatesubscriptioninputbillingdetailscontactdetailsinput-")

#### [`UpdateSubscriptionInput.shippingDetails`](#) ● [`ContactDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/contact-details-input/.md) input[​](#updatesubscriptioninputshippingdetailscontactdetailsinput- "Direct link to updatesubscriptioninputshippingdetailscontactdetailsinput-")

#### [`UpdateSubscriptionInput.nextPaymentAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#updatesubscriptioninputnextpaymentatawstimestamp- "Direct link to updatesubscriptioninputnextpaymentatawstimestamp-")

#### [`UpdateSubscriptionInput.trialPeriodEnd`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#updatesubscriptioninputtrialperiodendawstimestamp- "Direct link to updatesubscriptioninputtrialperiodendawstimestamp-")

#### [`UpdateSubscriptionInput.cancelAtPeriodEnd`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#updatesubscriptioninputcancelatperiodendboolean- "Direct link to updatesubscriptioninputcancelatperiodendboolean-")

#### [`UpdateSubscriptionInput.pauseIntervalCount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#updatesubscriptioninputpauseintervalcountint- "Direct link to updatesubscriptioninputpauseintervalcountint-")

#### [`UpdateSubscriptionInput.pauseAtPeriodEnd`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#updatesubscriptioninputpauseatperiodendboolean- "Direct link to updatesubscriptioninputpauseatperiodendboolean-")

#### [`UpdateSubscriptionInput.skipIntervalCount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#updatesubscriptioninputskipintervalcountint- "Direct link to updatesubscriptioninputskipintervalcountint-")

#### [`UpdateSubscriptionInput.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#updatesubscriptioninputidid-- "Direct link to updatesubscriptioninputidid--")

#### [`UpdateSubscriptionInput.retrySchedule`](#) ● [`[RetryScheduleInput!]`](https://docs.monei.com/apis/graphql/types/inputs/retry-schedule-input/.md) list input[​](#updatesubscriptioninputretryscheduleretryscheduleinput-- "Direct link to updatesubscriptioninputretryscheduleretryscheduleinput--")

#### [`UpdateSubscriptionInput.metadata`](#) ● [`[KeyValueInput!]`](https://docs.monei.com/apis/graphql/types/inputs/key-value-input/.md) list input[​](#updatesubscriptioninputmetadatakeyvalueinput-- "Direct link to updatesubscriptioninputmetadatakeyvalueinput--")

### Member Of[​](#member-of "Direct link to Member Of")

[`updateSubscription`](https://docs.monei.com/apis/graphql/operations/mutations/update-subscription/.md) mutation


---

# UpdateWebhookInput

No description

```
input UpdateWebhookInput {
  id: ID!
  url: String
  eventTypes: [WebhookEventType!]
  enabled: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UpdateWebhookInput.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#updatewebhookinputidid-- "Direct link to updatewebhookinputidid--")

#### [`UpdateWebhookInput.url`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#updatewebhookinputurlstring- "Direct link to updatewebhookinputurlstring-")

#### [`UpdateWebhookInput.eventTypes`](#) ● [`[WebhookEventType!]`](https://docs.monei.com/apis/graphql/types/enums/webhook-event-type/.md) list enum[​](#updatewebhookinputeventtypeswebhookeventtype-- "Direct link to updatewebhookinputeventtypeswebhookeventtype--")

#### [`UpdateWebhookInput.enabled`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#updatewebhookinputenabledboolean- "Direct link to updatewebhookinputenabledboolean-")

### Member Of[​](#member-of "Direct link to Member Of")

[`updateWebhook`](https://docs.monei.com/apis/graphql/operations/mutations/update-webhook/.md) mutation


---

# UserEventsInput

No description

```
input UserEventsInput {
  nextToken: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UserEventsInput.nextToken`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#usereventsinputnexttokenstring- "Direct link to usereventsinputnexttokenstring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`userEvents`](https://docs.monei.com/apis/graphql/operations/queries/user-events/.md) query


---

# AccountBalancesConnection

No description

```
type AccountBalancesConnection {
  items: [AccountBalances!]!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountBalancesConnection.items`](#) ● [`[AccountBalances!]!`](https://docs.monei.com/apis/graphql/types/objects/account-balances/.md) non-null object[​](#accountbalancesconnectionitemsaccountbalances-- "Direct link to accountbalancesconnectionitemsaccountbalances--")

List of the account balances

### Returned By[​](#returned-by "Direct link to Returned By")

[`accountBalances`](https://docs.monei.com/apis/graphql/operations/queries/account-balances/.md) query


---

# AccountBalances

No description

```
type AccountBalances {
  accountId: ID
  currency: String!
  clearedAmount: Int!
  outstandingAmount: Int!
  totalAmount: Int!
  createdAt: String!
  updatedAt: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountBalances.accountId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#accountbalancesaccountidid- "Direct link to accountbalancesaccountidid-")

The unique identifier for the account

#### [`AccountBalances.currency`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#accountbalancescurrencystring-- "Direct link to accountbalancescurrencystring--")

The currency of the account

#### [`AccountBalances.clearedAmount`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#accountbalancesclearedamountint-- "Direct link to accountbalancesclearedamountint--")

The cleared amount of the account

#### [`AccountBalances.outstandingAmount`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#accountbalancesoutstandingamountint-- "Direct link to accountbalancesoutstandingamountint--")

The outstanding amount of the account

#### [`AccountBalances.totalAmount`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#accountbalancestotalamountint-- "Direct link to accountbalancestotalamountint--")

The total amount of the account

#### [`AccountBalances.createdAt`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#accountbalancescreatedatstring-- "Direct link to accountbalancescreatedatstring--")

The date and time the account was created

#### [`AccountBalances.updatedAt`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountbalancesupdatedatstring- "Direct link to accountbalancesupdatedatstring-")

The date and time the account was last updated

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountBalancesConnection`](https://docs.monei.com/apis/graphql/types/objects/account-balances-connection/.md) object


---

# AccountBranding

Account branding

```
type AccountBranding {
  accentColor: String
  bgColor: String
  logoUrl: String
  iconUrl: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountBranding.accentColor`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountbrandingaccentcolorstring- "Direct link to accountbrandingaccentcolorstring-")

Merchant's accent color

#### [`AccountBranding.bgColor`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountbrandingbgcolorstring- "Direct link to accountbrandingbgcolorstring-")

Merchant's background color

#### [`AccountBranding.logoUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountbrandinglogourlstring- "Direct link to accountbrandinglogourlstring-")

Merchant's logo URL, the logo will be displayed on the payment page

#### [`AccountBranding.iconUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountbrandingiconurlstring- "Direct link to accountbrandingiconurlstring-")

Merchant's icon URL, the icon will be used as an icon for the payment page

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object


---

# AccountContract

Account contract information

```
type AccountContract {
  envelopeId: ID!
  status: ContractStatus!
  path: String @deprecated
  signedDate: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountContract.envelopeId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#accountcontractenvelopeidid-- "Direct link to accountcontractenvelopeidid--")

Contract envelope ID

#### [`AccountContract.status`](#) ● [`ContractStatus!`](https://docs.monei.com/apis/graphql/types/enums/contract-status/.md) non-null enum[​](#accountcontractstatuscontractstatus-- "Direct link to accountcontractstatuscontractstatus--")

Contract status

#### [`AccountContract.path`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) deprecated scalar[​](#accountcontractpathstring-- "Direct link to accountcontractpathstring--")

DEPRECATED

contract is stored as a document

#### [`AccountContract.signedDate`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountcontractsigneddatestring- "Direct link to accountcontractsigneddatestring-")

Contract signature date in ISO 8601 format

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object


---

# AccountInvoiceBusiness

Account invoice business details

```
type AccountInvoiceBusiness {
  legalName: String
  iban: String
  documentNumber: String
  mandateSignatureTimestamp: Int
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountInvoiceBusiness.legalName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountinvoicebusinesslegalnamestring- "Direct link to accountinvoicebusinesslegalnamestring-")

Business legal name

#### [`AccountInvoiceBusiness.iban`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountinvoicebusinessibanstring- "Direct link to accountinvoicebusinessibanstring-")

Business IBAN

#### [`AccountInvoiceBusiness.documentNumber`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountinvoicebusinessdocumentnumberstring- "Direct link to accountinvoicebusinessdocumentnumberstring-")

Business tax ID

#### [`AccountInvoiceBusiness.mandateSignatureTimestamp`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#accountinvoicebusinessmandatesignaturetimestampint- "Direct link to accountinvoicebusinessmandatesignaturetimestampint-")

SEPA mandate signature date as a unix timestamp

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountInvoice`](https://docs.monei.com/apis/graphql/types/objects/account-invoice/.md) object


---

# AccountInvoiceLineItem

Account invoice line item

* If the `unitType` is `money`, `unitAmount` is the amount in the currency of the invoice in cents and the line item amount is calculated as `quantity * unitAmount`
* If the `unitType` is `percent`, `unitAmount` is the percentage value, quantity is an amount in the currency of the invoice in cents and the line item amount is calculated as `quantity * unitAmount / 100`

```
type AccountInvoiceLineItem {
  name: String!
  quantity: Int!
  unitAmount: Float!
  unitType: UnitType!
  currency: Currencies!
  amount: Int!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountInvoiceLineItem.name`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#accountinvoicelineitemnamestring-- "Direct link to accountinvoicelineitemnamestring--")

Line item name

#### [`AccountInvoiceLineItem.quantity`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#accountinvoicelineitemquantityint-- "Direct link to accountinvoicelineitemquantityint--")

Line item quantity

#### [`AccountInvoiceLineItem.unitAmount`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#accountinvoicelineitemunitamountfloat-- "Direct link to accountinvoicelineitemunitamountfloat--")

Line item unit amount

#### [`AccountInvoiceLineItem.unitType`](#) ● [`UnitType!`](https://docs.monei.com/apis/graphql/types/enums/unit-type/.md) non-null enum[​](#accountinvoicelineitemunittypeunittype-- "Direct link to accountinvoicelineitemunittypeunittype--")

Line item unit type

#### [`AccountInvoiceLineItem.currency`](#) ● [`Currencies!`](https://docs.monei.com/apis/graphql/types/enums/currencies/.md) non-null enum[​](#accountinvoicelineitemcurrencycurrencies-- "Direct link to accountinvoicelineitemcurrencycurrencies--")

Line item currency

#### [`AccountInvoiceLineItem.amount`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#accountinvoicelineitemamountint-- "Direct link to accountinvoicelineitemamountint--")

Line item total amount in cents

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountInvoice`](https://docs.monei.com/apis/graphql/types/objects/account-invoice/.md) object


---

# AccountInvoice

Invoice that MONEI issues to the account, this invoice is generated based on the account transactions and includes all the fees for the given period

```
type AccountInvoice {
  id: ID!
  number: String
  accountId: ID!
  period: Period!
  currency: Currencies!
  amount: Int!
  tax: Int!
  totalAmount: Int!
  lineItems: [AccountInvoiceLineItem!]!
  business: AccountInvoiceBusiness
  referralCode: String
  createdAt: Int!
  status: AccountInvoiceStatus
  paymentMethod: AccountInvoicePaymentMethod
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountInvoice.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#accountinvoiceidid-- "Direct link to accountinvoiceidid--")

Account invoice ID

#### [`AccountInvoice.number`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountinvoicenumberstring- "Direct link to accountinvoicenumberstring-")

Account invoice number

#### [`AccountInvoice.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#accountinvoiceaccountidid-- "Direct link to accountinvoiceaccountidid--")

Account ID

#### [`AccountInvoice.period`](#) ● [`Period!`](https://docs.monei.com/apis/graphql/types/objects/period/.md) non-null object[​](#accountinvoiceperiodperiod-- "Direct link to accountinvoiceperiodperiod--")

Invoice period

#### [`AccountInvoice.currency`](#) ● [`Currencies!`](https://docs.monei.com/apis/graphql/types/enums/currencies/.md) non-null enum[​](#accountinvoicecurrencycurrencies-- "Direct link to accountinvoicecurrencycurrencies--")

Invoice currency

#### [`AccountInvoice.amount`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#accountinvoiceamountint-- "Direct link to accountinvoiceamountint--")

Invoice amount in cents

#### [`AccountInvoice.tax`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#accountinvoicetaxint-- "Direct link to accountinvoicetaxint--")

Invoice tax amount in cents

#### [`AccountInvoice.totalAmount`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#accountinvoicetotalamountint-- "Direct link to accountinvoicetotalamountint--")

Invoice total amount in cents

#### [`AccountInvoice.lineItems`](#) ● [`[AccountInvoiceLineItem!]!`](https://docs.monei.com/apis/graphql/types/objects/account-invoice-line-item/.md) non-null object[​](#accountinvoicelineitemsaccountinvoicelineitem-- "Direct link to accountinvoicelineitemsaccountinvoicelineitem--")

Invoice line items

#### [`AccountInvoice.business`](#) ● [`AccountInvoiceBusiness`](https://docs.monei.com/apis/graphql/types/objects/account-invoice-business/.md) object[​](#accountinvoicebusinessaccountinvoicebusiness- "Direct link to accountinvoicebusinessaccountinvoicebusiness-")

Invoice customer details

#### [`AccountInvoice.referralCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountinvoicereferralcodestring- "Direct link to accountinvoicereferralcodestring-")

Referral code used to generate the invoice

#### [`AccountInvoice.createdAt`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#accountinvoicecreatedatint-- "Direct link to accountinvoicecreatedatint--")

Invoice creation date as a unix timestamp

#### [`AccountInvoice.status`](#) ● [`AccountInvoiceStatus`](https://docs.monei.com/apis/graphql/types/enums/account-invoice-status/.md) enum[​](#accountinvoicestatusaccountinvoicestatus- "Direct link to accountinvoicestatusaccountinvoicestatus-")

Invoice status

#### [`AccountInvoice.paymentMethod`](#) ● [`AccountInvoicePaymentMethod`](https://docs.monei.com/apis/graphql/types/enums/account-invoice-payment-method/.md) enum[​](#accountinvoicepaymentmethodaccountinvoicepaymentmethod- "Direct link to accountinvoicepaymentmethodaccountinvoicepaymentmethod-")

Invoice payment method

### Returned By[​](#returned-by "Direct link to Returned By")

[`accountInvoice`](https://docs.monei.com/apis/graphql/operations/queries/account-invoice/.md) query

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountInvoicesConnection`](https://docs.monei.com/apis/graphql/types/objects/account-invoices-connection/.md) object


---

# AccountInvoicesConnection

Account invoices connection

```
type AccountInvoicesConnection {
  items: [AccountInvoice!]!
  total: Int!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountInvoicesConnection.items`](#) ● [`[AccountInvoice!]!`](https://docs.monei.com/apis/graphql/types/objects/account-invoice/.md) non-null object[​](#accountinvoicesconnectionitemsaccountinvoice-- "Direct link to accountinvoicesconnectionitemsaccountinvoice--")

List of account invoices

#### [`AccountInvoicesConnection.total`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#accountinvoicesconnectiontotalint-- "Direct link to accountinvoicesconnectiontotalint--")

Total number of account invoices

### Returned By[​](#returned-by "Direct link to Returned By")

[`accountInvoices`](https://docs.monei.com/apis/graphql/operations/queries/account-invoices/.md) query


---

# AccountLevelUpdate

No description

```
type AccountLevelUpdate {
  accountId: ID
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountLevelUpdate.accountId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#accountlevelupdateaccountidid- "Direct link to accountlevelupdateaccountidid-")

### Returned By[​](#returned-by "Direct link to Returned By")

[`onUpdateAccount`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-account/.md) subscription ● [`onUpdateAccountV2`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-account-v2/.md) subscription ● [`onUpdateAnalytics`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-analytics/.md) subscription ● [`onUpdateAnalyticsV2`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-analytics-v2/.md) subscription ● [`onUpdateCharges`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-charges/.md) subscription ● [`onUpdateChargesV2`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-charges-v2/.md) subscription ● [`onUpdateDocuments`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-documents/.md) subscription ● [`onUpdateDocumentsV2`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-documents-v2/.md) subscription ● [`onUpdateEvents`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-events/.md) subscription ● [`onUpdateEventsV2`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-events-v2/.md) subscription ● [`onUpdateSubscriptions`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-subscriptions/.md) subscription ● [`onUpdateWebReport`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-web-report/.md) subscription ● [`publishUpdateAccount`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-account/.md) mutation ● [`publishUpdateAnalytics`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-analytics/.md) mutation ● [`publishUpdateCharges`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-charges/.md) mutation ● [`publishUpdateDocuments`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-documents/.md) mutation ● [`publishUpdateEvents`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-events/.md) mutation ● [`publishUpdateSubscriptions`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-subscriptions/.md) mutation ● [`publishUpdateWebReport`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-web-report/.md) mutation


---

# AccountNotifications

Account notifications

```
type AccountNotifications {
  emailCustomerOnRefund: Boolean
  emailCustomerOnSuccess: Boolean
  emailCustomerOnSubscription: Boolean
  emailAdminOnSuccess: Boolean
  emailAdminOnSubscription: Boolean
  adminEmails: [String!]
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountNotifications.emailCustomerOnRefund`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accountnotificationsemailcustomeronrefundboolean- "Direct link to accountnotificationsemailcustomeronrefundboolean-")

Whether to send an email to the customer on refund

#### [`AccountNotifications.emailCustomerOnSuccess`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accountnotificationsemailcustomeronsuccessboolean- "Direct link to accountnotificationsemailcustomeronsuccessboolean-")

Whether to send an email to the customer on successful payment

#### [`AccountNotifications.emailCustomerOnSubscription`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accountnotificationsemailcustomeronsubscriptionboolean- "Direct link to accountnotificationsemailcustomeronsubscriptionboolean-")

Whether to send an email to the customer on successful subscription

#### [`AccountNotifications.emailAdminOnSuccess`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accountnotificationsemailadminonsuccessboolean- "Direct link to accountnotificationsemailadminonsuccessboolean-")

Whether to send an email to the admin on every successful payment

#### [`AccountNotifications.emailAdminOnSubscription`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accountnotificationsemailadminonsubscriptionboolean- "Direct link to accountnotificationsemailadminonsubscriptionboolean-")

Whether to send an email to the admin on every successful subscription

#### [`AccountNotifications.adminEmails`](#) ● [`[String!]`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) list scalar[​](#accountnotificationsadminemailsstring-- "Direct link to accountnotificationsadminemailsstring--")

List of admin emails to send notifications

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object


---

# AccountPaymentMethodsBizum

No description

```
type AccountPaymentMethodsBizum {
  enabled: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountPaymentMethodsBizum.enabled`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accountpaymentmethodsbizumenabledboolean- "Direct link to accountpaymentmethodsbizumenabledboolean-")

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountPaymentMethods`](https://docs.monei.com/apis/graphql/types/objects/account-payment-methods/.md) object


---

# AccountPaymentMethodsCreditCard

No description

```
type AccountPaymentMethodsCreditCard {
  enabled: Boolean
  preauthorization: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountPaymentMethodsCreditCard.enabled`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accountpaymentmethodscreditcardenabledboolean- "Direct link to accountpaymentmethodscreditcardenabledboolean-")

#### [`AccountPaymentMethodsCreditCard.preauthorization`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accountpaymentmethodscreditcardpreauthorizationboolean- "Direct link to accountpaymentmethodscreditcardpreauthorizationboolean-")

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountPaymentMethods`](https://docs.monei.com/apis/graphql/types/objects/account-payment-methods/.md) object


---

# AccountPaymentMethods

No description

```
type AccountPaymentMethods {
  CREDITCARD: AccountPaymentMethodsCreditCard
  BIZUM: AccountPaymentMethodsBizum
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountPaymentMethods.CREDITCARD`](#) ● [`AccountPaymentMethodsCreditCard`](https://docs.monei.com/apis/graphql/types/objects/account-payment-methods-credit-card/.md) object[​](#accountpaymentmethodscreditcardaccountpaymentmethodscreditcard- "Direct link to accountpaymentmethodscreditcardaccountpaymentmethodscreditcard-")

#### [`AccountPaymentMethods.BIZUM`](#) ● [`AccountPaymentMethodsBizum`](https://docs.monei.com/apis/graphql/types/objects/account-payment-methods-bizum/.md) object[​](#accountpaymentmethodsbizumaccountpaymentmethodsbizum- "Direct link to accountpaymentmethodsbizumaccountpaymentmethodsbizum-")

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object


---

# AccountPayoutTerms

Account payout terms

```
type AccountPayoutTerms {
  iban: String
  firstPeriod: Int
  period: Int
  reservePercent: Float
  suspended: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountPayoutTerms.iban`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountpayouttermsibanstring- "Direct link to accountpayouttermsibanstring-")

IBAN to make settlements to

#### [`AccountPayoutTerms.firstPeriod`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#accountpayouttermsfirstperiodint- "Direct link to accountpayouttermsfirstperiodint-")

First settlement period in days

#### [`AccountPayoutTerms.period`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#accountpayouttermsperiodint- "Direct link to accountpayouttermsperiodint-")

Settlement period in days

#### [`AccountPayoutTerms.reservePercent`](#) ● [`Float`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) scalar[​](#accountpayouttermsreservepercentfloat- "Direct link to accountpayouttermsreservepercentfloat-")

The percentage of the total amount of the settlement that will be withheld and released with the next settlement

#### [`AccountPayoutTerms.suspended`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accountpayouttermssuspendedboolean- "Direct link to accountpayouttermssuspendedboolean-")

Whether the settlements are suspended

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object


---

# AccountPublicBusinessDetails

Account public business details

```
type AccountPublicBusinessDetails {
  companyName: String
  website: String
  phone: String
  address: Address
  supportWebsite: String
  supportEmail: String
  supportPhone: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountPublicBusinessDetails.companyName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountpublicbusinessdetailscompanynamestring- "Direct link to accountpublicbusinessdetailscompanynamestring-")

Company name

#### [`AccountPublicBusinessDetails.website`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountpublicbusinessdetailswebsitestring- "Direct link to accountpublicbusinessdetailswebsitestring-")

Company website

#### [`AccountPublicBusinessDetails.phone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountpublicbusinessdetailsphonestring- "Direct link to accountpublicbusinessdetailsphonestring-")

Company phone, E.164 format, e.g. +34666777888

#### [`AccountPublicBusinessDetails.address`](#) ● [`Address`](https://docs.monei.com/apis/graphql/types/objects/address/.md) object[​](#accountpublicbusinessdetailsaddressaddress- "Direct link to accountpublicbusinessdetailsaddressaddress-")

Company address

#### [`AccountPublicBusinessDetails.supportWebsite`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountpublicbusinessdetailssupportwebsitestring- "Direct link to accountpublicbusinessdetailssupportwebsitestring-")

Support website

#### [`AccountPublicBusinessDetails.supportEmail`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountpublicbusinessdetailssupportemailstring- "Direct link to accountpublicbusinessdetailssupportemailstring-")

Support email

#### [`AccountPublicBusinessDetails.supportPhone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountpublicbusinessdetailssupportphonestring- "Direct link to accountpublicbusinessdetailssupportphonestring-")

Support phone, E.164 format, e.g. +34666777888

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object


---

# AccountSettlement

No description

```
type AccountSettlement {
  accountId: ID!
  acquirerFees: Int!
  grossVolume: Int!
  iban: String
  id: ID!
  legalName: String
  netVolume: Int!
  payMethod: SettlementPayMethods
  periodEndAt: AWSTimestamp!
  periodStartAt: AWSTimestamp!
  releasedAmount: Int
  reservedAmount: Int
  scheduledAt: AWSTimestamp!
  status: SettlementStatus!
  settleGross: Boolean
  storeId: ID
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountSettlement.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#accountsettlementaccountidid-- "Direct link to accountsettlementaccountidid--")

Account ID

#### [`AccountSettlement.acquirerFees`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#accountsettlementacquirerfeesint-- "Direct link to accountsettlementacquirerfeesint--")

Fees for the settlement period

#### [`AccountSettlement.grossVolume`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#accountsettlementgrossvolumeint-- "Direct link to accountsettlementgrossvolumeint--")

Gross volume for the settlement period

#### [`AccountSettlement.iban`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountsettlementibanstring- "Direct link to accountsettlementibanstring-")

IBAN for the settlement bank transfer

#### [`AccountSettlement.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#accountsettlementidid-- "Direct link to accountsettlementidid--")

Settlement ID

#### [`AccountSettlement.legalName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountsettlementlegalnamestring- "Direct link to accountsettlementlegalnamestring-")

Legal name of the store

#### [`AccountSettlement.netVolume`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#accountsettlementnetvolumeint-- "Direct link to accountsettlementnetvolumeint--")

Net volume for the settlement period

#### [`AccountSettlement.payMethod`](#) ● [`SettlementPayMethods`](https://docs.monei.com/apis/graphql/types/enums/settlement-pay-methods/.md) enum[​](#accountsettlementpaymethodsettlementpaymethods- "Direct link to accountsettlementpaymethodsettlementpaymethods-")

Payment method for the all the transactions in the settlement

#### [`AccountSettlement.periodEndAt`](#) ● [`AWSTimestamp!`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) non-null scalar[​](#accountsettlementperiodendatawstimestamp-- "Direct link to accountsettlementperiodendatawstimestamp--")

Settlement end period

#### [`AccountSettlement.periodStartAt`](#) ● [`AWSTimestamp!`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) non-null scalar[​](#accountsettlementperiodstartatawstimestamp-- "Direct link to accountsettlementperiodstartatawstimestamp--")

Settlement start period

#### [`AccountSettlement.releasedAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#accountsettlementreleasedamountint- "Direct link to accountsettlementreleasedamountint-")

Released amount hold in the previous settlement

#### [`AccountSettlement.reservedAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#accountsettlementreservedamountint- "Direct link to accountsettlementreservedamountint-")

Reserve amount hold from the previous settlement

#### [`AccountSettlement.scheduledAt`](#) ● [`AWSTimestamp!`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) non-null scalar[​](#accountsettlementscheduledatawstimestamp-- "Direct link to accountsettlementscheduledatawstimestamp--")

Settlement completion projected date

#### [`AccountSettlement.status`](#) ● [`SettlementStatus!`](https://docs.monei.com/apis/graphql/types/enums/settlement-status/.md) non-null enum[​](#accountsettlementstatussettlementstatus-- "Direct link to accountsettlementstatussettlementstatus--")

Settlement status

#### [`AccountSettlement.settleGross`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accountsettlementsettlegrossboolean- "Direct link to accountsettlementsettlegrossboolean-")

Payout type

#### [`AccountSettlement.storeId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#accountsettlementstoreidid- "Direct link to accountsettlementstoreidid-")

Settlement associated to a specific store in the account

### Returned By[​](#returned-by "Direct link to Returned By")

[`accountSettlement`](https://docs.monei.com/apis/graphql/operations/queries/account-settlement/.md) query

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountSettlementsConnection`](https://docs.monei.com/apis/graphql/types/objects/account-settlements-connection/.md) object


---

# AccountSettlementsConnection

No description

```
type AccountSettlementsConnection {
  items: [AccountSettlement!]!
  total: Int!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountSettlementsConnection.items`](#) ● [`[AccountSettlement!]!`](https://docs.monei.com/apis/graphql/types/objects/account-settlement/.md) non-null object[​](#accountsettlementsconnectionitemsaccountsettlement-- "Direct link to accountsettlementsconnectionitemsaccountsettlement--")

#### [`AccountSettlementsConnection.total`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#accountsettlementsconnectiontotalint-- "Direct link to accountsettlementsconnectiontotalint--")

### Returned By[​](#returned-by "Direct link to Returned By")

[`accountSettlements`](https://docs.monei.com/apis/graphql/operations/queries/account-settlements/.md) query


---

# AccountTokenizationMethodsClickToPayItem

No description

```
type AccountTokenizationMethodsClickToPayItem {
  enabled: Boolean
  dpaId: ID
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountTokenizationMethodsClickToPayItem.enabled`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accounttokenizationmethodsclicktopayitemenabledboolean- "Direct link to accounttokenizationmethodsclicktopayitemenabledboolean-")

#### [`AccountTokenizationMethodsClickToPayItem.dpaId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#accounttokenizationmethodsclicktopayitemdpaidid- "Direct link to accounttokenizationmethodsclicktopayitemdpaidid-")

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountTokenizationMethods`](https://docs.monei.com/apis/graphql/types/objects/account-tokenization-methods/.md) object


---

# AccountTokenizationMethodsItem

No description

```
type AccountTokenizationMethodsItem {
  enabled: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountTokenizationMethodsItem.enabled`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accounttokenizationmethodsitemenabledboolean- "Direct link to accounttokenizationmethodsitemenabledboolean-")

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountTokenizationMethods`](https://docs.monei.com/apis/graphql/types/objects/account-tokenization-methods/.md) object


---

# AccountTokenizationMethods

No description

```
type AccountTokenizationMethods {
  googlePay: AccountTokenizationMethodsItem
  applePay: AccountTokenizationMethodsItem
  clickToPay: AccountTokenizationMethodsClickToPayItem
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AccountTokenizationMethods.googlePay`](#) ● [`AccountTokenizationMethodsItem`](https://docs.monei.com/apis/graphql/types/objects/account-tokenization-methods-item/.md) object[​](#accounttokenizationmethodsgooglepayaccounttokenizationmethodsitem- "Direct link to accounttokenizationmethodsgooglepayaccounttokenizationmethodsitem-")

#### [`AccountTokenizationMethods.applePay`](#) ● [`AccountTokenizationMethodsItem`](https://docs.monei.com/apis/graphql/types/objects/account-tokenization-methods-item/.md) object[​](#accounttokenizationmethodsapplepayaccounttokenizationmethodsitem- "Direct link to accounttokenizationmethodsapplepayaccounttokenizationmethodsitem-")

#### [`AccountTokenizationMethods.clickToPay`](#) ● [`AccountTokenizationMethodsClickToPayItem`](https://docs.monei.com/apis/graphql/types/objects/account-tokenization-methods-click-to-pay-item/.md) object[​](#accounttokenizationmethodsclicktopayaccounttokenizationmethodsclicktopayitem- "Direct link to accounttokenizationmethodsclicktopayaccounttokenizationmethodsclicktopayitem-")

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object


---

# Account

Account information

```
type Account {
  id: ID!
  externalId: String
  masterAccountId: ID
  name: String
  paymentMethods: AccountPaymentMethods @deprecated
  publicBusinessDetails: AccountPublicBusinessDetails
  branding: AccountBranding
  defaultCurrency: Currencies @deprecated
  test: Boolean
  blocked: Boolean
  status: AccountStatus!
  reason: String @deprecated
  timezone: String
  adminEmail: String
  apiKey: String
  customDomain: String
  customDomainConfig: CustomDomainConfig
  payoutTerms: AccountPayoutTerms
  business: BusinessData
  representatives: [Representative!]
  iban: String
  bankAccount: BankAccount
  language: String
  tokenizationMethods: AccountTokenizationMethods
  notifications: AccountNotifications
  billingPlan: BillingPlans
  contract: AccountContract
  referralCode: String
  promoCode: String
  allowCreateApiKey: Boolean
  previewFeatures: [String!]
  notConfiguredReason: NotConfiguredReason @deprecated
  notConfiguredNote: String @deprecated
  userNote: String
  createdAt: String!
  approvedAt: String
  updatedAt: String
  rejectedReason: RejectedReason @deprecated
  rejectedNote: String @deprecated
  statusReason: StatusReason
  statusNote: String
  fraudDetectorThreshold: Int
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Account.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#accountidid-- "Direct link to accountidid--")

Account ID

#### [`Account.externalId`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountexternalidstring- "Direct link to accountexternalidstring-")

Account external ID, provided by the partner (master account)

#### [`Account.masterAccountId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#accountmasteraccountidid- "Direct link to accountmasteraccountidid-")

Master account ID, if the account is a sub-account of a partner (master account)

#### [`Account.name`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountnamestring- "Direct link to accountnamestring-")

Account name

#### [`Account.paymentMethods`](#) ● [`AccountPaymentMethods`](https://docs.monei.com/apis/graphql/types/objects/account-payment-methods/.md) deprecated object[​](#accountpaymentmethodsaccountpaymentmethods-- "Direct link to accountpaymentmethodsaccountpaymentmethods--")

DEPRECATED

not used anymore

#### [`Account.publicBusinessDetails`](#) ● [`AccountPublicBusinessDetails`](https://docs.monei.com/apis/graphql/types/objects/account-public-business-details/.md) object[​](#accountpublicbusinessdetailsaccountpublicbusinessdetails- "Direct link to accountpublicbusinessdetailsaccountpublicbusinessdetails-")

Public business information

#### [`Account.branding`](#) ● [`AccountBranding`](https://docs.monei.com/apis/graphql/types/objects/account-branding/.md) object[​](#accountbrandingaccountbranding- "Direct link to accountbrandingaccountbranding-")

Account branding

#### [`Account.defaultCurrency`](#) ● [`Currencies`](https://docs.monei.com/apis/graphql/types/enums/currencies/.md) deprecated enum[​](#accountdefaultcurrencycurrencies-- "Direct link to accountdefaultcurrencycurrencies--")

DEPRECATED

not used anymore

#### [`Account.test`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accounttestboolean- "Direct link to accounttestboolean-")

If the account is a test account

#### [`Account.blocked`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accountblockedboolean- "Direct link to accountblockedboolean-")

If the account is blocked

#### [`Account.status`](#) ● [`AccountStatus!`](https://docs.monei.com/apis/graphql/types/enums/account-status/.md) non-null enum[​](#accountstatusaccountstatus-- "Direct link to accountstatusaccountstatus--")

Account status

#### [`Account.reason`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) deprecated scalar[​](#accountreasonstring-- "Direct link to accountreasonstring--")

DEPRECATED

Use statusReason instead

#### [`Account.timezone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accounttimezonestring- "Direct link to accounttimezonestring-")

The account default timezone, e.g. Europe/Madrid

#### [`Account.adminEmail`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountadminemailstring- "Direct link to accountadminemailstring-")

Account admin email

#### [`Account.apiKey`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountapikeystring- "Direct link to accountapikeystring-")

Account API key, used to authenticate requests to REST and GraphQL APIs

#### [`Account.customDomain`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountcustomdomainstring- "Direct link to accountcustomdomainstring-")

Account custom domain, this domain will be used for the hosted payment page

#### [`Account.customDomainConfig`](#) ● [`CustomDomainConfig`](https://docs.monei.com/apis/graphql/types/objects/custom-domain-config/.md) object[​](#accountcustomdomainconfigcustomdomainconfig- "Direct link to accountcustomdomainconfigcustomdomainconfig-")

Account custom domain configuration

#### [`Account.payoutTerms`](#) ● [`AccountPayoutTerms`](https://docs.monei.com/apis/graphql/types/objects/account-payout-terms/.md) object[​](#accountpayouttermsaccountpayoutterms- "Direct link to accountpayouttermsaccountpayoutterms-")

Account payout terms

#### [`Account.business`](#) ● [`BusinessData`](https://docs.monei.com/apis/graphql/types/objects/business-data/.md) object[​](#accountbusinessbusinessdata- "Direct link to accountbusinessbusinessdata-")

Business basic data

#### [`Account.representatives`](#) ● [`[Representative!]`](https://docs.monei.com/apis/graphql/types/objects/representative/.md) list object[​](#accountrepresentativesrepresentative-- "Direct link to accountrepresentativesrepresentative--")

Legal representatives

#### [`Account.iban`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountibanstring- "Direct link to accountibanstring-")

IBAN number to receive settlements

#### [`Account.bankAccount`](#) ● [`BankAccount`](https://docs.monei.com/apis/graphql/types/objects/bank-account/.md) object[​](#accountbankaccountbankaccount- "Direct link to accountbankaccountbankaccount-")

Bank account information

#### [`Account.language`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountlanguagestring- "Direct link to accountlanguagestring-")

Preferred language

#### [`Account.tokenizationMethods`](#) ● [`AccountTokenizationMethods`](https://docs.monei.com/apis/graphql/types/objects/account-tokenization-methods/.md) object[​](#accounttokenizationmethodsaccounttokenizationmethods- "Direct link to accounttokenizationmethodsaccounttokenizationmethods-")

Tokenization methods

#### [`Account.notifications`](#) ● [`AccountNotifications`](https://docs.monei.com/apis/graphql/types/objects/account-notifications/.md) object[​](#accountnotificationsaccountnotifications- "Direct link to accountnotificationsaccountnotifications-")

Account notifications

#### [`Account.billingPlan`](#) ● [`BillingPlans`](https://docs.monei.com/apis/graphql/types/enums/billing-plans/.md) enum[​](#accountbillingplanbillingplans- "Direct link to accountbillingplanbillingplans-")

Billing Plan

#### [`Account.contract`](#) ● [`AccountContract`](https://docs.monei.com/apis/graphql/types/objects/account-contract/.md) object[​](#accountcontractaccountcontract- "Direct link to accountcontractaccountcontract-")

Account contract

#### [`Account.referralCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountreferralcodestring- "Direct link to accountreferralcodestring-")

Account referral code

#### [`Account.promoCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountpromocodestring- "Direct link to accountpromocodestring-")

Account promo code

#### [`Account.allowCreateApiKey`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#accountallowcreateapikeyboolean- "Direct link to accountallowcreateapikeyboolean-")

Allow creating API keys, if false, the account will not be able to create new API keys

#### [`Account.previewFeatures`](#) ● [`[String!]`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) list scalar[​](#accountpreviewfeaturesstring-- "Direct link to accountpreviewfeaturesstring--")

Access to preview features

#### [`Account.notConfiguredReason`](#) ● [`NotConfiguredReason`](https://docs.monei.com/apis/graphql/types/enums/not-configured-reason/.md) deprecated enum[​](#accountnotconfiguredreasonnotconfiguredreason-- "Direct link to accountnotconfiguredreasonnotconfiguredreason--")

DEPRECATED

Use statusReason instead

#### [`Account.notConfiguredNote`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) deprecated scalar[​](#accountnotconfigurednotestring-- "Direct link to accountnotconfigurednotestring--")

DEPRECATED

Use statusNote instead

#### [`Account.userNote`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountusernotestring- "Direct link to accountusernotestring-")

User provided note

#### [`Account.createdAt`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#accountcreatedatstring-- "Direct link to accountcreatedatstring--")

The date when the account was created in ISO 8601 format

#### [`Account.approvedAt`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountapprovedatstring- "Direct link to accountapprovedatstring-")

The date when the account was approved in ISO 8601 format

#### [`Account.updatedAt`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountupdatedatstring- "Direct link to accountupdatedatstring-")

The date when the account was updated in ISO 8601 format

#### [`Account.rejectedReason`](#) ● [`RejectedReason`](https://docs.monei.com/apis/graphql/types/enums/rejected-reason/.md) deprecated enum[​](#accountrejectedreasonrejectedreason-- "Direct link to accountrejectedreasonrejectedreason--")

DEPRECATED

Use statusReason instead

#### [`Account.rejectedNote`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) deprecated scalar[​](#accountrejectednotestring-- "Direct link to accountrejectednotestring--")

DEPRECATED

Use statusNote instead

#### [`Account.statusReason`](#) ● [`StatusReason`](https://docs.monei.com/apis/graphql/types/enums/status-reason/.md) enum[​](#accountstatusreasonstatusreason- "Direct link to accountstatusreasonstatusreason-")

The reason why the account status was changed

#### [`Account.statusNote`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#accountstatusnotestring- "Direct link to accountstatusnotestring-")

The note about the account status

#### [`Account.fraudDetectorThreshold`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#accountfrauddetectorthresholdint- "Direct link to accountfrauddetectorthresholdint-")

Fraud detector threshold is a number between 0 and 1000, 0 is the lowest risk and 1000 is the highest risk

### Returned By[​](#returned-by "Direct link to Returned By")

[`account`](https://docs.monei.com/apis/graphql/operations/queries/account/.md) query ● [`connectMasterAccount`](https://docs.monei.com/apis/graphql/operations/mutations/connect-master-account/.md) mutation ● [`disableCustomDomain`](https://docs.monei.com/apis/graphql/operations/mutations/disable-custom-domain/.md) mutation ● [`disableTokenizationMethod`](https://docs.monei.com/apis/graphql/operations/mutations/disable-tokenization-method/.md) mutation ● [`disconnectMasterAccount`](https://docs.monei.com/apis/graphql/operations/mutations/disconnect-master-account/.md) mutation ● [`enableCustomDomain`](https://docs.monei.com/apis/graphql/operations/mutations/enable-custom-domain/.md) mutation ● [`enableTokenizationMethod`](https://docs.monei.com/apis/graphql/operations/mutations/enable-tokenization-method/.md) mutation ● [`liveAccount`](https://docs.monei.com/apis/graphql/operations/queries/live-account/.md) query ● [`requestAccountReview`](https://docs.monei.com/apis/graphql/operations/mutations/request-account-review/.md) mutation ● [`setupAccount`](https://docs.monei.com/apis/graphql/operations/mutations/setup-account/.md) mutation ● [`startCompanyLookup`](https://docs.monei.com/apis/graphql/operations/mutations/start-company-lookup/.md) mutation ● [`updateAccount`](https://docs.monei.com/apis/graphql/operations/mutations/update-account/.md) mutation ● [`verifyBusinessDetails`](https://docs.monei.com/apis/graphql/operations/mutations/verify-business-details/.md) mutation ● [`verifyCustomDomain`](https://docs.monei.com/apis/graphql/operations/mutations/verify-custom-domain/.md) mutation


---

# ActivateAccount

Account activation response

```
type ActivateAccount {
  contractUrl: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ActivateAccount.contractUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#activateaccountcontracturlstring- "Direct link to activateaccountcontracturlstring-")

The url of the contract signing session

### Returned By[​](#returned-by "Direct link to Returned By")

[`activateAccount`](https://docs.monei.com/apis/graphql/operations/mutations/activate-account/.md) mutation


---

# Address

Full address details

```
type Address {
  city: String
  country: String
  line1: String
  line2: String
  zip: String
  state: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Address.city`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#addresscitystring- "Direct link to addresscitystring-")

Address city

#### [`Address.country`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#addresscountrystring- "Direct link to addresscountrystring-")

Address country as ISO 3166-1 alpha-2 code

#### [`Address.line1`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#addressline1string- "Direct link to addressline1string-")

Address line 1

#### [`Address.line2`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#addressline2string- "Direct link to addressline2string-")

Address line 2

#### [`Address.zip`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#addresszipstring- "Direct link to addresszipstring-")

Address ZIP code

#### [`Address.state`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#addressstatestring- "Direct link to addressstatestring-")

Address state

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountPublicBusinessDetails`](https://docs.monei.com/apis/graphql/types/objects/account-public-business-details/.md) object ● [`BusinessData`](https://docs.monei.com/apis/graphql/types/objects/business-data/.md) object ● [`ContactDetails`](https://docs.monei.com/apis/graphql/types/objects/contact-details/.md) object ● [`PaymentMethodSepa`](https://docs.monei.com/apis/graphql/types/objects/payment-method-sepa/.md) object ● [`Representative`](https://docs.monei.com/apis/graphql/types/objects/representative/.md) object ● [`Store`](https://docs.monei.com/apis/graphql/types/objects/store/.md) object


---

# ApplePayCertificate

Custom Apple Pay Certificate needed to enable Apple Pay in the native iOS app. Apple only allows certificates that are created by developers to be used in the Apple Pay payment process. Register your custom Apple Pay certificate to allow MONEI to decrypt the payment data.

```
type ApplePayCertificate {
  id: ID!
  accountId: ID!
  expireAt: String
  active: Boolean!
  cert: String
  csr: String
  createdAt: String!
  updatedAt: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ApplePayCertificate.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#applepaycertificateidid-- "Direct link to applepaycertificateidid--")

Apple Pay certificate ID

#### [`ApplePayCertificate.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#applepaycertificateaccountidid-- "Direct link to applepaycertificateaccountidid--")

Account ID

#### [`ApplePayCertificate.expireAt`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#applepaycertificateexpireatstring- "Direct link to applepaycertificateexpireatstring-")

Expiration date, in ISO 8601 format

#### [`ApplePayCertificate.active`](#) ● [`Boolean!`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) non-null scalar[​](#applepaycertificateactiveboolean-- "Direct link to applepaycertificateactiveboolean--")

Whether the certificate is active or not

#### [`ApplePayCertificate.cert`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#applepaycertificatecertstring- "Direct link to applepaycertificatecertstring-")

The base64 encoded PEM certificate

#### [`ApplePayCertificate.csr`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#applepaycertificatecsrstring- "Direct link to applepaycertificatecsrstring-")

The base64 encoded PEM Certificate Signing Request

#### [`ApplePayCertificate.createdAt`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#applepaycertificatecreatedatstring-- "Direct link to applepaycertificatecreatedatstring--")

Created date, in ISO 8601 format

#### [`ApplePayCertificate.updatedAt`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#applepaycertificateupdatedatstring- "Direct link to applepaycertificateupdatedatstring-")

Updated date, in ISO 8601 format

### Returned By[​](#returned-by "Direct link to Returned By")

[`activateApplePayCert`](https://docs.monei.com/apis/graphql/operations/mutations/activate-apple-pay-cert/.md) mutation ● [`applePayCert`](https://docs.monei.com/apis/graphql/operations/queries/apple-pay-cert/.md) query ● [`applePayCerts`](https://docs.monei.com/apis/graphql/operations/queries/apple-pay-certs/.md) query ● [`createApplePayCert`](https://docs.monei.com/apis/graphql/operations/mutations/create-apple-pay-cert/.md) mutation ● [`updateApplePayCert`](https://docs.monei.com/apis/graphql/operations/mutations/update-apple-pay-cert/.md) mutation


---

# AuthorizedUser

An authorized user that can access the MONEI dashboard. One user can have access to multiple accounts with different access levels.

```
type AuthorizedUser {
  userEmail: String!
  id: ID!
  accessLevel: AuthorizedUserAccessLevel!
  storeId: ID
  pointOfSaleId: ID
  status: AuthorizedUserStatus!
  lastLoginAt: String
  createdAt: String
  updatedAt: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AuthorizedUser.userEmail`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#authorizeduseruseremailstring-- "Direct link to authorizeduseruseremailstring--")

Email address of the authorized user

#### [`AuthorizedUser.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#authorizeduseridid-- "Direct link to authorizeduseridid--")

ID of the authorized user

#### [`AuthorizedUser.accessLevel`](#) ● [`AuthorizedUserAccessLevel!`](https://docs.monei.com/apis/graphql/types/enums/authorized-user-access-level/.md) non-null enum[​](#authorizeduseraccesslevelauthorizeduseraccesslevel-- "Direct link to authorizeduseraccesslevelauthorizeduseraccesslevel--")

Access level for the authorized user

#### [`AuthorizedUser.storeId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#authorizeduserstoreidid- "Direct link to authorizeduserstoreidid-")

Limit access to a specific store

#### [`AuthorizedUser.pointOfSaleId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#authorizeduserpointofsaleidid- "Direct link to authorizeduserpointofsaleidid-")

Limit access to a specific point of sale

#### [`AuthorizedUser.status`](#) ● [`AuthorizedUserStatus!`](https://docs.monei.com/apis/graphql/types/enums/authorized-user-status/.md) non-null enum[​](#authorizeduserstatusauthorizeduserstatus-- "Direct link to authorizeduserstatusauthorizeduserstatus--")

Status of the authorized user

#### [`AuthorizedUser.lastLoginAt`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#authorizeduserlastloginatstring- "Direct link to authorizeduserlastloginatstring-")

Last login date

#### [`AuthorizedUser.createdAt`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#authorizedusercreatedatstring- "Direct link to authorizedusercreatedatstring-")

Creation date, in ISO 8601 format

#### [`AuthorizedUser.updatedAt`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#authorizeduserupdatedatstring- "Direct link to authorizeduserupdatedatstring-")

Updated date, in ISO 8601 format

### Returned By[​](#returned-by "Direct link to Returned By")

[`createAuthorizedUser`](https://docs.monei.com/apis/graphql/operations/mutations/create-authorized-user/.md) mutation ● [`updateAuthorizedUser`](https://docs.monei.com/apis/graphql/operations/mutations/update-authorized-user/.md) mutation

### Member Of[​](#member-of "Direct link to Member Of")

[`AuthorizedUsersConnection`](https://docs.monei.com/apis/graphql/types/objects/authorized-users-connection/.md) object


---

# AuthorizedUsersConnection

No description

```
type AuthorizedUsersConnection {
  items: [AuthorizedUser!]!
  nextToken: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AuthorizedUsersConnection.items`](#) ● [`[AuthorizedUser!]!`](https://docs.monei.com/apis/graphql/types/objects/authorized-user/.md) non-null object[​](#authorizedusersconnectionitemsauthorizeduser-- "Direct link to authorizedusersconnectionitemsauthorizeduser--")

List of the authorized users

#### [`AuthorizedUsersConnection.nextToken`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#authorizedusersconnectionnexttokenstring- "Direct link to authorizedusersconnectionnexttokenstring-")

The string that you use in a subsequent request to get the next page of results in a paginated response.

### Returned By[​](#returned-by "Direct link to Returned By")

[`authorizedUsers`](https://docs.monei.com/apis/graphql/operations/queries/authorized-users/.md) query


---

# AvailablePaymentMethod

No description

```
type AvailablePaymentMethod {
  paymentMethod: PaymentMethods
  configured: Boolean
  enabled: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AvailablePaymentMethod.paymentMethod`](#) ● [`PaymentMethods`](https://docs.monei.com/apis/graphql/types/enums/payment-methods/.md) enum[​](#availablepaymentmethodpaymentmethodpaymentmethods- "Direct link to availablepaymentmethodpaymentmethodpaymentmethods-")

The specific payment method

#### [`AvailablePaymentMethod.configured`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#availablepaymentmethodconfiguredboolean- "Direct link to availablepaymentmethodconfiguredboolean-")

Whether there is one provider configured for the payment method

#### [`AvailablePaymentMethod.enabled`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#availablepaymentmethodenabledboolean- "Direct link to availablepaymentmethodenabledboolean-")

Whether there is one provider enabled for the payment method

### Returned By[​](#returned-by "Direct link to Returned By")

[`availablePaymentMethods`](https://docs.monei.com/apis/graphql/operations/queries/available-payment-methods/.md) query


---

# AvailableProcessor

No description

```
type AvailableProcessor {
  paymentMethod: PaymentMethods
  processor: Processor
  configured: Boolean
  configurable: Boolean
  enabled: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`AvailableProcessor.paymentMethod`](#) ● [`PaymentMethods`](https://docs.monei.com/apis/graphql/types/enums/payment-methods/.md) enum[​](#availableprocessorpaymentmethodpaymentmethods- "Direct link to availableprocessorpaymentmethodpaymentmethods-")

The requested payment method

#### [`AvailableProcessor.processor`](#) ● [`Processor`](https://docs.monei.com/apis/graphql/types/enums/processor/.md) enum[​](#availableprocessorprocessorprocessor- "Direct link to availableprocessorprocessorprocessor-")

The specific processor

#### [`AvailableProcessor.configured`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#availableprocessorconfiguredboolean- "Direct link to availableprocessorconfiguredboolean-")

Whether there is one provider configured for the payment method and processor

#### [`AvailableProcessor.configurable`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#availableprocessorconfigurableboolean- "Direct link to availableprocessorconfigurableboolean-")

Whether the processor is open to be configured or not

#### [`AvailableProcessor.enabled`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#availableprocessorenabledboolean- "Direct link to availableprocessorenabledboolean-")

Whether there is one provider enabled for the payment method and processor

### Returned By[​](#returned-by "Direct link to Returned By")

[`availableProcessors`](https://docs.monei.com/apis/graphql/operations/queries/available-processors/.md) query


---

# BankAccount

Bank account information

```
type BankAccount {
  status: BankAccountStatus!
  iban: String
  currency: String
  ownerName: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`BankAccount.status`](#) ● [`BankAccountStatus!`](https://docs.monei.com/apis/graphql/types/enums/bank-account-status/.md) non-null enum[​](#bankaccountstatusbankaccountstatus-- "Direct link to bankaccountstatusbankaccountstatus--")

Bank account status

#### [`BankAccount.iban`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#bankaccountibanstring- "Direct link to bankaccountibanstring-")

Bank account IBAN

#### [`BankAccount.currency`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#bankaccountcurrencystring- "Direct link to bankaccountcurrencystring-")

Bank account currency

#### [`BankAccount.ownerName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#bankaccountownernamestring- "Direct link to bankaccountownernamestring-")

Bank account owner name

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object


---

# Bank

No description

```
type Bank {
  id: ID!
  name: String!
  logo: String!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Bank.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#bankidid-- "Direct link to bankidid--")

#### [`Bank.name`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#banknamestring-- "Direct link to banknamestring--")

#### [`Bank.logo`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#banklogostring-- "Direct link to banklogostring--")

### Returned By[​](#returned-by "Direct link to Returned By")

[`banks`](https://docs.monei.com/apis/graphql/operations/queries/banks/.md) query


---

# BlacklistItem

Blacklist item, e.g. email, phone, ip, card, bin, fingerprint. All payments with this value will be blocked.

```
type BlacklistItem {
  value: String!
  type: BlacklistItemType!
  accountId: ID
  createdAt: String!
  updatedAt: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`BlacklistItem.value`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#blacklistitemvaluestring-- "Direct link to blacklistitemvaluestring--")

The value of the blacklist item, e.g. email, phone, ip, card, bin, fingerprint

#### [`BlacklistItem.type`](#) ● [`BlacklistItemType!`](https://docs.monei.com/apis/graphql/types/enums/blacklist-item-type/.md) non-null enum[​](#blacklistitemtypeblacklistitemtype-- "Direct link to blacklistitemtypeblacklistitemtype--")

The type of the blacklist item

#### [`BlacklistItem.accountId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#blacklistitemaccountidid- "Direct link to blacklistitemaccountidid-")

The account ID that created the blacklist item

#### [`BlacklistItem.createdAt`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#blacklistitemcreatedatstring-- "Direct link to blacklistitemcreatedatstring--")

Creation date in ISO 8601 format

#### [`BlacklistItem.updatedAt`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#blacklistitemupdatedatstring- "Direct link to blacklistitemupdatedatstring-")

Last update date in ISO 8601 format

### Returned By[​](#returned-by "Direct link to Returned By")

[`addBlacklistItem`](https://docs.monei.com/apis/graphql/operations/mutations/add-blacklist-item/.md) mutation ● [`blacklistItem`](https://docs.monei.com/apis/graphql/operations/queries/blacklist-item/.md) query

### Member Of[​](#member-of "Direct link to Member Of")

[`BlacklistItemsConnection`](https://docs.monei.com/apis/graphql/types/objects/blacklist-items-connection/.md) object


---

# BlacklistItemsConnection

No description

```
type BlacklistItemsConnection {
  items: [BlacklistItem]!
  nextToken: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`BlacklistItemsConnection.items`](#) ● [`[BlacklistItem]!`](https://docs.monei.com/apis/graphql/types/objects/blacklist-item/.md) non-null object[​](#blacklistitemsconnectionitemsblacklistitem-- "Direct link to blacklistitemsconnectionitemsblacklistitem--")

List of the authorized users

#### [`BlacklistItemsConnection.nextToken`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#blacklistitemsconnectionnexttokenstring- "Direct link to blacklistitemsconnectionnexttokenstring-")

The string that you use in a subsequent request to get the next page of results in a paginated response.

### Returned By[​](#returned-by "Direct link to Returned By")

[`blacklistItems`](https://docs.monei.com/apis/graphql/operations/queries/blacklist-items/.md) query


---

# BusinessData

Business details

```
type BusinessData {
  country: String
  legalForm: LegalForm
  legalName: String
  companyName: String
  address: Address
  documentNumber: String
  email: String
  phone: String
  website: String
  monthlyVolume: Long
  confirmWebsite: Boolean
  industry: Industries
  mcc: String
  allowedMcc: [String!]
  servicesDescription: String
  confirmServicesDescription: Boolean
  status: BusinessStatus
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`BusinessData.country`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#businessdatacountrystring- "Direct link to businessdatacountrystring-")

Country code, ISO 3166-1 alpha-2 code

#### [`BusinessData.legalForm`](#) ● [`LegalForm`](https://docs.monei.com/apis/graphql/types/enums/legal-form/.md) enum[​](#businessdatalegalformlegalform- "Direct link to businessdatalegalformlegalform-")

Legal form

#### [`BusinessData.legalName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#businessdatalegalnamestring- "Direct link to businessdatalegalnamestring-")

Legal name

#### [`BusinessData.companyName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#businessdatacompanynamestring- "Direct link to businessdatacompanynamestring-")

Company name, could be different from legal name

#### [`BusinessData.address`](#) ● [`Address`](https://docs.monei.com/apis/graphql/types/objects/address/.md) object[​](#businessdataaddressaddress- "Direct link to businessdataaddressaddress-")

Full address

#### [`BusinessData.documentNumber`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#businessdatadocumentnumberstring- "Direct link to businessdatadocumentnumberstring-")

Company tax ID (CIF/NIF)

#### [`BusinessData.email`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#businessdataemailstring- "Direct link to businessdataemailstring-")

Company email

#### [`BusinessData.phone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#businessdataphonestring- "Direct link to businessdataphonestring-")

Phone number in E.164 format, e.g. +34666777888

#### [`BusinessData.website`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#businessdatawebsitestring- "Direct link to businessdatawebsitestring-")

Website

#### [`BusinessData.monthlyVolume`](#) ● [`Long`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) scalar[​](#businessdatamonthlyvolumelong- "Direct link to businessdatamonthlyvolumelong-")

Expected monthly volume in EUR

#### [`BusinessData.confirmWebsite`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#businessdataconfirmwebsiteboolean- "Direct link to businessdataconfirmwebsiteboolean-")

Confirms that website complies with requirements

#### [`BusinessData.industry`](#) ● [`Industries`](https://docs.monei.com/apis/graphql/types/enums/industries/.md) enum[​](#businessdataindustryindustries- "Direct link to businessdataindustryindustries-")

Company Industry

#### [`BusinessData.mcc`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#businessdatamccstring- "Direct link to businessdatamccstring-")

Merchant Category Codes (MCC) in ISO 18245:2003 format

#### [`BusinessData.allowedMcc`](#) ● [`[String!]`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) list scalar[​](#businessdataallowedmccstring-- "Direct link to businessdataallowedmccstring--")

A list of allowed MCCs

#### [`BusinessData.servicesDescription`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#businessdataservicesdescriptionstring- "Direct link to businessdataservicesdescriptionstring-")

A description of the products or services it provides

#### [`BusinessData.confirmServicesDescription`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#businessdataconfirmservicesdescriptionboolean- "Direct link to businessdataconfirmservicesdescriptionboolean-")

Confirms that service complies with requirements

#### [`BusinessData.status`](#) ● [`BusinessStatus`](https://docs.monei.com/apis/graphql/types/enums/business-status/.md) enum[​](#businessdatastatusbusinessstatus- "Direct link to businessdatastatusbusinessstatus-")

Business status

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object


---

# CallbackData

No description

```
type CallbackData {
  status: [CallbackStatus!]!
  statusCode: String
  statusMessage: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CallbackData.status`](#) ● [`[CallbackStatus!]!`](https://docs.monei.com/apis/graphql/types/enums/callback-status/.md) non-null enum[​](#callbackdatastatuscallbackstatus-- "Direct link to callbackdatastatuscallbackstatus--")

#### [`CallbackData.statusCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#callbackdatastatuscodestring- "Direct link to callbackdatastatuscodestring-")

#### [`CallbackData.statusMessage`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#callbackdatastatusmessagestring- "Direct link to callbackdatastatusmessagestring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`Webhook`](https://docs.monei.com/apis/graphql/types/objects/webhook/.md) object


---

# CapitalAccountData

MONEI Capital account data containing offer and optional lead information

```
type CapitalAccountData {
  offer: CapitalOffer
  lead: CapitalLead
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CapitalAccountData.offer`](#) ● [`CapitalOffer`](https://docs.monei.com/apis/graphql/types/objects/capital-offer/.md) object[​](#capitalaccountdataoffercapitaloffer- "Direct link to capitalaccountdataoffercapitaloffer-")

MONEI Capital offer if available and not expired

#### [`CapitalAccountData.lead`](#) ● [`CapitalLead`](https://docs.monei.com/apis/graphql/types/objects/capital-lead/.md) object[​](#capitalaccountdataleadcapitallead- "Direct link to capitalaccountdataleadcapitallead-")

MONEI Capital lead if user has applied

### Returned By[​](#returned-by "Direct link to Returned By")

[`getCapitalDataByAccount`](https://docs.monei.com/apis/graphql/operations/queries/get-capital-data-by-account/.md) query


---

# CapitalLead

MONEI Capital lead information

```
type CapitalLead {
  onboardingStatus: CapitalOnboardingStatus!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CapitalLead.onboardingStatus`](#) ● [`CapitalOnboardingStatus!`](https://docs.monei.com/apis/graphql/types/enums/capital-onboarding-status/.md) non-null enum[​](#capitalleadonboardingstatuscapitalonboardingstatus-- "Direct link to capitalleadonboardingstatuscapitalonboardingstatus--")

Onboarding status

### Member Of[​](#member-of "Direct link to Member Of")

[`CapitalAccountData`](https://docs.monei.com/apis/graphql/types/objects/capital-account-data/.md) object


---

# CapitalLoanDefaultDetails

MONEI Capital loan default details

```
type CapitalLoanDefaultDetails {
  reason: String
  reasonDetails: String
  dateDefaulted: String!
  currentAmountAtTimeOfDefault: Float!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CapitalLoanDefaultDetails.reason`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#capitalloandefaultdetailsreasonstring- "Direct link to capitalloandefaultdetailsreasonstring-")

#### [`CapitalLoanDefaultDetails.reasonDetails`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#capitalloandefaultdetailsreasondetailsstring- "Direct link to capitalloandefaultdetailsreasondetailsstring-")

#### [`CapitalLoanDefaultDetails.dateDefaulted`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#capitalloandefaultdetailsdatedefaultedstring-- "Direct link to capitalloandefaultdetailsdatedefaultedstring--")

#### [`CapitalLoanDefaultDetails.currentAmountAtTimeOfDefault`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloandefaultdetailscurrentamountattimeofdefaultfloat-- "Direct link to capitalloandefaultdetailscurrentamountattimeofdefaultfloat--")

### Member Of[​](#member-of "Direct link to Member Of")

[`CapitalLoanDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-details/.md) object


---

# CapitalLoanDetails

MONEI Capital loan details

```
type CapitalLoanDetails {
  repaymentMethod: String
  repaymentFrequency: String
  expectedRepayment: Float!
  autoRepaymentSweep: Boolean!
  borrowerId: ID!
  borrowerName: String
  currencyISOCode: Currencies
  currentAmount: Float!
  currentServiceChargeRate: Float
  defaultDetails: CapitalLoanDefaultDetails
  discount: Float!
  id: ID!
  approvalDate: String
  maturityDate: String!
  originalAmount: Float!
  originalServiceChargeRate: Float
  projectedRepaymentDate: String!
  securityAndGuarantees: Boolean
  loanType: CapitalLoanType
  partnerLoanType: CapitalLoanType
  status: CapitalLoanStatus
  sweep: Float!
  loanNumber: Int!
  creditRating: String
  lead: CapitalLoanLead
  earlyRenewalDetails: CapitalLoanEarlyRenewalDetails
  fundingDetails: CapitalLoanFundingDetails
  writeOffDetails: CapitalLoanWriteOffDetails
  thirdPartyReferences: [CapitalLoanThirdPartyReference!]
  documents: [CapitalLoanDocumentItem!]
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CapitalLoanDetails.repaymentMethod`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#capitalloandetailsrepaymentmethodstring- "Direct link to capitalloandetailsrepaymentmethodstring-")

#### [`CapitalLoanDetails.repaymentFrequency`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#capitalloandetailsrepaymentfrequencystring- "Direct link to capitalloandetailsrepaymentfrequencystring-")

#### [`CapitalLoanDetails.expectedRepayment`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloandetailsexpectedrepaymentfloat-- "Direct link to capitalloandetailsexpectedrepaymentfloat--")

#### [`CapitalLoanDetails.autoRepaymentSweep`](#) ● [`Boolean!`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) non-null scalar[​](#capitalloandetailsautorepaymentsweepboolean-- "Direct link to capitalloandetailsautorepaymentsweepboolean--")

#### [`CapitalLoanDetails.borrowerId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#capitalloandetailsborroweridid-- "Direct link to capitalloandetailsborroweridid--")

#### [`CapitalLoanDetails.borrowerName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#capitalloandetailsborrowernamestring- "Direct link to capitalloandetailsborrowernamestring-")

#### [`CapitalLoanDetails.currencyISOCode`](#) ● [`Currencies`](https://docs.monei.com/apis/graphql/types/enums/currencies/.md) enum[​](#capitalloandetailscurrencyisocodecurrencies- "Direct link to capitalloandetailscurrencyisocodecurrencies-")

#### [`CapitalLoanDetails.currentAmount`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloandetailscurrentamountfloat-- "Direct link to capitalloandetailscurrentamountfloat--")

#### [`CapitalLoanDetails.currentServiceChargeRate`](#) ● [`Float`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) scalar[​](#capitalloandetailscurrentservicechargeratefloat- "Direct link to capitalloandetailscurrentservicechargeratefloat-")

#### [`CapitalLoanDetails.defaultDetails`](#) ● [`CapitalLoanDefaultDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-default-details/.md) object[​](#capitalloandetailsdefaultdetailscapitalloandefaultdetails- "Direct link to capitalloandetailsdefaultdetailscapitalloandefaultdetails-")

#### [`CapitalLoanDetails.discount`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloandetailsdiscountfloat-- "Direct link to capitalloandetailsdiscountfloat--")

#### [`CapitalLoanDetails.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#capitalloandetailsidid-- "Direct link to capitalloandetailsidid--")

#### [`CapitalLoanDetails.approvalDate`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#capitalloandetailsapprovaldatestring- "Direct link to capitalloandetailsapprovaldatestring-")

#### [`CapitalLoanDetails.maturityDate`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#capitalloandetailsmaturitydatestring-- "Direct link to capitalloandetailsmaturitydatestring--")

#### [`CapitalLoanDetails.originalAmount`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloandetailsoriginalamountfloat-- "Direct link to capitalloandetailsoriginalamountfloat--")

#### [`CapitalLoanDetails.originalServiceChargeRate`](#) ● [`Float`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) scalar[​](#capitalloandetailsoriginalservicechargeratefloat- "Direct link to capitalloandetailsoriginalservicechargeratefloat-")

#### [`CapitalLoanDetails.projectedRepaymentDate`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#capitalloandetailsprojectedrepaymentdatestring-- "Direct link to capitalloandetailsprojectedrepaymentdatestring--")

#### [`CapitalLoanDetails.securityAndGuarantees`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#capitalloandetailssecurityandguaranteesboolean- "Direct link to capitalloandetailssecurityandguaranteesboolean-")

#### [`CapitalLoanDetails.loanType`](#) ● [`CapitalLoanType`](https://docs.monei.com/apis/graphql/types/enums/capital-loan-type/.md) enum[​](#capitalloandetailsloantypecapitalloantype- "Direct link to capitalloandetailsloantypecapitalloantype-")

#### [`CapitalLoanDetails.partnerLoanType`](#) ● [`CapitalLoanType`](https://docs.monei.com/apis/graphql/types/enums/capital-loan-type/.md) enum[​](#capitalloandetailspartnerloantypecapitalloantype- "Direct link to capitalloandetailspartnerloantypecapitalloantype-")

#### [`CapitalLoanDetails.status`](#) ● [`CapitalLoanStatus`](https://docs.monei.com/apis/graphql/types/enums/capital-loan-status/.md) enum[​](#capitalloandetailsstatuscapitalloanstatus- "Direct link to capitalloandetailsstatuscapitalloanstatus-")

#### [`CapitalLoanDetails.sweep`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloandetailssweepfloat-- "Direct link to capitalloandetailssweepfloat--")

#### [`CapitalLoanDetails.loanNumber`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#capitalloandetailsloannumberint-- "Direct link to capitalloandetailsloannumberint--")

#### [`CapitalLoanDetails.creditRating`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#capitalloandetailscreditratingstring- "Direct link to capitalloandetailscreditratingstring-")

#### [`CapitalLoanDetails.lead`](#) ● [`CapitalLoanLead`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-lead/.md) object[​](#capitalloandetailsleadcapitalloanlead- "Direct link to capitalloandetailsleadcapitalloanlead-")

#### [`CapitalLoanDetails.earlyRenewalDetails`](#) ● [`CapitalLoanEarlyRenewalDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-early-renewal-details/.md) object[​](#capitalloandetailsearlyrenewaldetailscapitalloanearlyrenewaldetails- "Direct link to capitalloandetailsearlyrenewaldetailscapitalloanearlyrenewaldetails-")

#### [`CapitalLoanDetails.fundingDetails`](#) ● [`CapitalLoanFundingDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-funding-details/.md) object[​](#capitalloandetailsfundingdetailscapitalloanfundingdetails- "Direct link to capitalloandetailsfundingdetailscapitalloanfundingdetails-")

#### [`CapitalLoanDetails.writeOffDetails`](#) ● [`CapitalLoanWriteOffDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-write-off-details/.md) object[​](#capitalloandetailswriteoffdetailscapitalloanwriteoffdetails- "Direct link to capitalloandetailswriteoffdetailscapitalloanwriteoffdetails-")

#### [`CapitalLoanDetails.thirdPartyReferences`](#) ● [`[CapitalLoanThirdPartyReference!]`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-third-party-reference/.md) list object[​](#capitalloandetailsthirdpartyreferencescapitalloanthirdpartyreference-- "Direct link to capitalloandetailsthirdpartyreferencescapitalloanthirdpartyreference--")

#### [`CapitalLoanDetails.documents`](#) ● [`[CapitalLoanDocumentItem!]`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-document-item/.md) list object[​](#capitalloandetailsdocumentscapitalloandocumentitem-- "Direct link to capitalloandetailsdocumentscapitalloandocumentitem--")

### Returned By[​](#returned-by "Direct link to Returned By")

[`getCapitalLoan`](https://docs.monei.com/apis/graphql/operations/queries/get-capital-loan/.md) query


---

# CapitalLoanDocumentItem

MONEI Capital loan document

```
type CapitalLoanDocumentItem {
  document: CapitalLoanDocumentReference!
  documentType: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CapitalLoanDocumentItem.document`](#) ● [`CapitalLoanDocumentReference!`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-document-reference/.md) non-null object[​](#capitalloandocumentitemdocumentcapitalloandocumentreference-- "Direct link to capitalloandocumentitemdocumentcapitalloandocumentreference--")

#### [`CapitalLoanDocumentItem.documentType`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#capitalloandocumentitemdocumenttypestring- "Direct link to capitalloandocumentitemdocumenttypestring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`CapitalLoanDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-details/.md) object


---

# CapitalLoanDocumentReference

MONEI Capital loan document reference

```
type CapitalLoanDocumentReference {
  documentId: ID!
  documentName: String
  documentType: String
  dateUploaded: String!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CapitalLoanDocumentReference.documentId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#capitalloandocumentreferencedocumentidid-- "Direct link to capitalloandocumentreferencedocumentidid--")

#### [`CapitalLoanDocumentReference.documentName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#capitalloandocumentreferencedocumentnamestring- "Direct link to capitalloandocumentreferencedocumentnamestring-")

#### [`CapitalLoanDocumentReference.documentType`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#capitalloandocumentreferencedocumenttypestring- "Direct link to capitalloandocumentreferencedocumenttypestring-")

#### [`CapitalLoanDocumentReference.dateUploaded`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#capitalloandocumentreferencedateuploadedstring-- "Direct link to capitalloandocumentreferencedateuploadedstring--")

### Member Of[​](#member-of "Direct link to Member Of")

[`CapitalLoanDocumentItem`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-document-item/.md) object


---

# CapitalLoanDocument

MONEI Capital loan document

```
type CapitalLoanDocument {
  document: String
  documentId: ID!
  documentType: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CapitalLoanDocument.document`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#capitalloandocumentdocumentstring- "Direct link to capitalloandocumentdocumentstring-")

#### [`CapitalLoanDocument.documentId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#capitalloandocumentdocumentidid-- "Direct link to capitalloandocumentdocumentidid--")

#### [`CapitalLoanDocument.documentType`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#capitalloandocumentdocumenttypestring- "Direct link to capitalloandocumentdocumenttypestring-")

### Returned By[​](#returned-by "Direct link to Returned By")

[`getCapitalLoanDocument`](https://docs.monei.com/apis/graphql/operations/queries/get-capital-loan-document/.md) query


---

# CapitalLoanEarlyRenewalDetails

MONEI Capital loan early renewal details

```
type CapitalLoanEarlyRenewalDetails {
  oldLoanId: ID!
  oldLoanNumber: Int!
  isOldLoanRepaid: Boolean!
  newLoanId: ID!
  newLoanNumber: Int!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CapitalLoanEarlyRenewalDetails.oldLoanId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#capitalloanearlyrenewaldetailsoldloanidid-- "Direct link to capitalloanearlyrenewaldetailsoldloanidid--")

#### [`CapitalLoanEarlyRenewalDetails.oldLoanNumber`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#capitalloanearlyrenewaldetailsoldloannumberint-- "Direct link to capitalloanearlyrenewaldetailsoldloannumberint--")

#### [`CapitalLoanEarlyRenewalDetails.isOldLoanRepaid`](#) ● [`Boolean!`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) non-null scalar[​](#capitalloanearlyrenewaldetailsisoldloanrepaidboolean-- "Direct link to capitalloanearlyrenewaldetailsisoldloanrepaidboolean--")

#### [`CapitalLoanEarlyRenewalDetails.newLoanId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#capitalloanearlyrenewaldetailsnewloanidid-- "Direct link to capitalloanearlyrenewaldetailsnewloanidid--")

#### [`CapitalLoanEarlyRenewalDetails.newLoanNumber`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#capitalloanearlyrenewaldetailsnewloannumberint-- "Direct link to capitalloanearlyrenewaldetailsnewloannumberint--")

### Member Of[​](#member-of "Direct link to Member Of")

[`CapitalLoanDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-details/.md) object


---

# CapitalLoanFundingDetails

MONEI Capital loan funding details

```
type CapitalLoanFundingDetails {
  fundingAmount: Float!
  fundingDate: String!
  fundingPayments: [CapitalLoanFundingPayment!]
  amountFunded: Float!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CapitalLoanFundingDetails.fundingAmount`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloanfundingdetailsfundingamountfloat-- "Direct link to capitalloanfundingdetailsfundingamountfloat--")

#### [`CapitalLoanFundingDetails.fundingDate`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#capitalloanfundingdetailsfundingdatestring-- "Direct link to capitalloanfundingdetailsfundingdatestring--")

#### [`CapitalLoanFundingDetails.fundingPayments`](#) ● [`[CapitalLoanFundingPayment!]`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-funding-payment/.md) list object[​](#capitalloanfundingdetailsfundingpaymentscapitalloanfundingpayment-- "Direct link to capitalloanfundingdetailsfundingpaymentscapitalloanfundingpayment--")

#### [`CapitalLoanFundingDetails.amountFunded`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloanfundingdetailsamountfundedfloat-- "Direct link to capitalloanfundingdetailsamountfundedfloat--")

### Member Of[​](#member-of "Direct link to Member Of")

[`CapitalLoanDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-details/.md) object


---

# CapitalLoanFundingPayment

MONEI Capital loan funding payment

```
type CapitalLoanFundingPayment {
  paymentDate: String!
  paymentAmount: Float!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CapitalLoanFundingPayment.paymentDate`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#capitalloanfundingpaymentpaymentdatestring-- "Direct link to capitalloanfundingpaymentpaymentdatestring--")

#### [`CapitalLoanFundingPayment.paymentAmount`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloanfundingpaymentpaymentamountfloat-- "Direct link to capitalloanfundingpaymentpaymentamountfloat--")

### Member Of[​](#member-of "Direct link to Member Of")

[`CapitalLoanFundingDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-funding-details/.md) object


---

# CapitalLoanLead

MONEI Capital loan lead information

```
type CapitalLoanLead {
  countryISOCode: String
  email: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CapitalLoanLead.countryISOCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#capitalloanleadcountryisocodestring- "Direct link to capitalloanleadcountryisocodestring-")

#### [`CapitalLoanLead.email`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#capitalloanleademailstring- "Direct link to capitalloanleademailstring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`CapitalLoanDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-details/.md) object


---

# CapitalLoanRepayment

MONEI Capital loan repayment information

```
type CapitalLoanRepayment {
  paymentDate: String!
  totalCardTransactions: Float
  sweep: Float
  repaymentAmount: Float!
  loanBalance: Float!
  payments: [Float!]
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CapitalLoanRepayment.paymentDate`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#capitalloanrepaymentpaymentdatestring-- "Direct link to capitalloanrepaymentpaymentdatestring--")

#### [`CapitalLoanRepayment.totalCardTransactions`](#) ● [`Float`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) scalar[​](#capitalloanrepaymenttotalcardtransactionsfloat- "Direct link to capitalloanrepaymenttotalcardtransactionsfloat-")

#### [`CapitalLoanRepayment.sweep`](#) ● [`Float`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) scalar[​](#capitalloanrepaymentsweepfloat- "Direct link to capitalloanrepaymentsweepfloat-")

#### [`CapitalLoanRepayment.repaymentAmount`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloanrepaymentrepaymentamountfloat-- "Direct link to capitalloanrepaymentrepaymentamountfloat--")

#### [`CapitalLoanRepayment.loanBalance`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloanrepaymentloanbalancefloat-- "Direct link to capitalloanrepaymentloanbalancefloat--")

#### [`CapitalLoanRepayment.payments`](#) ● [`[Float!]`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) list scalar[​](#capitalloanrepaymentpaymentsfloat-- "Direct link to capitalloanrepaymentpaymentsfloat--")

### Member Of[​](#member-of "Direct link to Member Of")

[`CapitalLoanRepaymentsConnection`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-repayments-connection/.md) object


---

# CapitalLoanRepaymentsConnection

MONEI Capital loan repayments connection

```
type CapitalLoanRepaymentsConnection {
  items: [CapitalLoanRepayment!]!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CapitalLoanRepaymentsConnection.items`](#) ● [`[CapitalLoanRepayment!]!`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-repayment/.md) non-null object[​](#capitalloanrepaymentsconnectionitemscapitalloanrepayment-- "Direct link to capitalloanrepaymentsconnectionitemscapitalloanrepayment--")

List of MONEI Capital loan repayments

### Returned By[​](#returned-by "Direct link to Returned By")

[`getCapitalLoanRepayments`](https://docs.monei.com/apis/graphql/operations/queries/get-capital-loan-repayments/.md) query


---

# CapitalLoanThirdPartyReference

MONEI Capital loan third party reference

```
type CapitalLoanThirdPartyReference {
  thirdPartyId: ID!
  thirdPartyReference: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CapitalLoanThirdPartyReference.thirdPartyId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#capitalloanthirdpartyreferencethirdpartyidid-- "Direct link to capitalloanthirdpartyreferencethirdpartyidid--")

#### [`CapitalLoanThirdPartyReference.thirdPartyReference`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#capitalloanthirdpartyreferencethirdpartyreferencestring- "Direct link to capitalloanthirdpartyreferencethirdpartyreferencestring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`CapitalLoanDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-details/.md) object


---

# CapitalLoanWriteOffDetails

MONEI Capital loan write off details

```
type CapitalLoanWriteOffDetails {
  paymentDate: String!
  paymentAmount: Float!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CapitalLoanWriteOffDetails.paymentDate`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#capitalloanwriteoffdetailspaymentdatestring-- "Direct link to capitalloanwriteoffdetailspaymentdatestring--")

#### [`CapitalLoanWriteOffDetails.paymentAmount`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloanwriteoffdetailspaymentamountfloat-- "Direct link to capitalloanwriteoffdetailspaymentamountfloat--")

### Member Of[​](#member-of "Direct link to Member Of")

[`CapitalLoanDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-details/.md) object


---

# CapitalLoan

MONEI Capital loan information

```
type CapitalLoan {
  id: ID!
  loanNumber: Int!
  borrowerName: String
  currentAmount: Float!
  loanType: CapitalLoanType!
  partnerLoanType: CapitalLoanType!
  status: CapitalLoanStatus!
  maturityDate: String!
  sweep: Float!
  autoRepaymentSweep: Boolean!
  currencyISOCode: Currencies!
  currentAmountAtRepay: Float!
  currentAmountAtDelete: Float!
  currentAmountAtWriteOff: Float!
  merchantIds: [String!]
  creditRating: String
  fundingDate: String!
  fundedAmount: Float!
  originalAmount: Float!
  aheadBehindValue: Float!
  aheadBehindPercentage: Float!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CapitalLoan.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#capitalloanidid-- "Direct link to capitalloanidid--")

#### [`CapitalLoan.loanNumber`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#capitalloanloannumberint-- "Direct link to capitalloanloannumberint--")

#### [`CapitalLoan.borrowerName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#capitalloanborrowernamestring- "Direct link to capitalloanborrowernamestring-")

#### [`CapitalLoan.currentAmount`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloancurrentamountfloat-- "Direct link to capitalloancurrentamountfloat--")

#### [`CapitalLoan.loanType`](#) ● [`CapitalLoanType!`](https://docs.monei.com/apis/graphql/types/enums/capital-loan-type/.md) non-null enum[​](#capitalloanloantypecapitalloantype-- "Direct link to capitalloanloantypecapitalloantype--")

#### [`CapitalLoan.partnerLoanType`](#) ● [`CapitalLoanType!`](https://docs.monei.com/apis/graphql/types/enums/capital-loan-type/.md) non-null enum[​](#capitalloanpartnerloantypecapitalloantype-- "Direct link to capitalloanpartnerloantypecapitalloantype--")

#### [`CapitalLoan.status`](#) ● [`CapitalLoanStatus!`](https://docs.monei.com/apis/graphql/types/enums/capital-loan-status/.md) non-null enum[​](#capitalloanstatuscapitalloanstatus-- "Direct link to capitalloanstatuscapitalloanstatus--")

#### [`CapitalLoan.maturityDate`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#capitalloanmaturitydatestring-- "Direct link to capitalloanmaturitydatestring--")

#### [`CapitalLoan.sweep`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloansweepfloat-- "Direct link to capitalloansweepfloat--")

#### [`CapitalLoan.autoRepaymentSweep`](#) ● [`Boolean!`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) non-null scalar[​](#capitalloanautorepaymentsweepboolean-- "Direct link to capitalloanautorepaymentsweepboolean--")

#### [`CapitalLoan.currencyISOCode`](#) ● [`Currencies!`](https://docs.monei.com/apis/graphql/types/enums/currencies/.md) non-null enum[​](#capitalloancurrencyisocodecurrencies-- "Direct link to capitalloancurrencyisocodecurrencies--")

#### [`CapitalLoan.currentAmountAtRepay`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloancurrentamountatrepayfloat-- "Direct link to capitalloancurrentamountatrepayfloat--")

#### [`CapitalLoan.currentAmountAtDelete`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloancurrentamountatdeletefloat-- "Direct link to capitalloancurrentamountatdeletefloat--")

#### [`CapitalLoan.currentAmountAtWriteOff`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloancurrentamountatwriteofffloat-- "Direct link to capitalloancurrentamountatwriteofffloat--")

#### [`CapitalLoan.merchantIds`](#) ● [`[String!]`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) list scalar[​](#capitalloanmerchantidsstring-- "Direct link to capitalloanmerchantidsstring--")

#### [`CapitalLoan.creditRating`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#capitalloancreditratingstring- "Direct link to capitalloancreditratingstring-")

#### [`CapitalLoan.fundingDate`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#capitalloanfundingdatestring-- "Direct link to capitalloanfundingdatestring--")

#### [`CapitalLoan.fundedAmount`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloanfundedamountfloat-- "Direct link to capitalloanfundedamountfloat--")

#### [`CapitalLoan.originalAmount`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloanoriginalamountfloat-- "Direct link to capitalloanoriginalamountfloat--")

#### [`CapitalLoan.aheadBehindValue`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloanaheadbehindvaluefloat-- "Direct link to capitalloanaheadbehindvaluefloat--")

#### [`CapitalLoan.aheadBehindPercentage`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalloanaheadbehindpercentagefloat-- "Direct link to capitalloanaheadbehindpercentagefloat--")

### Member Of[​](#member-of "Direct link to Member Of")

[`CapitalLoansConnection`](https://docs.monei.com/apis/graphql/types/objects/capital-loans-connection/.md) object


---

# CapitalLoansConnection

MONEI Capital loans connection

```
type CapitalLoansConnection {
  items: [CapitalLoan!]!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CapitalLoansConnection.items`](#) ● [`[CapitalLoan!]!`](https://docs.monei.com/apis/graphql/types/objects/capital-loan/.md) non-null object[​](#capitalloansconnectionitemscapitalloan-- "Direct link to capitalloansconnectionitemscapitalloan--")

List of MONEI Capital loans

### Returned By[​](#returned-by "Direct link to Returned By")

[`getCapitalLoans`](https://docs.monei.com/apis/graphql/operations/queries/get-capital-loans/.md) query


---

# CapitalOffer

MONEI Capital offer information

```
type CapitalOffer {
  fee: Float!
  fundedAmount: Float!
  loanAmount: Float!
  currencyISOCode: Currencies!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CapitalOffer.fee`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalofferfeefloat-- "Direct link to capitalofferfeefloat--")

Fee amount

#### [`CapitalOffer.fundedAmount`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalofferfundedamountfloat-- "Direct link to capitalofferfundedamountfloat--")

Funded amount

#### [`CapitalOffer.loanAmount`](#) ● [`Float!`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) non-null scalar[​](#capitalofferloanamountfloat-- "Direct link to capitalofferloanamountfloat--")

Loan amount

#### [`CapitalOffer.currencyISOCode`](#) ● [`Currencies!`](https://docs.monei.com/apis/graphql/types/enums/currencies/.md) non-null enum[​](#capitaloffercurrencyisocodecurrencies-- "Direct link to capitaloffercurrencyisocodecurrencies--")

Currency ISO code

### Member Of[​](#member-of "Direct link to Member Of")

[`CapitalAccountData`](https://docs.monei.com/apis/graphql/types/objects/capital-account-data/.md) object


---

# ChargeEventObject

No description

```
type ChargeEventObject {
  id: ID!
  accountId: ID!
  providerId: ID
  checkoutId: ID!
  providerInternalId: ID
  providerReferenceId: ID
  createdAt: AWSTimestamp
  updatedAt: AWSTimestamp
  amount: Int
  amountEUR: Int
  authorizationCode: String
  billingDetails: ContactDetails
  billingPlan: BillingPlans
  currency: String!
  customer: Customer
  description: String
  descriptor: String
  livemode: Boolean
  orderId: ID
  storeId: ID
  pointOfSaleId: ID
  sequenceId: ID
  subscriptionId: ID
  paymentMethod: PaymentMethod
  cancellationReason: CancellationReason
  lastRefundAmount: Int
  lastRefundReason: RefundReason
  refundedAmount: Int
  shippingDetails: ContactDetails
  shop: Shop
  status: ChargeStatus!
  statusCode: String
  statusMessage: String
  sessionDetails: SessionDetails
  traceDetails: TraceDetails
  pageOpenedAt: AWSTimestamp
  fraudDetectorScore: Int
  metadata: [KeyValueItem!]
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ChargeEventObject.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#chargeeventobjectidid-- "Direct link to chargeeventobjectidid--")

#### [`ChargeEventObject.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#chargeeventobjectaccountidid-- "Direct link to chargeeventobjectaccountidid--")

#### [`ChargeEventObject.providerId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#chargeeventobjectprovideridid- "Direct link to chargeeventobjectprovideridid-")

#### [`ChargeEventObject.checkoutId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#chargeeventobjectcheckoutidid-- "Direct link to chargeeventobjectcheckoutidid--")

#### [`ChargeEventObject.providerInternalId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#chargeeventobjectproviderinternalidid- "Direct link to chargeeventobjectproviderinternalidid-")

#### [`ChargeEventObject.providerReferenceId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#chargeeventobjectproviderreferenceidid- "Direct link to chargeeventobjectproviderreferenceidid-")

#### [`ChargeEventObject.createdAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#chargeeventobjectcreatedatawstimestamp- "Direct link to chargeeventobjectcreatedatawstimestamp-")

#### [`ChargeEventObject.updatedAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#chargeeventobjectupdatedatawstimestamp- "Direct link to chargeeventobjectupdatedatawstimestamp-")

#### [`ChargeEventObject.amount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#chargeeventobjectamountint- "Direct link to chargeeventobjectamountint-")

#### [`ChargeEventObject.amountEUR`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#chargeeventobjectamounteurint- "Direct link to chargeeventobjectamounteurint-")

#### [`ChargeEventObject.authorizationCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#chargeeventobjectauthorizationcodestring- "Direct link to chargeeventobjectauthorizationcodestring-")

#### [`ChargeEventObject.billingDetails`](#) ● [`ContactDetails`](https://docs.monei.com/apis/graphql/types/objects/contact-details/.md) object[​](#chargeeventobjectbillingdetailscontactdetails- "Direct link to chargeeventobjectbillingdetailscontactdetails-")

#### [`ChargeEventObject.billingPlan`](#) ● [`BillingPlans`](https://docs.monei.com/apis/graphql/types/enums/billing-plans/.md) enum[​](#chargeeventobjectbillingplanbillingplans- "Direct link to chargeeventobjectbillingplanbillingplans-")

#### [`ChargeEventObject.currency`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#chargeeventobjectcurrencystring-- "Direct link to chargeeventobjectcurrencystring--")

#### [`ChargeEventObject.customer`](#) ● [`Customer`](https://docs.monei.com/apis/graphql/types/objects/customer/.md) object[​](#chargeeventobjectcustomercustomer- "Direct link to chargeeventobjectcustomercustomer-")

#### [`ChargeEventObject.description`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#chargeeventobjectdescriptionstring- "Direct link to chargeeventobjectdescriptionstring-")

#### [`ChargeEventObject.descriptor`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#chargeeventobjectdescriptorstring- "Direct link to chargeeventobjectdescriptorstring-")

#### [`ChargeEventObject.livemode`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#chargeeventobjectlivemodeboolean- "Direct link to chargeeventobjectlivemodeboolean-")

#### [`ChargeEventObject.orderId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#chargeeventobjectorderidid- "Direct link to chargeeventobjectorderidid-")

#### [`ChargeEventObject.storeId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#chargeeventobjectstoreidid- "Direct link to chargeeventobjectstoreidid-")

#### [`ChargeEventObject.pointOfSaleId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#chargeeventobjectpointofsaleidid- "Direct link to chargeeventobjectpointofsaleidid-")

#### [`ChargeEventObject.sequenceId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#chargeeventobjectsequenceidid- "Direct link to chargeeventobjectsequenceidid-")

#### [`ChargeEventObject.subscriptionId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#chargeeventobjectsubscriptionidid- "Direct link to chargeeventobjectsubscriptionidid-")

#### [`ChargeEventObject.paymentMethod`](#) ● [`PaymentMethod`](https://docs.monei.com/apis/graphql/types/objects/payment-method/.md) object[​](#chargeeventobjectpaymentmethodpaymentmethod- "Direct link to chargeeventobjectpaymentmethodpaymentmethod-")

#### [`ChargeEventObject.cancellationReason`](#) ● [`CancellationReason`](https://docs.monei.com/apis/graphql/types/enums/cancellation-reason/.md) enum[​](#chargeeventobjectcancellationreasoncancellationreason- "Direct link to chargeeventobjectcancellationreasoncancellationreason-")

#### [`ChargeEventObject.lastRefundAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#chargeeventobjectlastrefundamountint- "Direct link to chargeeventobjectlastrefundamountint-")

#### [`ChargeEventObject.lastRefundReason`](#) ● [`RefundReason`](https://docs.monei.com/apis/graphql/types/enums/refund-reason/.md) enum[​](#chargeeventobjectlastrefundreasonrefundreason- "Direct link to chargeeventobjectlastrefundreasonrefundreason-")

#### [`ChargeEventObject.refundedAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#chargeeventobjectrefundedamountint- "Direct link to chargeeventobjectrefundedamountint-")

#### [`ChargeEventObject.shippingDetails`](#) ● [`ContactDetails`](https://docs.monei.com/apis/graphql/types/objects/contact-details/.md) object[​](#chargeeventobjectshippingdetailscontactdetails- "Direct link to chargeeventobjectshippingdetailscontactdetails-")

#### [`ChargeEventObject.shop`](#) ● [`Shop`](https://docs.monei.com/apis/graphql/types/objects/shop/.md) object[​](#chargeeventobjectshopshop- "Direct link to chargeeventobjectshopshop-")

#### [`ChargeEventObject.status`](#) ● [`ChargeStatus!`](https://docs.monei.com/apis/graphql/types/enums/charge-status/.md) non-null enum[​](#chargeeventobjectstatuschargestatus-- "Direct link to chargeeventobjectstatuschargestatus--")

#### [`ChargeEventObject.statusCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#chargeeventobjectstatuscodestring- "Direct link to chargeeventobjectstatuscodestring-")

#### [`ChargeEventObject.statusMessage`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#chargeeventobjectstatusmessagestring- "Direct link to chargeeventobjectstatusmessagestring-")

#### [`ChargeEventObject.sessionDetails`](#) ● [`SessionDetails`](https://docs.monei.com/apis/graphql/types/objects/session-details/.md) object[​](#chargeeventobjectsessiondetailssessiondetails- "Direct link to chargeeventobjectsessiondetailssessiondetails-")

#### [`ChargeEventObject.traceDetails`](#) ● [`TraceDetails`](https://docs.monei.com/apis/graphql/types/objects/trace-details/.md) object[​](#chargeeventobjecttracedetailstracedetails- "Direct link to chargeeventobjecttracedetailstracedetails-")

#### [`ChargeEventObject.pageOpenedAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#chargeeventobjectpageopenedatawstimestamp- "Direct link to chargeeventobjectpageopenedatawstimestamp-")

#### [`ChargeEventObject.fraudDetectorScore`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#chargeeventobjectfrauddetectorscoreint- "Direct link to chargeeventobjectfrauddetectorscoreint-")

#### [`ChargeEventObject.metadata`](#) ● [`[KeyValueItem!]`](https://docs.monei.com/apis/graphql/types/objects/key-value-item/.md) list object[​](#chargeeventobjectmetadatakeyvalueitem-- "Direct link to chargeeventobjectmetadatakeyvalueitem--")

### Member Of[​](#member-of "Direct link to Member Of")

[`ChargeEvent`](https://docs.monei.com/apis/graphql/types/objects/charge-event/.md) object


---

# ChargeEvent

No description

```
type ChargeEvent {
  id: ID!
  type: String!
  accountId: ID!
  livemode: Boolean
  objectId: ID!
  objectType: String!
  object: ChargeEventObject!
  createdAt: AWSTimestamp
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ChargeEvent.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#chargeeventidid-- "Direct link to chargeeventidid--")

Charge event ID

#### [`ChargeEvent.type`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#chargeeventtypestring-- "Direct link to chargeeventtypestring--")

Event type

#### [`ChargeEvent.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#chargeeventaccountidid-- "Direct link to chargeeventaccountidid--")

Account ID

#### [`ChargeEvent.livemode`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#chargeeventlivemodeboolean- "Direct link to chargeeventlivemodeboolean-")

If the event was created in live mode

#### [`ChargeEvent.objectId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#chargeeventobjectidid-- "Direct link to chargeeventobjectidid--")

The event object ID, this is the ID of the charge

#### [`ChargeEvent.objectType`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#chargeeventobjecttypestring-- "Direct link to chargeeventobjecttypestring--")

The event object type, this is always 'charge'

#### [`ChargeEvent.object`](#) ● [`ChargeEventObject!`](https://docs.monei.com/apis/graphql/types/objects/charge-event-object/.md) non-null object[​](#chargeeventobjectchargeeventobject-- "Direct link to chargeeventobjectchargeeventobject--")

The event object

#### [`ChargeEvent.createdAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#chargeeventcreatedatawstimestamp- "Direct link to chargeeventcreatedatawstimestamp-")

Event creation date as a Unix timestamp

### Member Of[​](#member-of "Direct link to Member Of")

[`ChargeEventsConnection`](https://docs.monei.com/apis/graphql/types/objects/charge-events-connection/.md) object


---

# ChargeEventsConnection

No description

```
type ChargeEventsConnection {
  items: [ChargeEvent!]!
  total: Int!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ChargeEventsConnection.items`](#) ● [`[ChargeEvent!]!`](https://docs.monei.com/apis/graphql/types/objects/charge-event/.md) non-null object[​](#chargeeventsconnectionitemschargeevent-- "Direct link to chargeeventsconnectionitemschargeevent--")

#### [`ChargeEventsConnection.total`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#chargeeventsconnectiontotalint-- "Direct link to chargeeventsconnectiontotalint--")

### Returned By[​](#returned-by "Direct link to Returned By")

[`chargeEvents`](https://docs.monei.com/apis/graphql/operations/queries/charge-events/.md) query ● [`events`](https://docs.monei.com/apis/graphql/operations/queries/events/.md) query


---

# Charge

No description

```
type Charge {
  id: ID!
  accountId: ID!
  providerId: ID
  checkoutId: ID!
  providerInternalId: ID
  providerReferenceId: ID
  createdAt: AWSTimestamp
  updatedAt: AWSTimestamp
  amount: Int
  amountEUR: Int
  authorizationCode: String
  billingDetails: ContactDetails
  billingPlan: BillingPlans
  currency: String!
  customer: Customer
  description: String
  descriptor: String
  livemode: Boolean
  orderId: ID
  storeId: ID
  pointOfSaleId: ID
  terminalId: ID
  sequenceId: ID
  subscriptionId: ID
  paymentMethod: PaymentMethod
  cancellationReason: CancellationReason
  lastRefundAmount: Int
  lastRefundReason: RefundReason
  refundedAmount: Int
  shippingDetails: ContactDetails
  shop: Shop
  status: ChargeStatus!
  statusCode: String
  statusMessage: String
  sessionDetails: SessionDetails
  traceDetails: TraceDetails
  pageOpenedAt: AWSTimestamp
  metadata: [KeyValueItem!]
  fraudDetectorScore: Int
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Charge.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#chargeidid-- "Direct link to chargeidid--")

The charge ID

#### [`Charge.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#chargeaccountidid-- "Direct link to chargeaccountidid--")

The account ID

#### [`Charge.providerId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#chargeprovideridid- "Direct link to chargeprovideridid-")

The provider ID

#### [`Charge.checkoutId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#chargecheckoutidid-- "Direct link to chargecheckoutidid--")

#### [`Charge.providerInternalId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#chargeproviderinternalidid- "Direct link to chargeproviderinternalidid-")

#### [`Charge.providerReferenceId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#chargeproviderreferenceidid- "Direct link to chargeproviderreferenceidid-")

#### [`Charge.createdAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#chargecreatedatawstimestamp- "Direct link to chargecreatedatawstimestamp-")

Created date as a Unix timestamp

#### [`Charge.updatedAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#chargeupdatedatawstimestamp- "Direct link to chargeupdatedatawstimestamp-")

Updated date as a Unix timestamp

#### [`Charge.amount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#chargeamountint- "Direct link to chargeamountint-")

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).

#### [`Charge.amountEUR`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#chargeamounteurint- "Direct link to chargeamounteurint-")

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

#### [`Charge.authorizationCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#chargeauthorizationcodestring- "Direct link to chargeauthorizationcodestring-")

The authorization code

#### [`Charge.billingDetails`](#) ● [`ContactDetails`](https://docs.monei.com/apis/graphql/types/objects/contact-details/.md) object[​](#chargebillingdetailscontactdetails- "Direct link to chargebillingdetailscontactdetails-")

Billing information

#### [`Charge.billingPlan`](#) ● [`BillingPlans`](https://docs.monei.com/apis/graphql/types/enums/billing-plans/.md) enum[​](#chargebillingplanbillingplans- "Direct link to chargebillingplanbillingplans-")

Billing plan

#### [`Charge.currency`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#chargecurrencystring-- "Direct link to chargecurrencystring--")

The currency of the payment

#### [`Charge.customer`](#) ● [`Customer`](https://docs.monei.com/apis/graphql/types/objects/customer/.md) object[​](#chargecustomercustomer- "Direct link to chargecustomercustomer-")

Basic information about the customer

#### [`Charge.description`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#chargedescriptionstring- "Direct link to chargedescriptionstring-")

The payment description

#### [`Charge.descriptor`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#chargedescriptorstring- "Direct link to chargedescriptorstring-")

The payment descriptor that will appear on the customer's statement

#### [`Charge.livemode`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#chargelivemodeboolean- "Direct link to chargelivemodeboolean-")

Whether the charge was made in live mode

#### [`Charge.orderId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#chargeorderidid- "Direct link to chargeorderidid-")

The order ID in your platform (eg: the invoice number)

#### [`Charge.storeId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#chargestoreidid- "Direct link to chargestoreidid-")

The ID of the store

#### [`Charge.pointOfSaleId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#chargepointofsaleidid- "Direct link to chargepointofsaleidid-")

The ID of the Point of Sale this payment will be associated to

#### [`Charge.terminalId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#chargeterminalidid- "Direct link to chargeterminalidid-")

The ID of the terminal this payment will be associated to

#### [`Charge.sequenceId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#chargesequenceidid- "Direct link to chargesequenceidid-")

The sequence ID

#### [`Charge.subscriptionId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#chargesubscriptionidid- "Direct link to chargesubscriptionidid-")

The subscription ID

#### [`Charge.paymentMethod`](#) ● [`PaymentMethod`](https://docs.monei.com/apis/graphql/types/objects/payment-method/.md) object[​](#chargepaymentmethodpaymentmethod- "Direct link to chargepaymentmethodpaymentmethod-")

The payment method

#### [`Charge.cancellationReason`](#) ● [`CancellationReason`](https://docs.monei.com/apis/graphql/types/enums/cancellation-reason/.md) enum[​](#chargecancellationreasoncancellationreason- "Direct link to chargecancellationreasoncancellationreason-")

The reason why the payment is being canceled

#### [`Charge.lastRefundAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#chargelastrefundamountint- "Direct link to chargelastrefundamountint-")

The last refund amount

#### [`Charge.lastRefundReason`](#) ● [`RefundReason`](https://docs.monei.com/apis/graphql/types/enums/refund-reason/.md) enum[​](#chargelastrefundreasonrefundreason- "Direct link to chargelastrefundreasonrefundreason-")

The last refund reason

#### [`Charge.refundedAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#chargerefundedamountint- "Direct link to chargerefundedamountint-")

Total refunded amount

#### [`Charge.shippingDetails`](#) ● [`ContactDetails`](https://docs.monei.com/apis/graphql/types/objects/contact-details/.md) object[​](#chargeshippingdetailscontactdetails- "Direct link to chargeshippingdetailscontactdetails-")

Shipping information

#### [`Charge.shop`](#) ● [`Shop`](https://docs.monei.com/apis/graphql/types/objects/shop/.md) object[​](#chargeshopshop- "Direct link to chargeshopshop-")

Shop information

#### [`Charge.status`](#) ● [`ChargeStatus!`](https://docs.monei.com/apis/graphql/types/enums/charge-status/.md) non-null enum[​](#chargestatuschargestatus-- "Direct link to chargestatuschargestatus--")

The charge status

#### [`Charge.statusCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#chargestatuscodestring- "Direct link to chargestatuscodestring-")

The status code, full list of possible values can be found in the [documentation](https://docs.monei.com/api/#tag/Status-codes)

#### [`Charge.statusMessage`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#chargestatusmessagestring- "Direct link to chargestatusmessagestring-")

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

#### [`Charge.sessionDetails`](#) ● [`SessionDetails`](https://docs.monei.com/apis/graphql/types/objects/session-details/.md) object[​](#chargesessiondetailssessiondetails- "Direct link to chargesessiondetailssessiondetails-")

Session details

#### [`Charge.traceDetails`](#) ● [`TraceDetails`](https://docs.monei.com/apis/graphql/types/objects/trace-details/.md) object[​](#chargetracedetailstracedetails- "Direct link to chargetracedetailstracedetails-")

Trace details

#### [`Charge.pageOpenedAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#chargepageopenedatawstimestamp- "Direct link to chargepageopenedatawstimestamp-")

Time when the payment page was opened by customer as a Unix timestamp

#### [`Charge.metadata`](#) ● [`[KeyValueItem!]`](https://docs.monei.com/apis/graphql/types/objects/key-value-item/.md) list object[​](#chargemetadatakeyvalueitem-- "Direct link to chargemetadatakeyvalueitem--")

Metadata key-value pairs

#### [`Charge.fraudDetectorScore`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#chargefrauddetectorscoreint- "Direct link to chargefrauddetectorscoreint-")

Fraud detector score (0-1000)

### Returned By[​](#returned-by "Direct link to Returned By")

[`charge`](https://docs.monei.com/apis/graphql/operations/queries/charge/.md) query ● [`onUpdateCharge`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-charge/.md) subscription ● [`publishUpdateCharge`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-charge/.md) mutation

### Member Of[​](#member-of "Direct link to Member Of")

[`ChargesConnection`](https://docs.monei.com/apis/graphql/types/objects/charges-connection/.md) object


---

# ChargesConnection

No description

```
type ChargesConnection {
  items: [Charge!]!
  total: Int!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ChargesConnection.items`](#) ● [`[Charge!]!`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) non-null object[​](#chargesconnectionitemscharge-- "Direct link to chargesconnectionitemscharge--")

#### [`ChargesConnection.total`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#chargesconnectiontotalint-- "Direct link to chargesconnectiontotalint--")

### Returned By[​](#returned-by "Direct link to Returned By")

[`charges`](https://docs.monei.com/apis/graphql/operations/queries/charges/.md) query


---

# ChargesDateRangeKPI

No description

```
type ChargesDateRangeKPI {
  currency: Currencies!
  total: ChargesDateRangeKPITotal!
  data: [ChargesDateRangeKPIRow!]!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ChargesDateRangeKPI.currency`](#) ● [`Currencies!`](https://docs.monei.com/apis/graphql/types/enums/currencies/.md) non-null enum[​](#chargesdaterangekpicurrencycurrencies-- "Direct link to chargesdaterangekpicurrencycurrencies--")

#### [`ChargesDateRangeKPI.total`](#) ● [`ChargesDateRangeKPITotal!`](https://docs.monei.com/apis/graphql/types/objects/charges-date-range-kpitotal/.md) non-null object[​](#chargesdaterangekpitotalchargesdaterangekpitotal-- "Direct link to chargesdaterangekpitotalchargesdaterangekpitotal--")

#### [`ChargesDateRangeKPI.data`](#) ● [`[ChargesDateRangeKPIRow!]!`](https://docs.monei.com/apis/graphql/types/objects/charges-date-range-kpirow/.md) non-null object[​](#chargesdaterangekpidatachargesdaterangekpirow-- "Direct link to chargesdaterangekpidatachargesdaterangekpirow--")

### Returned By[​](#returned-by "Direct link to Returned By")

[`chargesDateRangeKPI`](https://docs.monei.com/apis/graphql/operations/queries/charges-date-range-kpi/.md) query


---

# ChargesDateRangeKPIRow

No description

```
type ChargesDateRangeKPIRow {
  timestamp: AWSTimestamp!
  succeededAmount: Long!
  succeededCount: Long!
  capturedAmount: Long!
  capturedCount: Long!
  directAmount: Long!
  directCount: Long!
  canceledAmount: Long!
  canceledCount: Long!
  refundedAmount: Long!
  refundedCount: Long!
  failedAmount: Long!
  failedCount: Long!
  cuSucceededAmount: Long!
  cuSucceededCount: Long!
  cuCapturedAmount: Long!
  cuCapturedCount: Long!
  cuDirectAmount: Long!
  cuDirectCount: Long!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ChargesDateRangeKPIRow.timestamp`](#) ● [`AWSTimestamp!`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) non-null scalar[​](#chargesdaterangekpirowtimestampawstimestamp-- "Direct link to chargesdaterangekpirowtimestampawstimestamp--")

#### [`ChargesDateRangeKPIRow.succeededAmount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpirowsucceededamountlong-- "Direct link to chargesdaterangekpirowsucceededamountlong--")

#### [`ChargesDateRangeKPIRow.succeededCount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpirowsucceededcountlong-- "Direct link to chargesdaterangekpirowsucceededcountlong--")

#### [`ChargesDateRangeKPIRow.capturedAmount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpirowcapturedamountlong-- "Direct link to chargesdaterangekpirowcapturedamountlong--")

#### [`ChargesDateRangeKPIRow.capturedCount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpirowcapturedcountlong-- "Direct link to chargesdaterangekpirowcapturedcountlong--")

#### [`ChargesDateRangeKPIRow.directAmount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpirowdirectamountlong-- "Direct link to chargesdaterangekpirowdirectamountlong--")

#### [`ChargesDateRangeKPIRow.directCount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpirowdirectcountlong-- "Direct link to chargesdaterangekpirowdirectcountlong--")

#### [`ChargesDateRangeKPIRow.canceledAmount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpirowcanceledamountlong-- "Direct link to chargesdaterangekpirowcanceledamountlong--")

#### [`ChargesDateRangeKPIRow.canceledCount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpirowcanceledcountlong-- "Direct link to chargesdaterangekpirowcanceledcountlong--")

#### [`ChargesDateRangeKPIRow.refundedAmount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpirowrefundedamountlong-- "Direct link to chargesdaterangekpirowrefundedamountlong--")

#### [`ChargesDateRangeKPIRow.refundedCount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpirowrefundedcountlong-- "Direct link to chargesdaterangekpirowrefundedcountlong--")

#### [`ChargesDateRangeKPIRow.failedAmount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpirowfailedamountlong-- "Direct link to chargesdaterangekpirowfailedamountlong--")

#### [`ChargesDateRangeKPIRow.failedCount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpirowfailedcountlong-- "Direct link to chargesdaterangekpirowfailedcountlong--")

#### [`ChargesDateRangeKPIRow.cuSucceededAmount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpirowcusucceededamountlong-- "Direct link to chargesdaterangekpirowcusucceededamountlong--")

#### [`ChargesDateRangeKPIRow.cuSucceededCount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpirowcusucceededcountlong-- "Direct link to chargesdaterangekpirowcusucceededcountlong--")

#### [`ChargesDateRangeKPIRow.cuCapturedAmount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpirowcucapturedamountlong-- "Direct link to chargesdaterangekpirowcucapturedamountlong--")

#### [`ChargesDateRangeKPIRow.cuCapturedCount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpirowcucapturedcountlong-- "Direct link to chargesdaterangekpirowcucapturedcountlong--")

#### [`ChargesDateRangeKPIRow.cuDirectAmount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpirowcudirectamountlong-- "Direct link to chargesdaterangekpirowcudirectamountlong--")

#### [`ChargesDateRangeKPIRow.cuDirectCount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpirowcudirectcountlong-- "Direct link to chargesdaterangekpirowcudirectcountlong--")

### Member Of[​](#member-of "Direct link to Member Of")

[`ChargesDateRangeKPI`](https://docs.monei.com/apis/graphql/types/objects/charges-date-range-kpi/.md) object


---

# ChargesDateRangeKPITotal

No description

```
type ChargesDateRangeKPITotal {
  succeededAmount: Long!
  succeededCount: Long!
  capturedAmount: Long!
  capturedCount: Long!
  directAmount: Long!
  directCount: Long!
  canceledAmount: Long!
  canceledCount: Long!
  refundedAmount: Long!
  refundedCount: Long!
  failedAmount: Long!
  failedCount: Long!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ChargesDateRangeKPITotal.succeededAmount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpitotalsucceededamountlong-- "Direct link to chargesdaterangekpitotalsucceededamountlong--")

#### [`ChargesDateRangeKPITotal.succeededCount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpitotalsucceededcountlong-- "Direct link to chargesdaterangekpitotalsucceededcountlong--")

#### [`ChargesDateRangeKPITotal.capturedAmount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpitotalcapturedamountlong-- "Direct link to chargesdaterangekpitotalcapturedamountlong--")

#### [`ChargesDateRangeKPITotal.capturedCount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpitotalcapturedcountlong-- "Direct link to chargesdaterangekpitotalcapturedcountlong--")

#### [`ChargesDateRangeKPITotal.directAmount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpitotaldirectamountlong-- "Direct link to chargesdaterangekpitotaldirectamountlong--")

#### [`ChargesDateRangeKPITotal.directCount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpitotaldirectcountlong-- "Direct link to chargesdaterangekpitotaldirectcountlong--")

#### [`ChargesDateRangeKPITotal.canceledAmount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpitotalcanceledamountlong-- "Direct link to chargesdaterangekpitotalcanceledamountlong--")

#### [`ChargesDateRangeKPITotal.canceledCount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpitotalcanceledcountlong-- "Direct link to chargesdaterangekpitotalcanceledcountlong--")

#### [`ChargesDateRangeKPITotal.refundedAmount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpitotalrefundedamountlong-- "Direct link to chargesdaterangekpitotalrefundedamountlong--")

#### [`ChargesDateRangeKPITotal.refundedCount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpitotalrefundedcountlong-- "Direct link to chargesdaterangekpitotalrefundedcountlong--")

#### [`ChargesDateRangeKPITotal.failedAmount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpitotalfailedamountlong-- "Direct link to chargesdaterangekpitotalfailedamountlong--")

#### [`ChargesDateRangeKPITotal.failedCount`](#) ● [`Long!`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) non-null scalar[​](#chargesdaterangekpitotalfailedcountlong-- "Direct link to chargesdaterangekpitotalfailedcountlong--")

### Member Of[​](#member-of "Direct link to Member Of")

[`ChargesDateRangeKPI`](https://docs.monei.com/apis/graphql/types/objects/charges-date-range-kpi/.md) object


---

# ChargesExport

No description

```
type ChargesExport {
  id: ID!
  status: ExportStatus!
  expireAt: AWSTimestamp
  statusCode: String
  statusMessage: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ChargesExport.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#chargesexportidid-- "Direct link to chargesexportidid--")

#### [`ChargesExport.status`](#) ● [`ExportStatus!`](https://docs.monei.com/apis/graphql/types/enums/export-status/.md) non-null enum[​](#chargesexportstatusexportstatus-- "Direct link to chargesexportstatusexportstatus--")

#### [`ChargesExport.expireAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#chargesexportexpireatawstimestamp- "Direct link to chargesexportexpireatawstimestamp-")

#### [`ChargesExport.statusCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#chargesexportstatuscodestring- "Direct link to chargesexportstatuscodestring-")

#### [`ChargesExport.statusMessage`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#chargesexportstatusmessagestring- "Direct link to chargesexportstatusmessagestring-")

### Returned By[​](#returned-by "Direct link to Returned By")

[`chargesExport`](https://docs.monei.com/apis/graphql/operations/queries/charges-export/.md) query ● [`startExportCharges`](https://docs.monei.com/apis/graphql/operations/mutations/start-export-charges/.md) mutation

### Member Of[​](#member-of "Direct link to Member Of")

[`ChargesExportsConnection`](https://docs.monei.com/apis/graphql/types/objects/charges-exports-connection/.md) object


---

# ChargesExportsConnection

No description

```
type ChargesExportsConnection {
  items: [ChargesExport!]!
  nextToken: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ChargesExportsConnection.items`](#) ● [`[ChargesExport!]!`](https://docs.monei.com/apis/graphql/types/objects/charges-export/.md) non-null object[​](#chargesexportsconnectionitemschargesexport-- "Direct link to chargesexportsconnectionitemschargesexport--")

List of the authorized users

#### [`ChargesExportsConnection.nextToken`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#chargesexportsconnectionnexttokenstring- "Direct link to chargesexportsconnectionnexttokenstring-")

The string that you use in a subsequent request to get the next page of results in a paginated response.

### Returned By[​](#returned-by "Direct link to Returned By")

[`chargesExports`](https://docs.monei.com/apis/graphql/operations/queries/charges-exports/.md) query


---

# Code

No description

```
type Code {
  id: ID!
  type: CodeTypes!
  enabled: Boolean
  pointOfSaleId: ID
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Code.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#codeidid-- "Direct link to codeidid--")

The Code's ID

#### [`Code.type`](#) ● [`CodeTypes!`](https://docs.monei.com/apis/graphql/types/enums/code-types/.md) non-null enum[​](#codetypecodetypes-- "Direct link to codetypecodetypes--")

The type of the code

#### [`Code.enabled`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#codeenabledboolean- "Direct link to codeenabledboolean-")

Whether the code is enabled or not

#### [`Code.pointOfSaleId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#codepointofsaleidid- "Direct link to codepointofsaleidid-")

The ID of the Point of Sale this code will be associated to

### Returned By[​](#returned-by "Direct link to Returned By")

[`code`](https://docs.monei.com/apis/graphql/operations/queries/code/.md) query ● [`codes`](https://docs.monei.com/apis/graphql/operations/queries/codes/.md) query ● [`registerCode`](https://docs.monei.com/apis/graphql/operations/mutations/register-code/.md) mutation ● [`updateCode`](https://docs.monei.com/apis/graphql/operations/mutations/update-code/.md) mutation


---

# ConnectShopifyShopResult

No description

```
type ConnectShopifyShopResult {
  redirectUrl: String!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ConnectShopifyShopResult.redirectUrl`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#connectshopifyshopresultredirecturlstring-- "Direct link to connectshopifyshopresultredirecturlstring--")

### Returned By[​](#returned-by "Direct link to Returned By")

[`connectShopifyShop`](https://docs.monei.com/apis/graphql/operations/mutations/connect-shopify-shop/.md) mutation


---

# ContactDetails

Contact details

```
type ContactDetails {
  email: String
  name: String
  company: String
  phone: String
  address: Address
  taxId: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ContactDetails.email`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#contactdetailsemailstring- "Direct link to contactdetailsemailstring-")

Contact email

#### [`ContactDetails.name`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#contactdetailsnamestring- "Direct link to contactdetailsnamestring-")

Contact name

#### [`ContactDetails.company`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#contactdetailscompanystring- "Direct link to contactdetailscompanystring-")

Contact company

#### [`ContactDetails.phone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#contactdetailsphonestring- "Direct link to contactdetailsphonestring-")

Contact phone in E.164 format, e.g. +34666777888

#### [`ContactDetails.address`](#) ● [`Address`](https://docs.monei.com/apis/graphql/types/objects/address/.md) object[​](#contactdetailsaddressaddress- "Direct link to contactdetailsaddressaddress-")

Contact address

#### [`ContactDetails.taxId`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#contactdetailstaxidstring- "Direct link to contactdetailstaxidstring-")

Contact tax ID

### Member Of[​](#member-of "Direct link to Member Of")

[`Charge`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) object ● [`ChargeEventObject`](https://docs.monei.com/apis/graphql/types/objects/charge-event-object/.md) object ● [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object ● [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object ● [`SubscriptionEventObject`](https://docs.monei.com/apis/graphql/types/objects/subscription-event-object/.md) object


---

# Countries

No description

```
type Countries {
  supportedCountries: [Country!]!
  currentCountry: Country
  currentCountryCode: String
  isSupported: Boolean!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Countries.supportedCountries`](#) ● [`[Country!]!`](https://docs.monei.com/apis/graphql/types/objects/country/.md) non-null object[​](#countriessupportedcountriescountry-- "Direct link to countriessupportedcountriescountry--")

The list of all supported countries

#### [`Countries.currentCountry`](#) ● [`Country`](https://docs.monei.com/apis/graphql/types/objects/country/.md) object[​](#countriescurrentcountrycountry- "Direct link to countriescurrentcountrycountry-")

The current user country

#### [`Countries.currentCountryCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#countriescurrentcountrycodestring- "Direct link to countriescurrentcountrycodestring-")

The current user country code

#### [`Countries.isSupported`](#) ● [`Boolean!`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) non-null scalar[​](#countriesissupportedboolean-- "Direct link to countriesissupportedboolean--")

Whether the user's country is supported or not

### Returned By[​](#returned-by "Direct link to Returned By")

[`countries`](https://docs.monei.com/apis/graphql/operations/queries/countries/.md) query


---

# CountryStore

No description

```
type CountryStore {
  countryCode: String!
  storeId: String!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CountryStore.countryCode`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#countrystorecountrycodestring-- "Direct link to countrystorecountrycodestring--")

#### [`CountryStore.storeId`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#countrystorestoreidstring-- "Direct link to countrystorestoreidstring--")

### Member Of[​](#member-of "Direct link to Member Of")

[`ShopifyShopSettings`](https://docs.monei.com/apis/graphql/types/objects/shopify-shop-settings/.md) object ● [`ShopifyStore`](https://docs.monei.com/apis/graphql/types/objects/shopify-store/.md) object ● [`UpdateShopifyShopSettingsResult`](https://docs.monei.com/apis/graphql/types/objects/update-shopify-shop-settings-result/.md) object


---

# Country

No description

```
type Country {
  name: String!
  phoneCode: String!
  code: String!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Country.name`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#countrynamestring-- "Direct link to countrynamestring--")

#### [`Country.phoneCode`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#countryphonecodestring-- "Direct link to countryphonecodestring--")

#### [`Country.code`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#countrycodestring-- "Direct link to countrycodestring--")

### Member Of[​](#member-of "Direct link to Member Of")

[`Countries`](https://docs.monei.com/apis/graphql/types/objects/countries/.md) object


---

# CustomDomainConfig

No description

```
type CustomDomainConfig {
  domain: String
  certificateDnsRecord: DnsRecord
  distributionDnsRecord: DnsRecord
  status: CustomDomainStatus
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CustomDomainConfig.domain`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#customdomainconfigdomainstring- "Direct link to customdomainconfigdomainstring-")

The custom domain name

#### [`CustomDomainConfig.certificateDnsRecord`](#) ● [`DnsRecord`](https://docs.monei.com/apis/graphql/types/objects/dns-record/.md) object[​](#customdomainconfigcertificatednsrecorddnsrecord- "Direct link to customdomainconfigcertificatednsrecorddnsrecord-")

The DNS record of the SSL/TLS certificate to add to the DNS database

#### [`CustomDomainConfig.distributionDnsRecord`](#) ● [`DnsRecord`](https://docs.monei.com/apis/graphql/types/objects/dns-record/.md) object[​](#customdomainconfigdistributiondnsrecorddnsrecord- "Direct link to customdomainconfigdistributiondnsrecorddnsrecord-")

The DNS record of the CloudFront distribution to add to the DNS database

#### [`CustomDomainConfig.status`](#) ● [`CustomDomainStatus`](https://docs.monei.com/apis/graphql/types/enums/custom-domain-status/.md) enum[​](#customdomainconfigstatuscustomdomainstatus- "Direct link to customdomainconfigstatuscustomdomainstatus-")

The status of the custom domain

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object


---

# Customer

Customer details

```
type Customer {
  email: String
  name: String
  phone: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Customer.email`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#customeremailstring- "Direct link to customeremailstring-")

Customer email

#### [`Customer.name`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#customernamestring- "Direct link to customernamestring-")

Customer name

#### [`Customer.phone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#customerphonestring- "Direct link to customerphonestring-")

Customer phone in E.164 format, e.g. +34666777888

### Member Of[​](#member-of "Direct link to Member Of")

[`Charge`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) object ● [`ChargeEventObject`](https://docs.monei.com/apis/graphql/types/objects/charge-event-object/.md) object ● [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object ● [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object ● [`SubscriptionEventObject`](https://docs.monei.com/apis/graphql/types/objects/subscription-event-object/.md) object


---

# DnsRecord

No description

```
type DnsRecord {
  name: String
  type: String
  value: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`DnsRecord.name`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#dnsrecordnamestring- "Direct link to dnsrecordnamestring-")

The name of the DNS record to create in the domain

#### [`DnsRecord.type`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#dnsrecordtypestring- "Direct link to dnsrecordtypestring-")

The type of DNS record (e.g.: CNAME)

#### [`DnsRecord.value`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#dnsrecordvaluestring- "Direct link to dnsrecordvaluestring-")

The value of the DNS record to add to the DNS database

### Member Of[​](#member-of "Direct link to Member Of")

[`CustomDomainConfig`](https://docs.monei.com/apis/graphql/types/objects/custom-domain-config/.md) object


---

# Document

No description

```
type Document {
  id: ID!
  accountId: ID!
  name: String
  note: String
  type: DocumentType!
  status: DocumentStatus!
  statusCode: String
  statusMessage: String
  contentType: String
  createdAt: String!
  updatedAt: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Document.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#documentidid-- "Direct link to documentidid--")

#### [`Document.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#documentaccountidid-- "Direct link to documentaccountidid--")

#### [`Document.name`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#documentnamestring- "Direct link to documentnamestring-")

#### [`Document.note`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#documentnotestring- "Direct link to documentnotestring-")

#### [`Document.type`](#) ● [`DocumentType!`](https://docs.monei.com/apis/graphql/types/enums/document-type/.md) non-null enum[​](#documenttypedocumenttype-- "Direct link to documenttypedocumenttype--")

#### [`Document.status`](#) ● [`DocumentStatus!`](https://docs.monei.com/apis/graphql/types/enums/document-status/.md) non-null enum[​](#documentstatusdocumentstatus-- "Direct link to documentstatusdocumentstatus--")

#### [`Document.statusCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#documentstatuscodestring- "Direct link to documentstatuscodestring-")

#### [`Document.statusMessage`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#documentstatusmessagestring- "Direct link to documentstatusmessagestring-")

#### [`Document.contentType`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#documentcontenttypestring- "Direct link to documentcontenttypestring-")

#### [`Document.createdAt`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#documentcreatedatstring-- "Direct link to documentcreatedatstring--")

#### [`Document.updatedAt`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#documentupdatedatstring- "Direct link to documentupdatedatstring-")

### Returned By[​](#returned-by "Direct link to Returned By")

[`createDocument`](https://docs.monei.com/apis/graphql/operations/mutations/create-document/.md) mutation ● [`document`](https://docs.monei.com/apis/graphql/operations/queries/document/.md) query

### Member Of[​](#member-of "Direct link to Member Of")

[`DocumentsConnection`](https://docs.monei.com/apis/graphql/types/objects/documents-connection/.md) object


---

# DocumentsConnection

No description

```
type DocumentsConnection {
  items: [Document!]!
  nextToken: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`DocumentsConnection.items`](#) ● [`[Document!]!`](https://docs.monei.com/apis/graphql/types/objects/document/.md) non-null object[​](#documentsconnectionitemsdocument-- "Direct link to documentsconnectionitemsdocument--")

List of the authorized users

#### [`DocumentsConnection.nextToken`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#documentsconnectionnexttokenstring- "Direct link to documentsconnectionnexttokenstring-")

The string that you use in a subsequent request to get the next page of results in a paginated response.

### Returned By[​](#returned-by "Direct link to Returned By")

[`documents`](https://docs.monei.com/apis/graphql/operations/queries/documents/.md) query


---

# DownloadFile

No description

```
type DownloadFile {
  downloadUrl: String!
  expiresAt: AWSTimestamp!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`DownloadFile.downloadUrl`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#downloadfiledownloadurlstring-- "Direct link to downloadfiledownloadurlstring--")

The URL to download the file. It will only last for 15 minutes.

#### [`DownloadFile.expiresAt`](#) ● [`AWSTimestamp!`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) non-null scalar[​](#downloadfileexpiresatawstimestamp-- "Direct link to downloadfileexpiresatawstimestamp--")

The expiration time for the downloadUrl

### Returned By[​](#returned-by "Direct link to Returned By")

[`downloadAccountInvoice`](https://docs.monei.com/apis/graphql/operations/mutations/download-account-invoice/.md) mutation ● [`downloadContract`](https://docs.monei.com/apis/graphql/operations/mutations/download-contract/.md) mutation ● [`downloadDocument`](https://docs.monei.com/apis/graphql/operations/mutations/download-document/.md) mutation ● [`downloadExport`](https://docs.monei.com/apis/graphql/operations/mutations/download-export/.md) mutation ● [`downloadOperationsFile`](https://docs.monei.com/apis/graphql/operations/mutations/download-operations-file/.md) mutation


---

# ExportCharges

No description

```
type ExportCharges {
  downloadUrl: String!
  expiresAt: AWSTimestamp!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ExportCharges.downloadUrl`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#exportchargesdownloadurlstring-- "Direct link to exportchargesdownloadurlstring--")

The URL to download the charges CSV file. It will only last for 15 minutes.

#### [`ExportCharges.expiresAt`](#) ● [`AWSTimestamp!`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) non-null scalar[​](#exportchargesexpiresatawstimestamp-- "Direct link to exportchargesexpiresatawstimestamp--")

The expiration time for the downloadUrl

### Returned By[​](#returned-by "Direct link to Returned By")

[`exportCharges`](https://docs.monei.com/apis/graphql/operations/mutations/export-charges/.md) mutation


---

# ItemLevelUpdate

No description

```
type ItemLevelUpdate {
  accountId: ID
  id: ID
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ItemLevelUpdate.accountId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#itemlevelupdateaccountidid- "Direct link to itemlevelupdateaccountidid-")

#### [`ItemLevelUpdate.id`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#itemlevelupdateidid- "Direct link to itemlevelupdateidid-")

### Returned By[​](#returned-by "Direct link to Returned By")

[`onUpdateChargeEvents`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-charge-events/.md) subscription ● [`onUpdateChargeEventsV2`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-charge-events-v2/.md) subscription ● [`onUpdateChargeV2`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-charge-v2/.md) subscription ● [`onUpdateSubscription`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-subscription/.md) subscription ● [`onUpdateSubscriptionEvents`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-subscription-events/.md) subscription ● [`onUpdateSubscriptionEventsV2`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-subscription-events-v2/.md) subscription ● [`publishUpdateChargeEvents`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-charge-events/.md) mutation ● [`publishUpdateChargeEventsV2`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-charge-events-v2/.md) mutation ● [`publishUpdateChargeV2`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-charge-v2/.md) mutation ● [`publishUpdateSubscription`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-subscription/.md) mutation ● [`publishUpdateSubscriptionEvents`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-subscription-events/.md) mutation ● [`publishUpdateSubscriptionEventsV2`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-subscription-events-v2/.md) mutation


---

# KeyValueItem

No description

```
type KeyValueItem {
  key: String!
  value: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`KeyValueItem.key`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#keyvalueitemkeystring-- "Direct link to keyvalueitemkeystring--")

#### [`KeyValueItem.value`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#keyvalueitemvaluestring- "Direct link to keyvalueitemvaluestring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`Charge`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) object ● [`ChargeEventObject`](https://docs.monei.com/apis/graphql/types/objects/charge-event-object/.md) object ● [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object ● [`Store`](https://docs.monei.com/apis/graphql/types/objects/store/.md) object ● [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object ● [`SubscriptionEventObject`](https://docs.monei.com/apis/graphql/types/objects/subscription-event-object/.md) object ● [`UserEvent`](https://docs.monei.com/apis/graphql/types/objects/user-event/.md) object


---

# LastPayment

No description

```
type LastPayment {
  id: ID!
  status: PaymentStatus!
  statusMessage: String
  statusCode: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`LastPayment.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#lastpaymentidid-- "Direct link to lastpaymentidid--")

#### [`LastPayment.status`](#) ● [`PaymentStatus!`](https://docs.monei.com/apis/graphql/types/enums/payment-status/.md) non-null enum[​](#lastpaymentstatuspaymentstatus-- "Direct link to lastpaymentstatuspaymentstatus--")

#### [`LastPayment.statusMessage`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#lastpaymentstatusmessagestring- "Direct link to lastpaymentstatusmessagestring-")

#### [`LastPayment.statusCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#lastpaymentstatuscodestring- "Direct link to lastpaymentstatuscodestring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object ● [`SubscriptionEventObject`](https://docs.monei.com/apis/graphql/types/objects/subscription-event-object/.md) object


---

# MetadataConfigItem

No description

```
type MetadataConfigItem {
  key: String!
  type: MetadataItemType!
  label: String
  possibleValues: [String!]
  regex: String
  secret: Boolean
  required: Boolean
  default: String
  example: String
  internal: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`MetadataConfigItem.key`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#metadataconfigitemkeystring-- "Direct link to metadataconfigitemkeystring--")

#### [`MetadataConfigItem.type`](#) ● [`MetadataItemType!`](https://docs.monei.com/apis/graphql/types/enums/metadata-item-type/.md) non-null enum[​](#metadataconfigitemtypemetadataitemtype-- "Direct link to metadataconfigitemtypemetadataitemtype--")

#### [`MetadataConfigItem.label`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#metadataconfigitemlabelstring- "Direct link to metadataconfigitemlabelstring-")

#### [`MetadataConfigItem.possibleValues`](#) ● [`[String!]`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) list scalar[​](#metadataconfigitempossiblevaluesstring-- "Direct link to metadataconfigitempossiblevaluesstring--")

#### [`MetadataConfigItem.regex`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#metadataconfigitemregexstring- "Direct link to metadataconfigitemregexstring-")

#### [`MetadataConfigItem.secret`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#metadataconfigitemsecretboolean- "Direct link to metadataconfigitemsecretboolean-")

#### [`MetadataConfigItem.required`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#metadataconfigitemrequiredboolean- "Direct link to metadataconfigitemrequiredboolean-")

#### [`MetadataConfigItem.default`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#metadataconfigitemdefaultstring- "Direct link to metadataconfigitemdefaultstring-")

#### [`MetadataConfigItem.example`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#metadataconfigitemexamplestring- "Direct link to metadataconfigitemexamplestring-")

#### [`MetadataConfigItem.internal`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#metadataconfigiteminternalboolean- "Direct link to metadataconfigiteminternalboolean-")

### Member Of[​](#member-of "Direct link to Member Of")

[`ProviderConfig`](https://docs.monei.com/apis/graphql/types/objects/provider-config/.md) object


---

# MetadataItem

No description

```
type MetadataItem {
  key: String!
  value: String
  type: MetadataItemType!
  label: String
  possibleValues: [String!]
  regex: String
  secret: Boolean
  required: Boolean
  default: String
  example: String
  internal: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`MetadataItem.key`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#metadataitemkeystring-- "Direct link to metadataitemkeystring--")

#### [`MetadataItem.value`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#metadataitemvaluestring- "Direct link to metadataitemvaluestring-")

#### [`MetadataItem.type`](#) ● [`MetadataItemType!`](https://docs.monei.com/apis/graphql/types/enums/metadata-item-type/.md) non-null enum[​](#metadataitemtypemetadataitemtype-- "Direct link to metadataitemtypemetadataitemtype--")

#### [`MetadataItem.label`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#metadataitemlabelstring- "Direct link to metadataitemlabelstring-")

#### [`MetadataItem.possibleValues`](#) ● [`[String!]`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) list scalar[​](#metadataitempossiblevaluesstring-- "Direct link to metadataitempossiblevaluesstring--")

#### [`MetadataItem.regex`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#metadataitemregexstring- "Direct link to metadataitemregexstring-")

#### [`MetadataItem.secret`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#metadataitemsecretboolean- "Direct link to metadataitemsecretboolean-")

#### [`MetadataItem.required`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#metadataitemrequiredboolean- "Direct link to metadataitemrequiredboolean-")

#### [`MetadataItem.default`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#metadataitemdefaultstring- "Direct link to metadataitemdefaultstring-")

#### [`MetadataItem.example`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#metadataitemexamplestring- "Direct link to metadataitemexamplestring-")

#### [`MetadataItem.internal`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#metadataiteminternalboolean- "Direct link to metadataiteminternalboolean-")

### Member Of[​](#member-of "Direct link to Member Of")

[`Provider`](https://docs.monei.com/apis/graphql/types/objects/provider/.md) object


---

# NextAction

No description

```
type NextAction {
  type: NextActionTypes
  redirectUrl: String
  mustRedirect: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`NextAction.type`](#) ● [`NextActionTypes`](https://docs.monei.com/apis/graphql/types/enums/next-action-types/.md) enum[​](#nextactiontypenextactiontypes- "Direct link to nextactiontypenextactiontypes-")

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.

#### [`NextAction.redirectUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#nextactionredirecturlstring- "Direct link to nextactionredirecturlstring-")

Redirect your customer to this url to continue payment process.

#### [`NextAction.mustRedirect`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#nextactionmustredirectboolean- "Direct link to nextactionmustredirectboolean-")

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

### Member Of[​](#member-of "Direct link to Member Of")

[`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object


---

# PayPalLink

No description

```
type PayPalLink {
  link: String!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PayPalLink.link`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#paypallinklinkstring-- "Direct link to paypallinklinkstring--")

### Returned By[​](#returned-by "Direct link to Returned By")

[`createPayPalLink`](https://docs.monei.com/apis/graphql/operations/mutations/create-pay-pal-link/.md) mutation


---

# PaymentAction

Action for payment rule

```
type PaymentAction {
  type: String!
  providerId: ID
  percentage: Int
  paymentMethod: String
  tokenizationMethod: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentAction.type`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#paymentactiontypestring-- "Direct link to paymentactiontypestring--")

Action type (route\_to, force\_challenge, skip\_challenge, decline, hide, show)

#### [`PaymentAction.providerId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#paymentactionprovideridid- "Direct link to paymentactionprovideridid-")

Provider ID (for route\_to action)

#### [`PaymentAction.percentage`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#paymentactionpercentageint- "Direct link to paymentactionpercentageint-")

Percentage (for route\_to action, 1-100)

#### [`PaymentAction.paymentMethod`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentactionpaymentmethodstring- "Direct link to paymentactionpaymentmethodstring-")

Payment method (for hide/show actions)

#### [`PaymentAction.tokenizationMethod`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentactiontokenizationmethodstring- "Direct link to paymentactiontokenizationmethodstring-")

Tokenization method (for hide/show actions)

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentRule`](https://docs.monei.com/apis/graphql/types/objects/payment-rule/.md) object


---

# PaymentCondition

Condition for payment rule

```
type PaymentCondition {
  id: ID!
  field: String!
  operator: String!
  value: String
  valueSource: String!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentCondition.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#paymentconditionidid-- "Direct link to paymentconditionidid--")

Condition ID

#### [`PaymentCondition.field`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#paymentconditionfieldstring-- "Direct link to paymentconditionfieldstring--")

Field to evaluate

#### [`PaymentCondition.operator`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#paymentconditionoperatorstring-- "Direct link to paymentconditionoperatorstring--")

Operator to use (=, !=, <, >, <=, >=, in)

#### [`PaymentCondition.value`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentconditionvaluestring- "Direct link to paymentconditionvaluestring-")

Value to compare against

#### [`PaymentCondition.valueSource`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#paymentconditionvaluesourcestring-- "Direct link to paymentconditionvaluesourcestring--")

Source of the value

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentConditions`](https://docs.monei.com/apis/graphql/types/objects/payment-conditions/.md) object


---

# PaymentConditions

Conditions for payment rule

```
type PaymentConditions {
  combinator: CombinatorType!
  rules: [PaymentCondition!]!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentConditions.combinator`](#) ● [`CombinatorType!`](https://docs.monei.com/apis/graphql/types/enums/combinator-type/.md) non-null enum[​](#paymentconditionscombinatorcombinatortype-- "Direct link to paymentconditionscombinatorcombinatortype--")

Combinator for conditions

#### [`PaymentConditions.rules`](#) ● [`[PaymentCondition!]!`](https://docs.monei.com/apis/graphql/types/objects/payment-condition/.md) non-null object[​](#paymentconditionsrulespaymentcondition-- "Direct link to paymentconditionsrulespaymentcondition--")

List of rules/conditions

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentRule`](https://docs.monei.com/apis/graphql/types/objects/payment-rule/.md) object


---

# PaymentMethodBizum

Bizum payment method details

```
type PaymentMethodBizum {
  phoneNumber: String
  integrationType: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentMethodBizum.phoneNumber`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodbizumphonenumberstring- "Direct link to paymentmethodbizumphonenumberstring-")

Bizum phone number in E.164 format, e.g. +34666777888

#### [`PaymentMethodBizum.integrationType`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodbizumintegrationtypestring- "Direct link to paymentmethodbizumintegrationtypestring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethod`](https://docs.monei.com/apis/graphql/types/objects/payment-method/.md) object


---

# PaymentMethodCardPresent

No description

```
type PaymentMethodCardPresent {
  brand: CardBrand
  country: String
  type: CardType
  bin: String
  last4: String
  fingerprint: String
  cardholderName: String
  cardholderEmail: String
  expiration: Long
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentMethodCardPresent.brand`](#) ● [`CardBrand`](https://docs.monei.com/apis/graphql/types/enums/card-brand/.md) enum[​](#paymentmethodcardpresentbrandcardbrand- "Direct link to paymentmethodcardpresentbrandcardbrand-")

Card brand

#### [`PaymentMethodCardPresent.country`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardpresentcountrystring- "Direct link to paymentmethodcardpresentcountrystring-")

Card country as ISO 3166-1 alpha-2 code

#### [`PaymentMethodCardPresent.type`](#) ● [`CardType`](https://docs.monei.com/apis/graphql/types/enums/card-type/.md) enum[​](#paymentmethodcardpresenttypecardtype- "Direct link to paymentmethodcardpresenttypecardtype-")

Card type

#### [`PaymentMethodCardPresent.bin`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardpresentbinstring- "Direct link to paymentmethodcardpresentbinstring-")

Card BIN

#### [`PaymentMethodCardPresent.last4`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardpresentlast4string- "Direct link to paymentmethodcardpresentlast4string-")

Card last 4 digits

#### [`PaymentMethodCardPresent.fingerprint`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardpresentfingerprintstring- "Direct link to paymentmethodcardpresentfingerprintstring-")

Card fingerprint

#### [`PaymentMethodCardPresent.cardholderName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardpresentcardholdernamestring- "Direct link to paymentmethodcardpresentcardholdernamestring-")

Cardholder name

#### [`PaymentMethodCardPresent.cardholderEmail`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardpresentcardholderemailstring- "Direct link to paymentmethodcardpresentcardholderemailstring-")

Cardholder email

#### [`PaymentMethodCardPresent.expiration`](#) ● [`Long`](https://docs.monei.com/apis/graphql/types/scalars/long/.md) scalar[​](#paymentmethodcardpresentexpirationlong- "Direct link to paymentmethodcardpresentexpirationlong-")

Expiration date as unix timestamp

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethod`](https://docs.monei.com/apis/graphql/types/objects/payment-method/.md) object


---

# PaymentMethodCard

Card payment method details

```
type PaymentMethodCard {
  brand: CardBrand
  country: String
  type: CardType
  threeDSecure: Boolean
  threeDSecureVersion: String
  threeDSecureFlow: ThreeDSecureFlow
  last4: String
  fingerprint: String
  cardholderName: String
  cardholderEmail: String
  expiration: AWSTimestamp
  bank: String
  tokenizationMethod: TokenizationMethods
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentMethodCard.brand`](#) ● [`CardBrand`](https://docs.monei.com/apis/graphql/types/enums/card-brand/.md) enum[​](#paymentmethodcardbrandcardbrand- "Direct link to paymentmethodcardbrandcardbrand-")

Card brand

#### [`PaymentMethodCard.country`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardcountrystring- "Direct link to paymentmethodcardcountrystring-")

Card country as ISO 3166-1 alpha-2 code

#### [`PaymentMethodCard.type`](#) ● [`CardType`](https://docs.monei.com/apis/graphql/types/enums/card-type/.md) enum[​](#paymentmethodcardtypecardtype- "Direct link to paymentmethodcardtypecardtype-")

Card type

#### [`PaymentMethodCard.threeDSecure`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#paymentmethodcardthreedsecureboolean- "Direct link to paymentmethodcardthreedsecureboolean-")

Indicates if transaction was 3D Secure

#### [`PaymentMethodCard.threeDSecureVersion`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardthreedsecureversionstring- "Direct link to paymentmethodcardthreedsecureversionstring-")

3D Secure version

#### [`PaymentMethodCard.threeDSecureFlow`](#) ● [`ThreeDSecureFlow`](https://docs.monei.com/apis/graphql/types/enums/three-dsecure-flow/.md) enum[​](#paymentmethodcardthreedsecureflowthreedsecureflow- "Direct link to paymentmethodcardthreedsecureflowthreedsecureflow-")

3D Secure flow

#### [`PaymentMethodCard.last4`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardlast4string- "Direct link to paymentmethodcardlast4string-")

Card last 4 digits

#### [`PaymentMethodCard.fingerprint`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardfingerprintstring- "Direct link to paymentmethodcardfingerprintstring-")

Card fingerprint

#### [`PaymentMethodCard.cardholderName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardcardholdernamestring- "Direct link to paymentmethodcardcardholdernamestring-")

Cardholder name

#### [`PaymentMethodCard.cardholderEmail`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardcardholderemailstring- "Direct link to paymentmethodcardcardholderemailstring-")

Cardholder email

#### [`PaymentMethodCard.expiration`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#paymentmethodcardexpirationawstimestamp- "Direct link to paymentmethodcardexpirationawstimestamp-")

Expiration date as unix timestamp

#### [`PaymentMethodCard.bank`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodcardbankstring- "Direct link to paymentmethodcardbankstring-")

Card issuing bank

#### [`PaymentMethodCard.tokenizationMethod`](#) ● [`TokenizationMethods`](https://docs.monei.com/apis/graphql/types/enums/tokenization-methods/.md) enum[​](#paymentmethodcardtokenizationmethodtokenizationmethods- "Direct link to paymentmethodcardtokenizationmethodtokenizationmethods-")

Card tokenization method

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethod`](https://docs.monei.com/apis/graphql/types/objects/payment-method/.md) object


---

# PaymentMethodKlarna

No description

```
type PaymentMethodKlarna {
  billingCategory: BillingCategoryKlarna
  authPaymentMethod: AuthPaymentMethodKlarna
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentMethodKlarna.billingCategory`](#) ● [`BillingCategoryKlarna`](https://docs.monei.com/apis/graphql/types/enums/billing-category-klarna/.md) enum[​](#paymentmethodklarnabillingcategorybillingcategoryklarna- "Direct link to paymentmethodklarnabillingcategorybillingcategoryklarna-")

Billing category

#### [`PaymentMethodKlarna.authPaymentMethod`](#) ● [`AuthPaymentMethodKlarna`](https://docs.monei.com/apis/graphql/types/enums/auth-payment-method-klarna/.md) enum[​](#paymentmethodklarnaauthpaymentmethodauthpaymentmethodklarna- "Direct link to paymentmethodklarnaauthpaymentmethodauthpaymentmethodklarna-")

Authentication payment method

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethod`](https://docs.monei.com/apis/graphql/types/objects/payment-method/.md) object


---

# PaymentMethodMBWay

No description

```
type PaymentMethodMBWay {
  phoneNumber: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentMethodMBWay.phoneNumber`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodmbwayphonenumberstring- "Direct link to paymentmethodmbwayphonenumberstring-")

MBWay phone number in E.164 format, e.g. +34666777888

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethod`](https://docs.monei.com/apis/graphql/types/objects/payment-method/.md) object


---

# PaymentMethodPaypal

Paypal payment method details

```
type PaymentMethodPaypal {
  orderId: ID
  payerId: ID
  email: String
  name: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentMethodPaypal.orderId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#paymentmethodpaypalorderidid- "Direct link to paymentmethodpaypalorderidid-")

Paypal payer ID

#### [`PaymentMethodPaypal.payerId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#paymentmethodpaypalpayeridid- "Direct link to paymentmethodpaypalpayeridid-")

Paypal payer ID

#### [`PaymentMethodPaypal.email`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodpaypalemailstring- "Direct link to paymentmethodpaypalemailstring-")

Paypal payer email

#### [`PaymentMethodPaypal.name`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodpaypalnamestring- "Direct link to paymentmethodpaypalnamestring-")

Paypal payer name

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethod`](https://docs.monei.com/apis/graphql/types/objects/payment-method/.md) object


---

# PaymentMethodSepa

No description

```
type PaymentMethodSepa {
  accountholderAddress: Address
  accountholderEmail: String
  accountholderName: String
  countryCode: String
  bankAddress: String
  bankCode: String
  bankName: String
  bic: String
  last4: String
  fingerprint: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentMethodSepa.accountholderAddress`](#) ● [`Address`](https://docs.monei.com/apis/graphql/types/objects/address/.md) object[​](#paymentmethodsepaaccountholderaddressaddress- "Direct link to paymentmethodsepaaccountholderaddressaddress-")

Account holder address

#### [`PaymentMethodSepa.accountholderEmail`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodsepaaccountholderemailstring- "Direct link to paymentmethodsepaaccountholderemailstring-")

Account holder email

#### [`PaymentMethodSepa.accountholderName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodsepaaccountholdernamestring- "Direct link to paymentmethodsepaaccountholdernamestring-")

Account holder name

#### [`PaymentMethodSepa.countryCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodsepacountrycodestring- "Direct link to paymentmethodsepacountrycodestring-")

Country code as ISO 3166-1 alpha-2 code

#### [`PaymentMethodSepa.bankAddress`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodsepabankaddressstring- "Direct link to paymentmethodsepabankaddressstring-")

Bank address

#### [`PaymentMethodSepa.bankCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodsepabankcodestring- "Direct link to paymentmethodsepabankcodestring-")

Bank code

#### [`PaymentMethodSepa.bankName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodsepabanknamestring- "Direct link to paymentmethodsepabanknamestring-")

Bank name

#### [`PaymentMethodSepa.bic`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodsepabicstring- "Direct link to paymentmethodsepabicstring-")

Bank BIC

#### [`PaymentMethodSepa.last4`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodsepalast4string- "Direct link to paymentmethodsepalast4string-")

Card last 4 digits

#### [`PaymentMethodSepa.fingerprint`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentmethodsepafingerprintstring- "Direct link to paymentmethodsepafingerprintstring-")

Card fingerprint

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethod`](https://docs.monei.com/apis/graphql/types/objects/payment-method/.md) object


---

# PaymentMethodTrustly

No description

```
type PaymentMethodTrustly {
  customerId: ID
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentMethodTrustly.customerId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#paymentmethodtrustlycustomeridid- "Direct link to paymentmethodtrustlycustomeridid-")

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentMethod`](https://docs.monei.com/apis/graphql/types/objects/payment-method/.md) object


---

# PaymentMethod

Payment method details

```
type PaymentMethod {
  method: PaymentMethods
  card: PaymentMethodCard
  cardPresent: PaymentMethodCardPresent
  bizum: PaymentMethodBizum
  paypal: PaymentMethodPaypal
  trustly: PaymentMethodTrustly
  sepa: PaymentMethodSepa
  klarna: PaymentMethodKlarna
  mbway: PaymentMethodMBWay
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentMethod.method`](#) ● [`PaymentMethods`](https://docs.monei.com/apis/graphql/types/enums/payment-methods/.md) enum[​](#paymentmethodmethodpaymentmethods- "Direct link to paymentmethodmethodpaymentmethods-")

#### [`PaymentMethod.card`](#) ● [`PaymentMethodCard`](https://docs.monei.com/apis/graphql/types/objects/payment-method-card/.md) object[​](#paymentmethodcardpaymentmethodcard- "Direct link to paymentmethodcardpaymentmethodcard-")

#### [`PaymentMethod.cardPresent`](#) ● [`PaymentMethodCardPresent`](https://docs.monei.com/apis/graphql/types/objects/payment-method-card-present/.md) object[​](#paymentmethodcardpresentpaymentmethodcardpresent- "Direct link to paymentmethodcardpresentpaymentmethodcardpresent-")

#### [`PaymentMethod.bizum`](#) ● [`PaymentMethodBizum`](https://docs.monei.com/apis/graphql/types/objects/payment-method-bizum/.md) object[​](#paymentmethodbizumpaymentmethodbizum- "Direct link to paymentmethodbizumpaymentmethodbizum-")

#### [`PaymentMethod.paypal`](#) ● [`PaymentMethodPaypal`](https://docs.monei.com/apis/graphql/types/objects/payment-method-paypal/.md) object[​](#paymentmethodpaypalpaymentmethodpaypal- "Direct link to paymentmethodpaypalpaymentmethodpaypal-")

#### [`PaymentMethod.trustly`](#) ● [`PaymentMethodTrustly`](https://docs.monei.com/apis/graphql/types/objects/payment-method-trustly/.md) object[​](#paymentmethodtrustlypaymentmethodtrustly- "Direct link to paymentmethodtrustlypaymentmethodtrustly-")

#### [`PaymentMethod.sepa`](#) ● [`PaymentMethodSepa`](https://docs.monei.com/apis/graphql/types/objects/payment-method-sepa/.md) object[​](#paymentmethodsepapaymentmethodsepa- "Direct link to paymentmethodsepapaymentmethodsepa-")

#### [`PaymentMethod.klarna`](#) ● [`PaymentMethodKlarna`](https://docs.monei.com/apis/graphql/types/objects/payment-method-klarna/.md) object[​](#paymentmethodklarnapaymentmethodklarna- "Direct link to paymentmethodklarnapaymentmethodklarna-")

#### [`PaymentMethod.mbway`](#) ● [`PaymentMethodMBWay`](https://docs.monei.com/apis/graphql/types/objects/payment-method-mbway/.md) object[​](#paymentmethodmbwaypaymentmethodmbway- "Direct link to paymentmethodmbwaypaymentmethodmbway-")

### Member Of[​](#member-of "Direct link to Member Of")

[`Charge`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) object ● [`ChargeEventObject`](https://docs.monei.com/apis/graphql/types/objects/charge-event-object/.md) object ● [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object ● [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object ● [`SubscriptionEventObject`](https://docs.monei.com/apis/graphql/types/objects/subscription-event-object/.md) object


---

# PaymentRule

Payment rule

```
type PaymentRule {
  id: ID!
  accountId: ID!
  ruleType: PaymentRuleType!
  conditions: PaymentConditions!
  action: PaymentAction!
  createdAt: AWSDateTime!
  updatedAt: AWSDateTime
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentRule.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#paymentruleidid-- "Direct link to paymentruleidid--")

Rule ID

#### [`PaymentRule.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#paymentruleaccountidid-- "Direct link to paymentruleaccountidid--")

Account ID

#### [`PaymentRule.ruleType`](#) ● [`PaymentRuleType!`](https://docs.monei.com/apis/graphql/types/enums/payment-rule-type/.md) non-null enum[​](#paymentruleruletypepaymentruletype-- "Direct link to paymentruleruletypepaymentruletype--")

Type of payment rule

#### [`PaymentRule.conditions`](#) ● [`PaymentConditions!`](https://docs.monei.com/apis/graphql/types/objects/payment-conditions/.md) non-null object[​](#paymentruleconditionspaymentconditions-- "Direct link to paymentruleconditionspaymentconditions--")

The conditions that must be met for this rule to apply

#### [`PaymentRule.action`](#) ● [`PaymentAction!`](https://docs.monei.com/apis/graphql/types/objects/payment-action/.md) non-null object[​](#paymentruleactionpaymentaction-- "Direct link to paymentruleactionpaymentaction--")

The action to take when conditions are met

#### [`PaymentRule.createdAt`](#) ● [`AWSDateTime!`](https://docs.monei.com/apis/graphql/types/scalars/awsdate-time/.md) non-null scalar[​](#paymentrulecreatedatawsdatetime-- "Direct link to paymentrulecreatedatawsdatetime--")

When the rule was created

#### [`PaymentRule.updatedAt`](#) ● [`AWSDateTime`](https://docs.monei.com/apis/graphql/types/scalars/awsdate-time/.md) scalar[​](#paymentruleupdatedatawsdatetime- "Direct link to paymentruleupdatedatawsdatetime-")

When the rule was last updated

### Returned By[​](#returned-by "Direct link to Returned By")

[`createPaymentRule`](https://docs.monei.com/apis/graphql/operations/mutations/create-payment-rule/.md) mutation ● [`paymentRule`](https://docs.monei.com/apis/graphql/operations/queries/payment-rule/.md) query ● [`updatePaymentRule`](https://docs.monei.com/apis/graphql/operations/mutations/update-payment-rule/.md) mutation

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentRulesConnection`](https://docs.monei.com/apis/graphql/types/objects/payment-rules-connection/.md) object


---

# PaymentRulesConnection

Connection type for paginated payment rules

```
type PaymentRulesConnection {
  items: [PaymentRule!]!
  nextToken: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentRulesConnection.items`](#) ● [`[PaymentRule!]!`](https://docs.monei.com/apis/graphql/types/objects/payment-rule/.md) non-null object[​](#paymentrulesconnectionitemspaymentrule-- "Direct link to paymentrulesconnectionitemspaymentrule--")

List of payment rules

#### [`PaymentRulesConnection.nextToken`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentrulesconnectionnexttokenstring- "Direct link to paymentrulesconnectionnexttokenstring-")

Next token for pagination

### Returned By[​](#returned-by "Direct link to Returned By")

[`paymentRules`](https://docs.monei.com/apis/graphql/operations/queries/payment-rules/.md) query


---

# Payment

No description

```
type Payment {
  id: ID!
  amount: Int
  amountEUR: Int
  currency: String!
  orderId: ID
  storeId: ID
  pointOfSaleId: ID
  description: String
  descriptor: String
  accountId: ID!
  authorizationCode: String
  livemode: Boolean
  status: PaymentStatus!
  statusCode: String
  statusMessage: String
  customer: Customer
  sequenceId: ID
  subscriptionId: ID
  paymentToken: String
  paymentMethod: PaymentMethod
  shop: Shop
  billingDetails: ContactDetails
  shippingDetails: ContactDetails
  refundedAmount: Int
  lastRefundAmount: Int
  lastRefundReason: RefundReason
  cancellationReason: CancellationReason
  sessionDetails: SessionDetails
  traceDetails: TraceDetails
  nextAction: NextAction
  createdAt: AWSTimestamp
  updatedAt: AWSTimestamp
  pageOpenedAt: AWSTimestamp
  metadata: [KeyValueItem!]
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Payment.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#paymentidid-- "Direct link to paymentidid--")

#### [`Payment.amount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#paymentamountint- "Direct link to paymentamountint-")

#### [`Payment.amountEUR`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#paymentamounteurint- "Direct link to paymentamounteurint-")

#### [`Payment.currency`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#paymentcurrencystring-- "Direct link to paymentcurrencystring--")

#### [`Payment.orderId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#paymentorderidid- "Direct link to paymentorderidid-")

#### [`Payment.storeId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#paymentstoreidid- "Direct link to paymentstoreidid-")

#### [`Payment.pointOfSaleId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#paymentpointofsaleidid- "Direct link to paymentpointofsaleidid-")

#### [`Payment.description`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentdescriptionstring- "Direct link to paymentdescriptionstring-")

#### [`Payment.descriptor`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentdescriptorstring- "Direct link to paymentdescriptorstring-")

#### [`Payment.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#paymentaccountidid-- "Direct link to paymentaccountidid--")

#### [`Payment.authorizationCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentauthorizationcodestring- "Direct link to paymentauthorizationcodestring-")

#### [`Payment.livemode`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#paymentlivemodeboolean- "Direct link to paymentlivemodeboolean-")

#### [`Payment.status`](#) ● [`PaymentStatus!`](https://docs.monei.com/apis/graphql/types/enums/payment-status/.md) non-null enum[​](#paymentstatuspaymentstatus-- "Direct link to paymentstatuspaymentstatus--")

#### [`Payment.statusCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentstatuscodestring- "Direct link to paymentstatuscodestring-")

#### [`Payment.statusMessage`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentstatusmessagestring- "Direct link to paymentstatusmessagestring-")

#### [`Payment.customer`](#) ● [`Customer`](https://docs.monei.com/apis/graphql/types/objects/customer/.md) object[​](#paymentcustomercustomer- "Direct link to paymentcustomercustomer-")

#### [`Payment.sequenceId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#paymentsequenceidid- "Direct link to paymentsequenceidid-")

#### [`Payment.subscriptionId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#paymentsubscriptionidid- "Direct link to paymentsubscriptionidid-")

#### [`Payment.paymentToken`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#paymentpaymenttokenstring- "Direct link to paymentpaymenttokenstring-")

#### [`Payment.paymentMethod`](#) ● [`PaymentMethod`](https://docs.monei.com/apis/graphql/types/objects/payment-method/.md) object[​](#paymentpaymentmethodpaymentmethod- "Direct link to paymentpaymentmethodpaymentmethod-")

#### [`Payment.shop`](#) ● [`Shop`](https://docs.monei.com/apis/graphql/types/objects/shop/.md) object[​](#paymentshopshop- "Direct link to paymentshopshop-")

#### [`Payment.billingDetails`](#) ● [`ContactDetails`](https://docs.monei.com/apis/graphql/types/objects/contact-details/.md) object[​](#paymentbillingdetailscontactdetails- "Direct link to paymentbillingdetailscontactdetails-")

#### [`Payment.shippingDetails`](#) ● [`ContactDetails`](https://docs.monei.com/apis/graphql/types/objects/contact-details/.md) object[​](#paymentshippingdetailscontactdetails- "Direct link to paymentshippingdetailscontactdetails-")

#### [`Payment.refundedAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#paymentrefundedamountint- "Direct link to paymentrefundedamountint-")

#### [`Payment.lastRefundAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#paymentlastrefundamountint- "Direct link to paymentlastrefundamountint-")

#### [`Payment.lastRefundReason`](#) ● [`RefundReason`](https://docs.monei.com/apis/graphql/types/enums/refund-reason/.md) enum[​](#paymentlastrefundreasonrefundreason- "Direct link to paymentlastrefundreasonrefundreason-")

#### [`Payment.cancellationReason`](#) ● [`CancellationReason`](https://docs.monei.com/apis/graphql/types/enums/cancellation-reason/.md) enum[​](#paymentcancellationreasoncancellationreason- "Direct link to paymentcancellationreasoncancellationreason-")

#### [`Payment.sessionDetails`](#) ● [`SessionDetails`](https://docs.monei.com/apis/graphql/types/objects/session-details/.md) object[​](#paymentsessiondetailssessiondetails- "Direct link to paymentsessiondetailssessiondetails-")

#### [`Payment.traceDetails`](#) ● [`TraceDetails`](https://docs.monei.com/apis/graphql/types/objects/trace-details/.md) object[​](#paymenttracedetailstracedetails- "Direct link to paymenttracedetailstracedetails-")

#### [`Payment.nextAction`](#) ● [`NextAction`](https://docs.monei.com/apis/graphql/types/objects/next-action/.md) object[​](#paymentnextactionnextaction- "Direct link to paymentnextactionnextaction-")

#### [`Payment.createdAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#paymentcreatedatawstimestamp- "Direct link to paymentcreatedatawstimestamp-")

#### [`Payment.updatedAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#paymentupdatedatawstimestamp- "Direct link to paymentupdatedatawstimestamp-")

#### [`Payment.pageOpenedAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#paymentpageopenedatawstimestamp- "Direct link to paymentpageopenedatawstimestamp-")

#### [`Payment.metadata`](#) ● [`[KeyValueItem!]`](https://docs.monei.com/apis/graphql/types/objects/key-value-item/.md) list object[​](#paymentmetadatakeyvalueitem-- "Direct link to paymentmetadatakeyvalueitem--")

### Returned By[​](#returned-by "Direct link to Returned By")

[`activateSubscription`](https://docs.monei.com/apis/graphql/operations/mutations/activate-subscription/.md) mutation ● [`cancelPayment`](https://docs.monei.com/apis/graphql/operations/mutations/cancel-payment/.md) mutation ● [`capturePayment`](https://docs.monei.com/apis/graphql/operations/mutations/capture-payment/.md) mutation ● [`createPayment`](https://docs.monei.com/apis/graphql/operations/mutations/create-payment/.md) mutation ● [`refundPayment`](https://docs.monei.com/apis/graphql/operations/mutations/refund-payment/.md) mutation ● [`sendPaymentLink`](https://docs.monei.com/apis/graphql/operations/mutations/send-payment-link/.md) mutation ● [`sendPaymentReceipt`](https://docs.monei.com/apis/graphql/operations/mutations/send-payment-receipt/.md) mutation ● [`sendPaymentRequest`](https://docs.monei.com/apis/graphql/operations/mutations/send-payment-request/.md) mutation


---

# Period

Account invoice period

```
type Period {
  from: Int!
  to: Int!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Period.from`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#periodfromint-- "Direct link to periodfromint--")

Start date of the period as a unix timestamp

#### [`Period.to`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#periodtoint-- "Direct link to periodtoint--")

End date of the period as a unix timestamp

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountInvoice`](https://docs.monei.com/apis/graphql/types/objects/account-invoice/.md) object


---

# PointOfSale

No description

```
type PointOfSale {
  id: ID!
  storeId: ID
  number: Int!
  name: String
  description: String
  manualAmount: Boolean
  requireEmail: Boolean
  requireTaxId: Boolean
  fixedAmount: Int
  includeQRCode: Boolean
  fixedCurrency: Currencies
  enabled: Boolean
  qrCodeText: String
  paymentCallbackUrl: String
  currentPaymentId: ID
  type: PointOfSaleType
  transactionType: TransactionTypes
  paymentMethods: [PaymentMethods!]
  pendingSetup: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PointOfSale.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#pointofsaleidid-- "Direct link to pointofsaleidid--")

The ID of the point of sale

#### [`PointOfSale.storeId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#pointofsalestoreidid- "Direct link to pointofsalestoreidid-")

The store's ID where this point of sale belongs

#### [`PointOfSale.number`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#pointofsalenumberint-- "Direct link to pointofsalenumberint--")

Point of sale unique number inside the store

#### [`PointOfSale.name`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#pointofsalenamestring- "Direct link to pointofsalenamestring-")

The name that represents the point of sale

#### [`PointOfSale.description`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#pointofsaledescriptionstring- "Direct link to pointofsaledescriptionstring-")

The description of the point of sale

#### [`PointOfSale.manualAmount`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#pointofsalemanualamountboolean- "Direct link to pointofsalemanualamountboolean-")

Whether the user can manually enter the amount or not

#### [`PointOfSale.requireEmail`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#pointofsalerequireemailboolean- "Direct link to pointofsalerequireemailboolean-")

Whether the user must provide an email address or not

#### [`PointOfSale.requireTaxId`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#pointofsalerequiretaxidboolean- "Direct link to pointofsalerequiretaxidboolean-")

Whether the user must provide a tax ID or not

#### [`PointOfSale.fixedAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#pointofsalefixedamountint- "Direct link to pointofsalefixedamountint-")

Fixed amount to be charged

#### [`PointOfSale.includeQRCode`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#pointofsaleincludeqrcodeboolean- "Direct link to pointofsaleincludeqrcodeboolean-")

Whether the user must provide a fixed amount or not

#### [`PointOfSale.fixedCurrency`](#) ● [`Currencies`](https://docs.monei.com/apis/graphql/types/enums/currencies/.md) enum[​](#pointofsalefixedcurrencycurrencies- "Direct link to pointofsalefixedcurrencycurrencies-")

Fixed currency to be charged

#### [`PointOfSale.enabled`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#pointofsaleenabledboolean- "Direct link to pointofsaleenabledboolean-")

Whether the point of sale is enabled or not

#### [`PointOfSale.qrCodeText`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#pointofsaleqrcodetextstring- "Direct link to pointofsaleqrcodetextstring-")

QR code text

#### [`PointOfSale.paymentCallbackUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#pointofsalepaymentcallbackurlstring- "Direct link to pointofsalepaymentcallbackurlstring-")

The URL where to notify a success payment (server-to-server HTTP POST request)

#### [`PointOfSale.currentPaymentId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#pointofsalecurrentpaymentidid- "Direct link to pointofsalecurrentpaymentidid-")

The ID of the current payment

#### [`PointOfSale.type`](#) ● [`PointOfSaleType`](https://docs.monei.com/apis/graphql/types/enums/point-of-sale-type/.md) enum[​](#pointofsaletypepointofsaletype- "Direct link to pointofsaletypepointofsaletype-")

The type of the point of sale

#### [`PointOfSale.transactionType`](#) ● [`TransactionTypes`](https://docs.monei.com/apis/graphql/types/enums/transaction-types/.md) enum[​](#pointofsaletransactiontypetransactiontypes- "Direct link to pointofsaletransactiontypetransactiontypes-")

The type of the transaction

#### [`PointOfSale.paymentMethods`](#) ● [`[PaymentMethods!]`](https://docs.monei.com/apis/graphql/types/enums/payment-methods/.md) list enum[​](#pointofsalepaymentmethodspaymentmethods-- "Direct link to pointofsalepaymentmethodspaymentmethods--")

The payment methods allowed for the point of sale

#### [`PointOfSale.pendingSetup`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#pointofsalependingsetupboolean- "Direct link to pointofsalependingsetupboolean-")

Pending setup status of the point of sale

### Returned By[​](#returned-by "Direct link to Returned By")

[`createPointOfSale`](https://docs.monei.com/apis/graphql/operations/mutations/create-point-of-sale/.md) mutation ● [`pointOfSale`](https://docs.monei.com/apis/graphql/operations/queries/point-of-sale/.md) query ● [`updatePointOfSale`](https://docs.monei.com/apis/graphql/operations/mutations/update-point-of-sale/.md) mutation ● [`userPointOfSale`](https://docs.monei.com/apis/graphql/operations/queries/user-point-of-sale/.md) query

### Member Of[​](#member-of "Direct link to Member Of")

[`PointsOfSaleConnection`](https://docs.monei.com/apis/graphql/types/objects/points-of-sale-connection/.md) object


---

# PointsOfSaleConnection

No description

```
type PointsOfSaleConnection {
  items: [PointOfSale!]!
  nextToken: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PointsOfSaleConnection.items`](#) ● [`[PointOfSale!]!`](https://docs.monei.com/apis/graphql/types/objects/point-of-sale/.md) non-null object[​](#pointsofsaleconnectionitemspointofsale-- "Direct link to pointsofsaleconnectionitemspointofsale--")

List of the authorized users

#### [`PointsOfSaleConnection.nextToken`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#pointsofsaleconnectionnexttokenstring- "Direct link to pointsofsaleconnectionnexttokenstring-")

The string that you use in a subsequent request to get the next page of results in a paginated response.

### Returned By[​](#returned-by "Direct link to Returned By")

[`pointsOfSale`](https://docs.monei.com/apis/graphql/operations/queries/points-of-sale/.md) query


---

# ProviderConfig

No description

```
type ProviderConfig {
  paymentMethod: PaymentMethods
  processor: Processor
  acquirers: [Acquirer!]
  metadataConfig: [MetadataConfigItem!]
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ProviderConfig.paymentMethod`](#) ● [`PaymentMethods`](https://docs.monei.com/apis/graphql/types/enums/payment-methods/.md) enum[​](#providerconfigpaymentmethodpaymentmethods- "Direct link to providerconfigpaymentmethodpaymentmethods-")

The requested payment method

#### [`ProviderConfig.processor`](#) ● [`Processor`](https://docs.monei.com/apis/graphql/types/enums/processor/.md) enum[​](#providerconfigprocessorprocessor- "Direct link to providerconfigprocessorprocessor-")

The requested processor

#### [`ProviderConfig.acquirers`](#) ● [`[Acquirer!]`](https://docs.monei.com/apis/graphql/types/enums/acquirer/.md) list enum[​](#providerconfigacquirersacquirer-- "Direct link to providerconfigacquirersacquirer--")

Which acquirers could be behind the provider

#### [`ProviderConfig.metadataConfig`](#) ● [`[MetadataConfigItem!]`](https://docs.monei.com/apis/graphql/types/objects/metadata-config-item/.md) list object[​](#providerconfigmetadataconfigmetadataconfigitem-- "Direct link to providerconfigmetadataconfigmetadataconfigitem--")

Metadata config

### Returned By[​](#returned-by "Direct link to Returned By")

[`providerConfig`](https://docs.monei.com/apis/graphql/operations/queries/provider-config/.md) query


---

# ProviderRules

No description

```
type ProviderRules {
  minAmount: Int
  maxAmount: Int
  shopNameLike: String
  descriptionLike: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ProviderRules.minAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#providerrulesminamountint- "Direct link to providerrulesminamountint-")

Minimum amount for this provider

#### [`ProviderRules.maxAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#providerrulesmaxamountint- "Direct link to providerrulesmaxamountint-")

Maximum amount for this provider

#### [`ProviderRules.shopNameLike`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#providerrulesshopnamelikestring- "Direct link to providerrulesshopnamelikestring-")

Shop name regular expression

#### [`ProviderRules.descriptionLike`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#providerrulesdescriptionlikestring- "Direct link to providerrulesdescriptionlikestring-")

Description regular expression

### Member Of[​](#member-of "Direct link to Member Of")

[`Provider`](https://docs.monei.com/apis/graphql/types/objects/provider/.md) object


---

# Provider

No description

```
type Provider {
  id: ID!
  processor: Processor
  enabled: Boolean
  paymentMethod: PaymentMethods
  acquirer: Acquirer
  configurable: Boolean
  metadata: [MetadataItem!]
  rules: ProviderRules
  currencies: [Currencies!]
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Provider.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#provideridid-- "Direct link to provideridid--")

Provider ID

#### [`Provider.processor`](#) ● [`Processor`](https://docs.monei.com/apis/graphql/types/enums/processor/.md) enum[​](#providerprocessorprocessor- "Direct link to providerprocessorprocessor-")

The integrated processor

#### [`Provider.enabled`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#providerenabledboolean- "Direct link to providerenabledboolean-")

Whether the provider is enabled or not

#### [`Provider.paymentMethod`](#) ● [`PaymentMethods`](https://docs.monei.com/apis/graphql/types/enums/payment-methods/.md) enum[​](#providerpaymentmethodpaymentmethods- "Direct link to providerpaymentmethodpaymentmethods-")

The specific payment method

#### [`Provider.acquirer`](#) ● [`Acquirer`](https://docs.monei.com/apis/graphql/types/enums/acquirer/.md) enum[​](#provideracquireracquirer- "Direct link to provideracquireracquirer-")

The acquirer behind the provider

#### [`Provider.configurable`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#providerconfigurableboolean- "Direct link to providerconfigurableboolean-")

Whether the provider is open to be configured or not

#### [`Provider.metadata`](#) ● [`[MetadataItem!]`](https://docs.monei.com/apis/graphql/types/objects/metadata-item/.md) list object[​](#providermetadatametadataitem-- "Direct link to providermetadatametadataitem--")

Metadata

#### [`Provider.rules`](#) ● [`ProviderRules`](https://docs.monei.com/apis/graphql/types/objects/provider-rules/.md) object[​](#providerrulesproviderrules- "Direct link to providerrulesproviderrules-")

Provider rules

#### [`Provider.currencies`](#) ● [`[Currencies!]`](https://docs.monei.com/apis/graphql/types/enums/currencies/.md) list enum[​](#providercurrenciescurrencies-- "Direct link to providercurrenciescurrencies--")

Currencies supported by the provider

### Returned By[​](#returned-by "Direct link to Returned By")

[`createProvider`](https://docs.monei.com/apis/graphql/operations/mutations/create-provider/.md) mutation ● [`deleteProvider`](https://docs.monei.com/apis/graphql/operations/mutations/delete-provider/.md) mutation ● [`enableProvider`](https://docs.monei.com/apis/graphql/operations/mutations/enable-provider/.md) mutation ● [`provider`](https://docs.monei.com/apis/graphql/operations/queries/provider/.md) query ● [`providers`](https://docs.monei.com/apis/graphql/operations/queries/providers/.md) query ● [`setDefaultCardProvider`](https://docs.monei.com/apis/graphql/operations/mutations/set-default-card-provider/.md) mutation ● [`updateProvider`](https://docs.monei.com/apis/graphql/operations/mutations/update-provider/.md) mutation


---

# Redirect

No description

```
type Redirect {
  redirectUrl: String!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Redirect.redirectUrl`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#redirectredirecturlstring-- "Direct link to redirectredirecturlstring--")

### Returned By[​](#returned-by "Direct link to Returned By")

[`notificationsPortalUrl`](https://docs.monei.com/apis/graphql/operations/queries/notifications-portal-url/.md) query


---

# RegisterApplePayDomain

No description

```
type RegisterApplePayDomain {
  success: Boolean!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`RegisterApplePayDomain.success`](#) ● [`Boolean!`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) non-null scalar[​](#registerapplepaydomainsuccessboolean-- "Direct link to registerapplepaydomainsuccessboolean--")

The result of successfully registering the domain

### Returned By[​](#returned-by "Direct link to Returned By")

[`registerApplePayDomain`](https://docs.monei.com/apis/graphql/operations/mutations/register-apple-pay-domain/.md) mutation


---

# Representative

Account legal representative

```
type Representative {
  firstName: String
  lastName: String
  address: Address
  email: String
  phone: String
  documentNumber: String
  stocksPercentage: Float
  status: IdVerificationStatus
  statusMessage: String
  statusCode: Int
  hasNoPublicActivity: Boolean
  nationality: String
  citizenship: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Representative.firstName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#representativefirstnamestring- "Direct link to representativefirstnamestring-")

First name

#### [`Representative.lastName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#representativelastnamestring- "Direct link to representativelastnamestring-")

Last name

#### [`Representative.address`](#) ● [`Address`](https://docs.monei.com/apis/graphql/types/objects/address/.md) object[​](#representativeaddressaddress- "Direct link to representativeaddressaddress-")

Full address

#### [`Representative.email`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#representativeemailstring- "Direct link to representativeemailstring-")

Email

#### [`Representative.phone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#representativephonestring- "Direct link to representativephonestring-")

Phone number in E.164 format, e.g. +34666777888

#### [`Representative.documentNumber`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#representativedocumentnumberstring- "Direct link to representativedocumentnumberstring-")

Document number (CIF/NIF)

#### [`Representative.stocksPercentage`](#) ● [`Float`](https://docs.monei.com/apis/graphql/types/scalars/float/.md) scalar[​](#representativestockspercentagefloat- "Direct link to representativestockspercentagefloat-")

Stock percentage (100% if it's an individual or freelancer)

#### [`Representative.status`](#) ● [`IdVerificationStatus`](https://docs.monei.com/apis/graphql/types/enums/id-verification-status/.md) enum[​](#representativestatusidverificationstatus- "Direct link to representativestatusidverificationstatus-")

Identity verification status

#### [`Representative.statusMessage`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#representativestatusmessagestring- "Direct link to representativestatusmessagestring-")

Identity verification status message

#### [`Representative.statusCode`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#representativestatuscodeint- "Direct link to representativestatuscodeint-")

Identity verification status code

#### [`Representative.hasNoPublicActivity`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#representativehasnopublicactivityboolean- "Direct link to representativehasnopublicactivityboolean-")

Confirms that representative complies with requirements

#### [`Representative.nationality`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#representativenationalitystring- "Direct link to representativenationalitystring-")

Nationality, ISO 3166-1 alpha-2 code

#### [`Representative.citizenship`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#representativecitizenshipstring- "Direct link to representativecitizenshipstring-")

Citizenship, ISO 3166-1 alpha-2 code

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object


---

# RetrySchedule

No description

```
type RetrySchedule {
  interval: Interval!
  intervalCount: Int!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`RetrySchedule.interval`](#) ● [`Interval!`](https://docs.monei.com/apis/graphql/types/enums/interval/.md) non-null enum[​](#retryscheduleintervalinterval-- "Direct link to retryscheduleintervalinterval--")

#### [`RetrySchedule.intervalCount`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#retryscheduleintervalcountint-- "Direct link to retryscheduleintervalcountint--")

### Member Of[​](#member-of "Direct link to Member Of")

[`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object


---

# SessionDetails

Session details

```
type SessionDetails {
  ip: AWSIPAddress
  userAgent: String
  comment: String
  countryCode: String
  lang: String
  deviceType: DeviceType
  deviceModel: String
  browser: String
  browserVersion: String
  browserAccept: String
  browserColorDepth: String
  browserScreenHeight: String
  browserScreenWidth: String
  browserTimezoneOffset: String
  os: String
  osVersion: String
  source: String
  sourceVersion: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SessionDetails.ip`](#) ● [`AWSIPAddress`](https://docs.monei.com/apis/graphql/types/scalars/awsipaddress/.md) scalar[​](#sessiondetailsipawsipaddress- "Direct link to sessiondetailsipawsipaddress-")

#### [`SessionDetails.userAgent`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsuseragentstring- "Direct link to sessiondetailsuseragentstring-")

#### [`SessionDetails.comment`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailscommentstring- "Direct link to sessiondetailscommentstring-")

#### [`SessionDetails.countryCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailscountrycodestring- "Direct link to sessiondetailscountrycodestring-")

#### [`SessionDetails.lang`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailslangstring- "Direct link to sessiondetailslangstring-")

#### [`SessionDetails.deviceType`](#) ● [`DeviceType`](https://docs.monei.com/apis/graphql/types/enums/device-type/.md) enum[​](#sessiondetailsdevicetypedevicetype- "Direct link to sessiondetailsdevicetypedevicetype-")

#### [`SessionDetails.deviceModel`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsdevicemodelstring- "Direct link to sessiondetailsdevicemodelstring-")

#### [`SessionDetails.browser`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsbrowserstring- "Direct link to sessiondetailsbrowserstring-")

#### [`SessionDetails.browserVersion`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsbrowserversionstring- "Direct link to sessiondetailsbrowserversionstring-")

#### [`SessionDetails.browserAccept`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsbrowseracceptstring- "Direct link to sessiondetailsbrowseracceptstring-")

#### [`SessionDetails.browserColorDepth`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsbrowsercolordepthstring- "Direct link to sessiondetailsbrowsercolordepthstring-")

#### [`SessionDetails.browserScreenHeight`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsbrowserscreenheightstring- "Direct link to sessiondetailsbrowserscreenheightstring-")

#### [`SessionDetails.browserScreenWidth`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsbrowserscreenwidthstring- "Direct link to sessiondetailsbrowserscreenwidthstring-")

#### [`SessionDetails.browserTimezoneOffset`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsbrowsertimezoneoffsetstring- "Direct link to sessiondetailsbrowsertimezoneoffsetstring-")

#### [`SessionDetails.os`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsosstring- "Direct link to sessiondetailsosstring-")

#### [`SessionDetails.osVersion`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailsosversionstring- "Direct link to sessiondetailsosversionstring-")

#### [`SessionDetails.source`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailssourcestring- "Direct link to sessiondetailssourcestring-")

#### [`SessionDetails.sourceVersion`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sessiondetailssourceversionstring- "Direct link to sessiondetailssourceversionstring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`Charge`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) object ● [`ChargeEventObject`](https://docs.monei.com/apis/graphql/types/objects/charge-event-object/.md) object ● [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object ● [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object ● [`UserEvent`](https://docs.monei.com/apis/graphql/types/objects/user-event/.md) object


---

# Session

No description

```
type Session {
  sessionUrl: String!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Session.sessionUrl`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#sessionsessionurlstring-- "Direct link to sessionsessionurlstring--")

### Returned By[​](#returned-by "Direct link to Returned By")

[`createBankSession`](https://docs.monei.com/apis/graphql/operations/mutations/create-bank-session/.md) mutation ● [`createDocumentSession`](https://docs.monei.com/apis/graphql/operations/mutations/create-document-session/.md) mutation ● [`createIdSession`](https://docs.monei.com/apis/graphql/operations/mutations/create-id-session/.md) mutation


---

# SettlementEventObject

No description

```
type SettlementEventObject {
  accountId: ID!
  acquirerFees: Int!
  createdAt: AWSTimestamp!
  grossVolume: Int!
  iban: String
  id: ID!
  legalName: String
  netVolume: Int!
  period: Int!
  payMethod: SettlementPayMethods
  periodEndAt: AWSTimestamp!
  periodStartAt: AWSTimestamp!
  previousNegative: Boolean
  releasedAmount: Int
  reservedAmount: Int
  reservePercent: Int!
  scheduledAt: AWSTimestamp!
  status: SettlementStatus!
  updatedAt: AWSTimestamp!
  storeId: ID
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SettlementEventObject.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#settlementeventobjectaccountidid-- "Direct link to settlementeventobjectaccountidid--")

#### [`SettlementEventObject.acquirerFees`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#settlementeventobjectacquirerfeesint-- "Direct link to settlementeventobjectacquirerfeesint--")

#### [`SettlementEventObject.createdAt`](#) ● [`AWSTimestamp!`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) non-null scalar[​](#settlementeventobjectcreatedatawstimestamp-- "Direct link to settlementeventobjectcreatedatawstimestamp--")

#### [`SettlementEventObject.grossVolume`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#settlementeventobjectgrossvolumeint-- "Direct link to settlementeventobjectgrossvolumeint--")

#### [`SettlementEventObject.iban`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#settlementeventobjectibanstring- "Direct link to settlementeventobjectibanstring-")

#### [`SettlementEventObject.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#settlementeventobjectidid-- "Direct link to settlementeventobjectidid--")

#### [`SettlementEventObject.legalName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#settlementeventobjectlegalnamestring- "Direct link to settlementeventobjectlegalnamestring-")

#### [`SettlementEventObject.netVolume`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#settlementeventobjectnetvolumeint-- "Direct link to settlementeventobjectnetvolumeint--")

#### [`SettlementEventObject.period`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#settlementeventobjectperiodint-- "Direct link to settlementeventobjectperiodint--")

#### [`SettlementEventObject.payMethod`](#) ● [`SettlementPayMethods`](https://docs.monei.com/apis/graphql/types/enums/settlement-pay-methods/.md) enum[​](#settlementeventobjectpaymethodsettlementpaymethods- "Direct link to settlementeventobjectpaymethodsettlementpaymethods-")

#### [`SettlementEventObject.periodEndAt`](#) ● [`AWSTimestamp!`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) non-null scalar[​](#settlementeventobjectperiodendatawstimestamp-- "Direct link to settlementeventobjectperiodendatawstimestamp--")

#### [`SettlementEventObject.periodStartAt`](#) ● [`AWSTimestamp!`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) non-null scalar[​](#settlementeventobjectperiodstartatawstimestamp-- "Direct link to settlementeventobjectperiodstartatawstimestamp--")

#### [`SettlementEventObject.previousNegative`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#settlementeventobjectpreviousnegativeboolean- "Direct link to settlementeventobjectpreviousnegativeboolean-")

#### [`SettlementEventObject.releasedAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#settlementeventobjectreleasedamountint- "Direct link to settlementeventobjectreleasedamountint-")

#### [`SettlementEventObject.reservedAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#settlementeventobjectreservedamountint- "Direct link to settlementeventobjectreservedamountint-")

#### [`SettlementEventObject.reservePercent`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#settlementeventobjectreservepercentint-- "Direct link to settlementeventobjectreservepercentint--")

#### [`SettlementEventObject.scheduledAt`](#) ● [`AWSTimestamp!`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) non-null scalar[​](#settlementeventobjectscheduledatawstimestamp-- "Direct link to settlementeventobjectscheduledatawstimestamp--")

#### [`SettlementEventObject.status`](#) ● [`SettlementStatus!`](https://docs.monei.com/apis/graphql/types/enums/settlement-status/.md) non-null enum[​](#settlementeventobjectstatussettlementstatus-- "Direct link to settlementeventobjectstatussettlementstatus--")

#### [`SettlementEventObject.updatedAt`](#) ● [`AWSTimestamp!`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) non-null scalar[​](#settlementeventobjectupdatedatawstimestamp-- "Direct link to settlementeventobjectupdatedatawstimestamp--")

#### [`SettlementEventObject.storeId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#settlementeventobjectstoreidid- "Direct link to settlementeventobjectstoreidid-")

### Member Of[​](#member-of "Direct link to Member Of")

[`SettlementEvent`](https://docs.monei.com/apis/graphql/types/objects/settlement-event/.md) object


---

# SettlementEvent

No description

```
type SettlementEvent {
  id: ID!
  type: String!
  accountId: ID!
  objectId: ID!
  objectType: String!
  object: SettlementEventObject!
  createdAt: AWSTimestamp!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SettlementEvent.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#settlementeventidid-- "Direct link to settlementeventidid--")

#### [`SettlementEvent.type`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#settlementeventtypestring-- "Direct link to settlementeventtypestring--")

#### [`SettlementEvent.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#settlementeventaccountidid-- "Direct link to settlementeventaccountidid--")

#### [`SettlementEvent.objectId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#settlementeventobjectidid-- "Direct link to settlementeventobjectidid--")

#### [`SettlementEvent.objectType`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#settlementeventobjecttypestring-- "Direct link to settlementeventobjecttypestring--")

#### [`SettlementEvent.object`](#) ● [`SettlementEventObject!`](https://docs.monei.com/apis/graphql/types/objects/settlement-event-object/.md) non-null object[​](#settlementeventobjectsettlementeventobject-- "Direct link to settlementeventobjectsettlementeventobject--")

#### [`SettlementEvent.createdAt`](#) ● [`AWSTimestamp!`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) non-null scalar[​](#settlementeventcreatedatawstimestamp-- "Direct link to settlementeventcreatedatawstimestamp--")

### Member Of[​](#member-of "Direct link to Member Of")

[`SettlementEventsConnection`](https://docs.monei.com/apis/graphql/types/objects/settlement-events-connection/.md) object


---

# SettlementEventsConnection

No description

```
type SettlementEventsConnection {
  items: [SettlementEvent!]!
  total: Int!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SettlementEventsConnection.items`](#) ● [`[SettlementEvent!]!`](https://docs.monei.com/apis/graphql/types/objects/settlement-event/.md) non-null object[​](#settlementeventsconnectionitemssettlementevent-- "Direct link to settlementeventsconnectionitemssettlementevent--")

#### [`SettlementEventsConnection.total`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#settlementeventsconnectiontotalint-- "Direct link to settlementeventsconnectiontotalint--")

### Returned By[​](#returned-by "Direct link to Returned By")

[`settlementEvents`](https://docs.monei.com/apis/graphql/operations/queries/settlement-events/.md) query


---

# SftpConfigExport

No description

```
type SftpConfigExport {
  id: ID!
  host: String!
  port: Int!
  username: String!
  path: String!
  columns: [String!]
  timezone: String
  enabled: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SftpConfigExport.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#sftpconfigexportidid-- "Direct link to sftpconfigexportidid--")

#### [`SftpConfigExport.host`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#sftpconfigexporthoststring-- "Direct link to sftpconfigexporthoststring--")

#### [`SftpConfigExport.port`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#sftpconfigexportportint-- "Direct link to sftpconfigexportportint--")

#### [`SftpConfigExport.username`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#sftpconfigexportusernamestring-- "Direct link to sftpconfigexportusernamestring--")

#### [`SftpConfigExport.path`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#sftpconfigexportpathstring-- "Direct link to sftpconfigexportpathstring--")

#### [`SftpConfigExport.columns`](#) ● [`[String!]`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) list scalar[​](#sftpconfigexportcolumnsstring-- "Direct link to sftpconfigexportcolumnsstring--")

#### [`SftpConfigExport.timezone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#sftpconfigexporttimezonestring- "Direct link to sftpconfigexporttimezonestring-")

#### [`SftpConfigExport.enabled`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#sftpconfigexportenabledboolean- "Direct link to sftpconfigexportenabledboolean-")

### Returned By[​](#returned-by "Direct link to Returned By")

[`createExportSftpConfig`](https://docs.monei.com/apis/graphql/operations/mutations/create-export-sftp-config/.md) mutation ● [`exportSftpConfig`](https://docs.monei.com/apis/graphql/operations/queries/export-sftp-config/.md) query ● [`updateExportSftpConfig`](https://docs.monei.com/apis/graphql/operations/mutations/update-export-sftp-config/.md) mutation

### Member Of[​](#member-of "Direct link to Member Of")

[`SftpConfigExportsConnection`](https://docs.monei.com/apis/graphql/types/objects/sftp-config-exports-connection/.md) object


---

# SftpConfigExportsConnection

No description

```
type SftpConfigExportsConnection {
  items: [SftpConfigExport!]!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SftpConfigExportsConnection.items`](#) ● [`[SftpConfigExport!]!`](https://docs.monei.com/apis/graphql/types/objects/sftp-config-export/.md) non-null object[​](#sftpconfigexportsconnectionitemssftpconfigexport-- "Direct link to sftpconfigexportsconnectionitemssftpconfigexport--")

List of SFTP config exports

### Returned By[​](#returned-by "Direct link to Returned By")

[`exportSftpConfigs`](https://docs.monei.com/apis/graphql/operations/queries/export-sftp-configs/.md) query


---

# Shop

Shop details

```
type Shop {
  name: String
  country: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Shop.name`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#shopnamestring- "Direct link to shopnamestring-")

Shop name

#### [`Shop.country`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#shopcountrystring- "Direct link to shopcountrystring-")

Shop country

### Member Of[​](#member-of "Direct link to Member Of")

[`Charge`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) object ● [`ChargeEventObject`](https://docs.monei.com/apis/graphql/types/objects/charge-event-object/.md) object ● [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object


---

# ShopifyShopSettings

No description

```
type ShopifyShopSettings {
  settingsUrl: String!
  countryStores: [CountryStore!]
  testMode: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ShopifyShopSettings.settingsUrl`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#shopifyshopsettingssettingsurlstring-- "Direct link to shopifyshopsettingssettingsurlstring--")

#### [`ShopifyShopSettings.countryStores`](#) ● [`[CountryStore!]`](https://docs.monei.com/apis/graphql/types/objects/country-store/.md) list object[​](#shopifyshopsettingscountrystorescountrystore-- "Direct link to shopifyshopsettingscountrystorescountrystore--")

#### [`ShopifyShopSettings.testMode`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#shopifyshopsettingstestmodeboolean- "Direct link to shopifyshopsettingstestmodeboolean-")

### Returned By[​](#returned-by "Direct link to Returned By")

[`getShopifyShopSettings`](https://docs.monei.com/apis/graphql/operations/queries/get-shopify-shop-settings/.md) query


---

# ShopifyStore

No description

```
type ShopifyStore {
  domain: String!
  paymentMethod: String!
  accountId: String
  countryStores: [CountryStore!]
  testMode: Boolean
  createOrderOnTimeout: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ShopifyStore.domain`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#shopifystoredomainstring-- "Direct link to shopifystoredomainstring--")

#### [`ShopifyStore.paymentMethod`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#shopifystorepaymentmethodstring-- "Direct link to shopifystorepaymentmethodstring--")

#### [`ShopifyStore.accountId`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#shopifystoreaccountidstring- "Direct link to shopifystoreaccountidstring-")

#### [`ShopifyStore.countryStores`](#) ● [`[CountryStore!]`](https://docs.monei.com/apis/graphql/types/objects/country-store/.md) list object[​](#shopifystorecountrystorescountrystore-- "Direct link to shopifystorecountrystorescountrystore--")

#### [`ShopifyStore.testMode`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#shopifystoretestmodeboolean- "Direct link to shopifystoretestmodeboolean-")

#### [`ShopifyStore.createOrderOnTimeout`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#shopifystorecreateorderontimeoutboolean- "Direct link to shopifystorecreateorderontimeoutboolean-")

### Member Of[​](#member-of "Direct link to Member Of")

[`ShopifyStoresConnection`](https://docs.monei.com/apis/graphql/types/objects/shopify-stores-connection/.md) object


---

# ShopifyStoresConnection

No description

```
type ShopifyStoresConnection {
  items: [ShopifyStore!]!
  nextToken: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`ShopifyStoresConnection.items`](#) ● [`[ShopifyStore!]!`](https://docs.monei.com/apis/graphql/types/objects/shopify-store/.md) non-null object[​](#shopifystoresconnectionitemsshopifystore-- "Direct link to shopifystoresconnectionitemsshopifystore--")

#### [`ShopifyStoresConnection.nextToken`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#shopifystoresconnectionnexttokenstring- "Direct link to shopifystoresconnectionnexttokenstring-")

### Returned By[​](#returned-by "Direct link to Returned By")

[`shopifyStores`](https://docs.monei.com/apis/graphql/operations/queries/shopify-stores/.md) query


---

# Store

No description

```
type Store {
  id: ID!
  name: String
  address: Address
  phone: String
  email: String
  iban: String
  website: String
  metadata: [KeyValueItem!]
  blocked: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Store.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#storeidid-- "Direct link to storeidid--")

The Store's ID

#### [`Store.name`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#storenamestring- "Direct link to storenamestring-")

A name that represents the store

#### [`Store.address`](#) ● [`Address`](https://docs.monei.com/apis/graphql/types/objects/address/.md) object[​](#storeaddressaddress- "Direct link to storeaddressaddress-")

The store's address

#### [`Store.phone`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#storephonestring- "Direct link to storephonestring-")

The store's phone number

#### [`Store.email`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#storeemailstring- "Direct link to storeemailstring-")

The store's email address

#### [`Store.iban`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#storeibanstring- "Direct link to storeibanstring-")

The store's IBAN

#### [`Store.website`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#storewebsitestring- "Direct link to storewebsitestring-")

The store's website

#### [`Store.metadata`](#) ● [`[KeyValueItem!]`](https://docs.monei.com/apis/graphql/types/objects/key-value-item/.md) list object[​](#storemetadatakeyvalueitem-- "Direct link to storemetadatakeyvalueitem--")

Metadata

#### [`Store.blocked`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#storeblockedboolean- "Direct link to storeblockedboolean-")

Whether the store is blocked or not

### Returned By[​](#returned-by "Direct link to Returned By")

[`createStore`](https://docs.monei.com/apis/graphql/operations/mutations/create-store/.md) mutation ● [`store`](https://docs.monei.com/apis/graphql/operations/queries/store/.md) query ● [`updateStore`](https://docs.monei.com/apis/graphql/operations/mutations/update-store/.md) mutation ● [`userStore`](https://docs.monei.com/apis/graphql/operations/queries/user-store/.md) query

### Member Of[​](#member-of "Direct link to Member Of")

[`StoresConnection`](https://docs.monei.com/apis/graphql/types/objects/stores-connection/.md) object


---

# StoresConnection

No description

```
type StoresConnection {
  items: [Store!]!
  nextToken: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`StoresConnection.items`](#) ● [`[Store!]!`](https://docs.monei.com/apis/graphql/types/objects/store/.md) non-null object[​](#storesconnectionitemsstore-- "Direct link to storesconnectionitemsstore--")

List of the authorized users

#### [`StoresConnection.nextToken`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#storesconnectionnexttokenstring- "Direct link to storesconnectionnexttokenstring-")

The string that you use in a subsequent request to get the next page of results in a paginated response.

### Returned By[​](#returned-by "Direct link to Returned By")

[`stores`](https://docs.monei.com/apis/graphql/operations/queries/stores/.md) query


---

# SubscriptionEventObject

No description

```
type SubscriptionEventObject {
  id: ID!
  accountId: ID!
  createdAt: AWSTimestamp
  updatedAt: AWSTimestamp
  amount: Int
  billingDetails: ContactDetails
  currency: String!
  allowedPaymentMethods: [SubscriptionPaymentMethods]
  customer: Customer
  description: String
  descriptor: String
  cancelAtPeriodEnd: Boolean
  pauseIntervalCount: Int
  pauseAtPeriodEnd: Boolean
  skipIntervalCount: Int
  currentPeriodStart: AWSTimestamp
  currentPeriodEnd: AWSTimestamp
  trialPeriodDays: Int
  trialPeriodEnd: AWSTimestamp
  livemode: Boolean
  storeId: ID
  pointOfSaleId: ID
  sequenceId: ID
  lastOrderId: ID
  lastPayment: LastPayment
  paymentMethod: PaymentMethod
  shippingDetails: ContactDetails
  status: SubscriptionStatus!
  traceDetails: TraceDetails
  interval: Interval!
  intervalCount: Int!
  retryCount: Int
  metadata: [KeyValueItem!]
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SubscriptionEventObject.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#subscriptioneventobjectidid-- "Direct link to subscriptioneventobjectidid--")

#### [`SubscriptionEventObject.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#subscriptioneventobjectaccountidid-- "Direct link to subscriptioneventobjectaccountidid--")

#### [`SubscriptionEventObject.createdAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#subscriptioneventobjectcreatedatawstimestamp- "Direct link to subscriptioneventobjectcreatedatawstimestamp-")

#### [`SubscriptionEventObject.updatedAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#subscriptioneventobjectupdatedatawstimestamp- "Direct link to subscriptioneventobjectupdatedatawstimestamp-")

#### [`SubscriptionEventObject.amount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#subscriptioneventobjectamountint- "Direct link to subscriptioneventobjectamountint-")

#### [`SubscriptionEventObject.billingDetails`](#) ● [`ContactDetails`](https://docs.monei.com/apis/graphql/types/objects/contact-details/.md) object[​](#subscriptioneventobjectbillingdetailscontactdetails- "Direct link to subscriptioneventobjectbillingdetailscontactdetails-")

#### [`SubscriptionEventObject.currency`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#subscriptioneventobjectcurrencystring-- "Direct link to subscriptioneventobjectcurrencystring--")

#### [`SubscriptionEventObject.allowedPaymentMethods`](#) ● [`[SubscriptionPaymentMethods]`](https://docs.monei.com/apis/graphql/types/enums/subscription-payment-methods/.md) list enum[​](#subscriptioneventobjectallowedpaymentmethodssubscriptionpaymentmethods-- "Direct link to subscriptioneventobjectallowedpaymentmethodssubscriptionpaymentmethods--")

#### [`SubscriptionEventObject.customer`](#) ● [`Customer`](https://docs.monei.com/apis/graphql/types/objects/customer/.md) object[​](#subscriptioneventobjectcustomercustomer- "Direct link to subscriptioneventobjectcustomercustomer-")

#### [`SubscriptionEventObject.description`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#subscriptioneventobjectdescriptionstring- "Direct link to subscriptioneventobjectdescriptionstring-")

#### [`SubscriptionEventObject.descriptor`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#subscriptioneventobjectdescriptorstring- "Direct link to subscriptioneventobjectdescriptorstring-")

#### [`SubscriptionEventObject.cancelAtPeriodEnd`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#subscriptioneventobjectcancelatperiodendboolean- "Direct link to subscriptioneventobjectcancelatperiodendboolean-")

#### [`SubscriptionEventObject.pauseIntervalCount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#subscriptioneventobjectpauseintervalcountint- "Direct link to subscriptioneventobjectpauseintervalcountint-")

#### [`SubscriptionEventObject.pauseAtPeriodEnd`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#subscriptioneventobjectpauseatperiodendboolean- "Direct link to subscriptioneventobjectpauseatperiodendboolean-")

#### [`SubscriptionEventObject.skipIntervalCount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#subscriptioneventobjectskipintervalcountint- "Direct link to subscriptioneventobjectskipintervalcountint-")

#### [`SubscriptionEventObject.currentPeriodStart`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#subscriptioneventobjectcurrentperiodstartawstimestamp- "Direct link to subscriptioneventobjectcurrentperiodstartawstimestamp-")

#### [`SubscriptionEventObject.currentPeriodEnd`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#subscriptioneventobjectcurrentperiodendawstimestamp- "Direct link to subscriptioneventobjectcurrentperiodendawstimestamp-")

#### [`SubscriptionEventObject.trialPeriodDays`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#subscriptioneventobjecttrialperioddaysint- "Direct link to subscriptioneventobjecttrialperioddaysint-")

#### [`SubscriptionEventObject.trialPeriodEnd`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#subscriptioneventobjecttrialperiodendawstimestamp- "Direct link to subscriptioneventobjecttrialperiodendawstimestamp-")

#### [`SubscriptionEventObject.livemode`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#subscriptioneventobjectlivemodeboolean- "Direct link to subscriptioneventobjectlivemodeboolean-")

#### [`SubscriptionEventObject.storeId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#subscriptioneventobjectstoreidid- "Direct link to subscriptioneventobjectstoreidid-")

#### [`SubscriptionEventObject.pointOfSaleId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#subscriptioneventobjectpointofsaleidid- "Direct link to subscriptioneventobjectpointofsaleidid-")

#### [`SubscriptionEventObject.sequenceId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#subscriptioneventobjectsequenceidid- "Direct link to subscriptioneventobjectsequenceidid-")

#### [`SubscriptionEventObject.lastOrderId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#subscriptioneventobjectlastorderidid- "Direct link to subscriptioneventobjectlastorderidid-")

#### [`SubscriptionEventObject.lastPayment`](#) ● [`LastPayment`](https://docs.monei.com/apis/graphql/types/objects/last-payment/.md) object[​](#subscriptioneventobjectlastpaymentlastpayment- "Direct link to subscriptioneventobjectlastpaymentlastpayment-")

#### [`SubscriptionEventObject.paymentMethod`](#) ● [`PaymentMethod`](https://docs.monei.com/apis/graphql/types/objects/payment-method/.md) object[​](#subscriptioneventobjectpaymentmethodpaymentmethod- "Direct link to subscriptioneventobjectpaymentmethodpaymentmethod-")

#### [`SubscriptionEventObject.shippingDetails`](#) ● [`ContactDetails`](https://docs.monei.com/apis/graphql/types/objects/contact-details/.md) object[​](#subscriptioneventobjectshippingdetailscontactdetails- "Direct link to subscriptioneventobjectshippingdetailscontactdetails-")

#### [`SubscriptionEventObject.status`](#) ● [`SubscriptionStatus!`](https://docs.monei.com/apis/graphql/types/enums/subscription-status/.md) non-null enum[​](#subscriptioneventobjectstatussubscriptionstatus-- "Direct link to subscriptioneventobjectstatussubscriptionstatus--")

#### [`SubscriptionEventObject.traceDetails`](#) ● [`TraceDetails`](https://docs.monei.com/apis/graphql/types/objects/trace-details/.md) object[​](#subscriptioneventobjecttracedetailstracedetails- "Direct link to subscriptioneventobjecttracedetailstracedetails-")

#### [`SubscriptionEventObject.interval`](#) ● [`Interval!`](https://docs.monei.com/apis/graphql/types/enums/interval/.md) non-null enum[​](#subscriptioneventobjectintervalinterval-- "Direct link to subscriptioneventobjectintervalinterval--")

#### [`SubscriptionEventObject.intervalCount`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#subscriptioneventobjectintervalcountint-- "Direct link to subscriptioneventobjectintervalcountint--")

#### [`SubscriptionEventObject.retryCount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#subscriptioneventobjectretrycountint- "Direct link to subscriptioneventobjectretrycountint-")

#### [`SubscriptionEventObject.metadata`](#) ● [`[KeyValueItem!]`](https://docs.monei.com/apis/graphql/types/objects/key-value-item/.md) list object[​](#subscriptioneventobjectmetadatakeyvalueitem-- "Direct link to subscriptioneventobjectmetadatakeyvalueitem--")

### Member Of[​](#member-of "Direct link to Member Of")

[`SubscriptionEvent`](https://docs.monei.com/apis/graphql/types/objects/subscription-event/.md) object


---

# SubscriptionEvent

No description

```
type SubscriptionEvent {
  id: ID!
  type: String!
  accountId: ID!
  livemode: Boolean
  objectId: ID!
  objectType: String!
  object: SubscriptionEventObject!
  createdAt: AWSTimestamp
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SubscriptionEvent.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#subscriptioneventidid-- "Direct link to subscriptioneventidid--")

#### [`SubscriptionEvent.type`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#subscriptioneventtypestring-- "Direct link to subscriptioneventtypestring--")

#### [`SubscriptionEvent.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#subscriptioneventaccountidid-- "Direct link to subscriptioneventaccountidid--")

#### [`SubscriptionEvent.livemode`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#subscriptioneventlivemodeboolean- "Direct link to subscriptioneventlivemodeboolean-")

#### [`SubscriptionEvent.objectId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#subscriptioneventobjectidid-- "Direct link to subscriptioneventobjectidid--")

#### [`SubscriptionEvent.objectType`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#subscriptioneventobjecttypestring-- "Direct link to subscriptioneventobjecttypestring--")

#### [`SubscriptionEvent.object`](#) ● [`SubscriptionEventObject!`](https://docs.monei.com/apis/graphql/types/objects/subscription-event-object/.md) non-null object[​](#subscriptioneventobjectsubscriptioneventobject-- "Direct link to subscriptioneventobjectsubscriptioneventobject--")

#### [`SubscriptionEvent.createdAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#subscriptioneventcreatedatawstimestamp- "Direct link to subscriptioneventcreatedatawstimestamp-")

### Member Of[​](#member-of "Direct link to Member Of")

[`SubscriptionEventsConnection`](https://docs.monei.com/apis/graphql/types/objects/subscription-events-connection/.md) object


---

# SubscriptionEventsConnection

No description

```
type SubscriptionEventsConnection {
  items: [SubscriptionEvent!]!
  total: Int!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SubscriptionEventsConnection.items`](#) ● [`[SubscriptionEvent!]!`](https://docs.monei.com/apis/graphql/types/objects/subscription-event/.md) non-null object[​](#subscriptioneventsconnectionitemssubscriptionevent-- "Direct link to subscriptioneventsconnectionitemssubscriptionevent--")

#### [`SubscriptionEventsConnection.total`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#subscriptioneventsconnectiontotalint-- "Direct link to subscriptioneventsconnectiontotalint--")

### Returned By[​](#returned-by "Direct link to Returned By")

[`subscriptionEvents`](https://docs.monei.com/apis/graphql/operations/queries/subscription-events/.md) query


---

# Subscription

No description

```
type Subscription {
  id: ID!
  accountId: ID!
  livemode: Boolean!
  amount: Int!
  trialAmount: Int
  currency: Currencies
  allowedPaymentMethods: [SubscriptionPaymentMethods]
  description: String
  descriptor: String
  cancelAtPeriodEnd: Boolean
  pauseIntervalCount: Int
  pauseAtPeriodEnd: Boolean
  skipIntervalCount: Int
  currentPeriodStart: AWSTimestamp
  currentPeriodEnd: AWSTimestamp
  trialPeriodDays: Int
  trialPeriodEnd: AWSTimestamp
  customerId: ID
  customer: Customer
  billingDetails: ContactDetails
  shippingDetails: ContactDetails
  sequenceId: ID
  lastOrderId: ID
  lastPayment: LastPayment
  paymentMethod: PaymentMethod
  nextPaymentAt: AWSTimestamp
  createdAt: AWSTimestamp
  updatedAt: AWSTimestamp
  interval: Interval!
  intervalCount: Int!
  retryCount: Int
  status: SubscriptionStatus!
  sessionDetails: SessionDetails
  traceDetails: TraceDetails
  callbackUrl: String
  paymentCallbackUrl: String
  storeId: ID
  retrySchedule: [RetrySchedule!]
  metadata: [KeyValueItem!]
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Subscription.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#subscriptionidid-- "Direct link to subscriptionidid--")

#### [`Subscription.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#subscriptionaccountidid-- "Direct link to subscriptionaccountidid--")

#### [`Subscription.livemode`](#) ● [`Boolean!`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) non-null scalar[​](#subscriptionlivemodeboolean-- "Direct link to subscriptionlivemodeboolean--")

#### [`Subscription.amount`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#subscriptionamountint-- "Direct link to subscriptionamountint--")

#### [`Subscription.trialAmount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#subscriptiontrialamountint- "Direct link to subscriptiontrialamountint-")

#### [`Subscription.currency`](#) ● [`Currencies`](https://docs.monei.com/apis/graphql/types/enums/currencies/.md) enum[​](#subscriptioncurrencycurrencies- "Direct link to subscriptioncurrencycurrencies-")

#### [`Subscription.allowedPaymentMethods`](#) ● [`[SubscriptionPaymentMethods]`](https://docs.monei.com/apis/graphql/types/enums/subscription-payment-methods/.md) list enum[​](#subscriptionallowedpaymentmethodssubscriptionpaymentmethods-- "Direct link to subscriptionallowedpaymentmethodssubscriptionpaymentmethods--")

#### [`Subscription.description`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#subscriptiondescriptionstring- "Direct link to subscriptiondescriptionstring-")

#### [`Subscription.descriptor`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#subscriptiondescriptorstring- "Direct link to subscriptiondescriptorstring-")

#### [`Subscription.cancelAtPeriodEnd`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#subscriptioncancelatperiodendboolean- "Direct link to subscriptioncancelatperiodendboolean-")

#### [`Subscription.pauseIntervalCount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#subscriptionpauseintervalcountint- "Direct link to subscriptionpauseintervalcountint-")

#### [`Subscription.pauseAtPeriodEnd`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#subscriptionpauseatperiodendboolean- "Direct link to subscriptionpauseatperiodendboolean-")

#### [`Subscription.skipIntervalCount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#subscriptionskipintervalcountint- "Direct link to subscriptionskipintervalcountint-")

#### [`Subscription.currentPeriodStart`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#subscriptioncurrentperiodstartawstimestamp- "Direct link to subscriptioncurrentperiodstartawstimestamp-")

#### [`Subscription.currentPeriodEnd`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#subscriptioncurrentperiodendawstimestamp- "Direct link to subscriptioncurrentperiodendawstimestamp-")

#### [`Subscription.trialPeriodDays`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#subscriptiontrialperioddaysint- "Direct link to subscriptiontrialperioddaysint-")

#### [`Subscription.trialPeriodEnd`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#subscriptiontrialperiodendawstimestamp- "Direct link to subscriptiontrialperiodendawstimestamp-")

#### [`Subscription.customerId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#subscriptioncustomeridid- "Direct link to subscriptioncustomeridid-")

#### [`Subscription.customer`](#) ● [`Customer`](https://docs.monei.com/apis/graphql/types/objects/customer/.md) object[​](#subscriptioncustomercustomer- "Direct link to subscriptioncustomercustomer-")

#### [`Subscription.billingDetails`](#) ● [`ContactDetails`](https://docs.monei.com/apis/graphql/types/objects/contact-details/.md) object[​](#subscriptionbillingdetailscontactdetails- "Direct link to subscriptionbillingdetailscontactdetails-")

#### [`Subscription.shippingDetails`](#) ● [`ContactDetails`](https://docs.monei.com/apis/graphql/types/objects/contact-details/.md) object[​](#subscriptionshippingdetailscontactdetails- "Direct link to subscriptionshippingdetailscontactdetails-")

#### [`Subscription.sequenceId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#subscriptionsequenceidid- "Direct link to subscriptionsequenceidid-")

#### [`Subscription.lastOrderId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#subscriptionlastorderidid- "Direct link to subscriptionlastorderidid-")

#### [`Subscription.lastPayment`](#) ● [`LastPayment`](https://docs.monei.com/apis/graphql/types/objects/last-payment/.md) object[​](#subscriptionlastpaymentlastpayment- "Direct link to subscriptionlastpaymentlastpayment-")

#### [`Subscription.paymentMethod`](#) ● [`PaymentMethod`](https://docs.monei.com/apis/graphql/types/objects/payment-method/.md) object[​](#subscriptionpaymentmethodpaymentmethod- "Direct link to subscriptionpaymentmethodpaymentmethod-")

#### [`Subscription.nextPaymentAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#subscriptionnextpaymentatawstimestamp- "Direct link to subscriptionnextpaymentatawstimestamp-")

#### [`Subscription.createdAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#subscriptioncreatedatawstimestamp- "Direct link to subscriptioncreatedatawstimestamp-")

#### [`Subscription.updatedAt`](#) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#subscriptionupdatedatawstimestamp- "Direct link to subscriptionupdatedatawstimestamp-")

#### [`Subscription.interval`](#) ● [`Interval!`](https://docs.monei.com/apis/graphql/types/enums/interval/.md) non-null enum[​](#subscriptionintervalinterval-- "Direct link to subscriptionintervalinterval--")

#### [`Subscription.intervalCount`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#subscriptionintervalcountint-- "Direct link to subscriptionintervalcountint--")

#### [`Subscription.retryCount`](#) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#subscriptionretrycountint- "Direct link to subscriptionretrycountint-")

#### [`Subscription.status`](#) ● [`SubscriptionStatus!`](https://docs.monei.com/apis/graphql/types/enums/subscription-status/.md) non-null enum[​](#subscriptionstatussubscriptionstatus-- "Direct link to subscriptionstatussubscriptionstatus--")

#### [`Subscription.sessionDetails`](#) ● [`SessionDetails`](https://docs.monei.com/apis/graphql/types/objects/session-details/.md) object[​](#subscriptionsessiondetailssessiondetails- "Direct link to subscriptionsessiondetailssessiondetails-")

#### [`Subscription.traceDetails`](#) ● [`TraceDetails`](https://docs.monei.com/apis/graphql/types/objects/trace-details/.md) object[​](#subscriptiontracedetailstracedetails- "Direct link to subscriptiontracedetailstracedetails-")

#### [`Subscription.callbackUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#subscriptioncallbackurlstring- "Direct link to subscriptioncallbackurlstring-")

#### [`Subscription.paymentCallbackUrl`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#subscriptionpaymentcallbackurlstring- "Direct link to subscriptionpaymentcallbackurlstring-")

#### [`Subscription.storeId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#subscriptionstoreidid- "Direct link to subscriptionstoreidid-")

#### [`Subscription.retrySchedule`](#) ● [`[RetrySchedule!]`](https://docs.monei.com/apis/graphql/types/objects/retry-schedule/.md) list object[​](#subscriptionretryscheduleretryschedule-- "Direct link to subscriptionretryscheduleretryschedule--")

#### [`Subscription.metadata`](#) ● [`[KeyValueItem!]`](https://docs.monei.com/apis/graphql/types/objects/key-value-item/.md) list object[​](#subscriptionmetadatakeyvalueitem-- "Direct link to subscriptionmetadatakeyvalueitem--")

### Returned By[​](#returned-by "Direct link to Returned By")

[`cancelSubscription`](https://docs.monei.com/apis/graphql/operations/mutations/cancel-subscription/.md) mutation ● [`createSubscription`](https://docs.monei.com/apis/graphql/operations/mutations/create-subscription/.md) mutation ● [`pauseSubscription`](https://docs.monei.com/apis/graphql/operations/mutations/pause-subscription/.md) mutation ● [`resumeSubscription`](https://docs.monei.com/apis/graphql/operations/mutations/resume-subscription/.md) mutation ● [`sendSubscriptionLink`](https://docs.monei.com/apis/graphql/operations/mutations/send-subscription-link/.md) mutation ● [`sendSubscriptionStatus`](https://docs.monei.com/apis/graphql/operations/mutations/send-subscription-status/.md) mutation ● [`subscription`](https://docs.monei.com/apis/graphql/operations/queries/subscription/.md) query ● [`updateSubscription`](https://docs.monei.com/apis/graphql/operations/mutations/update-subscription/.md) mutation

### Member Of[​](#member-of "Direct link to Member Of")

[`SubscriptionsConnection`](https://docs.monei.com/apis/graphql/types/objects/subscriptions-connection/.md) object


---

# SubscriptionsConnection

No description

```
type SubscriptionsConnection {
  items: [Subscription!]!
  total: Int!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`SubscriptionsConnection.items`](#) ● [`[Subscription!]!`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) non-null object[​](#subscriptionsconnectionitemssubscription-- "Direct link to subscriptionsconnectionitemssubscription--")

#### [`SubscriptionsConnection.total`](#) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#subscriptionsconnectiontotalint-- "Direct link to subscriptionsconnectiontotalint--")

### Returned By[​](#returned-by "Direct link to Returned By")

[`subscriptions`](https://docs.monei.com/apis/graphql/operations/queries/subscriptions/.md) query


---

# TraceDetails

No description

```
type TraceDetails {
  ip: AWSIPAddress
  userAgent: String
  comment: String
  countryCode: String
  lang: String
  deviceType: DeviceType
  deviceModel: String
  browser: String
  browserVersion: String
  browserAccept: String
  os: String
  osVersion: String
  source: String
  sourceVersion: String
  userId: ID
  userEmail: String
  userName: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`TraceDetails.ip`](#) ● [`AWSIPAddress`](https://docs.monei.com/apis/graphql/types/scalars/awsipaddress/.md) scalar[​](#tracedetailsipawsipaddress- "Direct link to tracedetailsipawsipaddress-")

#### [`TraceDetails.userAgent`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsuseragentstring- "Direct link to tracedetailsuseragentstring-")

#### [`TraceDetails.comment`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailscommentstring- "Direct link to tracedetailscommentstring-")

#### [`TraceDetails.countryCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailscountrycodestring- "Direct link to tracedetailscountrycodestring-")

#### [`TraceDetails.lang`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailslangstring- "Direct link to tracedetailslangstring-")

#### [`TraceDetails.deviceType`](#) ● [`DeviceType`](https://docs.monei.com/apis/graphql/types/enums/device-type/.md) enum[​](#tracedetailsdevicetypedevicetype- "Direct link to tracedetailsdevicetypedevicetype-")

#### [`TraceDetails.deviceModel`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsdevicemodelstring- "Direct link to tracedetailsdevicemodelstring-")

#### [`TraceDetails.browser`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsbrowserstring- "Direct link to tracedetailsbrowserstring-")

#### [`TraceDetails.browserVersion`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsbrowserversionstring- "Direct link to tracedetailsbrowserversionstring-")

#### [`TraceDetails.browserAccept`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsbrowseracceptstring- "Direct link to tracedetailsbrowseracceptstring-")

#### [`TraceDetails.os`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsosstring- "Direct link to tracedetailsosstring-")

#### [`TraceDetails.osVersion`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsosversionstring- "Direct link to tracedetailsosversionstring-")

#### [`TraceDetails.source`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailssourcestring- "Direct link to tracedetailssourcestring-")

#### [`TraceDetails.sourceVersion`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailssourceversionstring- "Direct link to tracedetailssourceversionstring-")

#### [`TraceDetails.userId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#tracedetailsuseridid- "Direct link to tracedetailsuseridid-")

#### [`TraceDetails.userEmail`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsuseremailstring- "Direct link to tracedetailsuseremailstring-")

#### [`TraceDetails.userName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#tracedetailsusernamestring- "Direct link to tracedetailsusernamestring-")

### Member Of[​](#member-of "Direct link to Member Of")

[`Charge`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) object ● [`ChargeEventObject`](https://docs.monei.com/apis/graphql/types/objects/charge-event-object/.md) object ● [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object ● [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object ● [`SubscriptionEventObject`](https://docs.monei.com/apis/graphql/types/objects/subscription-event-object/.md) object


---

# UpdateShopifyShopSettingsResult

No description

```
type UpdateShopifyShopSettingsResult {
  countryStores: [CountryStore!]
  testMode: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UpdateShopifyShopSettingsResult.countryStores`](#) ● [`[CountryStore!]`](https://docs.monei.com/apis/graphql/types/objects/country-store/.md) list object[​](#updateshopifyshopsettingsresultcountrystorescountrystore-- "Direct link to updateshopifyshopsettingsresultcountrystorescountrystore--")

#### [`UpdateShopifyShopSettingsResult.testMode`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#updateshopifyshopsettingsresulttestmodeboolean- "Direct link to updateshopifyshopsettingsresulttestmodeboolean-")

### Returned By[​](#returned-by "Direct link to Returned By")

[`updateShopifyShopSettings`](https://docs.monei.com/apis/graphql/operations/mutations/update-shopify-shop-settings/.md) mutation


---

# UploadFile

No description

```
type UploadFile {
  uploadUrl: String!
  expiresAt: AWSTimestamp!
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UploadFile.uploadUrl`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#uploadfileuploadurlstring-- "Direct link to uploadfileuploadurlstring--")

The URL to upload the file. It will only last for 15 minutes.

#### [`UploadFile.expiresAt`](#) ● [`AWSTimestamp!`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) non-null scalar[​](#uploadfileexpiresatawstimestamp-- "Direct link to uploadfileexpiresatawstimestamp--")

The expiration time for the downloadUrl

### Returned By[​](#returned-by "Direct link to Returned By")

[`uploadDocument`](https://docs.monei.com/apis/graphql/operations/mutations/upload-document/.md) mutation


---

# UserAccount

An account that can be accessed by the authorized user

```
type UserAccount {
  accessLevel: AuthorizedUserAccessLevel!
  accountId: ID!
  accountName: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UserAccount.accessLevel`](#) ● [`AuthorizedUserAccessLevel!`](https://docs.monei.com/apis/graphql/types/enums/authorized-user-access-level/.md) non-null enum[​](#useraccountaccesslevelauthorizeduseraccesslevel-- "Direct link to useraccountaccesslevelauthorizeduseraccesslevel--")

Access level for this account

#### [`UserAccount.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#useraccountaccountidid-- "Direct link to useraccountaccountidid--")

Account ID

#### [`UserAccount.accountName`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#useraccountaccountnamestring- "Direct link to useraccountaccountnamestring-")

Account name

### Member Of[​](#member-of "Direct link to Member Of")

[`UserAccountsConnection`](https://docs.monei.com/apis/graphql/types/objects/user-accounts-connection/.md) object


---

# UserAccountsConnection

No description

```
type UserAccountsConnection {
  items: [UserAccount!]!
  nextToken: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UserAccountsConnection.items`](#) ● [`[UserAccount!]!`](https://docs.monei.com/apis/graphql/types/objects/user-account/.md) non-null object[​](#useraccountsconnectionitemsuseraccount-- "Direct link to useraccountsconnectionitemsuseraccount--")

List of the authorized users

#### [`UserAccountsConnection.nextToken`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#useraccountsconnectionnexttokenstring- "Direct link to useraccountsconnectionnexttokenstring-")

The string that you use in a subsequent request to get the next page of results in a paginated response.

### Returned By[​](#returned-by "Direct link to Returned By")

[`userAccounts`](https://docs.monei.com/apis/graphql/operations/queries/user-accounts/.md) query


---

# UserEvent

No description

```
type UserEvent {
  id: ID!
  type: String!
  objectType: String!
  objectId: ID
  createdAt: AWSTimestamp!
  sessionDetails: SessionDetails
  metadata: [KeyValueItem!]
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UserEvent.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#usereventidid-- "Direct link to usereventidid--")

#### [`UserEvent.type`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#usereventtypestring-- "Direct link to usereventtypestring--")

#### [`UserEvent.objectType`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#usereventobjecttypestring-- "Direct link to usereventobjecttypestring--")

#### [`UserEvent.objectId`](#) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#usereventobjectidid- "Direct link to usereventobjectidid-")

#### [`UserEvent.createdAt`](#) ● [`AWSTimestamp!`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) non-null scalar[​](#usereventcreatedatawstimestamp-- "Direct link to usereventcreatedatawstimestamp--")

#### [`UserEvent.sessionDetails`](#) ● [`SessionDetails`](https://docs.monei.com/apis/graphql/types/objects/session-details/.md) object[​](#usereventsessiondetailssessiondetails- "Direct link to usereventsessiondetailssessiondetails-")

#### [`UserEvent.metadata`](#) ● [`[KeyValueItem!]`](https://docs.monei.com/apis/graphql/types/objects/key-value-item/.md) list object[​](#usereventmetadatakeyvalueitem-- "Direct link to usereventmetadatakeyvalueitem--")

### Member Of[​](#member-of "Direct link to Member Of")

[`UserEventsConnection`](https://docs.monei.com/apis/graphql/types/objects/user-events-connection/.md) object


---

# UserEventsConnection

No description

```
type UserEventsConnection {
  items: [UserEvent!]!
  nextToken: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`UserEventsConnection.items`](#) ● [`[UserEvent!]!`](https://docs.monei.com/apis/graphql/types/objects/user-event/.md) non-null object[​](#usereventsconnectionitemsuserevent-- "Direct link to usereventsconnectionitemsuserevent--")

#### [`UserEventsConnection.nextToken`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#usereventsconnectionnexttokenstring- "Direct link to usereventsconnectionnexttokenstring-")

### Returned By[​](#returned-by "Direct link to Returned By")

[`userEvents`](https://docs.monei.com/apis/graphql/operations/queries/user-events/.md) query


---

# WebReport

A web report is a report of the website.

```
type WebReport {
  baseUrl: String!
  status: WebReportStatus!
  statusCode: String
  statusMessage: String
  riskCategory: String
  restricted: Boolean
  underConstruction: Boolean
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`WebReport.baseUrl`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#webreportbaseurlstring-- "Direct link to webreportbaseurlstring--")

The base URL of the website.

#### [`WebReport.status`](#) ● [`WebReportStatus!`](https://docs.monei.com/apis/graphql/types/enums/web-report-status/.md) non-null enum[​](#webreportstatuswebreportstatus-- "Direct link to webreportstatuswebreportstatus--")

The status of the web report.

#### [`WebReport.statusCode`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#webreportstatuscodestring- "Direct link to webreportstatuscodestring-")

The status code of the web report.

#### [`WebReport.statusMessage`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#webreportstatusmessagestring- "Direct link to webreportstatusmessagestring-")

The status message of the web report.

#### [`WebReport.riskCategory`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#webreportriskcategorystring- "Direct link to webreportriskcategorystring-")

The risk category of the website.

#### [`WebReport.restricted`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#webreportrestrictedboolean- "Direct link to webreportrestrictedboolean-")

Whether the website belongs to a restricted category.

#### [`WebReport.underConstruction`](#) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#webreportunderconstructionboolean- "Direct link to webreportunderconstructionboolean-")

Whether the website is under construction.

### Returned By[​](#returned-by "Direct link to Returned By")

[`validateWebsite`](https://docs.monei.com/apis/graphql/operations/mutations/validate-website/.md) mutation ● [`webReport`](https://docs.monei.com/apis/graphql/operations/queries/web-report/.md) query


---

# Webhook

No description

```
type Webhook {
  id: ID!
  accountId: ID!
  url: String!
  eventTypes: [WebhookEventType!]!
  secret: String
  enabled: Boolean!
  createdAt: String!
  updatedAt: String
  lastResponse: CallbackData
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Webhook.id`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#webhookidid-- "Direct link to webhookidid--")

#### [`Webhook.accountId`](#) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#webhookaccountidid-- "Direct link to webhookaccountidid--")

#### [`Webhook.url`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#webhookurlstring-- "Direct link to webhookurlstring--")

#### [`Webhook.eventTypes`](#) ● [`[WebhookEventType!]!`](https://docs.monei.com/apis/graphql/types/enums/webhook-event-type/.md) non-null enum[​](#webhookeventtypeswebhookeventtype-- "Direct link to webhookeventtypeswebhookeventtype--")

#### [`Webhook.secret`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#webhooksecretstring- "Direct link to webhooksecretstring-")

#### [`Webhook.enabled`](#) ● [`Boolean!`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) non-null scalar[​](#webhookenabledboolean-- "Direct link to webhookenabledboolean--")

#### [`Webhook.createdAt`](#) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#webhookcreatedatstring-- "Direct link to webhookcreatedatstring--")

#### [`Webhook.updatedAt`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#webhookupdatedatstring- "Direct link to webhookupdatedatstring-")

#### [`Webhook.lastResponse`](#) ● [`CallbackData`](https://docs.monei.com/apis/graphql/types/objects/callback-data/.md) object[​](#webhooklastresponsecallbackdata- "Direct link to webhooklastresponsecallbackdata-")

### Returned By[​](#returned-by "Direct link to Returned By")

[`createWebhook`](https://docs.monei.com/apis/graphql/operations/mutations/create-webhook/.md) mutation ● [`updateWebhook`](https://docs.monei.com/apis/graphql/operations/mutations/update-webhook/.md) mutation ● [`webhook`](https://docs.monei.com/apis/graphql/operations/queries/webhook/.md) query

### Member Of[​](#member-of "Direct link to Member Of")

[`WebhooksConnection`](https://docs.monei.com/apis/graphql/types/objects/webhooks-connection/.md) object


---

# WebhooksConnection

No description

```
type WebhooksConnection {
  items: [Webhook]!
  nextToken: String
}
```

### Fields[​](#fields "Direct link to Fields")

#### [`WebhooksConnection.items`](#) ● [`[Webhook]!`](https://docs.monei.com/apis/graphql/types/objects/webhook/.md) non-null object[​](#webhooksconnectionitemswebhook-- "Direct link to webhooksconnectionitemswebhook--")

List of the authorized users

#### [`WebhooksConnection.nextToken`](#) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#webhooksconnectionnexttokenstring- "Direct link to webhooksconnectionnexttokenstring-")

The string that you use in a subsequent request to get the next page of results in a paginated response.

### Returned By[​](#returned-by "Direct link to Returned By")

[`webhooks`](https://docs.monei.com/apis/graphql/operations/queries/webhooks/.md) query


---

# AWSDateTime

The `AWSDateTime` scalar type provided by AWS AppSync, represents a valid \*\*\*extended\*\*\* [ISO 8601 DateTime](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) string. In other words, this scalar type accepts datetime strings of the form `YYYY-MM-DDThh:mm:ss.SSSZ`. The scalar can also accept "negative years" of the form `-YYYY` which correspond to years before `0000`. For example, "\*\*-2017-01-01T00:00Z\*\*" and "\*\*-9999-01-01T00:00Z\*\*" are both valid datetime strings. The field after the two digit seconds field is a nanoseconds field. It can accept between 1 and 9 digits. So, for example, "\*\*1970-01-01T12:00:00.2Z\*\*", "\*\*1970-01-01T12:00:00.277Z\*\*" and "\*\*1970-01-01T12:00:00.123456789Z\*\*" are all valid datetime strings. The seconds and nanoseconds fields are optional (the seconds field must be specified if the nanoseconds field is to be used). The [time zone offset](https://en.wikipedia.org/wiki/ISO_8601#Time_zone_designators) is compulsory for this scalar. The time zone offset must either be `Z` (representing the UTC time zone) or be in the format `±hh:mm:ss`. The seconds field in the timezone offset will be considered valid even though it is not part of the ISO 8601 standard.

```
scalar AWSDateTime
```

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentRule`](https://docs.monei.com/apis/graphql/types/objects/payment-rule/.md) object


---

# AWSEmail

The `AWSEmail` scalar type provided by AWS AppSync, represents an Email address string that complies with [RFC 822](https://www.ietf.org/rfc/rfc822.txt). For example, "\*\*<username@example.com>\*\*" is a valid Email address.

```
scalar AWSEmail
```

### Member Of[​](#member-of "Direct link to Member Of")

[`SendPaymentMessageInput`](https://docs.monei.com/apis/graphql/types/inputs/send-payment-message-input/.md) input ● [`SendSubscriptionMessageInput`](https://docs.monei.com/apis/graphql/types/inputs/send-subscription-message-input/.md) input


---

# AWSIPAddress

The `AWSIPAddress` scalar type provided by AWS AppSync, represents a valid [IPv4](https://en.wikipedia.org/wiki/IPv4#Addressing) or [IPv6](https://en.wikipedia.org/wiki/IPv6_address) address string. IP addresses with subnet masks are considered valid. However, subnet masks are not necessary. For example, "\*\*127.0.0.1\*\*" and "\*\*127.0.0.1/8\*\*" are both considered valid IP Addresses.

```
scalar AWSIPAddress
```

### Member Of[​](#member-of "Direct link to Member Of")

[`SessionDetails`](https://docs.monei.com/apis/graphql/types/objects/session-details/.md) object ● [`SessionDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/session-details-input/.md) input ● [`TraceDetails`](https://docs.monei.com/apis/graphql/types/objects/trace-details/.md) object ● [`TraceDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/trace-details-input/.md) input


---

# AWSJSON

The `AWSJSON` scalar type provided by AWS AppSync, represents a JSON string that complies with [RFC 8259](https://tools.ietf.org/html/rfc8259). Maps like "\*\*{\\"upvotes\\": 10}\*\*", lists like "\*\*\[1,2,3]\*\*", and scalar values like "\*\*\\"AWSJSON example string\\"\*\*", "\*\*1\*\*", and "\*\*true\*\*" are accepted as valid JSON and will automatically be parsed and loaded in the resolver mapping templates as Maps, Lists, or Scalar values rather than as the literal input strings. Invalid JSON strings like "\*\*{a: 1}\*\*", "\*\*{'a': 1}\*\*" and "\*\*Unquoted string\*\*" will throw GraphQL validation errors.

```
scalar AWSJSON
```

### Returned By[​](#returned-by "Direct link to Returned By")

[`createCapitalEmbedToken`](https://docs.monei.com/apis/graphql/operations/mutations/create-capital-embed-token/.md) mutation


---

# AWSPhone

The `AWSPhone` scalar type provided by AWS AppSync, represents a valid Phone Number. Phone numbers are serialized and deserialized as Strings. Segments of the phone number may be whitespace delimited or hyphenated. The number can specify a country code at the beginning. However, United States numbers without country codes are still considered to be valid.

```
scalar AWSPhone
```

### Member Of[​](#member-of "Direct link to Member Of")

[`SendPaymentMessageInput`](https://docs.monei.com/apis/graphql/types/inputs/send-payment-message-input/.md) input ● [`SendSubscriptionMessageInput`](https://docs.monei.com/apis/graphql/types/inputs/send-subscription-message-input/.md) input


---

# AWSTimestamp

The `AWSTimestamp` scalar type provided by AWS AppSync, represents the number of seconds that have elapsed since `1970-01-01T00:00Z`. Negative values are also accepted and these represent the number of seconds till `1970-01-01T00:00Z`. Timestamps are serialized and deserialized as integers. The minimum supported timestamp value is \*\*`-31557014167219200`*\* which corresponds to `-1000000000-01-01T00:00Z`. The maximum supported timestamp value is \*\*`31556889864403199`*\* which corresponds to `1000000000-12-31T23:59:59.999999999Z`.

```
scalar AWSTimestamp
```

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountSettlement`](https://docs.monei.com/apis/graphql/types/objects/account-settlement/.md) object ● [`ActivateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/activate-subscription-input/.md) input ● [`Charge`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) object ● [`ChargeEvent`](https://docs.monei.com/apis/graphql/types/objects/charge-event/.md) object ● [`ChargeEventObject`](https://docs.monei.com/apis/graphql/types/objects/charge-event-object/.md) object ● [`ChargesDateRangeKPIRow`](https://docs.monei.com/apis/graphql/types/objects/charges-date-range-kpirow/.md) object ● [`ChargesExport`](https://docs.monei.com/apis/graphql/types/objects/charges-export/.md) object ● [`CreatePaymentInput`](https://docs.monei.com/apis/graphql/types/inputs/create-payment-input/.md) input ● [`CreateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/create-subscription-input/.md) input ● [`DownloadFile`](https://docs.monei.com/apis/graphql/types/objects/download-file/.md) object ● [`ExportCharges`](https://docs.monei.com/apis/graphql/types/objects/export-charges/.md) object ● [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object ● [`PaymentMethodCard`](https://docs.monei.com/apis/graphql/types/objects/payment-method-card/.md) object ● [`SettlementEvent`](https://docs.monei.com/apis/graphql/types/objects/settlement-event/.md) object ● [`SettlementEventObject`](https://docs.monei.com/apis/graphql/types/objects/settlement-event-object/.md) object ● [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object ● [`SubscriptionEvent`](https://docs.monei.com/apis/graphql/types/objects/subscription-event/.md) object ● [`SubscriptionEventObject`](https://docs.monei.com/apis/graphql/types/objects/subscription-event-object/.md) object ● [`UpdateChargeInput`](https://docs.monei.com/apis/graphql/types/inputs/update-charge-input/.md) input ● [`UpdateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/update-subscription-input/.md) input ● [`UploadFile`](https://docs.monei.com/apis/graphql/types/objects/upload-file/.md) object ● [`UserEvent`](https://docs.monei.com/apis/graphql/types/objects/user-event/.md) object


---

# Boolean

The `Boolean` scalar type represents `true` or `false`.

```
scalar Boolean
```

### Returned By[​](#returned-by "Direct link to Returned By")

[`createAccount`](https://docs.monei.com/apis/graphql/operations/mutations/create-account/.md) mutation ● [`createCapitalLead`](https://docs.monei.com/apis/graphql/operations/mutations/create-capital-lead/.md) mutation ● [`deleteApiKey`](https://docs.monei.com/apis/graphql/operations/mutations/delete-api-key/.md) mutation ● [`deleteApplePayCert`](https://docs.monei.com/apis/graphql/operations/mutations/delete-apple-pay-cert/.md) mutation ● [`deleteAuthorizedUser`](https://docs.monei.com/apis/graphql/operations/mutations/delete-authorized-user/.md) mutation ● [`deleteBlacklistItem`](https://docs.monei.com/apis/graphql/operations/mutations/delete-blacklist-item/.md) mutation ● [`deleteCode`](https://docs.monei.com/apis/graphql/operations/mutations/delete-code/.md) mutation ● [`deleteDocument`](https://docs.monei.com/apis/graphql/operations/mutations/delete-document/.md) mutation ● [`deleteExportSftpConfig`](https://docs.monei.com/apis/graphql/operations/mutations/delete-export-sftp-config/.md) mutation ● [`deletePaymentRule`](https://docs.monei.com/apis/graphql/operations/mutations/delete-payment-rule/.md) mutation ● [`deletePointOfSale`](https://docs.monei.com/apis/graphql/operations/mutations/delete-point-of-sale/.md) mutation ● [`deleteStore`](https://docs.monei.com/apis/graphql/operations/mutations/delete-store/.md) mutation ● [`deleteWebhook`](https://docs.monei.com/apis/graphql/operations/mutations/delete-webhook/.md) mutation ● [`selectUserAccount`](https://docs.monei.com/apis/graphql/operations/mutations/select-user-account/.md) mutation

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object ● [`AccountNotifications`](https://docs.monei.com/apis/graphql/types/objects/account-notifications/.md) object ● [`AccountNotificationsInput`](https://docs.monei.com/apis/graphql/types/inputs/account-notifications-input/.md) input ● [`AccountPaymentMethodsBizum`](https://docs.monei.com/apis/graphql/types/objects/account-payment-methods-bizum/.md) object ● [`AccountPaymentMethodsCreditCard`](https://docs.monei.com/apis/graphql/types/objects/account-payment-methods-credit-card/.md) object ● [`AccountPayoutTerms`](https://docs.monei.com/apis/graphql/types/objects/account-payout-terms/.md) object ● [`AccountSettlement`](https://docs.monei.com/apis/graphql/types/objects/account-settlement/.md) object ● [`AccountTokenizationMethodsClickToPayItem`](https://docs.monei.com/apis/graphql/types/objects/account-tokenization-methods-click-to-pay-item/.md) object ● [`AccountTokenizationMethodsItem`](https://docs.monei.com/apis/graphql/types/objects/account-tokenization-methods-item/.md) object ● [`ApplePayCertificate`](https://docs.monei.com/apis/graphql/types/objects/apple-pay-certificate/.md) object ● [`AvailablePaymentMethod`](https://docs.monei.com/apis/graphql/types/objects/available-payment-method/.md) object ● [`AvailableProcessor`](https://docs.monei.com/apis/graphql/types/objects/available-processor/.md) object ● [`BusinessData`](https://docs.monei.com/apis/graphql/types/objects/business-data/.md) object ● [`BusinessDataInput`](https://docs.monei.com/apis/graphql/types/inputs/business-data-input/.md) input ● [`CancelSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/cancel-subscription-input/.md) input ● [`CapitalLoan`](https://docs.monei.com/apis/graphql/types/objects/capital-loan/.md) object ● [`CapitalLoanDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-details/.md) object ● [`CapitalLoanEarlyRenewalDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-early-renewal-details/.md) object ● [`Charge`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) object ● [`ChargeEvent`](https://docs.monei.com/apis/graphql/types/objects/charge-event/.md) object ● [`ChargeEventObject`](https://docs.monei.com/apis/graphql/types/objects/charge-event-object/.md) object ● [`Code`](https://docs.monei.com/apis/graphql/types/objects/code/.md) object ● [`Countries`](https://docs.monei.com/apis/graphql/types/objects/countries/.md) object ● [`createAccount`](https://docs.monei.com/apis/graphql/operations/mutations/create-account/.md) mutation ● [`CreateExportSftpConfigInput`](https://docs.monei.com/apis/graphql/types/inputs/create-export-sftp-config-input/.md) input ● [`CreatePointOfSaleInput`](https://docs.monei.com/apis/graphql/types/inputs/create-point-of-sale-input/.md) input ● [`CreateProviderInput`](https://docs.monei.com/apis/graphql/types/inputs/create-provider-input/.md) input ● [`CreateStoreInput`](https://docs.monei.com/apis/graphql/types/inputs/create-store-input/.md) input ● [`CreateWebhookInput`](https://docs.monei.com/apis/graphql/types/inputs/create-webhook-input/.md) input ● [`enableProvider`](https://docs.monei.com/apis/graphql/operations/mutations/enable-provider/.md) mutation ● [`include`](https://docs.monei.com/apis/graphql/operations/directives/include/.md) directive ● [`MetadataConfigItem`](https://docs.monei.com/apis/graphql/types/objects/metadata-config-item/.md) object ● [`MetadataItem`](https://docs.monei.com/apis/graphql/types/objects/metadata-item/.md) object ● [`NextAction`](https://docs.monei.com/apis/graphql/types/objects/next-action/.md) object ● [`PauseSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/pause-subscription-input/.md) input ● [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object ● [`PaymentMethodCard`](https://docs.monei.com/apis/graphql/types/objects/payment-method-card/.md) object ● [`PaymentMethodCardInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-card-input/.md) input ● [`PointOfSale`](https://docs.monei.com/apis/graphql/types/objects/point-of-sale/.md) object ● [`Provider`](https://docs.monei.com/apis/graphql/types/objects/provider/.md) object ● [`RegisterApplePayDomain`](https://docs.monei.com/apis/graphql/types/objects/register-apple-pay-domain/.md) object ● [`Representative`](https://docs.monei.com/apis/graphql/types/objects/representative/.md) object ● [`RepresentativeInput`](https://docs.monei.com/apis/graphql/types/inputs/representative-input/.md) input ● [`SearchableBooleanFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-boolean-filter-input/.md) input ● [`SearchableIDFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-idfilter-input/.md) input ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input ● [`SettlementEventObject`](https://docs.monei.com/apis/graphql/types/objects/settlement-event-object/.md) object ● [`SftpConfigExport`](https://docs.monei.com/apis/graphql/types/objects/sftp-config-export/.md) object ● [`ShopifyShopSettings`](https://docs.monei.com/apis/graphql/types/objects/shopify-shop-settings/.md) object ● [`ShopifyStore`](https://docs.monei.com/apis/graphql/types/objects/shopify-store/.md) object ● [`skip`](https://docs.monei.com/apis/graphql/operations/directives/skip/.md) directive ● [`Store`](https://docs.monei.com/apis/graphql/types/objects/store/.md) object ● [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object ● [`SubscriptionEvent`](https://docs.monei.com/apis/graphql/types/objects/subscription-event/.md) object ● [`SubscriptionEventObject`](https://docs.monei.com/apis/graphql/types/objects/subscription-event-object/.md) object ● [`UpdateApplePayCertInput`](https://docs.monei.com/apis/graphql/types/inputs/update-apple-pay-cert-input/.md) input ● [`UpdateChargeInput`](https://docs.monei.com/apis/graphql/types/inputs/update-charge-input/.md) input ● [`UpdateCodeInput`](https://docs.monei.com/apis/graphql/types/inputs/update-code-input/.md) input ● [`UpdateExportSftpConfigInput`](https://docs.monei.com/apis/graphql/types/inputs/update-export-sftp-config-input/.md) input ● [`UpdatePointOfSaleInput`](https://docs.monei.com/apis/graphql/types/inputs/update-point-of-sale-input/.md) input ● [`UpdateProviderInput`](https://docs.monei.com/apis/graphql/types/inputs/update-provider-input/.md) input ● [`UpdateShopifyShopSettingsInput`](https://docs.monei.com/apis/graphql/types/inputs/update-shopify-shop-settings-input/.md) input ● [`UpdateShopifyShopSettingsResult`](https://docs.monei.com/apis/graphql/types/objects/update-shopify-shop-settings-result/.md) object ● [`UpdateStoreInput`](https://docs.monei.com/apis/graphql/types/inputs/update-store-input/.md) input ● [`UpdateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/update-subscription-input/.md) input ● [`UpdateWebhookInput`](https://docs.monei.com/apis/graphql/types/inputs/update-webhook-input/.md) input ● [`Webhook`](https://docs.monei.com/apis/graphql/types/objects/webhook/.md) object ● [`WebReport`](https://docs.monei.com/apis/graphql/types/objects/web-report/.md) object


---

# Float

The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).

```
scalar Float
```

### Member Of[​](#member-of "Direct link to Member Of")

[`AccountInvoiceLineItem`](https://docs.monei.com/apis/graphql/types/objects/account-invoice-line-item/.md) object ● [`AccountPayoutTerms`](https://docs.monei.com/apis/graphql/types/objects/account-payout-terms/.md) object ● [`CapitalLoan`](https://docs.monei.com/apis/graphql/types/objects/capital-loan/.md) object ● [`CapitalLoanDefaultDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-default-details/.md) object ● [`CapitalLoanDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-details/.md) object ● [`CapitalLoanFundingDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-funding-details/.md) object ● [`CapitalLoanFundingPayment`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-funding-payment/.md) object ● [`CapitalLoanRepayment`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-repayment/.md) object ● [`CapitalLoanWriteOffDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-write-off-details/.md) object ● [`CapitalOffer`](https://docs.monei.com/apis/graphql/types/objects/capital-offer/.md) object ● [`Representative`](https://docs.monei.com/apis/graphql/types/objects/representative/.md) object ● [`RepresentativeInput`](https://docs.monei.com/apis/graphql/types/inputs/representative-input/.md) input ● [`SearchableFloatFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-float-filter-input/.md) input


---

# ID

The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.

```
scalar ID
```

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object ● [`AccountBalances`](https://docs.monei.com/apis/graphql/types/objects/account-balances/.md) object ● [`AccountContract`](https://docs.monei.com/apis/graphql/types/objects/account-contract/.md) object ● [`accountInvoice`](https://docs.monei.com/apis/graphql/operations/queries/account-invoice/.md) query ● [`AccountInvoice`](https://docs.monei.com/apis/graphql/types/objects/account-invoice/.md) object ● [`AccountLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/account-level-update/.md) object ● [`accountSettlement`](https://docs.monei.com/apis/graphql/operations/queries/account-settlement/.md) query ● [`AccountSettlement`](https://docs.monei.com/apis/graphql/types/objects/account-settlement/.md) object ● [`AccountTokenizationMethodsClickToPayItem`](https://docs.monei.com/apis/graphql/types/objects/account-tokenization-methods-click-to-pay-item/.md) object ● [`ActivateApplePayCertInput`](https://docs.monei.com/apis/graphql/types/inputs/activate-apple-pay-cert-input/.md) input ● [`ActivateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/activate-subscription-input/.md) input ● [`applePayCert`](https://docs.monei.com/apis/graphql/operations/queries/apple-pay-cert/.md) query ● [`ApplePayCertificate`](https://docs.monei.com/apis/graphql/types/objects/apple-pay-certificate/.md) object ● [`AuthorizedUser`](https://docs.monei.com/apis/graphql/types/objects/authorized-user/.md) object ● [`Bank`](https://docs.monei.com/apis/graphql/types/objects/bank/.md) object ● [`BlacklistItem`](https://docs.monei.com/apis/graphql/types/objects/blacklist-item/.md) object ● [`CancelPaymentInput`](https://docs.monei.com/apis/graphql/types/inputs/cancel-payment-input/.md) input ● [`CancelSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/cancel-subscription-input/.md) input ● [`CapitalLoan`](https://docs.monei.com/apis/graphql/types/objects/capital-loan/.md) object ● [`CapitalLoanDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-details/.md) object ● [`CapitalLoanDocument`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-document/.md) object ● [`CapitalLoanDocumentReference`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-document-reference/.md) object ● [`CapitalLoanEarlyRenewalDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-early-renewal-details/.md) object ● [`CapitalLoanThirdPartyReference`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-third-party-reference/.md) object ● [`CapturePaymentInput`](https://docs.monei.com/apis/graphql/types/inputs/capture-payment-input/.md) input ● [`charge`](https://docs.monei.com/apis/graphql/operations/queries/charge/.md) query ● [`Charge`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) object ● [`ChargeEvent`](https://docs.monei.com/apis/graphql/types/objects/charge-event/.md) object ● [`ChargeEventObject`](https://docs.monei.com/apis/graphql/types/objects/charge-event-object/.md) object ● [`chargeEvents`](https://docs.monei.com/apis/graphql/operations/queries/charge-events/.md) query ● [`ChargeEventsChangeInput`](https://docs.monei.com/apis/graphql/types/inputs/charge-events-change-input/.md) input ● [`chargesDateRangeKPI`](https://docs.monei.com/apis/graphql/operations/queries/charges-date-range-kpi/.md) query ● [`chargesExport`](https://docs.monei.com/apis/graphql/operations/queries/charges-export/.md) query ● [`ChargesExport`](https://docs.monei.com/apis/graphql/types/objects/charges-export/.md) object ● [`code`](https://docs.monei.com/apis/graphql/operations/queries/code/.md) query ● [`Code`](https://docs.monei.com/apis/graphql/types/objects/code/.md) object ● [`codes`](https://docs.monei.com/apis/graphql/operations/queries/codes/.md) query ● [`CreateAuthorizedUserInput`](https://docs.monei.com/apis/graphql/types/inputs/create-authorized-user-input/.md) input ● [`createBankSession`](https://docs.monei.com/apis/graphql/operations/mutations/create-bank-session/.md) mutation ● [`CreatePaymentInput`](https://docs.monei.com/apis/graphql/types/inputs/create-payment-input/.md) input ● [`CreatePointOfSaleInput`](https://docs.monei.com/apis/graphql/types/inputs/create-point-of-sale-input/.md) input ● [`CreateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/create-subscription-input/.md) input ● [`deleteApplePayCert`](https://docs.monei.com/apis/graphql/operations/mutations/delete-apple-pay-cert/.md) mutation ● [`deleteCode`](https://docs.monei.com/apis/graphql/operations/mutations/delete-code/.md) mutation ● [`deleteDocument`](https://docs.monei.com/apis/graphql/operations/mutations/delete-document/.md) mutation ● [`deleteExportSftpConfig`](https://docs.monei.com/apis/graphql/operations/mutations/delete-export-sftp-config/.md) mutation ● [`deletePaymentRule`](https://docs.monei.com/apis/graphql/operations/mutations/delete-payment-rule/.md) mutation ● [`deletePointOfSale`](https://docs.monei.com/apis/graphql/operations/mutations/delete-point-of-sale/.md) mutation ● [`deleteProvider`](https://docs.monei.com/apis/graphql/operations/mutations/delete-provider/.md) mutation ● [`deleteStore`](https://docs.monei.com/apis/graphql/operations/mutations/delete-store/.md) mutation ● [`deleteWebhook`](https://docs.monei.com/apis/graphql/operations/mutations/delete-webhook/.md) mutation ● [`document`](https://docs.monei.com/apis/graphql/operations/queries/document/.md) query ● [`Document`](https://docs.monei.com/apis/graphql/types/objects/document/.md) object ● [`downloadAccountInvoice`](https://docs.monei.com/apis/graphql/operations/mutations/download-account-invoice/.md) mutation ● [`downloadDocument`](https://docs.monei.com/apis/graphql/operations/mutations/download-document/.md) mutation ● [`downloadExport`](https://docs.monei.com/apis/graphql/operations/mutations/download-export/.md) mutation ● [`downloadOperationsFile`](https://docs.monei.com/apis/graphql/operations/mutations/download-operations-file/.md) mutation ● [`enableProvider`](https://docs.monei.com/apis/graphql/operations/mutations/enable-provider/.md) mutation ● [`exportSftpConfig`](https://docs.monei.com/apis/graphql/operations/queries/export-sftp-config/.md) query ● [`getCapitalLoan`](https://docs.monei.com/apis/graphql/operations/queries/get-capital-loan/.md) query ● [`getCapitalLoanDocument`](https://docs.monei.com/apis/graphql/operations/queries/get-capital-loan-document/.md) query ● [`getCapitalLoanRepayments`](https://docs.monei.com/apis/graphql/operations/queries/get-capital-loan-repayments/.md) query ● [`ItemLevelUpdate`](https://docs.monei.com/apis/graphql/types/objects/item-level-update/.md) object ● [`LastPayment`](https://docs.monei.com/apis/graphql/types/objects/last-payment/.md) object ● [`onUpdateAccount`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-account/.md) subscription ● [`onUpdateAnalytics`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-analytics/.md) subscription ● [`onUpdateCharge`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-charge/.md) subscription ● [`onUpdateChargeEvents`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-charge-events/.md) subscription ● [`onUpdateChargeEventsV2`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-charge-events-v2/.md) subscription ● [`onUpdateCharges`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-charges/.md) subscription ● [`onUpdateChargeV2`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-charge-v2/.md) subscription ● [`onUpdateDocuments`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-documents/.md) subscription ● [`onUpdateEvents`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-events/.md) subscription ● [`onUpdateSubscription`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-subscription/.md) subscription ● [`onUpdateSubscriptionEvents`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-subscription-events/.md) subscription ● [`onUpdateSubscriptionEventsV2`](https://docs.monei.com/apis/graphql/operations/subscriptions/on-update-subscription-events-v2/.md) subscription ● [`PauseSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/pause-subscription-input/.md) input ● [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object ● [`PaymentAction`](https://docs.monei.com/apis/graphql/types/objects/payment-action/.md) object ● [`PaymentActionInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-action-input/.md) input ● [`PaymentCondition`](https://docs.monei.com/apis/graphql/types/objects/payment-condition/.md) object ● [`PaymentConditionInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-condition-input/.md) input ● [`paymentEmailPreview`](https://docs.monei.com/apis/graphql/operations/queries/payment-email-preview/.md) query ● [`PaymentMethodPaypal`](https://docs.monei.com/apis/graphql/types/objects/payment-method-paypal/.md) object ● [`PaymentMethodPaypalInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-paypal-input/.md) input ● [`PaymentMethodTrustly`](https://docs.monei.com/apis/graphql/types/objects/payment-method-trustly/.md) object ● [`PaymentMethodTrustlyInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-trustly-input/.md) input ● [`paymentRule`](https://docs.monei.com/apis/graphql/operations/queries/payment-rule/.md) query ● [`PaymentRule`](https://docs.monei.com/apis/graphql/types/objects/payment-rule/.md) object ● [`pointOfSale`](https://docs.monei.com/apis/graphql/operations/queries/point-of-sale/.md) query ● [`PointOfSale`](https://docs.monei.com/apis/graphql/types/objects/point-of-sale/.md) object ● [`pointsOfSale`](https://docs.monei.com/apis/graphql/operations/queries/points-of-sale/.md) query ● [`previewPaymentEmail`](https://docs.monei.com/apis/graphql/operations/queries/preview-payment-email/.md) query ● [`previewSubscriptionEmail`](https://docs.monei.com/apis/graphql/operations/queries/preview-subscription-email/.md) query ● [`provider`](https://docs.monei.com/apis/graphql/operations/queries/provider/.md) query ● [`Provider`](https://docs.monei.com/apis/graphql/types/objects/provider/.md) object ● [`publishUpdateAccount`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-account/.md) mutation ● [`publishUpdateAnalytics`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-analytics/.md) mutation ● [`publishUpdateCharge`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-charge/.md) mutation ● [`publishUpdateChargeEvents`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-charge-events/.md) mutation ● [`publishUpdateChargeEventsV2`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-charge-events-v2/.md) mutation ● [`publishUpdateCharges`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-charges/.md) mutation ● [`publishUpdateChargeV2`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-charge-v2/.md) mutation ● [`publishUpdateDocuments`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-documents/.md) mutation ● [`publishUpdateEvents`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-events/.md) mutation ● [`publishUpdateSubscription`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-subscription/.md) mutation ● [`publishUpdateSubscriptionEvents`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-subscription-events/.md) mutation ● [`publishUpdateSubscriptionEventsV2`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-subscription-events-v2/.md) mutation ● [`publishUpdateSubscriptions`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-subscriptions/.md) mutation ● [`publishUpdateWebReport`](https://docs.monei.com/apis/graphql/operations/mutations/publish-update-web-report/.md) mutation ● [`RefundPaymentInput`](https://docs.monei.com/apis/graphql/types/inputs/refund-payment-input/.md) input ● [`RegisterCodeInput`](https://docs.monei.com/apis/graphql/types/inputs/register-code-input/.md) input ● [`ResumeSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/resume-subscription-input/.md) input ● [`SearchableIDFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-idfilter-input/.md) input ● [`selectUserAccount`](https://docs.monei.com/apis/graphql/operations/mutations/select-user-account/.md) mutation ● [`SendPaymentMessageInput`](https://docs.monei.com/apis/graphql/types/inputs/send-payment-message-input/.md) input ● [`SendPaymentRequestInput`](https://docs.monei.com/apis/graphql/types/inputs/send-payment-request-input/.md) input ● [`SendSubscriptionMessageInput`](https://docs.monei.com/apis/graphql/types/inputs/send-subscription-message-input/.md) input ● [`setDefaultCardProvider`](https://docs.monei.com/apis/graphql/operations/mutations/set-default-card-provider/.md) mutation ● [`SettlementEvent`](https://docs.monei.com/apis/graphql/types/objects/settlement-event/.md) object ● [`SettlementEventObject`](https://docs.monei.com/apis/graphql/types/objects/settlement-event-object/.md) object ● [`settlementEvents`](https://docs.monei.com/apis/graphql/operations/queries/settlement-events/.md) query ● [`SftpConfigExport`](https://docs.monei.com/apis/graphql/types/objects/sftp-config-export/.md) object ● [`store`](https://docs.monei.com/apis/graphql/operations/queries/store/.md) query ● [`Store`](https://docs.monei.com/apis/graphql/types/objects/store/.md) object ● [`subscription`](https://docs.monei.com/apis/graphql/operations/queries/subscription/.md) query ● [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object ● [`subscriptionEmailPreview`](https://docs.monei.com/apis/graphql/operations/queries/subscription-email-preview/.md) query ● [`SubscriptionEvent`](https://docs.monei.com/apis/graphql/types/objects/subscription-event/.md) object ● [`SubscriptionEventObject`](https://docs.monei.com/apis/graphql/types/objects/subscription-event-object/.md) object ● [`subscriptionEvents`](https://docs.monei.com/apis/graphql/operations/queries/subscription-events/.md) query ● [`SubscriptionEventsChangeInput`](https://docs.monei.com/apis/graphql/types/inputs/subscription-events-change-input/.md) input ● [`TraceDetails`](https://docs.monei.com/apis/graphql/types/objects/trace-details/.md) object ● [`TraceDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/trace-details-input/.md) input ● [`UpdateApplePayCertInput`](https://docs.monei.com/apis/graphql/types/inputs/update-apple-pay-cert-input/.md) input ● [`UpdateAuthorizedUserInput`](https://docs.monei.com/apis/graphql/types/inputs/update-authorized-user-input/.md) input ● [`UpdateChargeInput`](https://docs.monei.com/apis/graphql/types/inputs/update-charge-input/.md) input ● [`UpdateCodeInput`](https://docs.monei.com/apis/graphql/types/inputs/update-code-input/.md) input ● [`UpdateExportSftpConfigInput`](https://docs.monei.com/apis/graphql/types/inputs/update-export-sftp-config-input/.md) input ● [`UpdatePaymentRuleInput`](https://docs.monei.com/apis/graphql/types/inputs/update-payment-rule-input/.md) input ● [`UpdatePointOfSaleInput`](https://docs.monei.com/apis/graphql/types/inputs/update-point-of-sale-input/.md) input ● [`UpdateProviderInput`](https://docs.monei.com/apis/graphql/types/inputs/update-provider-input/.md) input ● [`UpdateStoreInput`](https://docs.monei.com/apis/graphql/types/inputs/update-store-input/.md) input ● [`UpdateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/update-subscription-input/.md) input ● [`UpdateWebhookInput`](https://docs.monei.com/apis/graphql/types/inputs/update-webhook-input/.md) input ● [`uploadDocument`](https://docs.monei.com/apis/graphql/operations/mutations/upload-document/.md) mutation ● [`UserAccount`](https://docs.monei.com/apis/graphql/types/objects/user-account/.md) object ● [`UserEvent`](https://docs.monei.com/apis/graphql/types/objects/user-event/.md) object ● [`webhook`](https://docs.monei.com/apis/graphql/operations/queries/webhook/.md) query ● [`Webhook`](https://docs.monei.com/apis/graphql/types/objects/webhook/.md) object


---

# Int

The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

```
scalar Int
```

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object ● [`AccountBalances`](https://docs.monei.com/apis/graphql/types/objects/account-balances/.md) object ● [`AccountInvoice`](https://docs.monei.com/apis/graphql/types/objects/account-invoice/.md) object ● [`AccountInvoiceBusiness`](https://docs.monei.com/apis/graphql/types/objects/account-invoice-business/.md) object ● [`AccountInvoiceLineItem`](https://docs.monei.com/apis/graphql/types/objects/account-invoice-line-item/.md) object ● [`accountInvoices`](https://docs.monei.com/apis/graphql/operations/queries/account-invoices/.md) query ● [`AccountInvoicesConnection`](https://docs.monei.com/apis/graphql/types/objects/account-invoices-connection/.md) object ● [`AccountPayoutTerms`](https://docs.monei.com/apis/graphql/types/objects/account-payout-terms/.md) object ● [`AccountSettlement`](https://docs.monei.com/apis/graphql/types/objects/account-settlement/.md) object ● [`accountSettlements`](https://docs.monei.com/apis/graphql/operations/queries/account-settlements/.md) query ● [`AccountSettlementsConnection`](https://docs.monei.com/apis/graphql/types/objects/account-settlements-connection/.md) object ● [`ActivateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/activate-subscription-input/.md) input ● [`authorizedUsers`](https://docs.monei.com/apis/graphql/operations/queries/authorized-users/.md) query ● [`blacklistItems`](https://docs.monei.com/apis/graphql/operations/queries/blacklist-items/.md) query ● [`BusinessDataInput`](https://docs.monei.com/apis/graphql/types/inputs/business-data-input/.md) input ● [`CapitalLoan`](https://docs.monei.com/apis/graphql/types/objects/capital-loan/.md) object ● [`CapitalLoanDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-details/.md) object ● [`CapitalLoanEarlyRenewalDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-early-renewal-details/.md) object ● [`CapturePaymentInput`](https://docs.monei.com/apis/graphql/types/inputs/capture-payment-input/.md) input ● [`Charge`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) object ● [`ChargeEventObject`](https://docs.monei.com/apis/graphql/types/objects/charge-event-object/.md) object ● [`chargeEvents`](https://docs.monei.com/apis/graphql/operations/queries/charge-events/.md) query ● [`ChargeEventsConnection`](https://docs.monei.com/apis/graphql/types/objects/charge-events-connection/.md) object ● [`charges`](https://docs.monei.com/apis/graphql/operations/queries/charges/.md) query ● [`ChargesConnection`](https://docs.monei.com/apis/graphql/types/objects/charges-connection/.md) object ● [`chargesDateRangeKPI`](https://docs.monei.com/apis/graphql/operations/queries/charges-date-range-kpi/.md) query ● [`chargesExports`](https://docs.monei.com/apis/graphql/operations/queries/charges-exports/.md) query ● [`CreateExportSftpConfigInput`](https://docs.monei.com/apis/graphql/types/inputs/create-export-sftp-config-input/.md) input ● [`createIdSession`](https://docs.monei.com/apis/graphql/operations/mutations/create-id-session/.md) mutation ● [`CreatePaymentInput`](https://docs.monei.com/apis/graphql/types/inputs/create-payment-input/.md) input ● [`CreatePointOfSaleInput`](https://docs.monei.com/apis/graphql/types/inputs/create-point-of-sale-input/.md) input ● [`CreateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/create-subscription-input/.md) input ● [`documents`](https://docs.monei.com/apis/graphql/operations/queries/documents/.md) query ● [`events`](https://docs.monei.com/apis/graphql/operations/queries/events/.md) query ● [`PauseSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/pause-subscription-input/.md) input ● [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object ● [`PaymentAction`](https://docs.monei.com/apis/graphql/types/objects/payment-action/.md) object ● [`PaymentActionInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-action-input/.md) input ● [`paymentRules`](https://docs.monei.com/apis/graphql/operations/queries/payment-rules/.md) query ● [`Period`](https://docs.monei.com/apis/graphql/types/objects/period/.md) object ● [`PointOfSale`](https://docs.monei.com/apis/graphql/types/objects/point-of-sale/.md) object ● [`pointsOfSale`](https://docs.monei.com/apis/graphql/operations/queries/points-of-sale/.md) query ● [`ProviderRules`](https://docs.monei.com/apis/graphql/types/objects/provider-rules/.md) object ● [`ProviderRulesInput`](https://docs.monei.com/apis/graphql/types/inputs/provider-rules-input/.md) input ● [`RefundPaymentInput`](https://docs.monei.com/apis/graphql/types/inputs/refund-payment-input/.md) input ● [`Representative`](https://docs.monei.com/apis/graphql/types/objects/representative/.md) object ● [`RetrySchedule`](https://docs.monei.com/apis/graphql/types/objects/retry-schedule/.md) object ● [`RetryScheduleInput`](https://docs.monei.com/apis/graphql/types/inputs/retry-schedule-input/.md) input ● [`SearchableIntFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-int-filter-input/.md) input ● [`SettlementEventObject`](https://docs.monei.com/apis/graphql/types/objects/settlement-event-object/.md) object ● [`settlementEvents`](https://docs.monei.com/apis/graphql/operations/queries/settlement-events/.md) query ● [`SettlementEventsConnection`](https://docs.monei.com/apis/graphql/types/objects/settlement-events-connection/.md) object ● [`SftpConfigExport`](https://docs.monei.com/apis/graphql/types/objects/sftp-config-export/.md) object ● [`shopifyStores`](https://docs.monei.com/apis/graphql/operations/queries/shopify-stores/.md) query ● [`stores`](https://docs.monei.com/apis/graphql/operations/queries/stores/.md) query ● [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object ● [`SubscriptionEventObject`](https://docs.monei.com/apis/graphql/types/objects/subscription-event-object/.md) object ● [`subscriptionEvents`](https://docs.monei.com/apis/graphql/operations/queries/subscription-events/.md) query ● [`SubscriptionEventsConnection`](https://docs.monei.com/apis/graphql/types/objects/subscription-events-connection/.md) object ● [`subscriptions`](https://docs.monei.com/apis/graphql/operations/queries/subscriptions/.md) query ● [`SubscriptionsConnection`](https://docs.monei.com/apis/graphql/types/objects/subscriptions-connection/.md) object ● [`UpdateAccountInput`](https://docs.monei.com/apis/graphql/types/inputs/update-account-input/.md) input ● [`UpdateChargeInput`](https://docs.monei.com/apis/graphql/types/inputs/update-charge-input/.md) input ● [`UpdateExportSftpConfigInput`](https://docs.monei.com/apis/graphql/types/inputs/update-export-sftp-config-input/.md) input ● [`UpdatePointOfSaleInput`](https://docs.monei.com/apis/graphql/types/inputs/update-point-of-sale-input/.md) input ● [`UpdateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/update-subscription-input/.md) input ● [`userAccounts`](https://docs.monei.com/apis/graphql/operations/queries/user-accounts/.md) query ● [`webhooks`](https://docs.monei.com/apis/graphql/operations/queries/webhooks/.md) query


---

# Long

Long type

```
scalar Long
```

### Member Of[​](#member-of "Direct link to Member Of")

[`BusinessData`](https://docs.monei.com/apis/graphql/types/objects/business-data/.md) object ● [`ChargesDateRangeKPIRow`](https://docs.monei.com/apis/graphql/types/objects/charges-date-range-kpirow/.md) object ● [`ChargesDateRangeKPITotal`](https://docs.monei.com/apis/graphql/types/objects/charges-date-range-kpitotal/.md) object ● [`PaymentMethodCardPresent`](https://docs.monei.com/apis/graphql/types/objects/payment-method-card-present/.md) object ● [`PaymentMethodCardPresentInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-card-present-input/.md) input


---

# String

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

```
scalar String
```

### Returned By[​](#returned-by "Direct link to Returned By")

[`chargeSources`](https://docs.monei.com/apis/graphql/operations/queries/charge-sources/.md) query ● [`createApiKey`](https://docs.monei.com/apis/graphql/operations/mutations/create-api-key/.md) mutation ● [`paymentEmailPreview`](https://docs.monei.com/apis/graphql/operations/queries/payment-email-preview/.md) query ● [`posAuthToken`](https://docs.monei.com/apis/graphql/operations/queries/pos-auth-token/.md) query ● [`previewPaymentEmail`](https://docs.monei.com/apis/graphql/operations/queries/preview-payment-email/.md) query ● [`previewSubscriptionEmail`](https://docs.monei.com/apis/graphql/operations/queries/preview-subscription-email/.md) query ● [`subscriptionEmailPreview`](https://docs.monei.com/apis/graphql/operations/queries/subscription-email-preview/.md) query ● [`zendeskAuthToken`](https://docs.monei.com/apis/graphql/operations/queries/zendesk-auth-token/.md) query

### Member Of[​](#member-of "Direct link to Member Of")

[`Account`](https://docs.monei.com/apis/graphql/types/objects/account/.md) object ● [`AccountBalances`](https://docs.monei.com/apis/graphql/types/objects/account-balances/.md) object ● [`AccountBranding`](https://docs.monei.com/apis/graphql/types/objects/account-branding/.md) object ● [`AccountBrandingInput`](https://docs.monei.com/apis/graphql/types/inputs/account-branding-input/.md) input ● [`AccountContract`](https://docs.monei.com/apis/graphql/types/objects/account-contract/.md) object ● [`AccountInvoice`](https://docs.monei.com/apis/graphql/types/objects/account-invoice/.md) object ● [`AccountInvoiceBusiness`](https://docs.monei.com/apis/graphql/types/objects/account-invoice-business/.md) object ● [`AccountInvoiceLineItem`](https://docs.monei.com/apis/graphql/types/objects/account-invoice-line-item/.md) object ● [`AccountNotifications`](https://docs.monei.com/apis/graphql/types/objects/account-notifications/.md) object ● [`AccountNotificationsInput`](https://docs.monei.com/apis/graphql/types/inputs/account-notifications-input/.md) input ● [`AccountPayoutTerms`](https://docs.monei.com/apis/graphql/types/objects/account-payout-terms/.md) object ● [`AccountPublicBusinessDetails`](https://docs.monei.com/apis/graphql/types/objects/account-public-business-details/.md) object ● [`AccountPublicBusinessDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/account-public-business-details-input/.md) input ● [`AccountSettlement`](https://docs.monei.com/apis/graphql/types/objects/account-settlement/.md) object ● [`activateAccount`](https://docs.monei.com/apis/graphql/operations/mutations/activate-account/.md) mutation ● [`ActivateAccount`](https://docs.monei.com/apis/graphql/types/objects/activate-account/.md) object ● [`ActivateApplePayCertInput`](https://docs.monei.com/apis/graphql/types/inputs/activate-apple-pay-cert-input/.md) input ● [`ActivateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/activate-subscription-input/.md) input ● [`Address`](https://docs.monei.com/apis/graphql/types/objects/address/.md) object ● [`AddressInput`](https://docs.monei.com/apis/graphql/types/inputs/address-input/.md) input ● [`ApplePayCertificate`](https://docs.monei.com/apis/graphql/types/objects/apple-pay-certificate/.md) object ● [`AuthorizedUser`](https://docs.monei.com/apis/graphql/types/objects/authorized-user/.md) object ● [`authorizedUsers`](https://docs.monei.com/apis/graphql/operations/queries/authorized-users/.md) query ● [`AuthorizedUsersConnection`](https://docs.monei.com/apis/graphql/types/objects/authorized-users-connection/.md) object ● [`aws_auth`](https://docs.monei.com/apis/graphql/types/directives/aws-auth/.md) directive ● [`aws_cognito_user_pools`](https://docs.monei.com/apis/graphql/types/directives/aws-cognito-user-pools/.md) directive ● [`aws_publish`](https://docs.monei.com/apis/graphql/types/directives/aws-publish/.md) directive ● [`aws_subscribe`](https://docs.monei.com/apis/graphql/types/directives/aws-subscribe/.md) directive ● [`Bank`](https://docs.monei.com/apis/graphql/types/objects/bank/.md) object ● [`BankAccount`](https://docs.monei.com/apis/graphql/types/objects/bank-account/.md) object ● [`banks`](https://docs.monei.com/apis/graphql/operations/queries/banks/.md) query ● [`blacklistItem`](https://docs.monei.com/apis/graphql/operations/queries/blacklist-item/.md) query ● [`BlacklistItem`](https://docs.monei.com/apis/graphql/types/objects/blacklist-item/.md) object ● [`BlacklistItemInput`](https://docs.monei.com/apis/graphql/types/inputs/blacklist-item-input/.md) input ● [`blacklistItems`](https://docs.monei.com/apis/graphql/operations/queries/blacklist-items/.md) query ● [`BlacklistItemsConnection`](https://docs.monei.com/apis/graphql/types/objects/blacklist-items-connection/.md) object ● [`BusinessData`](https://docs.monei.com/apis/graphql/types/objects/business-data/.md) object ● [`BusinessDataInput`](https://docs.monei.com/apis/graphql/types/inputs/business-data-input/.md) input ● [`CallbackData`](https://docs.monei.com/apis/graphql/types/objects/callback-data/.md) object ● [`CapitalLoan`](https://docs.monei.com/apis/graphql/types/objects/capital-loan/.md) object ● [`CapitalLoanDefaultDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-default-details/.md) object ● [`CapitalLoanDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-details/.md) object ● [`CapitalLoanDocument`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-document/.md) object ● [`CapitalLoanDocumentItem`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-document-item/.md) object ● [`CapitalLoanDocumentReference`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-document-reference/.md) object ● [`CapitalLoanFundingDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-funding-details/.md) object ● [`CapitalLoanFundingPayment`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-funding-payment/.md) object ● [`CapitalLoanLead`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-lead/.md) object ● [`CapitalLoanRepayment`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-repayment/.md) object ● [`CapitalLoanThirdPartyReference`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-third-party-reference/.md) object ● [`CapitalLoanWriteOffDetails`](https://docs.monei.com/apis/graphql/types/objects/capital-loan-write-off-details/.md) object ● [`Charge`](https://docs.monei.com/apis/graphql/types/objects/charge/.md) object ● [`ChargeEvent`](https://docs.monei.com/apis/graphql/types/objects/charge-event/.md) object ● [`ChargeEventObject`](https://docs.monei.com/apis/graphql/types/objects/charge-event-object/.md) object ● [`chargesDateRangeKPI`](https://docs.monei.com/apis/graphql/operations/queries/charges-date-range-kpi/.md) query ● [`ChargesExport`](https://docs.monei.com/apis/graphql/types/objects/charges-export/.md) object ● [`chargesExports`](https://docs.monei.com/apis/graphql/operations/queries/charges-exports/.md) query ● [`ChargesExportsConnection`](https://docs.monei.com/apis/graphql/types/objects/charges-exports-connection/.md) object ● [`connectMasterAccount`](https://docs.monei.com/apis/graphql/operations/mutations/connect-master-account/.md) mutation ● [`ConnectShopifyShopInput`](https://docs.monei.com/apis/graphql/types/inputs/connect-shopify-shop-input/.md) input ● [`ConnectShopifyShopResult`](https://docs.monei.com/apis/graphql/types/objects/connect-shopify-shop-result/.md) object ● [`ContactDetails`](https://docs.monei.com/apis/graphql/types/objects/contact-details/.md) object ● [`ContactDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/contact-details-input/.md) input ● [`Countries`](https://docs.monei.com/apis/graphql/types/objects/countries/.md) object ● [`Country`](https://docs.monei.com/apis/graphql/types/objects/country/.md) object ● [`CountryStore`](https://docs.monei.com/apis/graphql/types/objects/country-store/.md) object ● [`CountryStoreInput`](https://docs.monei.com/apis/graphql/types/inputs/country-store-input/.md) input ● [`createAccount`](https://docs.monei.com/apis/graphql/operations/mutations/create-account/.md) mutation ● [`CreateAuthorizedUserInput`](https://docs.monei.com/apis/graphql/types/inputs/create-authorized-user-input/.md) input ● [`CreateDocumentInput`](https://docs.monei.com/apis/graphql/types/inputs/create-document-input/.md) input ● [`CreateExportSftpConfigInput`](https://docs.monei.com/apis/graphql/types/inputs/create-export-sftp-config-input/.md) input ● [`CreatePaymentInput`](https://docs.monei.com/apis/graphql/types/inputs/create-payment-input/.md) input ● [`CreatePointOfSaleInput`](https://docs.monei.com/apis/graphql/types/inputs/create-point-of-sale-input/.md) input ● [`CreateStoreInput`](https://docs.monei.com/apis/graphql/types/inputs/create-store-input/.md) input ● [`CreateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/create-subscription-input/.md) input ● [`CreateWebhookInput`](https://docs.monei.com/apis/graphql/types/inputs/create-webhook-input/.md) input ● [`CustomDomainConfig`](https://docs.monei.com/apis/graphql/types/objects/custom-domain-config/.md) object ● [`Customer`](https://docs.monei.com/apis/graphql/types/objects/customer/.md) object ● [`CustomerInput`](https://docs.monei.com/apis/graphql/types/inputs/customer-input/.md) input ● [`deleteAuthorizedUser`](https://docs.monei.com/apis/graphql/operations/mutations/delete-authorized-user/.md) mutation ● [`deleteBlacklistItem`](https://docs.monei.com/apis/graphql/operations/mutations/delete-blacklist-item/.md) mutation ● [`deprecated`](https://docs.monei.com/apis/graphql/types/directives/deprecated/.md) directive ● [`DnsRecord`](https://docs.monei.com/apis/graphql/types/objects/dns-record/.md) object ● [`Document`](https://docs.monei.com/apis/graphql/types/objects/document/.md) object ● [`documents`](https://docs.monei.com/apis/graphql/operations/queries/documents/.md) query ● [`DocumentsConnection`](https://docs.monei.com/apis/graphql/types/objects/documents-connection/.md) object ● [`DownloadFile`](https://docs.monei.com/apis/graphql/types/objects/download-file/.md) object ● [`enableCustomDomain`](https://docs.monei.com/apis/graphql/operations/mutations/enable-custom-domain/.md) mutation ● [`exportCharges`](https://docs.monei.com/apis/graphql/operations/mutations/export-charges/.md) mutation ● [`ExportCharges`](https://docs.monei.com/apis/graphql/types/objects/export-charges/.md) object ● [`GetShopifyShopSettingsInput`](https://docs.monei.com/apis/graphql/types/inputs/get-shopify-shop-settings-input/.md) input ● [`KeyValueInput`](https://docs.monei.com/apis/graphql/types/inputs/key-value-input/.md) input ● [`KeyValueItem`](https://docs.monei.com/apis/graphql/types/objects/key-value-item/.md) object ● [`LastPayment`](https://docs.monei.com/apis/graphql/types/objects/last-payment/.md) object ● [`MetadataConfigItem`](https://docs.monei.com/apis/graphql/types/objects/metadata-config-item/.md) object ● [`MetadataItem`](https://docs.monei.com/apis/graphql/types/objects/metadata-item/.md) object ● [`MetadataItemInput`](https://docs.monei.com/apis/graphql/types/inputs/metadata-item-input/.md) input ● [`NextAction`](https://docs.monei.com/apis/graphql/types/objects/next-action/.md) object ● [`Payment`](https://docs.monei.com/apis/graphql/types/objects/payment/.md) object ● [`PaymentAction`](https://docs.monei.com/apis/graphql/types/objects/payment-action/.md) object ● [`PaymentActionInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-action-input/.md) input ● [`PaymentCondition`](https://docs.monei.com/apis/graphql/types/objects/payment-condition/.md) object ● [`PaymentConditionInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-condition-input/.md) input ● [`paymentEmailPreview`](https://docs.monei.com/apis/graphql/operations/queries/payment-email-preview/.md) query ● [`PaymentMethodBizum`](https://docs.monei.com/apis/graphql/types/objects/payment-method-bizum/.md) object ● [`PaymentMethodBizumInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-bizum-input/.md) input ● [`PaymentMethodCard`](https://docs.monei.com/apis/graphql/types/objects/payment-method-card/.md) object ● [`PaymentMethodCardInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-card-input/.md) input ● [`PaymentMethodCardPresent`](https://docs.monei.com/apis/graphql/types/objects/payment-method-card-present/.md) object ● [`PaymentMethodCardPresentInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-card-present-input/.md) input ● [`PaymentMethodKlarnaInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-klarna-input/.md) input ● [`PaymentMethodMBWay`](https://docs.monei.com/apis/graphql/types/objects/payment-method-mbway/.md) object ● [`PaymentMethodMBWayInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-mbway-input/.md) input ● [`PaymentMethodPaypal`](https://docs.monei.com/apis/graphql/types/objects/payment-method-paypal/.md) object ● [`PaymentMethodPaypalInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-paypal-input/.md) input ● [`PaymentMethodSepa`](https://docs.monei.com/apis/graphql/types/objects/payment-method-sepa/.md) object ● [`PaymentMethodSepaInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-sepa-input/.md) input ● [`paymentRules`](https://docs.monei.com/apis/graphql/operations/queries/payment-rules/.md) query ● [`PaymentRulesConnection`](https://docs.monei.com/apis/graphql/types/objects/payment-rules-connection/.md) object ● [`PayPalLink`](https://docs.monei.com/apis/graphql/types/objects/pay-pal-link/.md) object ● [`PointOfSale`](https://docs.monei.com/apis/graphql/types/objects/point-of-sale/.md) object ● [`pointsOfSale`](https://docs.monei.com/apis/graphql/operations/queries/points-of-sale/.md) query ● [`PointsOfSaleConnection`](https://docs.monei.com/apis/graphql/types/objects/points-of-sale-connection/.md) object ● [`previewPaymentEmail`](https://docs.monei.com/apis/graphql/operations/queries/preview-payment-email/.md) query ● [`previewSubscriptionEmail`](https://docs.monei.com/apis/graphql/operations/queries/preview-subscription-email/.md) query ● [`ProviderRules`](https://docs.monei.com/apis/graphql/types/objects/provider-rules/.md) object ● [`ProviderRulesInput`](https://docs.monei.com/apis/graphql/types/inputs/provider-rules-input/.md) input ● [`Redirect`](https://docs.monei.com/apis/graphql/types/objects/redirect/.md) object ● [`RegisterApplePayDomainInput`](https://docs.monei.com/apis/graphql/types/inputs/register-apple-pay-domain-input/.md) input ● [`Representative`](https://docs.monei.com/apis/graphql/types/objects/representative/.md) object ● [`RepresentativeInput`](https://docs.monei.com/apis/graphql/types/inputs/representative-input/.md) input ● [`requestAccountReview`](https://docs.monei.com/apis/graphql/operations/mutations/request-account-review/.md) mutation ● [`SearchableStringFilterInput`](https://docs.monei.com/apis/graphql/types/inputs/searchable-string-filter-input/.md) input ● [`SendPaymentMessageInput`](https://docs.monei.com/apis/graphql/types/inputs/send-payment-message-input/.md) input ● [`SendPaymentRequestInput`](https://docs.monei.com/apis/graphql/types/inputs/send-payment-request-input/.md) input ● [`SendSubscriptionMessageInput`](https://docs.monei.com/apis/graphql/types/inputs/send-subscription-message-input/.md) input ● [`Session`](https://docs.monei.com/apis/graphql/types/objects/session/.md) object ● [`SessionDetails`](https://docs.monei.com/apis/graphql/types/objects/session-details/.md) object ● [`SessionDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/session-details-input/.md) input ● [`SettlementEvent`](https://docs.monei.com/apis/graphql/types/objects/settlement-event/.md) object ● [`SettlementEventObject`](https://docs.monei.com/apis/graphql/types/objects/settlement-event-object/.md) object ● [`SetupAccountInput`](https://docs.monei.com/apis/graphql/types/inputs/setup-account-input/.md) input ● [`SftpConfigExport`](https://docs.monei.com/apis/graphql/types/objects/sftp-config-export/.md) object ● [`Shop`](https://docs.monei.com/apis/graphql/types/objects/shop/.md) object ● [`ShopifyShopSettings`](https://docs.monei.com/apis/graphql/types/objects/shopify-shop-settings/.md) object ● [`ShopifyStore`](https://docs.monei.com/apis/graphql/types/objects/shopify-store/.md) object ● [`shopifyStores`](https://docs.monei.com/apis/graphql/operations/queries/shopify-stores/.md) query ● [`ShopifyStoresConnection`](https://docs.monei.com/apis/graphql/types/objects/shopify-stores-connection/.md) object ● [`ShopInput`](https://docs.monei.com/apis/graphql/types/inputs/shop-input/.md) input ● [`specifiedBy`](https://docs.monei.com/apis/graphql/types/directives/specified-by/.md) directive ● [`startCompanyLookup`](https://docs.monei.com/apis/graphql/operations/mutations/start-company-lookup/.md) mutation ● [`startExportCharges`](https://docs.monei.com/apis/graphql/operations/mutations/start-export-charges/.md) mutation ● [`Store`](https://docs.monei.com/apis/graphql/types/objects/store/.md) object ● [`stores`](https://docs.monei.com/apis/graphql/operations/queries/stores/.md) query ● [`StoresConnection`](https://docs.monei.com/apis/graphql/types/objects/stores-connection/.md) object ● [`Subscription`](https://docs.monei.com/apis/graphql/types/objects/subscription/.md) object ● [`subscriptionEmailPreview`](https://docs.monei.com/apis/graphql/operations/queries/subscription-email-preview/.md) query ● [`SubscriptionEvent`](https://docs.monei.com/apis/graphql/types/objects/subscription-event/.md) object ● [`SubscriptionEventObject`](https://docs.monei.com/apis/graphql/types/objects/subscription-event-object/.md) object ● [`TraceDetails`](https://docs.monei.com/apis/graphql/types/objects/trace-details/.md) object ● [`TraceDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/trace-details-input/.md) input ● [`UpdateAccountInput`](https://docs.monei.com/apis/graphql/types/inputs/update-account-input/.md) input ● [`UpdateAuthorizedUserInput`](https://docs.monei.com/apis/graphql/types/inputs/update-authorized-user-input/.md) input ● [`UpdateChargeInput`](https://docs.monei.com/apis/graphql/types/inputs/update-charge-input/.md) input ● [`UpdateExportSftpConfigInput`](https://docs.monei.com/apis/graphql/types/inputs/update-export-sftp-config-input/.md) input ● [`UpdatePointOfSaleInput`](https://docs.monei.com/apis/graphql/types/inputs/update-point-of-sale-input/.md) input ● [`UpdateShopifyShopSettingsInput`](https://docs.monei.com/apis/graphql/types/inputs/update-shopify-shop-settings-input/.md) input ● [`UpdateStoreInput`](https://docs.monei.com/apis/graphql/types/inputs/update-store-input/.md) input ● [`UpdateSubscriptionInput`](https://docs.monei.com/apis/graphql/types/inputs/update-subscription-input/.md) input ● [`UpdateWebhookInput`](https://docs.monei.com/apis/graphql/types/inputs/update-webhook-input/.md) input ● [`uploadDocument`](https://docs.monei.com/apis/graphql/operations/mutations/upload-document/.md) mutation ● [`UploadFile`](https://docs.monei.com/apis/graphql/types/objects/upload-file/.md) object ● [`UserAccount`](https://docs.monei.com/apis/graphql/types/objects/user-account/.md) object ● [`userAccounts`](https://docs.monei.com/apis/graphql/operations/queries/user-accounts/.md) query ● [`UserAccountsConnection`](https://docs.monei.com/apis/graphql/types/objects/user-accounts-connection/.md) object ● [`UserEvent`](https://docs.monei.com/apis/graphql/types/objects/user-event/.md) object ● [`UserEventsConnection`](https://docs.monei.com/apis/graphql/types/objects/user-events-connection/.md) object ● [`UserEventsInput`](https://docs.monei.com/apis/graphql/types/inputs/user-events-input/.md) input ● [`validateWebsite`](https://docs.monei.com/apis/graphql/operations/mutations/validate-website/.md) mutation ● [`Webhook`](https://docs.monei.com/apis/graphql/types/objects/webhook/.md) object ● [`webhooks`](https://docs.monei.com/apis/graphql/operations/queries/webhooks/.md) query ● [`WebhooksConnection`](https://docs.monei.com/apis/graphql/types/objects/webhooks-connection/.md) object ● [`WebReport`](https://docs.monei.com/apis/graphql/types/objects/web-report/.md) object


---

## [📄️<!-- --> <!-- -->Introduction](https://docs.monei.com/apis/rest/monei-api-v-1/.md)

[The MONEI API is organized around REST principles. Our API is designed to be intuitive and developer-friendly.](https://docs.monei.com/apis/rest/monei-api-v-1/.md)


---

# Apple Pay Certificate

Manage Apple Pay certificates for iOS app integration.

To accept Apple Pay in your iOS app, you need an Apple Pay Payment Processing Certificate. This API provides a complete certificate management workflow:

1. **Create** - Generate a Certificate Signing Request (CSR)
2. **Upload to Apple** - Use the CSR to create a certificate in Apple Developer Portal
3. **Activate** - Upload the signed certificate from Apple to enable payment processing
4. **Manage** - Enable, disable, or delete certificates as needed

The private key is securely generated and stored by MONEI. You never need to handle private keys directly.

<!-- -->

## [📄️<!-- --> <!-- -->Create Certificate](https://docs.monei.com/apis/rest/apple-pay-certificates-create/.md)

[Creates a new Apple Pay certificate by generating a Certificate Signing Request (CSR).](https://docs.monei.com/apis/rest/apple-pay-certificates-create/.md)

## [📄️<!-- --> <!-- -->List Certificates](https://docs.monei.com/apis/rest/apple-pay-certificates-get-all/.md)

[Retrieves all Apple Pay certificates for your account.](https://docs.monei.com/apis/rest/apple-pay-certificates-get-all/.md)

## [📄️<!-- --> <!-- -->Get Certificate](https://docs.monei.com/apis/rest/apple-pay-certificates-get/.md)

[Retrieves a specific Apple Pay certificate by its ID.](https://docs.monei.com/apis/rest/apple-pay-certificates-get/.md)

## [📄️<!-- --> <!-- -->Update Certificate](https://docs.monei.com/apis/rest/apple-pay-certificates-update/.md)

[Updates an Apple Pay certificate's active status.](https://docs.monei.com/apis/rest/apple-pay-certificates-update/.md)

## [📄️<!-- --> <!-- -->Delete Certificate](https://docs.monei.com/apis/rest/apple-pay-certificates-remove/.md)

[Deletes an Apple Pay certificate.](https://docs.monei.com/apis/rest/apple-pay-certificates-remove/.md)

## [📄️<!-- --> <!-- -->Activate Certificate](https://docs.monei.com/apis/rest/apple-pay-certificates-activate/.md)

[Activates an Apple Pay certificate by uploading the signed certificate from Apple.](https://docs.monei.com/apis/rest/apple-pay-certificates-activate/.md)


---

# Activate Certificate

```
POST 
/apple-pay/certificates/:id/activate
```

Activates an Apple Pay certificate by uploading the signed certificate from Apple.

After creating a certificate in the Apple Developer Portal using your CSR, download the signed certificate and upload it here to activate payment processing.

## Activation process[​](#activation-process "Direct link to Activation process")

1. Ensure you have downloaded the signed certificate (`.cer` file) from Apple Developer Portal.

2. Convert the certificate to base64:

   ```
   base64 -i apple_pay.cer
   ```

3. Call this endpoint with the base64-encoded certificate in the `cert` field.

## Validation[​](#validation "Direct link to Validation")

The certificate is validated to ensure:

* It matches the private key generated when creating the CSR
* It has a valid expiration date

Once activated, the certificate becomes available for decrypting Apple Pay payment tokens in your iOS app.

## Notes[​](#notes "Direct link to Notes")

* A certificate can only be activated once.
* The CSR is cleared after successful activation.
* The expiration date is extracted and stored for monitoring.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A certificate object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Create Certificate

```
POST 
/apple-pay/certificates
```

Creates a new Apple Pay certificate by generating a Certificate Signing Request (CSR).

Use this endpoint to start the certificate creation process for accepting Apple Pay in your iOS app.

## Setup workflow[​](#setup-workflow "Direct link to Setup workflow")

1. **Call this endpoint** to generate a CSR. The response includes the `csr` field in base64 format.

2. **Decode the CSR** and save it as a `.certSigningRequest` file:

   ```
   echo "CSR_VALUE" | base64 -d > apple_pay.certSigningRequest
   ```

3. **Go to [Apple Developer Portal](https://developer.apple.com/account/resources/certificates/list)**:

   * Navigate to Certificates, Identifiers & Profiles
   * Select your Merchant ID under Identifiers
   * In the "Apple Pay Payment Processing Certificate" section, click "Create Certificate"
   * Upload the `.certSigningRequest` file from step 2
   * Download the signed certificate (`.cer` file)

4. **Convert the certificate to base64**:

   ```
   base64 -i apple_pay.cer
   ```

5. **Activate the certificate** using the [Activate Certificate](https://docs.monei.com/apis/rest/apple-pay-certificates-activate/) endpoint with the base64 value.

## Important notes[​](#important-notes "Direct link to Important notes")

* **CSRs expire after 24 hours.** Complete the certificate creation in Apple Developer Portal within this window, or generate a new CSR.
* Each CSR can only be used once. If you need a new certificate, create a new CSR.
* The private key is securely generated and stored by MONEI. You never need to handle private keys directly.
* You must be enrolled in the [Apple Developer Program](https://developer.apple.com/programs/) to create certificates.
* The CSR is cleared from the response after the certificate is activated.

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 500
* 503

A certificate object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

Unexpected server error

The service is temporarily unavailable


---

# List Certificates

```
GET 
/apple-pay/certificates
```

Retrieves all Apple Pay certificates for your account.

Returns an array of certificate objects, including both active and inactive certificates. Use this to view all certificates and their status.

## Responses[​](#responses "Direct link to Responses")

* 200
* 401
* 500
* 503

A list of certificates

Unauthorized error. Please check your auth credentials

Unexpected server error

The service is temporarily unavailable


---

# Get Certificate

```
GET 
/apple-pay/certificates/:id
```

Retrieves a specific Apple Pay certificate by its ID.

Returns the certificate object with its current status, CSR (if not yet activated), and expiration date (if activated).

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 401
* 404
* 500
* 503

A certificate object

Unauthorized error. Please check your auth credentials

The specified resource was not found

Unexpected server error

The service is temporarily unavailable


---

# Delete Certificate

```
DELETE 
/apple-pay/certificates/:id
```

Deletes an Apple Pay certificate.

This permanently removes the certificate and its associated private key. The certificate will no longer be available for payment processing.

**Warning**: This action cannot be undone. If you only want to temporarily disable a certificate, use the [Update Certificate](https://docs.monei.com/apis/rest/apple-pay-certificates-update/) endpoint instead.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 401
* 404
* 500
* 503

A successful deletion response

Unauthorized error. Please check your auth credentials

The specified resource was not found

Unexpected server error

The service is temporarily unavailable


---

# Update Certificate

```
POST 
/apple-pay/certificates/:id
```

Updates an Apple Pay certificate's active status.

Use this endpoint to enable or disable a certificate. Disabling a certificate prevents it from being used for payment token decryption while keeping it available for future use.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A certificate object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Register Domain

```
POST 
/apple-pay/domains
```

Registers a domain with Apple Pay.

This endpoint allows you to register your website domain with Apple Pay, which is required before you can accept Apple Pay payments on your website. The domain must be accessible via HTTPS and have a valid SSL certificate.

Before registering, you must download this [domain association file](https://assets.monei.com/apple-pay/apple-developer-merchantid-domain-association/) and host it at `/.well-known/apple-developer-merchantid-domain-association` on your site.

For example, if you're registering `example.com`, make that file available at `https://example.com/.well-known/apple-developer-merchantid-domain-association`.

After registration, Apple will verify your domain. Once verified, you can display Apple Pay buttons and process Apple Pay payments on your website.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A successful response

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Apple Pay Domain

The Apple Pay Domain API allows you to register and manage domains for Apple Pay integration.

With the Apple Pay Domain API, you can:

* Register domains to use with Apple Pay
* View currently registered domains
* Ensure your website is properly configured for Apple Pay payments

Apple requires domain verification before you can accept Apple Pay payments on your website. This API simplifies the process of registering your domains with Apple Pay and maintaining your domain verification status.

## Domain registration process[​](#domain-registration-process "Direct link to Domain registration process")

To accept Apple Pay on your website, you must register your domain with Apple. This process:

1. Verifies that you control the domain
2. Allows Apple Pay buttons to be displayed on your website
3. Enables secure payment processing through Apple Pay

Once registered, your domain will be authorized to display Apple Pay payment options to customers.

<!-- -->

## [📄️<!-- --> <!-- -->Register Domain](https://docs.monei.com/apis/rest/apple-pay-domain-register/.md)

[Registers a domain with Apple Pay.](https://docs.monei.com/apis/rest/apple-pay-domain-register/.md)


---

# Validate Phone

```
POST 
/bizum/validate-phone
```

Validates if a phone number is registered with Bizum.

Use this endpoint to check if a customer's phone number can be used for Bizum payments before attempting to process a payment. This helps provide a better user experience by preventing failed payment attempts for non-registered numbers.

The response will indicate whether the phone number is valid for Bizum payments.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A successful response

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Bizum

The Bizum API allows you to integrate with Spain's popular mobile payment system.

With the Bizum API, you can:

* Validate customer phone numbers for Bizum compatibility
* Process payments using Bizum as a payment method
* Offer a seamless mobile payment experience for Spanish customers

Bizum is a widely used payment method in Spain that allows customers to make payments using their mobile phone number linked to their bank account. This API provides the necessary tools to incorporate Bizum into your payment options.

## Bizum validation[​](#bizum-validation "Direct link to Bizum validation")

Before processing a Bizum payment, you can validate if a customer's phone number is registered with Bizum using the validate-phone endpoint.

<!-- -->

## [📄️<!-- --> <!-- -->Validate Phone](https://docs.monei.com/apis/rest/bizum-validate-phone/.md)

[Validates if a phone number is registered with Bizum.](https://docs.monei.com/apis/rest/bizum-validate-phone/.md)


---

Version: 1.8.3

Export

* [OpenAPI Spec](https://js.monei.com/api/v1/openapi.json)

# MONEI API v1

The MONEI API is organized around REST principles. Our API is designed to be intuitive and developer-friendly.

### Base URL[​](#base-url "Direct link to Base URL")

All API requests should be made to:

```
https://api.monei.com/v1
```

### Environment[​](#environment "Direct link to Environment")

MONEI provides two environments:

* **Test Environment**: For development and testing without processing real payments
* **Live Environment**: For processing real transactions in production

### Client Libraries[​](#client-libraries "Direct link to Client Libraries")

We provide official SDKs to simplify integration:

* [PHP SDK](https://github.com/MONEI/monei-php-sdk)
* [Python SDK](https://github.com/MONEI/monei-python-sdk)
* [Node.js SDK](https://github.com/MONEI/monei-node-sdk)
* [Postman Collection](https://postman.monei.com/)

Our SDKs handle authentication, error handling, and request formatting automatically.

You can download the OpenAPI specification from the <https://js.monei.com/api/v1/openapi.json> and generate your own client library using the [OpenAPI Generator](https://openapi-generator.tech/).

### Important Requirements[​](#important-requirements "Direct link to Important Requirements")

* All API requests must be made over HTTPS
* If you are not using our official SDKs, you **must provide a valid `User-Agent` header** with each request
* Requests without proper authentication will return a `401 Unauthorized` error

### Error Handling[​](#error-handling "Direct link to Error Handling")

The API returns consistent error codes and messages to help you troubleshoot issues. Each response includes a `statusCode` attribute indicating the outcome of your request.

### Rate Limits[​](#rate-limits "Direct link to Rate Limits")

The API implements rate limiting to ensure stability. If you exceed the limits, requests will return a `429 Too Many Requests` status code.

## Authentication[​](#authentication "Direct link to Authentication")

* API Key: APIKey
* API Key: AccountId

The MONEI API uses API keys to authenticate requests. Each request must include your API key in the `Authorization` header. You can view and manage your API keys in the [MONEI Dashboard](https://dashboard.monei.com/settings/api). MONEI provides two types of API keys: test mode keys (prefixed with `pk_test_`) and live mode keys (prefixed with `pk_live_`).

| Security Scheme Type:  | apiKey        |
| ---------------------- | ------------- |
| Header parameter name: | Authorization |

If you're integrating with MONEI as a partner or platform, you'll need to use both your Master Account API Key and the Account ID of the merchant you're acting on behalf of. You can find the Account ID for each connected merchant in your [MONEI Partner Dashboard](https://admin.monei.com).

| Security Scheme Type:  | apiKey           |
| ---------------------- | ---------------- |
| Header parameter name: | MONEI-Account-ID |


---

# Get Payment Methods

```
GET 
/payment-methods
```

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. This is useful when you want to show payment options that are specifically available for a particular transaction.

When providing an `accountId`, the response will include all payment methods available for that account based on the merchant's configuration and supported payment methods.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

Available payment methods

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Payment Methods

The Payment Methods API allows you to retrieve available payment methods for an account or a specific payment. This information can be used to display appropriate payment options to your customers.

Payment methods vary by country, currency, and merchant configuration. This API helps you dynamically determine which payment methods are available for a specific transaction or account.

You can use this API to:

* Get all payment methods available for an account
* Get payment methods available for a specific payment
* Display payment options to your customers based on their location and purchase details

## Payment Methods object[​](#payment-methods-object "Direct link to Payment Methods object")

See [PaymentMethods](https://docs.monei.com/docs/apis/rest/schemas/paymentmethods/) for more information.

<!-- -->

## [📄️<!-- --> <!-- -->Get Payment Methods](https://docs.monei.com/apis/rest/payment-methods-get/.md)

[Retrieve available payment methods for an account or a specific payment.](https://docs.monei.com/apis/rest/payment-methods-get/.md)


---

# Cancel Payment

```
POST 
/payments/:id/cancel
```

Releases reserved funds from a previously authorized payment. This endpoint can only be used with payments in `AUTHORIZED` status.

This operation is part of the two-step authorization flow:

1. **Authorize**: Create a payment with `transactionType: AUTH` to reserve funds
2. **Cancel**: Release the reserved funds if you decide not to capture the payment

Cancellation makes the reserved funds available to the customer again and prevents you from being able to capture those funds in the future. Once cancelled, an authorization cannot be reactivated.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A payment object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Capture Payment

```
POST 
/payments/:id/capture
```

Captures funds from a previously authorized payment. This endpoint can only be used with payments in `AUTHORIZED` status.

This operation completes the two-step authorization flow:

1. **Authorize**: Create a payment with `transactionType: AUTH` to reserve funds
2. **Capture**: Transfer the reserved funds to your account when ready to fulfill the order

**Important**: Authorized payments expire after exactly seven days. After expiration, they will be marked as `EXPIRED` and can no longer be captured. Be sure to capture funds within this timeframe or communicate with your customer about a new payment.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A payment object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Confirm Payment

```
POST 
/payments/:id/confirm
```

Confirms a payment that was created without payment details. This endpoint can only be used with payments in `PENDING` status.

The two-step payment flow:

1. **Create**: First, create a payment without payment details (status: `PENDING`)
2. **Confirm**: Then provide payment details to complete the transaction

When confirming a payment, you can use:

* A newly generated `paymentToken` from [monei.js Components](https://docs.monei.com/monei-js/overview/)
* A permanent `paymentToken` from a previous payment (generated with `generatePaymentToken: true`)

Using permanent payment tokens enables one-click checkout experiences for returning customers without requiring them to re-enter their payment information.

You can provide additional customer information during confirmation, which will override any corresponding information originally passed in the payment creation request.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A payment object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Create Payment

```
POST 
/payments
```

Creates a new payment with the specified parameters.

You can create a payment in two ways:

1. **Immediate processing**: Provide a `paymentToken` or `paymentMethod` - The payment will be processed instantly
2. **Deferred processing**: Create without payment details - The payment remains in `PENDING` status until you confirm it later using the [confirm endpoint](https://docs.monei.com/apis/rest/payments-confirm/)

When creating a payment without payment details, you can redirect customers to the hosted payment page where they can select their preferred payment method and complete the transaction.

For immediate processing, use one of these token options:

* A temporary `paymentToken` generated on the frontend using [monei.js Components](https://docs.monei.com/monei-js/overview/)
* A permanent `paymentToken` from a previous successful payment (when `generatePaymentToken: true` was included)

Permanent tokens enable one-click checkout experiences for returning customers by allowing you to securely store and reuse payment details without requiring customers to re-enter their information.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A payment object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Get Payment

```
GET 
/payments/:id
```

Retrieves the complete details of an existing payment by its unique ID.

This endpoint returns all available information about the payment, including its current status, amount, customer details, timestamps, and transaction history. Use this to check the status of a payment, verify payment details, or retrieve information for your records.

Supply the unique payment ID that was returned from your previous request.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A payment object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Recurring Payment

```
POST 
/payments/:sequenceId/recurring
```

Creates a subsequent charge using the payment details from a previous transaction.

This endpoint enables recurring billing and subscription payments by:

* Using the same payment method as the original payment
* Charging the customer without requiring them to re-enter payment details
* Supporting variable or fixed amounts (defaults to the original payment amount if not specified)

**Prerequisites:**

1. The initial payment must be created with the `sequence` parameter
2. The initial payment will return a `sequenceId` in the response
3. This `sequenceId` must be provided in the URL path when making subsequent recurring charges

Ideal for subscription services, membership renewals, and installment payments.

**Need more advanced subscription management?** For comprehensive subscription management with features like billing cycles, trial periods, and automatic recurring billing, consider using the [Subscriptions API](https://docs.monei.com/apis/rest/subscriptions/) instead. It provides a complete solution for creating and managing subscription-based services.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A payment object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Refund Payment

```
POST 
/payments/:id/refund
```

Returns funds from a completed payment back to the customer's original payment method.

**Refund options:**

* **Full refund**: Return the entire payment amount
* **Partial refund**: Specify an amount less than the original payment
* **Multiple partial refunds**: Issue several partial refunds until the total payment amount is reached

**Limitations:**

* You can only refund payments that have been successfully processed
* A payment can only be refunded up to its original amount
* Once fully refunded, a payment cannot be refunded again
* Attempting to refund more than the remaining available amount will result in an error

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A payment object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Send Payment Link

```
POST 
/payments/:id/link
```

Sends a payment link to the customer through their preferred communication channel.

**This API can only be used for payments with the following status:**

* Pending

**Delivery channels are automatically selected based on available customer information:**

* If customer email is available: Link is sent via email
* If customer phone is available: Link is sent via WhatsApp
* If WhatsApp delivery fails: Link is sent via SMS as a fallback

The payment link allows customers to complete the payment at their convenience using their preferred payment method on the secure MONEI payment page. If no customer contact information is provided, the system will use the details stored in the payment record.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A payment object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Send Payment Receipt

```
POST 
/payments/:id/receipt
```

Sends a payment receipt to the customer through their preferred communication channel.

**This API can only be used for payments with the following status:**

* Succeeded

**Delivery channels are automatically selected based on available customer information:**

* If customer email is available: Receipt is sent via email
* If customer phone is available: Receipt is sent via WhatsApp
* If WhatsApp delivery fails: Receipt is sent via SMS as a fallback

The receipt includes payment details such as amount, date, transaction ID, and merchant information, providing customers with a record of their successful transaction. If no customer contact information is provided, the system will use the details stored in the payment record.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A payment object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Send Payment Request

```
POST 
/payments/:id/rtp
```

Sends a direct payment request to the customer's phone with smart channel selection.

**Smart delivery logic based on customer phone capabilities:**

* If the phone number is registered with Bizum and that payment method is available: The customer receives a push notification in their banking app to instantly approve the payment
* If Bizum is not available or the phone is not registered with Bizum: The customer receives a payment link via WhatsApp to complete the payment

This endpoint provides a streamlined payment experience, especially for Spanish customers with Bizum integration, enabling quick and convenient mobile payments.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A payment object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Payments

The Payments API provides a comprehensive platform for processing transactions and managing the complete payment lifecycle.

### Core Payment Operations[​](#core-payment-operations "Direct link to Core Payment Operations")

* Create and process payments with multiple payment methods
* Authorize payments and capture funds later
* Cancel authorized payments to release reserved funds
* Refund payments partially or in full
* Generate detailed receipts for completed payments

### Customer Experience Features[​](#customer-experience-features "Direct link to Customer Experience Features")

* Send payment requests via WhatsApp, SMS, or Bizum
* Create and distribute payment links through various channels
* Generate permanent payment tokens for one-click checkout experiences
* Support recurring billing and subscription payments

### Implementation Best Practices[​](#implementation-best-practices "Direct link to Implementation Best Practices")

* Create one payment per order or customer session for clear transaction records
* Use the unique payment ID for all subsequent operations on a payment
* Generate permanent payment tokens (with `generatePaymentToken: true`) for returning customers
* Implement webhook notifications to receive real-time payment status updates

## Payment Status Codes[​](#payment-status-codes "Direct link to Payment Status Codes")

The MONEI API returns a `statusCode` attribute in the Payment response to indicate the outcome of your request. This helps you understand whether an operation was successful or why it failed.

### Success Codes[​](#success-codes "Direct link to Success Codes")

Successful transactions return the following codes:

| Code | Message                            |
| ---- | ---------------------------------- |
| E000 | Transaction approved               |
| E001 | Transaction pending processing     |
| E002 | Transaction pending authentication |
| E003 | Transaction pending authorization  |

### Error Codes[​](#error-codes "Direct link to Error Codes")

Error codes are grouped by category to help you quickly identify the type of issue:

#### Configuration Errors (E1xx)[​](#configuration-errors-e1xx "Direct link to Configuration Errors (E1xx)")

These errors relate to account configuration issues:

| Code | Message                                                                                                      |
| ---- | ------------------------------------------------------------------------------------------------------------ |
| E101 | Error with payment processor configuration. Check this in your dashboard or contact MONEI for support        |
| E102 | Invalid or inactive MID. Please contact the acquiring entity                                                 |
| E103 | Operation not allowed/configured for this merchant. Please contact the acquiring entity or MONEI for support |
| E104 | Partial captures are not enabled in your account, please contact MONEI support                               |
| E105 | MOTO Payment are not enabled in your account, please contact MONEI support                                   |

#### Authentication and Request Errors (E15x)[​](#authentication-and-request-errors-e15x "Direct link to Authentication and Request Errors (E15x)")

These errors indicate issues with your API request format or authentication:

| Code | Message                                                                       |
| ---- | ----------------------------------------------------------------------------- |
| E150 | Invalid or malformed request. Please check the message format                 |
| E151 | Missing or malformed signature/auth                                           |
| E152 | Error while decrypting request                                                |
| E153 | Pre-authorization is expired and cannot be canceled or captured               |
| E154 | The payment date cannot be less than the cancellation or capture date         |
| E155 | The cancellation date exceeded the date allowed for pre-authorized operations |
| E156 | Unauthorized token                                                            |

#### Transaction Processing Errors (E2xx)[​](#transaction-processing-errors-e2xx "Direct link to Transaction Processing Errors (E2xx)")

These errors occur during payment processing:

| Code | Message                                                           |
| ---- | ----------------------------------------------------------------- |
| E200 | Transaction failed during payment processing                      |
| E201 | Transaction declined by the card-issuing bank                     |
| E202 | Transaction declined by the issuing bank                          |
| E203 | Payment method not allowed                                        |
| E204 | Wrong or not allowed currency                                     |
| E205 | Incorrect reference / transaction does not exist                  |
| E206 | Invalid payment method                                            |
| E207 | Transaction failed: process time exceeded                         |
| E208 | Transaction is currently being processed                          |
| E209 | Duplicated operation                                              |
| E210 | Wrong or not allowed payment amount                               |
| E211 | Refund declined by processor                                      |
| E212 | Transaction has already been captured                             |
| E213 | Transaction has already been canceled                             |
| E214 | The amount to be captured cannot exceed the pre-authorized amount |
| E215 | The transaction to be captured has not been pre-authorized yet    |
| E216 | The transaction to be canceled has not been pre-authorized yet    |
| E217 | Transaction denied by processor to avoid duplicated operations    |
| E218 | Error during payment request validation                           |
| E219 | Refund declined due to exceeded amount                            |
| E220 | Transaction has already been fully refunded                       |
| E221 | Transaction declined due to insufficient funds                    |
| E222 | The user has canceled the payment                                 |
| E223 | Waiting for the transaction to be completed                       |
| E224 | No reason to decline                                              |
| E225 | Refund not allowed                                                |
| E226 | Transaction cannot be completed, violation of law                 |
| E227 | Stop Payment Order                                                |
| E228 | Strong Customer Authentication required                           |
| E229 | Expired payment method                                            |

#### 3D Secure Related Errors (E3xx)[​](#3d-secure-related-errors-e3xx "Direct link to 3D Secure Related Errors (E3xx)")

These errors are related to 3D Secure authentication:

| Code | Message                                            |
| ---- | -------------------------------------------------- |
| E300 | Transaction declined due to security restrictions  |
| E301 | 3D Secure authentication failed                    |
| E302 | Authentication process timed out. Please try again |
| E303 | An error occurred during the 3D Secure process     |
| E304 | Invalid or malformed 3D Secure request             |
| E305 | Exemption not allowed                              |
| E306 | Exemption error                                    |
| E307 | Fraud control error                                |
| E308 | External MPI received wrong. Please check the data |
| E309 | External MPI not enabled. Please contact support   |
| E310 | Transaction confirmation rejected by the merchant  |

#### Card Related Errors (E5xx)[​](#card-related-errors-e5xx "Direct link to Card Related Errors (E5xx)")

These errors are specific to card payments:

| Code | Message                                                            |
| ---- | ------------------------------------------------------------------ |
| E500 | Transaction declined during card payment process                   |
| E501 | Card rejected: invalid card number                                 |
| E502 | Card rejected: wrong expiration date                               |
| E503 | Card rejected: wrong CVC/CVV2 number                               |
| E504 | Card number not registered                                         |
| E505 | Card is expired                                                    |
| E506 | Error during payment authorization. Please try again               |
| E507 | Cardholder has canceled the payment                                |
| E508 | Transaction declined: AMEX cards not accepted by payment processor |
| E509 | Card blocked temporarily or under suspicion of fraud               |
| E510 | Card does not allow pre-authorization operations                   |
| E511 | CVC/CVV2 number is required                                        |
| E512 | Unsupported card type                                              |
| E513 | Transaction type not allowed for this type of card                 |
| E514 | Transaction declined by card issuer                                |
| E515 | Implausible card data                                              |
| E516 | Incorrect PIN                                                      |
| E517 | Transaction not allowed for cardholder                             |
| E518 | The amount exceeds the card limit                                  |

#### Digital Wallet Errors (E6xx)[​](#digital-wallet-errors-e6xx "Direct link to Digital Wallet Errors (E6xx)")

These errors are related to digital wallet payments:

| Code | Message                                                        |
| ---- | -------------------------------------------------------------- |
| E600 | Transaction declined during ApplePay/GooglePay payment process |
| E601 | Incorrect ApplePay or GooglePay configuration                  |

#### PayPal Related Errors (E62x)[​](#paypal-related-errors-e62x "Direct link to PayPal Related Errors (E62x)")

These errors are specific to PayPal payments:

| Code | Message                                                              |
| ---- | -------------------------------------------------------------------- |
| E620 | Transaction declined during PayPal payment process                   |
| E621 | Transaction declined during PayPal payment process: invalid currency |

#### Bizum Related Errors (E64x-E65x)[​](#bizum-related-errors-e64x-e65x "Direct link to Bizum Related Errors (E64x-E65x)")

These errors are specific to Bizum payments:

| Code | Message                                                                    |
| ---- | -------------------------------------------------------------------------- |
| E640 | Bizum transaction declined after three authentication attempts             |
| E641 | Bizum transaction declined due to failed authorization                     |
| E642 | Bizum transaction declined due to insufficient funds                       |
| E643 | Bizum transaction canceled: the user does not want to continue             |
| E644 | Bizum transaction rejected by destination bank                             |
| E645 | Bizum transaction rejected by origin bank                                  |
| E646 | Bizum transaction rejected by processor                                    |
| E647 | Bizum transaction failed while connecting with processor. Please try again |
| E648 | Bizum transaction failed, payee is not found                               |
| E649 | Bizum transaction failed, payer is not found                               |
| E650 | Bizum REST not implemented                                                 |
| E651 | Bizum transaction declined due to failed authentication                    |
| E652 | The customer has disabled Bizum, please use another payment method         |

#### Click To Pay Related Errors (E68x)[​](#click-to-pay-related-errors-e68x "Direct link to Click To Pay Related Errors (E68x)")

These errors are specific to ClickToPay payments:

| Code | Message                                                |
| ---- | ------------------------------------------------------ |
| E680 | Transaction declined during ClickToPay payment process |
| E681 | Incorrect ClickToPay configuration                     |

#### System Errors (E9xx)[​](#system-errors-e9xx "Direct link to System Errors (E9xx)")

These errors indicate system-level issues:

| Code | Message                                        |
| ---- | ---------------------------------------------- |
| E999 | Service internal error. Please contact support |

<!-- -->

## [📄️<!-- --> <!-- -->Create Payment](https://docs.monei.com/apis/rest/payments-create/.md)

[Creates a new payment with the specified parameters.](https://docs.monei.com/apis/rest/payments-create/.md)

## [📄️<!-- --> <!-- -->Get Payment](https://docs.monei.com/apis/rest/payments-get/.md)

[Retrieves the complete details of an existing payment by its unique ID.](https://docs.monei.com/apis/rest/payments-get/.md)

## [📄️<!-- --> <!-- -->Confirm Payment](https://docs.monei.com/apis/rest/payments-confirm/.md)

[Confirms a payment that was created without payment details. This endpoint can only be used with](https://docs.monei.com/apis/rest/payments-confirm/.md)

## [📄️<!-- --> <!-- -->Capture Payment](https://docs.monei.com/apis/rest/payments-capture/.md)

[Captures funds from a previously authorized payment. This endpoint can only](https://docs.monei.com/apis/rest/payments-capture/.md)

## [📄️<!-- --> <!-- -->Cancel Payment](https://docs.monei.com/apis/rest/payments-cancel/.md)

[Releases reserved funds from a previously authorized payment. This endpoint can only](https://docs.monei.com/apis/rest/payments-cancel/.md)

## [📄️<!-- --> <!-- -->Refund Payment](https://docs.monei.com/apis/rest/payments-refund/.md)

[Returns funds from a completed payment back to the customer's original payment method.](https://docs.monei.com/apis/rest/payments-refund/.md)

## [📄️<!-- --> <!-- -->Recurring Payment](https://docs.monei.com/apis/rest/payments-recurring/.md)

[Creates a subsequent charge using the payment details from a previous transaction.](https://docs.monei.com/apis/rest/payments-recurring/.md)

## [📄️<!-- --> <!-- -->Send Payment Request](https://docs.monei.com/apis/rest/payments-send-request/.md)

[Sends a direct payment request to the customer's phone with smart channel selection.](https://docs.monei.com/apis/rest/payments-send-request/.md)

## [📄️<!-- --> <!-- -->Send Payment Link](https://docs.monei.com/apis/rest/payments-send-link/.md)

[Sends a payment link to the customer through their preferred communication channel.](https://docs.monei.com/apis/rest/payments-send-link/.md)

## [📄️<!-- --> <!-- -->Send Payment Receipt](https://docs.monei.com/apis/rest/payments-send-receipt/.md)

[Sends a payment receipt to the customer through their preferred communication channel.](https://docs.monei.com/apis/rest/payments-send-receipt/.md)


---

# AccountId

MONEI Account identifier.

**string**AccountId (string)

MONEI Account identifier.

**Example:&#x20;**`aa9333ba-82de-400c-9ae7-087b9f8d2242`

AccountId

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


---

# ActivateApplePayCertificateRequest

**cert**stringrequired

The signed certificate from Apple in base64 format. Download this from Apple Developer Portal after creating the certificate with your CSR.

**Example:&#x20;**`MIIEpDCCA4ygAwIBAgIIU...`

ActivateApplePayCertificateRequest

```
{
  "cert": "MIIEpDCCA4ygAwIBAgIIU..."
}
```


---

# ActivateSubscriptionRequest

**paymentToken**Payment-PaymentToken (string)

A payment token generated by monei.js [Components](https://docs.monei.com/monei-js/overview/) or a paymentToken [saved after a previous successful payment](https://docs.monei.com/guides/save-payment-method/). In case of the first one, you will also need to send the `sessionId` used to generate the token in the first place.

**Example:&#x20;**`7cc38b08ff471ccd313ad62b23b9f362b107560b`

**sessionId**Payment-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:&#x20;**`39603551437913`

**addAmount**integer\<int32>

The amount to be added to the subscription's initial payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge 1.00 USD).

**Example:&#x20;**`110`

**allowedPaymentMethods**string\[]

List of payment methods allowed for subscriptions.

| Enum Value | Description |
| ---------- | ----------- |
| card       | Card        |
| bizum      | Bizum       |

**Example:&#x20;**`["card","bizum"]`

**sequenceId**Payment-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:&#x20;**`62b23b9f3627cc38b08ff471ccd313ad`

**completeUrl**Payment-CompleteUrl (string)

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

**Example:&#x20;**`https://example.com/checkout/complete`

**failUrl**Payment-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:&#x20;**`https://example.com/checkout/fail`

**cancelUrl**Payment-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:&#x20;**`https://example.com/checkout/cancel`

**metadata**object

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:&#x20;**`{"systemId":"12345"}`

ActivateSubscriptionRequest

```
{
  "paymentToken": "7cc38b08ff471ccd313ad62b23b9f362b107560b",
  "sessionId": "39603551437913",
  "addAmount": 110,
  "allowedPaymentMethods": [
    "card",
    "bizum"
  ],
  "sequenceId": "62b23b9f3627cc38b08ff471ccd313ad",
  "completeUrl": "https://example.com/checkout/complete",
  "failUrl": "https://example.com/checkout/fail",
  "cancelUrl": "https://example.com/checkout/cancel",
  "metadata": {
    "systemId": "12345"
  }
}
```


---

# Address

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**city**string

City, district, suburb, town, or village.

**Example:&#x20;**`Málaga`

**line1**string

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

**Example:&#x20;**`Fake Street 123`

**line2**string

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

**Example:&#x20;**`null`

**zip**string

ZIP or postal code.

**Example:&#x20;**`1234`

**state**string

State, county, province, or region.

**Example:&#x20;**`Málaga`

Address

```
{
  "country": "ES",
  "city": "Málaga",
  "line1": "Fake Street 123",
  "line2": null,
  "zip": "1234",
  "state": "Málaga"
}
```


---

# ApiException

**status**stringrequired

Error type identifier

**statusCode**integer\<int32>required

HTTP status code

**message**stringrequired

Human-readable error message

**requestId**stringrequired

Unique identifier for the request

**Example:&#x20;**`df011689-bd3e-4953-95ca-c7bbdacaf6f8`

**requestTime**string\<date-time>required

Timestamp when the request was processed

**Example:&#x20;**`2025-03-05T10:25:52Z`

ApiException

```
{
  "status": "string",
  "statusCode": 0,
  "message": "string",
  "requestId": "df011689-bd3e-4953-95ca-c7bbdacaf6f8",
  "requestTime": "2025-03-05T10:25:52Z"
}
```


---

# ApplePayCertificate

An Apple Pay certificate for iOS app integration.

**id**stringrequired

Unique identifier of the certificate.

**Example:&#x20;**`a6ea0c67-d061-4f7c-9e3b-4a96a6e1e8b1`

**accountId**stringrequired

The account ID this certificate belongs to.

**Example:&#x20;**`acct_12345`

**csr**string

The Certificate Signing Request in base64 format. Only present before activation. Use this to create a certificate in Apple Developer Portal.

**Example:&#x20;**`MIIBEjCBuQIBADBOMRMwE...`

**cert**string

The certificate body in base64 format. Only present after activation.

**Example:&#x20;**`MIIEpDCCA4ygAwIBAgIIU...`

**active**booleanrequired

Whether the certificate is active for payment processing.

**Example:&#x20;**`true`

**expireAt**string\<date-time>

The certificate expiration date in ISO 8601 format. Only present after activation.

**Example:&#x20;**`2026-01-15T12:00:00.000Z`

**createdAt**string\<date-time>required

The certificate creation date in ISO 8601 format.

**Example:&#x20;**`2024-01-15T12:00:00.000Z`

ApplePayCertificate

```
{
  "id": "a6ea0c67-d061-4f7c-9e3b-4a96a6e1e8b1",
  "accountId": "acct_12345",
  "csr": "MIIBEjCBuQIBADBOMRMwE...",
  "cert": "MIIEpDCCA4ygAwIBAgIIU...",
  "active": true,
  "expireAt": "2026-01-15T12:00:00.000Z",
  "createdAt": "2024-01-15T12:00:00.000Z"
}
```


---

# BadRequestError

**status**stringrequired

Error type identifier

**Example:&#x20;**`BadRequestError`

**statusCode**integer\<int32>required

HTTP status code

**Example:&#x20;**`400`

**message**stringrequired

Human-readable error message

**Example:&#x20;**`Bad request`

**requestId**stringrequired

Unique identifier for the request

**Example:&#x20;**`df011689-bd3e-4953-95ca-c7bbdacaf6f8`

**requestTime**string\<date-time>required

Timestamp when the request was processed

**Example:&#x20;**`2025-03-05T10:25:52Z`

BadRequestError

```
{
  "status": "BadRequestError",
  "statusCode": 400,
  "message": "Bad request",
  "requestId": "df011689-bd3e-4953-95ca-c7bbdacaf6f8",
  "requestTime": "2025-03-05T10:25:52Z"
}
```


---

# Browser

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

**string**Browser (string)

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

**Example:&#x20;**`Chrome`

Browser

```
"Chrome"
```


---

# BrowserAccept

Browser accept header.

**string**BrowserAccept (string)

Browser accept header.

**Example:&#x20;**`text/html,application/xhtml+xml,application/json`

BrowserAccept

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


---

# BrowserColorDepth

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

**string**BrowserColorDepth (string)

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

**Example:&#x20;**`24`

BrowserColorDepth

```
"24"
```


---

# BrowserScreenHeight

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

**string**BrowserScreenHeight (string)

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

**Example:&#x20;**`1152`

BrowserScreenHeight

```
"1152"
```


---

# BrowserScreenWidth

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

**string**BrowserScreenWidth (string)

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

**Example:&#x20;**`2048`

BrowserScreenWidth

```
"2048"
```


---

# BrowserTimezoneOffset

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

**string**BrowserTimezoneOffset (string)

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

**Example:&#x20;**`-120`

BrowserTimezoneOffset

```
"-120"
```


---

# BrowserVersion

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

**string**BrowserVersion (string)

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

**Example:&#x20;**`83.0.4103.116`

BrowserVersion

```
"83.0.4103.116"
```


---

# CancelPaymentRequest

**cancellationReason**Payment-CancellationReason (string)

The reason for canceling the Payment.

**Possible values:** \[`duplicated`, `fraudulent`, `requested_by_customer`]

**Example:&#x20;**`null`

CancelPaymentRequest

```
{
  "cancellationReason": null
}
```


---

# CancelSubscriptionRequest

**cancelAtPeriodEnd**Subscription-CancelAtPeriodEnd (boolean)

If true, the subscription will be canceled at the end of the current period.

**Example:&#x20;**`false`

CancelSubscriptionRequest

```
{
  "cancelAtPeriodEnd": false
}
```


---

# CapturePaymentRequest

**amount**integer\<int32>

The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded.

**Example:&#x20;**`110`

CapturePaymentRequest

```
{
  "amount": 110
}
```


---

# CardholderEmail

The cardholder's email address.

**string**CardholderEmail (string)

The cardholder's email address.

**Example:&#x20;**`john.doe@monei.com`

CardholderEmail

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


---

# CardholderName

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

**string**CardholderName (string)

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

**Example:&#x20;**`John Doe`

CardholderName

```
"John Doe"
```


---

# ConfirmPaymentRequest

**paymentToken**Payment-PaymentToken (string)required

A payment token generated by monei.js [Components](https://docs.monei.com/monei-js/overview/) or a paymentToken [saved after a previous successful payment](https://docs.monei.com/guides/save-payment-method/).

**Example:&#x20;**`7cc38b08ff471ccd313ad62b23b9f362b107560b`

**paymentMethod** <!-- -->object

Additional information about the payment method used for this payment.

**card** <!-- -->object

Additional information about the card used for this payment.

**cardholderName**CardholderName (string)

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

**Example:&#x20;**`John Doe`

**cardholderEmail**CardholderEmail (string)

The cardholder's email address.

**Example:&#x20;**`john.doe@monei.com`

**generatePaymentToken**Payment-GeneratePaymentToken (boolean)

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

**Default value:&#x20;**`false`

**Example:&#x20;**`false`

**customer** <!-- -->object

**email**string

The customer's email address.

**Example:&#x20;**`john.doe@example.com`

**name**string

The customer's full name or business name.

**Example:&#x20;**`John Doe`

**phone**string

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

**Example:&#x20;**`null`

**billingDetails** <!-- -->object

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

**name**string

The customer's billing full name.

**Example:&#x20;**`John Doe`

**email**string

The customer's billing email address.

**Example:&#x20;**`john.doe@example.com`

**phone**string

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

**Example:&#x20;**`null`

**company**string

Billing company name.

**Example:&#x20;**`null`

**taxId**string

Company tax ID.

**Example:&#x20;**`null`

**address** <!-- -->object

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**city**string

City, district, suburb, town, or village.

**Example:&#x20;**`Málaga`

**line1**string

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

**Example:&#x20;**`Fake Street 123`

**line2**string

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

**Example:&#x20;**`null`

**zip**string

ZIP or postal code.

**Example:&#x20;**`1234`

**state**string

State, county, province, or region.

**Example:&#x20;**`Málaga`

**shippingDetails** <!-- -->object

Shipping information associated with the payment.

**name**string

The shipping customer's full name.

**Example:&#x20;**`John Doe`

**email**string

The shipping customer's email address.

**Example:&#x20;**`john.doe@example.com`

**phone**string

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

**Example:&#x20;**`null`

**company**string

Name of the company where the shipment is going.

**Example:&#x20;**`null`

**taxId**string

Company tax ID.

**Example:&#x20;**`null`

**address** <!-- -->object

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**city**string

City, district, suburb, town, or village.

**Example:&#x20;**`Málaga`

**line1**string

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

**Example:&#x20;**`Fake Street 123`

**line2**string

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

**Example:&#x20;**`null`

**zip**string

ZIP or postal code.

**Example:&#x20;**`1234`

**state**string

State, county, province, or region.

**Example:&#x20;**`Málaga`

**sessionDetails** <!-- -->Payment-SessionDetails

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

**ip**IP (string)

The IP address where the operation originated.

**Example:&#x20;**`100.100.200.100`

**countryCode**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**lang**Lang (string)

Two-letter language code ([ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1)).

**Example:&#x20;**`es`

**deviceType**DeviceType (string)

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

**Example:&#x20;**`desktop`

**deviceModel**DeviceModel (string)

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

**Example:&#x20;**`null`

**browser**Browser (string)

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

**Example:&#x20;**`Chrome`

**browserVersion**BrowserVersion (string)

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

**Example:&#x20;**`83.0.4103.116`

**os**Os (string)

Operation system (e.g., `iOS`).

**Example:&#x20;**`Mac OS`

**osVersion**OsVersion (string)

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

**Example:&#x20;**`10.15.4`

**source**Source (string)

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

**Example:&#x20;**`MONEI/PHP`

**sourceVersion**SourceVersion (string)

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

**Example:&#x20;**`0.1.2`

**userAgent**UserAgent (string)

Full user agent string of the browser session.

**Example:&#x20;**`Mozilla/5.0 (Windows NT 10.0; Win64; x64) ...`

**browserAccept**BrowserAccept (string)

Browser accept header.

**Example:&#x20;**`text/html,application/xhtml+xml,application/json`

**browserColorDepth**BrowserColorDepth (string)

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

**Example:&#x20;**`24`

**browserScreenHeight**BrowserScreenHeight (string)

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

**Example:&#x20;**`1152`

**browserScreenWidth**BrowserScreenWidth (string)

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

**Example:&#x20;**`2048`

**browserTimezoneOffset**BrowserTimezoneOffset (string)

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

**Example:&#x20;**`-120`

**metadata**object

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:&#x20;**`{"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"
  }
}
```


---

# Country

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**string**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

Country

```
"ES"
```


---

# CreatedAt

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

**integer**integer\<int64>

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

**Example:&#x20;**`1636366897`

CreatedAt

```
1636366897
```


---

# CreatePaymentRequest

**amount**integer\<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:&#x20;**`110`

**currency**Payment-Currency (string)required

Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase. Must be a supported currency.

**Example:&#x20;**`EUR`

**orderId**Payment-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:&#x20;**`14379133960355`

**callbackUrl**Payment-CallbackUrl (string)

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

**Example:&#x20;**`https://example.com/checkout/callback`

**completeUrl**Payment-CompleteUrl (string)

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

**Example:&#x20;**`https://example.com/checkout/complete`

**failUrl**Payment-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:&#x20;**`https://example.com/checkout/fail`

**cancelUrl**Payment-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:&#x20;**`https://example.com/checkout/cancel`

**paymentToken**Payment-PaymentToken (string)

A payment token generated by monei.js [Components](https://docs.monei.com/monei-js/overview/) or a paymentToken [saved after a previous successful payment](https://docs.monei.com/guides/save-payment-method/). In case of the first one, you will also need to send the `sessionId` used to generate the token in the first place.

**Example:&#x20;**`7cc38b08ff471ccd313ad62b23b9f362b107560b`

**sessionId**Payment-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:&#x20;**`39603551437913`

**generatePaymentToken**Payment-GeneratePaymentToken (boolean)

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

**Default value:&#x20;**`false`

**Example:&#x20;**`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](https://www.investopedia.com/terms/p/pci-compliance.asp).

**card** <!-- -->object

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

**number**string

The card number, as a string without any separators.

**cvc**string

Card security code.

**expMonth**string

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

**expYear**string

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

**cardholderName**CardholderName (string)

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

**Example:&#x20;**`John Doe`

**cardholderEmail**CardholderEmail (string)

The cardholder's email address.

**Example:&#x20;**`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.

**phoneNumber**string

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

**Example:&#x20;**`null`

**allowedPaymentMethods**string\[]

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

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

**Example:&#x20;**`["card","bizum","paypal"]`

**transactionType**Payment-TransactionType (string)

Controls when the funds will be captured.

| Enum Value | Description                                                                  |
| ---------- | ---------------------------------------------------------------------------- |
| SALE       | Automatically captures funds when the customer authorizes the payment        |
| AUTH       | Places a hold on funds without immediate capture, allowing for later capture |
| PAYOUT     | Sends funds to the customer                                                  |
| VERIF      | Verifies the payment method without placing a hold or capturing funds        |

**Possible values:** \[`SALE`, `AUTH`, `PAYOUT`, `VERIF`]

**Default value:&#x20;**`SALE`

**Example:&#x20;**`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`).

**type**stringrequired

**Possible values:** \[`recurring`]

**Example:&#x20;**`recurring`

**recurring** <!-- -->object

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

**expiry**string

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

**Default value:&#x20;**`*(The payment method or card expiration)*`

**Example:&#x20;**`20210630`

**frequency**integer\<int32>

The minimum number of **days** between the different recurring payments.

**Default value:&#x20;**`25`

**Example:&#x20;**`30`

**storeId**Payment-StoreId (string)

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

**Example:&#x20;**`e5f28150d9e8974c58ab5ec9c4a880f8734dcf05`

**pointOfSaleId**Payment-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:&#x20;**`fb269cccfa0cc021f5d0b8eb1421646c696213e1`

**subscriptionId**Payment-SubscriptionId (string)

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

**Example:&#x20;**`575bcd84-09fc-4a6e-8c4c-f88b8eb90bfa`

**autoRecover**Payment-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:&#x20;**`false`

**description**Payment-Description (string)

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

**Example:&#x20;**`Test Shop - #84370745531439`

**customer** <!-- -->object

**email**string

The customer's email address.

**Example:&#x20;**`john.doe@example.com`

**name**string

The customer's full name or business name.

**Example:&#x20;**`John Doe`

**phone**string

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

**Example:&#x20;**`null`

**billingDetails** <!-- -->object

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

**name**string

The customer's billing full name.

**Example:&#x20;**`John Doe`

**email**string

The customer's billing email address.

**Example:&#x20;**`john.doe@example.com`

**phone**string

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

**Example:&#x20;**`null`

**company**string

Billing company name.

**Example:&#x20;**`null`

**taxId**string

Company tax ID.

**Example:&#x20;**`null`

**address** <!-- -->object

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**city**string

City, district, suburb, town, or village.

**Example:&#x20;**`Málaga`

**line1**string

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

**Example:&#x20;**`Fake Street 123`

**line2**string

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

**Example:&#x20;**`null`

**zip**string

ZIP or postal code.

**Example:&#x20;**`1234`

**state**string

State, county, province, or region.

**Example:&#x20;**`Málaga`

**shippingDetails** <!-- -->object

Shipping information associated with the payment.

**name**string

The shipping customer's full name.

**Example:&#x20;**`John Doe`

**email**string

The shipping customer's email address.

**Example:&#x20;**`john.doe@example.com`

**phone**string

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

**Example:&#x20;**`null`

**company**string

Name of the company where the shipment is going.

**Example:&#x20;**`null`

**taxId**string

Company tax ID.

**Example:&#x20;**`null`

**address** <!-- -->object

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**city**string

City, district, suburb, town, or village.

**Example:&#x20;**`Málaga`

**line1**string

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

**Example:&#x20;**`Fake Street 123`

**line2**string

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

**Example:&#x20;**`null`

**zip**string

ZIP or postal code.

**Example:&#x20;**`1234`

**state**string

State, county, province, or region.

**Example:&#x20;**`Málaga`

**sessionDetails** <!-- -->Payment-SessionDetails

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

**ip**IP (string)

The IP address where the operation originated.

**Example:&#x20;**`100.100.200.100`

**countryCode**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**lang**Lang (string)

Two-letter language code ([ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1)).

**Example:&#x20;**`es`

**deviceType**DeviceType (string)

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

**Example:&#x20;**`desktop`

**deviceModel**DeviceModel (string)

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

**Example:&#x20;**`null`

**browser**Browser (string)

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

**Example:&#x20;**`Chrome`

**browserVersion**BrowserVersion (string)

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

**Example:&#x20;**`83.0.4103.116`

**os**Os (string)

Operation system (e.g., `iOS`).

**Example:&#x20;**`Mac OS`

**osVersion**OsVersion (string)

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

**Example:&#x20;**`10.15.4`

**source**Source (string)

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

**Example:&#x20;**`MONEI/PHP`

**sourceVersion**SourceVersion (string)

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

**Example:&#x20;**`0.1.2`

**userAgent**UserAgent (string)

Full user agent string of the browser session.

**Example:&#x20;**`Mozilla/5.0 (Windows NT 10.0; Win64; x64) ...`

**browserAccept**BrowserAccept (string)

Browser accept header.

**Example:&#x20;**`text/html,application/xhtml+xml,application/json`

**browserColorDepth**BrowserColorDepth (string)

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

**Example:&#x20;**`24`

**browserScreenHeight**BrowserScreenHeight (string)

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

**Example:&#x20;**`1152`

**browserScreenWidth**BrowserScreenWidth (string)

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

**Example:&#x20;**`2048`

**browserTimezoneOffset**BrowserTimezoneOffset (string)

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

**Example:&#x20;**`-120`

**expireAt**number\<int64>

Payment expiration time.

**Example:&#x20;**`1663581391`

**metadata**object

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:&#x20;**`{"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"
  }
}
```


---

# CreateSubscriptionRequest

**amount**integer\<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:&#x20;**`110`

**currency**Payment-Currency (string)required

Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase. Must be a supported currency.

**Example:&#x20;**`EUR`

**interval**Subscription-Interval (string)required

Subscription interval. The `minute` and `hour` intervals are only available in test mode.

| Enum Value | Description |
| ---------- | ----------- |
| minute     | Minutely    |
| hour       | Hourly      |
| day        | Daily       |
| week       | Weekly      |
| month      | Monthly     |
| year       | Yearly      |

**Possible values:** \[`minute`, `hour`, `day`, `week`, `month`, `year`]

**Example:&#x20;**`month`

**intervalCount**integer\<int32>

Number of intervals between subscription payments.

**Example:&#x20;**`1`

**allowedPaymentMethods**string\[]

List of payment methods allowed for subscriptions.

| Enum Value | Description |
| ---------- | ----------- |
| card       | Card        |
| bizum      | Bizum       |

**Example:&#x20;**`["card","bizum"]`

**description**Subscription-Description (string)

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

**Example:&#x20;**`MoonMail Monthly Lite`

**customer** <!-- -->object

**email**string

The customer's email address.

**Example:&#x20;**`john.doe@example.com`

**name**string

The customer's full name or business name.

**Example:&#x20;**`John Doe`

**phone**string

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

**Example:&#x20;**`null`

**billingDetails** <!-- -->object

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

**name**string

The customer's billing full name.

**Example:&#x20;**`John Doe`

**email**string

The customer's billing email address.

**Example:&#x20;**`john.doe@example.com`

**phone**string

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

**Example:&#x20;**`null`

**company**string

Billing company name.

**Example:&#x20;**`null`

**taxId**string

Company tax ID.

**Example:&#x20;**`null`

**address** <!-- -->object

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**city**string

City, district, suburb, town, or village.

**Example:&#x20;**`Málaga`

**line1**string

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

**Example:&#x20;**`Fake Street 123`

**line2**string

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

**Example:&#x20;**`null`

**zip**string

ZIP or postal code.

**Example:&#x20;**`1234`

**state**string

State, county, province, or region.

**Example:&#x20;**`Málaga`

**shippingDetails** <!-- -->object

Shipping information associated with the payment.

**name**string

The shipping customer's full name.

**Example:&#x20;**`John Doe`

**email**string

The shipping customer's email address.

**Example:&#x20;**`john.doe@example.com`

**phone**string

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

**Example:&#x20;**`null`

**company**string

Name of the company where the shipment is going.

**Example:&#x20;**`null`

**taxId**string

Company tax ID.

**Example:&#x20;**`null`

**address** <!-- -->object

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**city**string

City, district, suburb, town, or village.

**Example:&#x20;**`Málaga`

**line1**string

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

**Example:&#x20;**`Fake Street 123`

**line2**string

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

**Example:&#x20;**`null`

**zip**string

ZIP or postal code.

**Example:&#x20;**`1234`

**state**string

State, county, province, or region.

**Example:&#x20;**`Málaga`

**trialPeriodEnd**number\<int64>

The end date of the trial period. Measured in seconds since the Unix epoch.

**Example:&#x20;**`1636366897`

**trialPeriodDays**integer\<int32>

Number of days the trial period lasts.

**Example:&#x20;**`7`

**retrySchedule** <!-- -->object\[]

Defines a custom schedule for retrying failed subscription payments. Each entry in the array specifies how long to wait before attempting the next payment retry. If not specified, the system's default retry schedule will be used.

* Array \[

**interval**stringrequired

The unit of time to wait before the retry attempt.

| Enum Value | Description |
| ---------- | ----------- |
| day        | Daily       |
| week       | Weekly      |
| month      | Monthly     |
| year       | Yearly      |

**Possible values:** \[`day`, `week`, `month`, `year`]

**Example:&#x20;**`day`

**intervalCount**integer\<int32>required

The number of intervals to wait before the retry attempt.

**Possible values:** `>= 1` and `<= 31`

**Example:&#x20;**`3`

* ]

**callbackUrl**Subscription-CallbackUrl (string)

The URL will be called each time subscription status changes. You will receive a subscription object in the body of the request.

**Example:&#x20;**`https://example.com/subscriptions/callback`

**paymentCallbackUrl**Subscription-PaymentCallbackUrl (string)

The URL will be called each time subscription creates a new payments. You will receive the payment object in the body of the request.

**Example:&#x20;**`https://example.com/payments/callback`

**metadata**object

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:&#x20;**`{"systemId":"12345"}`

CreateSubscriptionRequest

```
{
  "amount": 110,
  "currency": "EUR",
  "interval": "month",
  "intervalCount": 1,
  "allowedPaymentMethods": [
    "card",
    "bizum"
  ],
  "description": "MoonMail Monthly Lite",
  "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"
    }
  },
  "trialPeriodEnd": 1636366897,
  "trialPeriodDays": 7,
  "retrySchedule": [
    {
      "interval": "day",
      "intervalCount": 1
    },
    {
      "interval": "day",
      "intervalCount": 3
    },
    {
      "interval": "week",
      "intervalCount": 1
    }
  ],
  "callbackUrl": "https://example.com/subscriptions/callback",
  "paymentCallbackUrl": "https://example.com/payments/callback",
  "metadata": {
    "systemId": "12345"
  }
}
```


---

# DeviceModel

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

**string**DeviceModel (string)

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

**Example:&#x20;**`null`

DeviceModel

```
null
```


---

# DeviceType

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

**string**DeviceType (string)

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

**Example:&#x20;**`desktop`

DeviceType

```
"desktop"
```


---

# DomainName

The domain name to register for Apple Pay.

**string**DomainName (string)

The domain name to register for Apple Pay.

**Example:&#x20;**`example.com`

DomainName

```
"example.com"
```


---

# InternalServerError

**status**stringrequired

Error type identifier

**Example:&#x20;**`InternalServerError`

**statusCode**integer\<int32>required

HTTP status code

**Example:&#x20;**`500`

**message**stringrequired

Human-readable error message

**Example:&#x20;**`An unexpected error occurred`

**requestId**stringrequired

Unique identifier for the request

**Example:&#x20;**`df011689-bd3e-4953-95ca-c7bbdacaf6f8`

**requestTime**string\<date-time>required

Timestamp when the request was processed

**Example:&#x20;**`2025-03-05T10:25:52Z`

InternalServerError

```
{
  "status": "InternalServerError",
  "statusCode": 500,
  "message": "An unexpected error occurred",
  "requestId": "df011689-bd3e-4953-95ca-c7bbdacaf6f8",
  "requestTime": "2025-03-05T10:25:52Z"
}
```


---

# IP

The IP address where the operation originated.

**string**IP (string)

The IP address where the operation originated.

**Example:&#x20;**`100.100.200.100`

IP

```
"100.100.200.100"
```


---

# Lang

Two-letter language code ([ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1)).

**string**Lang (string)

Two-letter language code ([ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1)).

**Example:&#x20;**`es`

Lang

```
"es"
```


---

# Livemode

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

**boolean**Livemode (boolean)

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

**Example:&#x20;**`false`

Livemode

```
false
```


---

# Metadata

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.

**object**object

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:&#x20;**`{"systemId":"12345"}`

Metadata

```
{
  "systemId": "12345"
}
```


---

# NotFoundError

**status**stringrequired

Error type identifier

**Example:&#x20;**`NotFoundError`

**statusCode**integer\<int32>required

HTTP status code

**Example:&#x20;**`404`

**message**stringrequired

Human-readable error message

**Example:&#x20;**`Resource not found`

**requestId**stringrequired

Unique identifier for the request

**Example:&#x20;**`df011689-bd3e-4953-95ca-c7bbdacaf6f8`

**requestTime**string\<date-time>required

Timestamp when the request was processed

**Example:&#x20;**`2025-03-05T10:25:52Z`

NotFoundError

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


---

# Os

Operation system (e.g., `iOS`).

**string**Os (string)

Operation system (e.g., `iOS`).

**Example:&#x20;**`Mac OS`

Os

```
"Mac OS"
```


---

# OsVersion

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

**string**OsVersion (string)

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

**Example:&#x20;**`10.15.4`

OsVersion

```
"10.15.4"
```


---

# PauseSubscriptionRequest

**pauseAtPeriodEnd**Subscription-PauseAtPeriodEnd (boolean)

If true, the subscription will be paused at the end of the current period.

**Example:&#x20;**`false`

**pauseIntervalCount**integer\<int32>

Number of intervals when subscription will be paused before it activates again.

**Example:&#x20;**`1`

PauseSubscriptionRequest

```
{
  "pauseAtPeriodEnd": false,
  "pauseIntervalCount": 1
}
```


---

# Payment-Amount

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).

**integer**integer\<int32>

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:&#x20;**`110`

Payment-Amount

```
110
```


---

# Payment-AuthorizationCode

Unique identifier provided by the bank performing transaction.

**string**Payment-AuthorizationCode (string)

Unique identifier provided by the bank performing transaction.

**Example:&#x20;**`475816`

Payment-AuthorizationCode

```
"475816"
```


---

# Payment-AutoRecover

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).

**boolean**Payment-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:&#x20;**`false`

Payment-AutoRecover

```
false
```


---

# Payment-BillingDetails

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

**name**string

The customer's billing full name.

**Example:&#x20;**`John Doe`

**email**string

The customer's billing email address.

**Example:&#x20;**`john.doe@example.com`

**phone**string

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

**Example:&#x20;**`null`

**company**string

Billing company name.

**Example:&#x20;**`null`

**taxId**string

Company tax ID.

**Example:&#x20;**`null`

**address** <!-- -->object

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**city**string

City, district, suburb, town, or village.

**Example:&#x20;**`Málaga`

**line1**string

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

**Example:&#x20;**`Fake Street 123`

**line2**string

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

**Example:&#x20;**`null`

**zip**string

ZIP or postal code.

**Example:&#x20;**`1234`

**state**string

State, county, province, or region.

**Example:&#x20;**`Málaga`

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


---

# Payment-CallbackUrl

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

**string**Payment-CallbackUrl (string)

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

**Example:&#x20;**`https://example.com/checkout/callback`

Payment-CallbackUrl

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


---

# Payment-CancellationReason

The reason for canceling the Payment.

**string**Payment-CancellationReason (string)

The reason for canceling the Payment.

**Possible values:** \[`duplicated`, `fraudulent`, `requested_by_customer`]

**Example:&#x20;**`null`

Payment-CancellationReason

```
null
```


---

# Payment-CancelUrl

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

**string**Payment-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:&#x20;**`https://example.com/checkout/cancel`

Payment-CancelUrl

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


---

# Payment-CompleteUrl

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

**string**Payment-CompleteUrl (string)

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

**Example:&#x20;**`https://example.com/checkout/complete`

Payment-CompleteUrl

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


---

# Payment-Currency

Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase. Must be a supported currency.

**string**Payment-Currency (string)

Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase. Must be a supported currency.

**Example:&#x20;**`EUR`

Payment-Currency

```
"EUR"
```


---

# Payment-Customer

**email**string

The customer's email address.

**Example:&#x20;**`john.doe@example.com`

**name**string

The customer's full name or business name.

**Example:&#x20;**`John Doe`

**phone**string

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

**Example:&#x20;**`null`

Payment-Customer

```
{
  "email": "john.doe@example.com",
  "name": "John Doe",
  "phone": null
}
```


---

# Payment-Description

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

**string**Payment-Description (string)

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

**Example:&#x20;**`Test Shop - #84370745531439`

Payment-Description

```
"Test Shop - #84370745531439"
```


---

# Payment-ExpireAt

Payment expiration time.

**number**number\<int64>

Payment expiration time.

**Example:&#x20;**`1663581391`

Payment-ExpireAt

```
1663581391
```


---

# Payment-FailUrl

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.

**string**Payment-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:&#x20;**`https://example.com/checkout/fail`

Payment-FailUrl

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


---

# Payment-GeneratePaymentToken

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

**boolean**Payment-GeneratePaymentToken (boolean)

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

**Default value:&#x20;**`false`

**Example:&#x20;**`false`

Payment-GeneratePaymentToken

```
false
```


---

# Payment-Id

Unique identifier for the payment.

**string**Payment-Id (string)

Unique identifier for the payment.

**Example:&#x20;**`af6029f80f5fc73a8ad2753eea0b1be0`

Payment-Id

```
"af6029f80f5fc73a8ad2753eea0b1be0"
```


---

# Payment-LastRefundAmount

Amount in cents refunded in the last transaction.

**integer**integer\<int32>

Amount in cents refunded in the last transaction.

**Example:&#x20;**`null`

Payment-LastRefundAmount

```
null
```


---

# Payment-LastRefundReason

The reason of the last refund transaction.

**string**Payment-LastRefundReason (string)

The reason of the last refund transaction.

**Possible values:** \[`duplicated`, `fraudulent`, `requested_by_customer`]

**Example:&#x20;**`null`

Payment-LastRefundReason

```
null
```


---

# Payment-MessageChannel

The channel used to send the payment message.

**string**Payment-MessageChannel (string)

The channel used to send the payment message.

| Enum Value | Description                       |
| ---------- | --------------------------------- |
| EMAIL      | Send message via email            |
| WHATSAPP   | Send message via WhatsApp         |
| SMS        | Send message via SMS text message |

**Possible values:** \[`EMAIL`, `WHATSAPP`, `SMS`]

**Example:&#x20;**`EMAIL`

Payment-MessageChannel

```
"EMAIL"
```


---

# Payment-MessageLanguage

The language of message sent to the customer. If not provided the default customer language is used if available.

**string**Payment-MessageLanguage (string)

The language of message sent to the customer. If not provided the default customer language is used if available.

| Enum Value | Description |
| ---------- | ----------- |
| en         | English     |
| es         | Spanish     |
| ca         | Catalan     |
| pt         | Portuguese  |
| de         | German      |
| it         | Italian     |
| fr         | French      |

**Possible values:** \[`en`, `es`, `ca`, `pt`, `de`, `it`, `fr`]

**Example:&#x20;**`en`

Payment-MessageLanguage

```
"en"
```


---

# Payment-NextAction

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.

**type**string

* `CONFIRM` - Your customer needs to be redirected to a [hosted payment page](https://docs.monei.com/integrations/use-prebuilt-payment-page/) or confirm payment using [payment token](https://docs.monei.com/integrations/build-custom-checkout/#3-confirm-the-payment-client-side). 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:&#x20;**`CONFIRM`

**mustRedirect**boolean

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

**Example:&#x20;**`false`

**redirectUrl**string

Redirect your customer to this url to continue payment process.

**Example:&#x20;**`https://secure.monei.com/payments/af6029f80f5fc73a8ad2753eea0b1be0`

Payment-NextAction

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


---

# Payment-OrderId

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

**string**Payment-OrderId (string)

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

**Example:&#x20;**`14379133960355`

Payment-OrderId

```
"14379133960355"
```


---

# Payment-PaymentMethod

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

**method**string

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:&#x20;**`card`

**card** <!-- -->object

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

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**brand**string

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:&#x20;**`visa`

**type**string

Card type `debit` or `credit`.

**Possible values:** \[`debit`, `credit`]

**Example:&#x20;**`credit`

**threeDSecure**boolean

Whether this transaction used 3D Secure authentication.

**Example:&#x20;**`false`

**threeDSecureVersion**string

The protocol version of the 3DS challenge.

**Example:&#x20;**`2.1.0`

**threeDSecureFlow**string

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:&#x20;**`CHALLENGE`

**expiration**integer\<int64>

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

**Example:&#x20;**`2048544000`

**last4**string

The last four digits of the card.

**Example:&#x20;**`0004`

**fingerprint**string

Unique identifier for the card number. Used to detect duplicate payment methods across customers. Not present for tokenized cards.

**Example:&#x20;**`7f2afde1566286c5fb126bb7e79bef549755cce6033dc429013c46d1365ff0e9`

**tokenizationMethod**string

The digital wallet used to tokenize the card.

**Possible values:** \[`applePay`, `googlePay`, `clickToPay`]

**Example:&#x20;**`applePay`

**cardholderName**string

The name of the cardholder.

**Example:&#x20;**`John Doe`

**cardholderEmail**string

The email of the cardholder.

**Example:&#x20;**`email@example.com`

**bizum** <!-- -->object

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

**phoneNumber**string

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

**Example:&#x20;**`null`

**paypal** <!-- -->object

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

**orderId**string

The Paypal's order ID.

**Example:&#x20;**`7XP21983KL5672104`

**payerId**string

The Paypal's payer ID.

**Example:&#x20;**`QWRTNBFHZXLPD`

**email**string

The Paypal's payer email.

**Example:&#x20;**`john.doe@example.com`

**name**string

The Paypal's payer name.

**Example:&#x20;**`John Doe`

**mbway** <!-- -->object

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

**phoneNumber**string

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

**Example:&#x20;**`null`

**trustly** <!-- -->object

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

**customerId**string

The Trustly's customer ID.

**Example:&#x20;**`null`

**sepa** <!-- -->object

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

**accountholderAddress**string

The address of the account holder.

**Example:&#x20;**`null`

**accountholderEmail**string

The email of the account holder.

**Example:&#x20;**`null`

**accountholderName**string

The name of the account holder.

**Example:&#x20;**`null`

**countryCode**string

The country code of the account holder.

**Example:&#x20;**`null`

**bankAddress**string

The address of the bank.

**Example:&#x20;**`null`

**bankCode**string

The code of the bank.

**Example:&#x20;**`null`

**bankName**string

The name of the bank.

**Example:&#x20;**`null`

**bic**string

The BIC of the bank.

**Example:&#x20;**`null`

**last4**string

The last 4 digits of the IBAN.

**Example:&#x20;**`null`

**fingerprint**string

Unique identifier for the IBAN. Used to detect duplicate payment methods across customers.

**Example:&#x20;**`7f2afde1566286c5fb126bb7e79bef549755cce6033dc429013c46d1365ff0e9`

**klarna** <!-- -->object

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

**billingCategory**string

| 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:&#x20;**`PAY_LATER`

**authPaymentMethod**string

| 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:&#x20;**`card`

Payment-PaymentMethod

```
{
  "method": "card",
  "card": {
    "country": "ES",
    "brand": "visa",
    "type": "credit",
    "threeDSecure": false,
    "threeDSecureVersion": "2.1.0",
    "threeDSecureFlow": "CHALLENGE",
    "expiration": 2048544000,
    "last4": "0004",
    "fingerprint": "7f2afde1566286c5fb126bb7e79bef549755cce6033dc429013c46d1365ff0e9",
    "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,
    "fingerprint": "7f2afde1566286c5fb126bb7e79bef549755cce6033dc429013c46d1365ff0e9"
  },
  "klarna": {
    "billingCategory": "PAY_LATER",
    "authPaymentMethod": "card"
  }
}
```


---

# Payment-PaymentMethodBizum

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

**phoneNumber**string

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

**Example:&#x20;**`null`

Payment-PaymentMethodBizum

```
{
  "phoneNumber": null
}
```


---

# Payment-PaymentMethodBizumInput

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.

**phoneNumber**string

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

**Example:&#x20;**`null`

Payment-PaymentMethodBizumInput

```
{
  "phoneNumber": null
}
```


---

# Payment-PaymentMethodCard

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

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**brand**string

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:&#x20;**`visa`

**type**string

Card type `debit` or `credit`.

**Possible values:** \[`debit`, `credit`]

**Example:&#x20;**`credit`

**threeDSecure**boolean

Whether this transaction used 3D Secure authentication.

**Example:&#x20;**`false`

**threeDSecureVersion**string

The protocol version of the 3DS challenge.

**Example:&#x20;**`2.1.0`

**threeDSecureFlow**string

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:&#x20;**`CHALLENGE`

**expiration**integer\<int64>

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

**Example:&#x20;**`2048544000`

**last4**string

The last four digits of the card.

**Example:&#x20;**`0004`

**fingerprint**string

Unique identifier for the card number. Used to detect duplicate payment methods across customers. Not present for tokenized cards.

**Example:&#x20;**`7f2afde1566286c5fb126bb7e79bef549755cce6033dc429013c46d1365ff0e9`

**tokenizationMethod**string

The digital wallet used to tokenize the card.

**Possible values:** \[`applePay`, `googlePay`, `clickToPay`]

**Example:&#x20;**`applePay`

**cardholderName**string

The name of the cardholder.

**Example:&#x20;**`John Doe`

**cardholderEmail**string

The email of the cardholder.

**Example:&#x20;**`email@example.com`

Payment-PaymentMethodCard

```
{
  "country": "ES",
  "brand": "visa",
  "type": "credit",
  "threeDSecure": false,
  "threeDSecureVersion": "2.1.0",
  "threeDSecureFlow": "CHALLENGE",
  "expiration": 2048544000,
  "last4": "0004",
  "fingerprint": "7f2afde1566286c5fb126bb7e79bef549755cce6033dc429013c46d1365ff0e9",
  "tokenizationMethod": "applePay",
  "cardholderName": "John Doe",
  "cardholderEmail": "email@example.com"
}
```


---

# Payment-PaymentMethodCardInput

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

**number**string

The card number, as a string without any separators.

**cvc**string

Card security code.

**expMonth**string

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

**expYear**string

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

**cardholderName**CardholderName (string)

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

**Example:&#x20;**`John Doe`

**cardholderEmail**CardholderEmail (string)

The cardholder's email address.

**Example:&#x20;**`john.doe@monei.com`

Payment-PaymentMethodCardInput

```
{
  "number": "string",
  "cvc": "string",
  "expMonth": "string",
  "expYear": "string",
  "cardholderName": "John Doe",
  "cardholderEmail": "john.doe@monei.com"
}
```


---

# Payment-PaymentMethodInput

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](https://www.investopedia.com/terms/p/pci-compliance.asp).

**card** <!-- -->object

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

**number**string

The card number, as a string without any separators.

**cvc**string

Card security code.

**expMonth**string

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

**expYear**string

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

**cardholderName**CardholderName (string)

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

**Example:&#x20;**`John Doe`

**cardholderEmail**CardholderEmail (string)

The cardholder's email address.

**Example:&#x20;**`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.

**phoneNumber**string

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

**Example:&#x20;**`null`

Payment-PaymentMethodInput

```
{
  "card": {
    "number": "string",
    "cvc": "string",
    "expMonth": "string",
    "expYear": "string",
    "cardholderName": "John Doe",
    "cardholderEmail": "john.doe@monei.com"
  },
  "bizum": {
    "phoneNumber": null
  }
}
```


---

# Payment-PaymentMethodKlarna

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

**billingCategory**string

| 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:&#x20;**`PAY_LATER`

**authPaymentMethod**string

| 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:&#x20;**`card`

Payment-PaymentMethodKlarna

```
{
  "billingCategory": "PAY_LATER",
  "authPaymentMethod": "card"
}
```


---

# Payment-PaymentMethodMbway

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

**phoneNumber**string

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

**Example:&#x20;**`null`

Payment-PaymentMethodMbway

```
{
  "phoneNumber": null
}
```


---

# Payment-PaymentMethodPaypal

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

**orderId**string

The Paypal's order ID.

**Example:&#x20;**`7XP21983KL5672104`

**payerId**string

The Paypal's payer ID.

**Example:&#x20;**`QWRTNBFHZXLPD`

**email**string

The Paypal's payer email.

**Example:&#x20;**`john.doe@example.com`

**name**string

The Paypal's payer name.

**Example:&#x20;**`John Doe`

Payment-PaymentMethodPaypal

```
{
  "orderId": "7XP21983KL5672104",
  "payerId": "QWRTNBFHZXLPD",
  "email": "john.doe@example.com",
  "name": "John Doe"
}
```


---

# Payment-PaymentMethods

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

* Array \[

****string

* ]

Payment-PaymentMethods

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


---

# Payment-PaymentMethodSepa

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

**accountholderAddress**string

The address of the account holder.

**Example:&#x20;**`null`

**accountholderEmail**string

The email of the account holder.

**Example:&#x20;**`null`

**accountholderName**string

The name of the account holder.

**Example:&#x20;**`null`

**countryCode**string

The country code of the account holder.

**Example:&#x20;**`null`

**bankAddress**string

The address of the bank.

**Example:&#x20;**`null`

**bankCode**string

The code of the bank.

**Example:&#x20;**`null`

**bankName**string

The name of the bank.

**Example:&#x20;**`null`

**bic**string

The BIC of the bank.

**Example:&#x20;**`null`

**last4**string

The last 4 digits of the IBAN.

**Example:&#x20;**`null`

**fingerprint**string

Unique identifier for the IBAN. Used to detect duplicate payment methods across customers.

**Example:&#x20;**`7f2afde1566286c5fb126bb7e79bef549755cce6033dc429013c46d1365ff0e9`

Payment-PaymentMethodSepa

```
{
  "accountholderAddress": null,
  "accountholderEmail": null,
  "accountholderName": null,
  "countryCode": null,
  "bankAddress": null,
  "bankCode": null,
  "bankName": null,
  "bic": null,
  "last4": null,
  "fingerprint": "7f2afde1566286c5fb126bb7e79bef549755cce6033dc429013c46d1365ff0e9"
}
```


---

# Payment-PaymentMethodTrustly

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

**customerId**string

The Trustly's customer ID.

**Example:&#x20;**`null`

Payment-PaymentMethodTrustly

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


---

# Payment-PaymentToken

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.

**string**Payment-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:&#x20;**`7cc38b08ff471ccd313ad62b23b9f362b107560b`

Payment-PaymentToken

```
"7cc38b08ff471ccd313ad62b23b9f362b107560b"
```


---

# Payment-PointOfSaleId

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.

**string**Payment-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:&#x20;**`fb269cccfa0cc021f5d0b8eb1421646c696213e1`

Payment-PointOfSaleId

```
"fb269cccfa0cc021f5d0b8eb1421646c696213e1"
```


---

# Payment-RefundedAmount

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

**integer**integer\<int32>

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

**Example:&#x20;**`null`

Payment-RefundedAmount

```
null
```


---

# Payment-RefundReason

The reason for refunding the Payment.

**string**Payment-RefundReason (string)

The reason for refunding the Payment.

**Possible values:** \[`duplicated`, `fraudulent`, `requested_by_customer`]

**Example:&#x20;**`null`

Payment-RefundReason

```
null
```


---

# Payment-Sequence

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`).

**type**stringrequired

**Possible values:** \[`recurring`]

**Example:&#x20;**`recurring`

**recurring** <!-- -->object

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

**expiry**string

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

**Default value:&#x20;**`*(The payment method or card expiration)*`

**Example:&#x20;**`20210630`

**frequency**integer\<int32>

The minimum number of **days** between the different recurring payments.

**Default value:&#x20;**`25`

**Example:&#x20;**`30`

Payment-Sequence

```
{
  "type": "recurring",
  "recurring": {
    "expiry": "20210630",
    "frequency": 30
  }
}
```


---

# Payment-SequenceId

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.

**string**Payment-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:&#x20;**`62b23b9f3627cc38b08ff471ccd313ad`

Payment-SequenceId

```
"62b23b9f3627cc38b08ff471ccd313ad"
```


---

# Payment-SequenceRecurring

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

**expiry**string

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

**Default value:&#x20;**`*(The payment method or card expiration)*`

**Example:&#x20;**`20210630`

**frequency**integer\<int32>

The minimum number of **days** between the different recurring payments.

**Default value:&#x20;**`25`

**Example:&#x20;**`30`

Payment-SequenceRecurring

```
{
  "expiry": "20210630",
  "frequency": 30
}
```


---

# Payment-SessionDetails

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

**ip**IP (string)

The IP address where the operation originated.

**Example:&#x20;**`100.100.200.100`

**countryCode**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**lang**Lang (string)

Two-letter language code ([ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1)).

**Example:&#x20;**`es`

**deviceType**DeviceType (string)

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

**Example:&#x20;**`desktop`

**deviceModel**DeviceModel (string)

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

**Example:&#x20;**`null`

**browser**Browser (string)

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

**Example:&#x20;**`Chrome`

**browserVersion**BrowserVersion (string)

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

**Example:&#x20;**`83.0.4103.116`

**os**Os (string)

Operation system (e.g., `iOS`).

**Example:&#x20;**`Mac OS`

**osVersion**OsVersion (string)

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

**Example:&#x20;**`10.15.4`

**source**Source (string)

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

**Example:&#x20;**`MONEI/PHP`

**sourceVersion**SourceVersion (string)

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

**Example:&#x20;**`0.1.2`

**userAgent**UserAgent (string)

Full user agent string of the browser session.

**Example:&#x20;**`Mozilla/5.0 (Windows NT 10.0; Win64; x64) ...`

**browserAccept**BrowserAccept (string)

Browser accept header.

**Example:&#x20;**`text/html,application/xhtml+xml,application/json`

**browserColorDepth**BrowserColorDepth (string)

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

**Example:&#x20;**`24`

**browserScreenHeight**BrowserScreenHeight (string)

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

**Example:&#x20;**`1152`

**browserScreenWidth**BrowserScreenWidth (string)

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

**Example:&#x20;**`2048`

**browserTimezoneOffset**BrowserTimezoneOffset (string)

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

**Example:&#x20;**`-120`

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


---

# Payment-SessionId

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.

**string**Payment-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:&#x20;**`39603551437913`

Payment-SessionId

```
"39603551437913"
```


---

# Payment-ShippingDetails

Shipping information associated with the payment.

**name**string

The shipping customer's full name.

**Example:&#x20;**`John Doe`

**email**string

The shipping customer's email address.

**Example:&#x20;**`john.doe@example.com`

**phone**string

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

**Example:&#x20;**`null`

**company**string

Name of the company where the shipment is going.

**Example:&#x20;**`null`

**taxId**string

Company tax ID.

**Example:&#x20;**`null`

**address** <!-- -->object

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**city**string

City, district, suburb, town, or village.

**Example:&#x20;**`Málaga`

**line1**string

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

**Example:&#x20;**`Fake Street 123`

**line2**string

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

**Example:&#x20;**`null`

**zip**string

ZIP or postal code.

**Example:&#x20;**`1234`

**state**string

State, county, province, or region.

**Example:&#x20;**`Málaga`

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


---

# Payment-Shop

The information about the shop (used in [hosted payment page](https://docs.monei.com/integrations/use-prebuilt-payment-page/)).

**name**string

The shop name.

**Example:&#x20;**`Test Shop`

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

Payment-Shop

```
{
  "name": "Test Shop",
  "country": "ES"
}
```


---

# Payment-Status

The status of the payment.

**string**Payment-Status (string)

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:&#x20;**`PENDING`

Payment-Status

```
"PENDING"
```


---

# Payment-StatusCode

Payment status code.

**string**Payment-StatusCode (string)

Payment status code.

**Example:&#x20;**`E000`

Payment-StatusCode

```
"E000"
```


---

# Payment-StatusMessage

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

**string**Payment-StatusMessage (string)

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

**Example:&#x20;**`Transaction approved`

Payment-StatusMessage

```
"Transaction approved"
```


---

# Payment-StoreId

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

**string**Payment-StoreId (string)

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

**Example:&#x20;**`e5f28150d9e8974c58ab5ec9c4a880f8734dcf05`

Payment-StoreId

```
"e5f28150d9e8974c58ab5ec9c4a880f8734dcf05"
```


---

# Payment-SubscriptionId

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

**string**Payment-SubscriptionId (string)

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

**Example:&#x20;**`575bcd84-09fc-4a6e-8c4c-f88b8eb90bfa`

Payment-SubscriptionId

```
"575bcd84-09fc-4a6e-8c4c-f88b8eb90bfa"
```


---

# Payment-TraceDetails

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

**ip**IP (string)

The IP address where the operation originated.

**Example:&#x20;**`100.100.200.100`

**countryCode**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**lang**Lang (string)

Two-letter language code ([ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1)).

**Example:&#x20;**`es`

**deviceType**DeviceType (string)

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

**Example:&#x20;**`desktop`

**deviceModel**DeviceModel (string)

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

**Example:&#x20;**`null`

**browser**Browser (string)

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

**Example:&#x20;**`Chrome`

**browserVersion**BrowserVersion (string)

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

**Example:&#x20;**`83.0.4103.116`

**os**Os (string)

Operation system (e.g., `iOS`).

**Example:&#x20;**`Mac OS`

**osVersion**OsVersion (string)

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

**Example:&#x20;**`10.15.4`

**source**Source (string)

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

**Example:&#x20;**`MONEI/PHP`

**sourceVersion**SourceVersion (string)

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

**Example:&#x20;**`0.1.2`

**userAgent**UserAgent (string)

Full user agent string of the browser session.

**Example:&#x20;**`Mozilla/5.0 (Windows NT 10.0; Win64; x64) ...`

**browserAccept**BrowserAccept (string)

Browser accept header.

**Example:&#x20;**`text/html,application/xhtml+xml,application/json`

**browserColorDepth**BrowserColorDepth (string)

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

**Example:&#x20;**`24`

**browserScreenHeight**BrowserScreenHeight (string)

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

**Example:&#x20;**`1152`

**browserScreenWidth**BrowserScreenWidth (string)

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

**Example:&#x20;**`2048`

**browserTimezoneOffset**BrowserTimezoneOffset (string)

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

**Example:&#x20;**`-120`

**userId**string

The ID of the user that started the operation.

**Example:&#x20;**`null`

**userEmail**string

The email of the user that started the operation.

**Example:&#x20;**`user@example.com`

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


---

# Payment-TransactionType

Controls when the funds will be captured.

**string**Payment-TransactionType (string)

Controls when the funds will be captured.

| Enum Value | Description                                                                  |
| ---------- | ---------------------------------------------------------------------------- |
| SALE       | Automatically captures funds when the customer authorizes the payment        |
| AUTH       | Places a hold on funds without immediate capture, allowing for later capture |
| PAYOUT     | Sends funds to the customer                                                  |
| VERIF      | Verifies the payment method without placing a hold or capturing funds        |

**Possible values:** \[`SALE`, `AUTH`, `PAYOUT`, `VERIF`]

**Default value:&#x20;**`SALE`

**Example:&#x20;**`SALE`

Payment-TransactionType

```
"SALE"
```


---

# Payment

**id**Payment-Id (string)required

Unique identifier for the payment.

**Example:&#x20;**`af6029f80f5fc73a8ad2753eea0b1be0`

**amount**integer\<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:&#x20;**`110`

**currency**Payment-Currency (string)required

Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase. Must be a supported currency.

**Example:&#x20;**`EUR`

**orderId**Payment-OrderId (string)

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

**Example:&#x20;**`14379133960355`

**description**Payment-Description (string)

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

**Example:&#x20;**`Test Shop - #84370745531439`

**accountId**AccountId (string)required

MONEI Account identifier.

**Example:&#x20;**`aa9333ba-82de-400c-9ae7-087b9f8d2242`

**authorizationCode**Payment-AuthorizationCode (string)

Unique identifier provided by the bank performing transaction.

**Example:&#x20;**`475816`

**livemode**Livemode (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:&#x20;**`false`

**status**Payment-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:&#x20;**`PENDING`

**statusCode**Payment-StatusCode (string)

Payment status code.

**Example:&#x20;**`E000`

**statusMessage**Payment-StatusMessage (string)

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

**Example:&#x20;**`Transaction approved`

**customer** <!-- -->object

**email**string

The customer's email address.

**Example:&#x20;**`john.doe@example.com`

**name**string

The customer's full name or business name.

**Example:&#x20;**`John Doe`

**phone**string

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

**Example:&#x20;**`null`

**shop** <!-- -->object

The information about the shop (used in [hosted payment page](https://docs.monei.com/integrations/use-prebuilt-payment-page/)).

**name**string

The shop name.

**Example:&#x20;**`Test Shop`

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**billingDetails** <!-- -->object

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

**name**string

The customer's billing full name.

**Example:&#x20;**`John Doe`

**email**string

The customer's billing email address.

**Example:&#x20;**`john.doe@example.com`

**phone**string

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

**Example:&#x20;**`null`

**company**string

Billing company name.

**Example:&#x20;**`null`

**taxId**string

Company tax ID.

**Example:&#x20;**`null`

**address** <!-- -->object

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**city**string

City, district, suburb, town, or village.

**Example:&#x20;**`Málaga`

**line1**string

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

**Example:&#x20;**`Fake Street 123`

**line2**string

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

**Example:&#x20;**`null`

**zip**string

ZIP or postal code.

**Example:&#x20;**`1234`

**state**string

State, county, province, or region.

**Example:&#x20;**`Málaga`

**shippingDetails** <!-- -->object

Shipping information associated with the payment.

**name**string

The shipping customer's full name.

**Example:&#x20;**`John Doe`

**email**string

The shipping customer's email address.

**Example:&#x20;**`john.doe@example.com`

**phone**string

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

**Example:&#x20;**`null`

**company**string

Name of the company where the shipment is going.

**Example:&#x20;**`null`

**taxId**string

Company tax ID.

**Example:&#x20;**`null`

**address** <!-- -->object

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**city**string

City, district, suburb, town, or village.

**Example:&#x20;**`Málaga`

**line1**string

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

**Example:&#x20;**`Fake Street 123`

**line2**string

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

**Example:&#x20;**`null`

**zip**string

ZIP or postal code.

**Example:&#x20;**`1234`

**state**string

State, county, province, or region.

**Example:&#x20;**`Málaga`

**refundedAmount**integer\<int32>

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

**Example:&#x20;**`null`

**lastRefundAmount**integer\<int32>

Amount in cents refunded in the last transaction.

**Example:&#x20;**`null`

**lastRefundReason**Payment-LastRefundReason (string)

The reason of the last refund transaction.

**Possible values:** \[`duplicated`, `fraudulent`, `requested_by_customer`]

**Example:&#x20;**`null`

**cancellationReason**Payment-CancellationReason (string)

The reason for canceling the Payment.

**Possible values:** \[`duplicated`, `fraudulent`, `requested_by_customer`]

**Example:&#x20;**`null`

**sessionDetails** <!-- -->Payment-SessionDetails

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

**ip**IP (string)

The IP address where the operation originated.

**Example:&#x20;**`100.100.200.100`

**countryCode**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**lang**Lang (string)

Two-letter language code ([ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1)).

**Example:&#x20;**`es`

**deviceType**DeviceType (string)

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

**Example:&#x20;**`desktop`

**deviceModel**DeviceModel (string)

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

**Example:&#x20;**`null`

**browser**Browser (string)

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

**Example:&#x20;**`Chrome`

**browserVersion**BrowserVersion (string)

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

**Example:&#x20;**`83.0.4103.116`

**os**Os (string)

Operation system (e.g., `iOS`).

**Example:&#x20;**`Mac OS`

**osVersion**OsVersion (string)

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

**Example:&#x20;**`10.15.4`

**source**Source (string)

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

**Example:&#x20;**`MONEI/PHP`

**sourceVersion**SourceVersion (string)

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

**Example:&#x20;**`0.1.2`

**userAgent**UserAgent (string)

Full user agent string of the browser session.

**Example:&#x20;**`Mozilla/5.0 (Windows NT 10.0; Win64; x64) ...`

**browserAccept**BrowserAccept (string)

Browser accept header.

**Example:&#x20;**`text/html,application/xhtml+xml,application/json`

**browserColorDepth**BrowserColorDepth (string)

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

**Example:&#x20;**`24`

**browserScreenHeight**BrowserScreenHeight (string)

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

**Example:&#x20;**`1152`

**browserScreenWidth**BrowserScreenWidth (string)

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

**Example:&#x20;**`2048`

**browserTimezoneOffset**BrowserTimezoneOffset (string)

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

**Example:&#x20;**`-120`

**traceDetails** <!-- -->Payment-TraceDetails

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

**ip**IP (string)

The IP address where the operation originated.

**Example:&#x20;**`100.100.200.100`

**countryCode**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**lang**Lang (string)

Two-letter language code ([ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1)).

**Example:&#x20;**`es`

**deviceType**DeviceType (string)

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

**Example:&#x20;**`desktop`

**deviceModel**DeviceModel (string)

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

**Example:&#x20;**`null`

**browser**Browser (string)

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

**Example:&#x20;**`Chrome`

**browserVersion**BrowserVersion (string)

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

**Example:&#x20;**`83.0.4103.116`

**os**Os (string)

Operation system (e.g., `iOS`).

**Example:&#x20;**`Mac OS`

**osVersion**OsVersion (string)

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

**Example:&#x20;**`10.15.4`

**source**Source (string)

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

**Example:&#x20;**`MONEI/PHP`

**sourceVersion**SourceVersion (string)

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

**Example:&#x20;**`0.1.2`

**userAgent**UserAgent (string)

Full user agent string of the browser session.

**Example:&#x20;**`Mozilla/5.0 (Windows NT 10.0; Win64; x64) ...`

**browserAccept**BrowserAccept (string)

Browser accept header.

**Example:&#x20;**`text/html,application/xhtml+xml,application/json`

**browserColorDepth**BrowserColorDepth (string)

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

**Example:&#x20;**`24`

**browserScreenHeight**BrowserScreenHeight (string)

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

**Example:&#x20;**`1152`

**browserScreenWidth**BrowserScreenWidth (string)

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

**Example:&#x20;**`2048`

**browserTimezoneOffset**BrowserTimezoneOffset (string)

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

**Example:&#x20;**`-120`

**userId**string

The ID of the user that started the operation.

**Example:&#x20;**`null`

**userEmail**string

The email of the user that started the operation.

**Example:&#x20;**`user@example.com`

**paymentToken**Payment-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:&#x20;**`7cc38b08ff471ccd313ad62b23b9f362b107560b`

**paymentMethod** <!-- -->object

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

**method**string

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:&#x20;**`card`

**card** <!-- -->object

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

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**brand**string

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:&#x20;**`visa`

**type**string

Card type `debit` or `credit`.

**Possible values:** \[`debit`, `credit`]

**Example:&#x20;**`credit`

**threeDSecure**boolean

Whether this transaction used 3D Secure authentication.

**Example:&#x20;**`false`

**threeDSecureVersion**string

The protocol version of the 3DS challenge.

**Example:&#x20;**`2.1.0`

**threeDSecureFlow**string

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:&#x20;**`CHALLENGE`

**expiration**integer\<int64>

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

**Example:&#x20;**`2048544000`

**last4**string

The last four digits of the card.

**Example:&#x20;**`0004`

**fingerprint**string

Unique identifier for the card number. Used to detect duplicate payment methods across customers. Not present for tokenized cards.

**Example:&#x20;**`7f2afde1566286c5fb126bb7e79bef549755cce6033dc429013c46d1365ff0e9`

**tokenizationMethod**string

The digital wallet used to tokenize the card.

**Possible values:** \[`applePay`, `googlePay`, `clickToPay`]

**Example:&#x20;**`applePay`

**cardholderName**string

The name of the cardholder.

**Example:&#x20;**`John Doe`

**cardholderEmail**string

The email of the cardholder.

**Example:&#x20;**`email@example.com`

**bizum** <!-- -->object

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

**phoneNumber**string

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

**Example:&#x20;**`null`

**paypal** <!-- -->object

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

**orderId**string

The Paypal's order ID.

**Example:&#x20;**`7XP21983KL5672104`

**payerId**string

The Paypal's payer ID.

**Example:&#x20;**`QWRTNBFHZXLPD`

**email**string

The Paypal's payer email.

**Example:&#x20;**`john.doe@example.com`

**name**string

The Paypal's payer name.

**Example:&#x20;**`John Doe`

**mbway** <!-- -->object

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

**phoneNumber**string

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

**Example:&#x20;**`null`

**trustly** <!-- -->object

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

**customerId**string

The Trustly's customer ID.

**Example:&#x20;**`null`

**sepa** <!-- -->object

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

**accountholderAddress**string

The address of the account holder.

**Example:&#x20;**`null`

**accountholderEmail**string

The email of the account holder.

**Example:&#x20;**`null`

**accountholderName**string

The name of the account holder.

**Example:&#x20;**`null`

**countryCode**string

The country code of the account holder.

**Example:&#x20;**`null`

**bankAddress**string

The address of the bank.

**Example:&#x20;**`null`

**bankCode**string

The code of the bank.

**Example:&#x20;**`null`

**bankName**string

The name of the bank.

**Example:&#x20;**`null`

**bic**string

The BIC of the bank.

**Example:&#x20;**`null`

**last4**string

The last 4 digits of the IBAN.

**Example:&#x20;**`null`

**fingerprint**string

Unique identifier for the IBAN. Used to detect duplicate payment methods across customers.

**Example:&#x20;**`7f2afde1566286c5fb126bb7e79bef549755cce6033dc429013c46d1365ff0e9`

**klarna** <!-- -->object

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

**billingCategory**string

| 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:&#x20;**`PAY_LATER`

**authPaymentMethod**string

| 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:&#x20;**`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`).

**type**stringrequired

**Possible values:** \[`recurring`]

**Example:&#x20;**`recurring`

**recurring** <!-- -->object

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

**expiry**string

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

**Default value:&#x20;**`*(The payment method or card expiration)*`

**Example:&#x20;**`20210630`

**frequency**integer\<int32>

The minimum number of **days** between the different recurring payments.

**Default value:&#x20;**`25`

**Example:&#x20;**`30`

**sequenceId**Payment-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:&#x20;**`62b23b9f3627cc38b08ff471ccd313ad`

**storeId**Payment-StoreId (string)

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

**Example:&#x20;**`e5f28150d9e8974c58ab5ec9c4a880f8734dcf05`

**pointOfSaleId**Payment-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:&#x20;**`fb269cccfa0cc021f5d0b8eb1421646c696213e1`

**metadata**object

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:&#x20;**`{"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.

**type**string

* `CONFIRM` - Your customer needs to be redirected to a [hosted payment page](https://docs.monei.com/integrations/use-prebuilt-payment-page/) or confirm payment using [payment token](https://docs.monei.com/integrations/build-custom-checkout/#3-confirm-the-payment-client-side). 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:&#x20;**`CONFIRM`

**mustRedirect**boolean

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

**Example:&#x20;**`false`

**redirectUrl**string

Redirect your customer to this url to continue payment process.

**Example:&#x20;**`https://secure.monei.com/payments/af6029f80f5fc73a8ad2753eea0b1be0`

**createdAt**integer\<int64>

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

**Example:&#x20;**`1636366897`

**updatedAt**integer\<int64>

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

**Example:&#x20;**`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",
      "fingerprint": "7f2afde1566286c5fb126bb7e79bef549755cce6033dc429013c46d1365ff0e9",
      "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,
      "fingerprint": "7f2afde1566286c5fb126bb7e79bef549755cce6033dc429013c46d1365ff0e9"
    },
    "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
}
```


---

# PaymentMethods-Amount

The amount of the payment in the smallest currency unit. For example, 10 EUR = 1000 cents. Only present when querying by paymentId.

**integer**PaymentMethods-Amount (integer)

The amount of the payment in the smallest currency unit. For example, 10 EUR = 1000 cents. Only present when querying by paymentId.

**Example:&#x20;**`10`

PaymentMethods-Amount

```
10
```


---

# PaymentMethods-Currency

Three-letter ISO currency code, in uppercase. Only present when querying by paymentId.

**string**PaymentMethods-Currency (string)

Three-letter ISO currency code, in uppercase. Only present when querying by paymentId.

**Example:&#x20;**`EUR`

PaymentMethods-Currency

```
"EUR"
```


---

# PaymentMethods-MerchantName

The name of the merchant

**string**PaymentMethods-MerchantName (string)

The name of the merchant

**Example:&#x20;**`MONEI`

PaymentMethods-MerchantName

```
"MONEI"
```


---

# PaymentMethods-MerchantUrl

The URL of the merchant's website

**string**PaymentMethods-MerchantUrl (string)

The URL of the merchant's website

**Example:&#x20;**`https://monei.com/`

PaymentMethods-MerchantUrl

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


---

# PaymentMethods-Metadata

Additional configuration details for each payment method.

**alipay** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["CN"]`

**bancontact** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["BE"]`

**bizum** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["ES"]`

**blik** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["PL"]`

**card** <!-- -->object

**brands**string\[]

List of card brands supported

**Example:&#x20;**`["visa","mastercard"]`

**eps** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["AT"]`

**iDeal** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["NL"]`

**mbway** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["PT"]`

**multibanco** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["PT"]`

**sofort** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["AT","BE","DE","ES","IT","NL","CH","PL"]`

**trustly** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["DE","DK","EE","ES","FI","GB","LT","LV","NL","NO","PL","SE","SK"]`

**sepa** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["AT","BE","BG","HR","CY","CZ","DK","EE","FI","FR","DE","GR","HU","IE","IT","LV","LT","LU","MT","NL","PL","PT","RO","SK","SI","ES","SE","IS","LI","NO","AD","SM","MC","VA","PF","TF","GI","GG","IM","JE","BL","PM","CH","GB","WF"]`

**klarna** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["AT","BE","CH","DE","DK","ES","FI","FR","GB","IT","NL","NO","SE"]`

**giropay** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["DE"]`

**googlePay** <!-- -->object

**merchantId**string

Google Pay merchant ID

**Example:&#x20;**`12345678901234567890`

**cvcRequired**boolean

Whether CVC is required for Google Pay transactions

**Example:&#x20;**`false`

**applePay** <!-- -->object

**merchantId**string

Apple Pay merchant ID

**Example:&#x20;**`merchant.com.monei`

**clickToPay** <!-- -->object

**tokenSupport**boolean

Whether token support is enabled

**Example:&#x20;**`true`

**preselected**boolean

Whether the method is preselected

**Example:&#x20;**`false`

**visa** <!-- -->object

**srciDpaId**string

**Example:&#x20;**`f47ac10b-58cc-4372-a567-0e02b2c3d479`

**srcInitiatorId**string

**Example:&#x20;**`550e8400-e29b-41d4-a716-446655440000`

**mastercard** <!-- -->object

**srciDpaId**string

**Example:&#x20;**`6ba7b810-9dad-11d1-80b4-00c04fd430c8`

**srcInitiatorId**string

**Example:&#x20;**`a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11`

**discover** <!-- -->object

**srciDpaId**string

**Example:&#x20;**`71f0c4d5-9947-4d1c-9cb3-d6a3f7c4e701`

**srcInitiatorId**string

**Example:&#x20;**`c2d06c25-9ddb-4a5e-9d5a-3ff1c8d98467`

PaymentMethods-Metadata

```
{
  "alipay": {
    "countries": [
      "CN"
    ]
  },
  "bancontact": {
    "countries": [
      "BE"
    ]
  },
  "bizum": {
    "countries": [
      "ES"
    ]
  },
  "blik": {
    "countries": [
      "PL"
    ]
  },
  "card": {
    "brands": [
      "visa",
      "mastercard"
    ]
  },
  "eps": {
    "countries": [
      "AT"
    ]
  },
  "iDeal": {
    "countries": [
      "NL"
    ]
  },
  "mbway": {
    "countries": [
      "PT"
    ]
  },
  "multibanco": {
    "countries": [
      "PT"
    ]
  },
  "sofort": {
    "countries": [
      "AT",
      "BE",
      "DE",
      "ES",
      "IT",
      "NL",
      "CH",
      "PL"
    ]
  },
  "trustly": {
    "countries": [
      "DE",
      "DK",
      "EE",
      "ES",
      "FI",
      "GB",
      "LT",
      "LV",
      "NL",
      "NO",
      "PL",
      "SE",
      "SK"
    ]
  },
  "sepa": {
    "countries": [
      "AT",
      "BE",
      "BG",
      "HR",
      "CY",
      "CZ",
      "DK",
      "EE",
      "FI",
      "FR",
      "DE",
      "GR",
      "HU",
      "IE",
      "IT",
      "LV",
      "LT",
      "LU",
      "MT",
      "NL",
      "PL",
      "PT",
      "RO",
      "SK",
      "SI",
      "ES",
      "SE",
      "IS",
      "LI",
      "NO",
      "AD",
      "SM",
      "MC",
      "VA",
      "PF",
      "TF",
      "GI",
      "GG",
      "IM",
      "JE",
      "BL",
      "PM",
      "CH",
      "GB",
      "WF"
    ]
  },
  "klarna": {
    "countries": [
      "AT",
      "BE",
      "CH",
      "DE",
      "DK",
      "ES",
      "FI",
      "FR",
      "GB",
      "IT",
      "NL",
      "NO",
      "SE"
    ]
  },
  "giropay": {
    "countries": [
      "DE"
    ]
  },
  "googlePay": {
    "merchantId": "12345678901234567890",
    "cvcRequired": false
  },
  "applePay": {
    "merchantId": "merchant.com.monei"
  },
  "clickToPay": {
    "tokenSupport": true,
    "preselected": false,
    "visa": {
      "srciDpaId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "srcInitiatorId": "550e8400-e29b-41d4-a716-446655440000"
    },
    "mastercard": {
      "srciDpaId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "srcInitiatorId": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
    },
    "discover": {
      "srciDpaId": "71f0c4d5-9947-4d1c-9cb3-d6a3f7c4e701",
      "srcInitiatorId": "c2d06c25-9ddb-4a5e-9d5a-3ff1c8d98467"
    }
  }
}
```


---

# PaymentMethods-Methods

An array of available payment methods for the account or payment. Possible values include:

* `alipay` - Alipay
* `applePay` - Apple Pay
* `bancontact` - Bancontact
* `bizum` - Bizum
* `blik` - BLIK
* `card` - Credit or debit card
* `cardPresent` - Card present (physical POS)
* `clickToPay` - Click to Pay
* `eps` - EPS
* `giropay` - Giropay
* `googlePay` - Google Pay
* `iDeal` - iDEAL
* `klarna` - Klarna
* `mbway` - MB WAY
* `multibanco` - Multibanco
* `paypal` - PayPal
* `sepa` - SEPA Direct Debit
* `sofort` - Sofort
* `trustly` - Trustly

* Array \[

****string

**Possible values:** \[`alipay`, `applePay`, `bancontact`, `bizum`, `blik`, `card`, `cardPresent`, `clickToPay`, `eps`, `giropay`, `googlePay`, `iDeal`, `klarna`, `mbway`, `multibanco`, `paypal`, `sepa`, `sofort`, `trustly`]

* ]

PaymentMethods-Methods

```
[
  "bizum",
  "applePay",
  "googlePay",
  "alipay",
  "bancontact",
  "blik",
  "eps",
  "iDeal",
  "mbway",
  "multibanco",
  "sofort",
  "trustly",
  "sepa",
  "klarna",
  "giropay",
  "card"
]
```


---

# PaymentMethods

**livemode**Livemode (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:&#x20;**`false`

**paymentMethods**string\[]required

An array of available payment methods for the account or payment. Possible values include:

* `alipay` - Alipay
* `applePay` - Apple Pay
* `bancontact` - Bancontact
* `bizum` - Bizum
* `blik` - BLIK
* `card` - Credit or debit card
* `cardPresent` - Card present (physical POS)
* `clickToPay` - Click to Pay
* `eps` - EPS
* `giropay` - Giropay
* `googlePay` - Google Pay
* `iDeal` - iDEAL
* `klarna` - Klarna
* `mbway` - MB WAY
* `multibanco` - Multibanco
* `paypal` - PayPal
* `sepa` - SEPA Direct Debit
* `sofort` - Sofort
* `trustly` - Trustly

**Possible values:** \[`alipay`, `applePay`, `bancontact`, `bizum`, `blik`, `card`, `cardPresent`, `clickToPay`, `eps`, `giropay`, `googlePay`, `iDeal`, `klarna`, `mbway`, `multibanco`, `paypal`, `sepa`, `sofort`, `trustly`]

**Example:&#x20;**`["bizum","applePay","googlePay","alipay","bancontact","blik","eps","iDeal","mbway","multibanco","sofort","trustly","sepa","klarna","giropay","card"]`

**metadata** <!-- -->objectrequired

Additional configuration details for each payment method.

**alipay** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["CN"]`

**bancontact** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["BE"]`

**bizum** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["ES"]`

**blik** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["PL"]`

**card** <!-- -->object

**brands**string\[]

List of card brands supported

**Example:&#x20;**`["visa","mastercard"]`

**eps** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["AT"]`

**iDeal** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["NL"]`

**mbway** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["PT"]`

**multibanco** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["PT"]`

**sofort** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["AT","BE","DE","ES","IT","NL","CH","PL"]`

**trustly** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["DE","DK","EE","ES","FI","GB","LT","LV","NL","NO","PL","SE","SK"]`

**sepa** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["AT","BE","BG","HR","CY","CZ","DK","EE","FI","FR","DE","GR","HU","IE","IT","LV","LT","LU","MT","NL","PL","PT","RO","SK","SI","ES","SE","IS","LI","NO","AD","SM","MC","VA","PF","TF","GI","GG","IM","JE","BL","PM","CH","GB","WF"]`

**klarna** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["AT","BE","CH","DE","DK","ES","FI","FR","GB","IT","NL","NO","SE"]`

**giropay** <!-- -->object

**countries**string\[]

List of countries where the payment method is available

**Example:&#x20;**`["DE"]`

**googlePay** <!-- -->object

**merchantId**string

Google Pay merchant ID

**Example:&#x20;**`12345678901234567890`

**cvcRequired**boolean

Whether CVC is required for Google Pay transactions

**Example:&#x20;**`false`

**applePay** <!-- -->object

**merchantId**string

Apple Pay merchant ID

**Example:&#x20;**`merchant.com.monei`

**clickToPay** <!-- -->object

**tokenSupport**boolean

Whether token support is enabled

**Example:&#x20;**`true`

**preselected**boolean

Whether the method is preselected

**Example:&#x20;**`false`

**visa** <!-- -->object

**srciDpaId**string

**Example:&#x20;**`f47ac10b-58cc-4372-a567-0e02b2c3d479`

**srcInitiatorId**string

**Example:&#x20;**`550e8400-e29b-41d4-a716-446655440000`

**mastercard** <!-- -->object

**srciDpaId**string

**Example:&#x20;**`6ba7b810-9dad-11d1-80b4-00c04fd430c8`

**srcInitiatorId**string

**Example:&#x20;**`a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11`

**discover** <!-- -->object

**srciDpaId**string

**Example:&#x20;**`71f0c4d5-9947-4d1c-9cb3-d6a3f7c4e701`

**srcInitiatorId**string

**Example:&#x20;**`c2d06c25-9ddb-4a5e-9d5a-3ff1c8d98467`

**merchantName**PaymentMethods-MerchantName (string)required

The name of the merchant

**Example:&#x20;**`MONEI`

**merchantUrl**PaymentMethods-MerchantUrl (string)required

The URL of the merchant's website

**Example:&#x20;**`https://monei.com/`

**countryCode**Country (string)required

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**accountId**AccountId (string)

MONEI Account identifier.

**Example:&#x20;**`aa9333ba-82de-400c-9ae7-087b9f8d2242`

**amount**PaymentMethods-Amount (integer)

The amount of the payment in the smallest currency unit. For example, 10 EUR = 1000 cents. Only present when querying by paymentId.

**Example:&#x20;**`10`

**currency**PaymentMethods-Currency (string)

Three-letter ISO currency code, in uppercase. Only present when querying by paymentId.

**Example:&#x20;**`EUR`

PaymentMethods

```
{
  "livemode": false,
  "paymentMethods": [
    "bizum",
    "applePay",
    "googlePay",
    "alipay",
    "bancontact",
    "blik",
    "eps",
    "iDeal",
    "mbway",
    "multibanco",
    "sofort",
    "trustly",
    "sepa",
    "klarna",
    "giropay",
    "card"
  ],
  "metadata": {
    "alipay": {
      "countries": [
        "CN"
      ]
    },
    "bancontact": {
      "countries": [
        "BE"
      ]
    },
    "bizum": {
      "countries": [
        "ES"
      ]
    },
    "blik": {
      "countries": [
        "PL"
      ]
    },
    "card": {
      "brands": [
        "visa",
        "mastercard"
      ]
    },
    "eps": {
      "countries": [
        "AT"
      ]
    },
    "iDeal": {
      "countries": [
        "NL"
      ]
    },
    "mbway": {
      "countries": [
        "PT"
      ]
    },
    "multibanco": {
      "countries": [
        "PT"
      ]
    },
    "sofort": {
      "countries": [
        "AT",
        "BE",
        "DE",
        "ES",
        "IT",
        "NL",
        "CH",
        "PL"
      ]
    },
    "trustly": {
      "countries": [
        "DE",
        "DK",
        "EE",
        "ES",
        "FI",
        "GB",
        "LT",
        "LV",
        "NL",
        "NO",
        "PL",
        "SE",
        "SK"
      ]
    },
    "sepa": {
      "countries": [
        "AT",
        "BE",
        "BG",
        "HR",
        "CY",
        "CZ",
        "DK",
        "EE",
        "FI",
        "FR",
        "DE",
        "GR",
        "HU",
        "IE",
        "IT",
        "LV",
        "LT",
        "LU",
        "MT",
        "NL",
        "PL",
        "PT",
        "RO",
        "SK",
        "SI",
        "ES",
        "SE",
        "IS",
        "LI",
        "NO",
        "AD",
        "SM",
        "MC",
        "VA",
        "PF",
        "TF",
        "GI",
        "GG",
        "IM",
        "JE",
        "BL",
        "PM",
        "CH",
        "GB",
        "WF"
      ]
    },
    "klarna": {
      "countries": [
        "AT",
        "BE",
        "CH",
        "DE",
        "DK",
        "ES",
        "FI",
        "FR",
        "GB",
        "IT",
        "NL",
        "NO",
        "SE"
      ]
    },
    "giropay": {
      "countries": [
        "DE"
      ]
    },
    "googlePay": {
      "merchantId": "12345678901234567890",
      "cvcRequired": false
    },
    "applePay": {
      "merchantId": "merchant.com.monei"
    },
    "clickToPay": {
      "tokenSupport": true,
      "preselected": false,
      "visa": {
        "srciDpaId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "srcInitiatorId": "550e8400-e29b-41d4-a716-446655440000"
      },
      "mastercard": {
        "srciDpaId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
        "srcInitiatorId": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
      },
      "discover": {
        "srciDpaId": "71f0c4d5-9947-4d1c-9cb3-d6a3f7c4e701",
        "srcInitiatorId": "c2d06c25-9ddb-4a5e-9d5a-3ff1c8d98467"
      }
    }
  },
  "merchantName": "MONEI",
  "merchantUrl": "https://monei.com/",
  "countryCode": "ES",
  "accountId": "aa9333ba-82de-400c-9ae7-087b9f8d2242",
  "amount": 10,
  "currency": "EUR"
}
```


---

# RecurringPaymentRequest

**orderId**Payment-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:&#x20;**`14379133960355`

**amount**integer\<int32>

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

**Example:&#x20;**`110`

**transactionType**Payment-TransactionType (string)

Same as the `transactionType` parameter from [create payment](https://docs.monei.com/apis/rest/payments-create/). If not sent, it will default in the same transaction type used in the initial payment.

| Enum Value | Description                                                                  |
| ---------- | ---------------------------------------------------------------------------- |
| SALE       | Automatically captures funds when the customer authorizes the payment        |
| AUTH       | Places a hold on funds without immediate capture, allowing for later capture |
| PAYOUT     | Sends funds to the customer                                                  |
| VERIF      | Verifies the payment method without placing a hold or capturing funds        |

**Possible values:** \[`SALE`, `AUTH`, `PAYOUT`, `VERIF`]

**Default value:&#x20;**`(same as initial payment)`

**Example:&#x20;**`SALE`

**description**Payment-Description (string)

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

**Example:&#x20;**`Test Shop - #84370745531439`

**customer** <!-- -->object

**email**string

The customer's email address.

**Example:&#x20;**`john.doe@example.com`

**name**string

The customer's full name or business name.

**Example:&#x20;**`John Doe`

**phone**string

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

**Example:&#x20;**`null`

**billingDetails** <!-- -->object

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

**name**string

The customer's billing full name.

**Example:&#x20;**`John Doe`

**email**string

The customer's billing email address.

**Example:&#x20;**`john.doe@example.com`

**phone**string

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

**Example:&#x20;**`null`

**company**string

Billing company name.

**Example:&#x20;**`null`

**taxId**string

Company tax ID.

**Example:&#x20;**`null`

**address** <!-- -->object

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**city**string

City, district, suburb, town, or village.

**Example:&#x20;**`Málaga`

**line1**string

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

**Example:&#x20;**`Fake Street 123`

**line2**string

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

**Example:&#x20;**`null`

**zip**string

ZIP or postal code.

**Example:&#x20;**`1234`

**state**string

State, county, province, or region.

**Example:&#x20;**`Málaga`

**shippingDetails** <!-- -->object

Shipping information associated with the payment.

**name**string

The shipping customer's full name.

**Example:&#x20;**`John Doe`

**email**string

The shipping customer's email address.

**Example:&#x20;**`john.doe@example.com`

**phone**string

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

**Example:&#x20;**`null`

**company**string

Name of the company where the shipment is going.

**Example:&#x20;**`null`

**taxId**string

Company tax ID.

**Example:&#x20;**`null`

**address** <!-- -->object

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**city**string

City, district, suburb, town, or village.

**Example:&#x20;**`Málaga`

**line1**string

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

**Example:&#x20;**`Fake Street 123`

**line2**string

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

**Example:&#x20;**`null`

**zip**string

ZIP or postal code.

**Example:&#x20;**`1234`

**state**string

State, county, province, or region.

**Example:&#x20;**`Málaga`

**callbackUrl**Payment-CallbackUrl (string)

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

**Example:&#x20;**`https://example.com/checkout/callback`

**metadata**object

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:&#x20;**`{"systemId":"12345"}`

RecurringPaymentRequest

```
{
  "orderId": "14379133960355",
  "amount": 110,
  "transactionType": "SALE",
  "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"
    }
  },
  "callbackUrl": "https://example.com/checkout/callback",
  "metadata": {
    "systemId": "12345"
  }
}
```


---

# RefundPaymentRequest

**amount**integer\<int32>

The amount to refund, which must be less than or equal to the original amount.

**Example:&#x20;**`110`

**refundReason**Payment-RefundReason (string)

The reason for refunding the Payment.

**Possible values:** \[`duplicated`, `fraudulent`, `requested_by_customer`]

**Example:&#x20;**`null`

RefundPaymentRequest

```
{
  "amount": 110,
  "refundReason": null
}
```


---

# RegisterApplePayDomainRequest

**domainName**DomainName (string)required

The domain name to register for Apple Pay.

**Example:&#x20;**`example.com`

RegisterApplePayDomainRequest

```
{
  "domainName": "example.com"
}
```


---

# SendPaymentLinkRequest

**customerEmail**string

The customer will receive payment link on this email address.

**Example:&#x20;**`john.doe@example.com`

**customerPhone**string

Phone number in E.164 format. The customer will receive payment link on this phone number.

**Example:&#x20;**`+34500000000`

**channel**Payment-MessageChannel (string)

The channel used to send the payment message.

| Enum Value | Description                       |
| ---------- | --------------------------------- |
| EMAIL      | Send message via email            |
| WHATSAPP   | Send message via WhatsApp         |
| SMS        | Send message via SMS text message |

**Possible values:** \[`EMAIL`, `WHATSAPP`, `SMS`]

**Example:&#x20;**`EMAIL`

**language**Payment-MessageLanguage (string)

The language of message sent to the customer. If not provided the default customer language is used if available.

| Enum Value | Description |
| ---------- | ----------- |
| en         | English     |
| es         | Spanish     |
| ca         | Catalan     |
| pt         | Portuguese  |
| de         | German      |
| it         | Italian     |
| fr         | French      |

**Possible values:** \[`en`, `es`, `ca`, `pt`, `de`, `it`, `fr`]

**Example:&#x20;**`en`

SendPaymentLinkRequest

```
{
  "customerEmail": "john.doe@example.com",
  "customerPhone": "+34500000000",
  "channel": "EMAIL",
  "language": "en"
}
```


---

# SendPaymentReceiptRequest

**customerEmail**string

The customer will receive payment receipt on this email address.

**Example:&#x20;**`john.doe@example.com`

**customerPhone**string

Phone number in E.164 format. The customer will receive payment receipt link on this phone number.

**Example:&#x20;**`+34500000000`

**channel**Payment-MessageChannel (string)

The channel used to send the payment message.

| Enum Value | Description                       |
| ---------- | --------------------------------- |
| EMAIL      | Send message via email            |
| WHATSAPP   | Send message via WhatsApp         |
| SMS        | Send message via SMS text message |

**Possible values:** \[`EMAIL`, `WHATSAPP`, `SMS`]

**Example:&#x20;**`EMAIL`

**language**Payment-MessageLanguage (string)

The language of message sent to the customer. If not provided the default customer language is used if available.

| Enum Value | Description |
| ---------- | ----------- |
| en         | English     |
| es         | Spanish     |
| ca         | Catalan     |
| pt         | Portuguese  |
| de         | German      |
| it         | Italian     |
| fr         | French      |

**Possible values:** \[`en`, `es`, `ca`, `pt`, `de`, `it`, `fr`]

**Example:&#x20;**`en`

SendPaymentReceiptRequest

```
{
  "customerEmail": "john.doe@example.com",
  "customerPhone": "+34500000000",
  "channel": "EMAIL",
  "language": "en"
}
```


---

# SendPaymentRequestRequest

**phoneNumber**stringrequired

Phone number in E.164 format. The customer will receive payment link on this phone number.

**Example:&#x20;**`+34500000000`

**language**Payment-MessageLanguage (string)

The language of message sent to the customer. If not provided the default customer language is used if available.

| Enum Value | Description |
| ---------- | ----------- |
| en         | English     |
| es         | Spanish     |
| ca         | Catalan     |
| pt         | Portuguese  |
| de         | German      |
| it         | Italian     |
| fr         | French      |

**Possible values:** \[`en`, `es`, `ca`, `pt`, `de`, `it`, `fr`]

**Example:&#x20;**`en`

SendPaymentRequestRequest

```
{
  "phoneNumber": "+34500000000",
  "language": "en"
}
```


---

# SendSubscriptionLinkRequest

**customerEmail**string\<email>

Customer email to send the subscription link to

**customerPhone**string

Customer phone number to send the subscription link to

**channel**string

Channel to use for sending the subscription link

| Enum Value | Description                       |
| ---------- | --------------------------------- |
| EMAIL      | Send message via email            |
| WHATSAPP   | Send message via WhatsApp         |
| SMS        | Send message via SMS text message |

**Possible values:** \[`EMAIL`, `WHATSAPP`, `SMS`]

**language**string

Language to use for the subscription link message

SendSubscriptionLinkRequest

```
{
  "customerEmail": "user@example.com",
  "customerPhone": "string",
  "channel": "EMAIL",
  "language": "string"
}
```


---

# SendSubscriptionStatusRequest

**customerEmail**string\<email>

Customer email to send the subscription status to

**customerPhone**string

Customer phone number to send the subscription status to

**channel**string

Channel to use for sending the subscription status

| Enum Value | Description                       |
| ---------- | --------------------------------- |
| EMAIL      | Send message via email            |
| WHATSAPP   | Send message via WhatsApp         |
| SMS        | Send message via SMS text message |

**Possible values:** \[`EMAIL`, `WHATSAPP`, `SMS`]

**language**string

Language to use for the subscription status message

SendSubscriptionStatusRequest

```
{
  "customerEmail": "user@example.com",
  "customerPhone": "string",
  "channel": "EMAIL",
  "language": "string"
}
```


---

# ServiceUnavailableError

**status**stringrequired

Error type identifier

**Example:&#x20;**`ServiceUnavailableError`

**statusCode**integer\<int32>required

HTTP status code

**Example:&#x20;**`503`

**message**stringrequired

Human-readable error message

**Example:&#x20;**`Upstream service is unavailable`

**requestId**stringrequired

Unique identifier for the request

**Example:&#x20;**`df011689-bd3e-4953-95ca-c7bbdacaf6f8`

**requestTime**string\<date-time>required

Timestamp when the request was processed

**Example:&#x20;**`2025-03-05T10:25:52Z`

ServiceUnavailableError

```
{
  "status": "ServiceUnavailableError",
  "statusCode": 503,
  "message": "Upstream service is unavailable",
  "requestId": "df011689-bd3e-4953-95ca-c7bbdacaf6f8",
  "requestTime": "2025-03-05T10:25:52Z"
}
```


---

# Source

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

**string**Source (string)

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

**Example:&#x20;**`MONEI/PHP`

Source

```
"MONEI/PHP"
```


---

# SourceVersion

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

**string**SourceVersion (string)

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

**Example:&#x20;**`0.1.2`

SourceVersion

```
"0.1.2"
```


---

# Subscription-CallbackUrl

The URL will be called each time subscription status changes. You will receive a subscription object in the body of the request.

**string**Subscription-CallbackUrl (string)

The URL will be called each time subscription status changes. You will receive a subscription object in the body of the request.

**Example:&#x20;**`https://example.com/subscriptions/callback`

Subscription-CallbackUrl

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


---

# Subscription-CancelAtPeriodEnd

If true, the subscription will be canceled at the end of the current period.

**boolean**Subscription-CancelAtPeriodEnd (boolean)

If true, the subscription will be canceled at the end of the current period.

**Example:&#x20;**`false`

Subscription-CancelAtPeriodEnd

```
false
```


---

# Subscription-CurrentPeriodEnd

The end date of the current subscription period. Measured in seconds since the Unix epoch.

**number**number\<int64>

The end date of the current subscription period. Measured in seconds since the Unix epoch.

**Example:&#x20;**`1636366897`

Subscription-CurrentPeriodEnd

```
1636366897
```


---

# Subscription-CurrentPeriodStart

The start date of the current subscription period. Measured in seconds since the Unix epoch.

**number**number\<int64>

The start date of the current subscription period. Measured in seconds since the Unix epoch.

**Example:&#x20;**`1636366897`

Subscription-CurrentPeriodStart

```
1636366897
```


---

# Subscription-Description

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

**string**Subscription-Description (string)

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

**Example:&#x20;**`MoonMail Monthly Lite`

Subscription-Description

```
"MoonMail Monthly Lite"
```


---

# Subscription-Id

Unique identifier for the subscription.

**string**Subscription-Id (string)

Unique identifier for the subscription.

**Example:&#x20;**`575bcd84-09fc-4a6e-8c4c-f88b8eb90bfa`

Subscription-Id

```
"575bcd84-09fc-4a6e-8c4c-f88b8eb90bfa"
```


---

# Subscription-Interval

Subscription interval. The `minute` and `hour` intervals are only available in test mode.

**string**Subscription-Interval (string)

Subscription interval. The `minute` and `hour` intervals are only available in test mode.

| Enum Value | Description |
| ---------- | ----------- |
| minute     | Minutely    |
| hour       | Hourly      |
| day        | Daily       |
| week       | Weekly      |
| month      | Monthly     |
| year       | Yearly      |

**Possible values:** \[`minute`, `hour`, `day`, `week`, `month`, `year`]

**Example:&#x20;**`month`

Subscription-Interval

```
"month"
```


---

# Subscription-IntervalCount

Number of intervals between subscription payments.

**integer**integer\<int32>

Number of intervals between subscription payments.

**Example:&#x20;**`1`

Subscription-IntervalCount

```
1
```


---

# Subscription-LastPayment

**id**Payment-Id (string)

Unique identifier for the payment.

**Example:&#x20;**`af6029f80f5fc73a8ad2753eea0b1be0`

**status**Payment-Status (string)

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:&#x20;**`PENDING`

**statusCode**Payment-StatusCode (string)

Payment status code.

**Example:&#x20;**`E000`

**statusMessage**Payment-StatusMessage (string)

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

**Example:&#x20;**`Transaction approved`

Subscription-LastPayment

```
{
  "id": "af6029f80f5fc73a8ad2753eea0b1be0",
  "status": "PENDING",
  "statusCode": "E000",
  "statusMessage": "Transaction approved"
}
```


---

# Subscription-NextPaymentAt

The date when the next payment will be made.

**integer**integer\<int64>

The date when the next payment will be made.

**Example:&#x20;**`1636366897`

Subscription-NextPaymentAt

```
1636366897
```


---

# Subscription-PauseAtPeriodEnd

If true, the subscription will be paused at the end of the current period.

**boolean**Subscription-PauseAtPeriodEnd (boolean)

If true, the subscription will be paused at the end of the current period.

**Example:&#x20;**`false`

Subscription-PauseAtPeriodEnd

```
false
```


---

# Subscription-PauseIntervalCount

Number of intervals when subscription will be paused before it activates again.

**integer**integer\<int32>

Number of intervals when subscription will be paused before it activates again.

**Example:&#x20;**`1`

Subscription-PauseIntervalCount

```
1
```


---

# Subscription-PaymentCallbackUrl

The URL will be called each time subscription creates a new payments. You will receive the payment object in the body of the request.

**string**Subscription-PaymentCallbackUrl (string)

The URL will be called each time subscription creates a new payments. You will receive the payment object in the body of the request.

**Example:&#x20;**`https://example.com/payments/callback`

Subscription-PaymentCallbackUrl

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


---

# Subscription-PaymentMethod

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

**method**string

Subscription method type.

| Enum Value | Description |
| ---------- | ----------- |
| card       | Card        |
| bizum      | Bizum       |

**Possible values:** \[`card`, `bizum`]

**Example:&#x20;**`card`

**card** <!-- -->object

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

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**brand**string

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:&#x20;**`visa`

**type**string

Card type `debit` or `credit`.

**Possible values:** \[`debit`, `credit`]

**Example:&#x20;**`credit`

**threeDSecure**boolean

Whether this transaction used 3D Secure authentication.

**Example:&#x20;**`false`

**threeDSecureVersion**string

The protocol version of the 3DS challenge.

**Example:&#x20;**`2.1.0`

**threeDSecureFlow**string

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:&#x20;**`CHALLENGE`

**expiration**integer\<int64>

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

**Example:&#x20;**`2048544000`

**last4**string

The last four digits of the card.

**Example:&#x20;**`0004`

**fingerprint**string

Unique identifier for the card number. Used to detect duplicate payment methods across customers. Not present for tokenized cards.

**Example:&#x20;**`7f2afde1566286c5fb126bb7e79bef549755cce6033dc429013c46d1365ff0e9`

**tokenizationMethod**string

The digital wallet used to tokenize the card.

**Possible values:** \[`applePay`, `googlePay`, `clickToPay`]

**Example:&#x20;**`applePay`

**cardholderName**string

The name of the cardholder.

**Example:&#x20;**`John Doe`

**cardholderEmail**string

The email of the cardholder.

**Example:&#x20;**`email@example.com`

**bizum** <!-- -->object

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

**phoneNumber**string

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

**Example:&#x20;**`null`

Subscription-PaymentMethod

```
{
  "method": "card",
  "card": {
    "country": "ES",
    "brand": "visa",
    "type": "credit",
    "threeDSecure": false,
    "threeDSecureVersion": "2.1.0",
    "threeDSecureFlow": "CHALLENGE",
    "expiration": 2048544000,
    "last4": "0004",
    "fingerprint": "7f2afde1566286c5fb126bb7e79bef549755cce6033dc429013c46d1365ff0e9",
    "tokenizationMethod": "applePay",
    "cardholderName": "John Doe",
    "cardholderEmail": "email@example.com"
  },
  "bizum": {
    "phoneNumber": null
  }
}
```


---

# Subscription-PaymentMethodCard

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

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**brand**string

Card brand.

| Enum Value | Description      |
| ---------- | ---------------- |
| visa       | Visa             |
| mastercard | Mastercard       |
| diners     | Diners Club      |
| amex       | American Express |
| jcb        | JCB              |
| unionpay   | UnionPay         |
| unknown    | Unknown          |

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

**Example:&#x20;**`visa`

**type**string

Card type `debit` or `credit`.

| Enum Value | Description |
| ---------- | ----------- |
| debit      | Debit       |
| credit     | Credit      |

**Possible values:** \[`debit`, `credit`]

**Example:&#x20;**`credit`

**threeDSecure**boolean

Wether this transaction used 3D Secure authentication.

**Example:&#x20;**`false`

**threeDSecureVersion**string

The protocol version of the 3DS challenge.

**Example:&#x20;**`2.1.0`

**expiration**integer\<int64>

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

**Example:&#x20;**`2048544000`

**last4**string

The last four digits of the card.

**Example:&#x20;**`0004`

**fingerprint**string

Unique identifier for the card number. Used to detect duplicate payment methods across customers. Not present for tokenized cards.

**Example:&#x20;**`7f2afde1566286c5fb126bb7e79bef549755cce6033dc429013c46d1365ff0e9`

Subscription-PaymentMethodCard

```
{
  "country": "ES",
  "brand": "visa",
  "type": "credit",
  "threeDSecure": false,
  "threeDSecureVersion": "2.1.0",
  "expiration": 2048544000,
  "last4": "0004",
  "fingerprint": "7f2afde1566286c5fb126bb7e79bef549755cce6033dc429013c46d1365ff0e9"
}
```


---

# Subscription-PaymentMethods

List of payment methods allowed for subscriptions.

* Array \[

****string

* ]

Subscription-PaymentMethods

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


---

# Subscription-RetryCount

Number of retries left for the subscription.

**integer**integer\<int32>

Number of retries left for the subscription.

**Example:&#x20;**`1`

Subscription-RetryCount

```
1
```


---

# Subscription-RetrySchedule

Defines a custom schedule for retrying failed subscription payments. Each entry in the array specifies how long to wait before attempting the next payment retry. If not specified, the system's default retry schedule will be used.

* Array \[

**interval**stringrequired

The unit of time to wait before the retry attempt.

| Enum Value | Description |
| ---------- | ----------- |
| day        | Daily       |
| week       | Weekly      |
| month      | Monthly     |
| year       | Yearly      |

**Possible values:** \[`day`, `week`, `month`, `year`]

**Example:&#x20;**`day`

**intervalCount**integer\<int32>required

The number of intervals to wait before the retry attempt.

**Possible values:** `>= 1` and `<= 31`

**Example:&#x20;**`3`

* ]

Subscription-RetrySchedule

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


---

# Subscription-SkipIntervalCount

The number of intervals during which the subscription billing cycle will be skipped without altering the subscription status. This is useful when payment for a specific period is received through different methods.

**integer**integer\<int32>

The number of intervals during which the subscription billing cycle will be skipped without altering the subscription status. This is useful when payment for a specific period is received through different methods.

**Example:&#x20;**`1`

Subscription-SkipIntervalCount

```
1
```


---

# Subscription-Status

The status of the subscription.

**string**Subscription-Status (string)

The status of the subscription.

| Enum Value | Description                                                                                        |
| ---------- | -------------------------------------------------------------------------------------------------- |
| PENDING    | The subscription has been created but is waiting for initial payment or activation                 |
| EXPIRED    | The subscription has reached its end date or maximum number of attempts without successful payment |
| TRIALING   | The subscription is in trial period before the first payment is required                           |
| ACTIVE     | The subscription is currently active and payments are being processed normally                     |
| PAST\_DUE  | The most recent payment attempt failed but the subscription will retry according to schedule       |
| PAUSED     | The subscription is temporarily suspended and will resume based on pause settings                  |
| CANCELED   | The subscription has been permanently terminated and will not process further payments             |

**Possible values:** \[`PENDING`, `EXPIRED`, `TRIALING`, `ACTIVE`, `PAST_DUE`, `PAUSED`, `CANCELED`]

**Example:&#x20;**`PENDING`

Subscription-Status

```
"PENDING"
```


---

# Subscription-TrialPeriodDays

Number of days the trial period lasts.

**integer**integer\<int32>

Number of days the trial period lasts.

**Example:&#x20;**`7`

Subscription-TrialPeriodDays

```
7
```


---

# Subscription-TrialPeriodEnd

The end date of the trial period. Measured in seconds since the Unix epoch.

**number**number\<int64>

The end date of the trial period. Measured in seconds since the Unix epoch.

**Example:&#x20;**`1636366897`

Subscription-TrialPeriodEnd

```
1636366897
```


---

# Subscription

**id**Subscription-Id (string)required

Unique identifier for the subscription.

**Example:&#x20;**`575bcd84-09fc-4a6e-8c4c-f88b8eb90bfa`

**amount**integer\<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:&#x20;**`110`

**currency**Payment-Currency (string)

Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase. Must be a supported currency.

**Example:&#x20;**`EUR`

**allowedPaymentMethods**string\[]

List of payment methods allowed for subscriptions.

| Enum Value | Description |
| ---------- | ----------- |
| card       | Card        |
| bizum      | Bizum       |

**Example:&#x20;**`["card","bizum"]`

**description**Subscription-Description (string)

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

**Example:&#x20;**`MoonMail Monthly Lite`

**accountId**AccountId (string)required

MONEI Account identifier.

**Example:&#x20;**`aa9333ba-82de-400c-9ae7-087b9f8d2242`

**livemode**Livemode (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:&#x20;**`false`

**status**Subscription-Status (string)required

The status of the subscription.

| Enum Value | Description                                                                                        |
| ---------- | -------------------------------------------------------------------------------------------------- |
| PENDING    | The subscription has been created but is waiting for initial payment or activation                 |
| EXPIRED    | The subscription has reached its end date or maximum number of attempts without successful payment |
| TRIALING   | The subscription is in trial period before the first payment is required                           |
| ACTIVE     | The subscription is currently active and payments are being processed normally                     |
| PAST\_DUE  | The most recent payment attempt failed but the subscription will retry according to schedule       |
| PAUSED     | The subscription is temporarily suspended and will resume based on pause settings                  |
| CANCELED   | The subscription has been permanently terminated and will not process further payments             |

**Possible values:** \[`PENDING`, `EXPIRED`, `TRIALING`, `ACTIVE`, `PAST_DUE`, `PAUSED`, `CANCELED`]

**Example:&#x20;**`PENDING`

**customer** <!-- -->object

**email**string

The customer's email address.

**Example:&#x20;**`john.doe@example.com`

**name**string

The customer's full name or business name.

**Example:&#x20;**`John Doe`

**phone**string

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

**Example:&#x20;**`null`

**billingDetails** <!-- -->object

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

**name**string

The customer's billing full name.

**Example:&#x20;**`John Doe`

**email**string

The customer's billing email address.

**Example:&#x20;**`john.doe@example.com`

**phone**string

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

**Example:&#x20;**`null`

**company**string

Billing company name.

**Example:&#x20;**`null`

**taxId**string

Company tax ID.

**Example:&#x20;**`null`

**address** <!-- -->object

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**city**string

City, district, suburb, town, or village.

**Example:&#x20;**`Málaga`

**line1**string

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

**Example:&#x20;**`Fake Street 123`

**line2**string

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

**Example:&#x20;**`null`

**zip**string

ZIP or postal code.

**Example:&#x20;**`1234`

**state**string

State, county, province, or region.

**Example:&#x20;**`Málaga`

**shippingDetails** <!-- -->object

Shipping information associated with the payment.

**name**string

The shipping customer's full name.

**Example:&#x20;**`John Doe`

**email**string

The shipping customer's email address.

**Example:&#x20;**`john.doe@example.com`

**phone**string

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

**Example:&#x20;**`null`

**company**string

Name of the company where the shipment is going.

**Example:&#x20;**`null`

**taxId**string

Company tax ID.

**Example:&#x20;**`null`

**address** <!-- -->object

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**city**string

City, district, suburb, town, or village.

**Example:&#x20;**`Málaga`

**line1**string

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

**Example:&#x20;**`Fake Street 123`

**line2**string

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

**Example:&#x20;**`null`

**zip**string

ZIP or postal code.

**Example:&#x20;**`1234`

**state**string

State, county, province, or region.

**Example:&#x20;**`Málaga`

**interval**Subscription-Interval (string)required

Subscription interval. The `minute` and `hour` intervals are only available in test mode.

| Enum Value | Description |
| ---------- | ----------- |
| minute     | Minutely    |
| hour       | Hourly      |
| day        | Daily       |
| week       | Weekly      |
| month      | Monthly     |
| year       | Yearly      |

**Possible values:** \[`minute`, `hour`, `day`, `week`, `month`, `year`]

**Example:&#x20;**`month`

**intervalCount**integer\<int32>required

Number of intervals between subscription payments.

**Example:&#x20;**`1`

**pauseIntervalCount**integer\<int32>

Number of intervals when subscription will be paused before it activates again.

**Example:&#x20;**`1`

**skipIntervalCount**integer\<int32>

The number of intervals during which the subscription billing cycle will be skipped without altering the subscription status. This is useful when payment for a specific period is received through different methods.

**Example:&#x20;**`1`

**lastOrderId**Payment-OrderId (string)

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

**Example:&#x20;**`14379133960355`

**lastPayment** <!-- -->object

**id**Payment-Id (string)

Unique identifier for the payment.

**Example:&#x20;**`af6029f80f5fc73a8ad2753eea0b1be0`

**status**Payment-Status (string)

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:&#x20;**`PENDING`

**statusCode**Payment-StatusCode (string)

Payment status code.

**Example:&#x20;**`E000`

**statusMessage**Payment-StatusMessage (string)

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

**Example:&#x20;**`Transaction approved`

**paymentMethod** <!-- -->object

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

**method**string

Subscription method type.

| Enum Value | Description |
| ---------- | ----------- |
| card       | Card        |
| bizum      | Bizum       |

**Possible values:** \[`card`, `bizum`]

**Example:&#x20;**`card`

**card** <!-- -->object

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

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**brand**string

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:&#x20;**`visa`

**type**string

Card type `debit` or `credit`.

**Possible values:** \[`debit`, `credit`]

**Example:&#x20;**`credit`

**threeDSecure**boolean

Whether this transaction used 3D Secure authentication.

**Example:&#x20;**`false`

**threeDSecureVersion**string

The protocol version of the 3DS challenge.

**Example:&#x20;**`2.1.0`

**threeDSecureFlow**string

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:&#x20;**`CHALLENGE`

**expiration**integer\<int64>

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

**Example:&#x20;**`2048544000`

**last4**string

The last four digits of the card.

**Example:&#x20;**`0004`

**fingerprint**string

Unique identifier for the card number. Used to detect duplicate payment methods across customers. Not present for tokenized cards.

**Example:&#x20;**`7f2afde1566286c5fb126bb7e79bef549755cce6033dc429013c46d1365ff0e9`

**tokenizationMethod**string

The digital wallet used to tokenize the card.

**Possible values:** \[`applePay`, `googlePay`, `clickToPay`]

**Example:&#x20;**`applePay`

**cardholderName**string

The name of the cardholder.

**Example:&#x20;**`John Doe`

**cardholderEmail**string

The email of the cardholder.

**Example:&#x20;**`email@example.com`

**bizum** <!-- -->object

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

**phoneNumber**string

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

**Example:&#x20;**`null`

**currentPeriodStart**number\<int64>

The start date of the current subscription period. Measured in seconds since the Unix epoch.

**Example:&#x20;**`1636366897`

**currentPeriodEnd**number\<int64>

The end date of the current subscription period. Measured in seconds since the Unix epoch.

**Example:&#x20;**`1636366897`

**trialPeriodEnd**number\<int64>

The end date of the trial period. Measured in seconds since the Unix epoch.

**Example:&#x20;**`1636366897`

**nextPaymentAt**integer\<int64>

The date when the next payment will be made.

**Example:&#x20;**`1636366897`

**retryCount**integer\<int32>

Number of retries left for the subscription.

**Example:&#x20;**`1`

**retrySchedule** <!-- -->object\[]

Defines a custom schedule for retrying failed subscription payments. Each entry in the array specifies how long to wait before attempting the next payment retry. If not specified, the system's default retry schedule will be used.

* Array \[

**interval**stringrequired

The unit of time to wait before the retry attempt.

| Enum Value | Description |
| ---------- | ----------- |
| day        | Daily       |
| week       | Weekly      |
| month      | Monthly     |
| year       | Yearly      |

**Possible values:** \[`day`, `week`, `month`, `year`]

**Example:&#x20;**`day`

**intervalCount**integer\<int32>required

The number of intervals to wait before the retry attempt.

**Possible values:** `>= 1` and `<= 31`

**Example:&#x20;**`3`

* ]

**cancelAtPeriodEnd**Subscription-CancelAtPeriodEnd (boolean)

If true, the subscription will be canceled at the end of the current period.

**Example:&#x20;**`false`

**pauseAtPeriodEnd**Subscription-PauseAtPeriodEnd (boolean)

If true, the subscription will be paused at the end of the current period.

**Example:&#x20;**`false`

**traceDetails** <!-- -->Payment-TraceDetails

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

**ip**IP (string)

The IP address where the operation originated.

**Example:&#x20;**`100.100.200.100`

**countryCode**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**lang**Lang (string)

Two-letter language code ([ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1)).

**Example:&#x20;**`es`

**deviceType**DeviceType (string)

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

**Example:&#x20;**`desktop`

**deviceModel**DeviceModel (string)

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

**Example:&#x20;**`null`

**browser**Browser (string)

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

**Example:&#x20;**`Chrome`

**browserVersion**BrowserVersion (string)

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

**Example:&#x20;**`83.0.4103.116`

**os**Os (string)

Operation system (e.g., `iOS`).

**Example:&#x20;**`Mac OS`

**osVersion**OsVersion (string)

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

**Example:&#x20;**`10.15.4`

**source**Source (string)

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

**Example:&#x20;**`MONEI/PHP`

**sourceVersion**SourceVersion (string)

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

**Example:&#x20;**`0.1.2`

**userAgent**UserAgent (string)

Full user agent string of the browser session.

**Example:&#x20;**`Mozilla/5.0 (Windows NT 10.0; Win64; x64) ...`

**browserAccept**BrowserAccept (string)

Browser accept header.

**Example:&#x20;**`text/html,application/xhtml+xml,application/json`

**browserColorDepth**BrowserColorDepth (string)

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

**Example:&#x20;**`24`

**browserScreenHeight**BrowserScreenHeight (string)

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

**Example:&#x20;**`1152`

**browserScreenWidth**BrowserScreenWidth (string)

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

**Example:&#x20;**`2048`

**browserTimezoneOffset**BrowserTimezoneOffset (string)

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

**Example:&#x20;**`-120`

**userId**string

The ID of the user that started the operation.

**Example:&#x20;**`null`

**userEmail**string

The email of the user that started the operation.

**Example:&#x20;**`user@example.com`

**sequenceId**Payment-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:&#x20;**`62b23b9f3627cc38b08ff471ccd313ad`

**callbackUrl**Subscription-CallbackUrl (string)

The URL will be called each time subscription status changes. You will receive a subscription object in the body of the request.

**Example:&#x20;**`https://example.com/subscriptions/callback`

**paymentCallbackUrl**Subscription-PaymentCallbackUrl (string)

The URL will be called each time subscription creates a new payments. You will receive the payment object in the body of the request.

**Example:&#x20;**`https://example.com/payments/callback`

**metadata**object

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:&#x20;**`{"systemId":"12345"}`

**createdAt**integer\<int64>

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

**Example:&#x20;**`1636366897`

**updatedAt**integer\<int64>

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

**Example:&#x20;**`1636366897`

Subscription

```
{
  "id": "575bcd84-09fc-4a6e-8c4c-f88b8eb90bfa",
  "amount": 110,
  "currency": "EUR",
  "allowedPaymentMethods": [
    "card",
    "bizum"
  ],
  "description": "MoonMail Monthly Lite",
  "accountId": "aa9333ba-82de-400c-9ae7-087b9f8d2242",
  "livemode": false,
  "status": "PENDING",
  "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"
    }
  },
  "interval": "month",
  "intervalCount": 1,
  "pauseIntervalCount": 1,
  "skipIntervalCount": 1,
  "lastOrderId": "14379133960355",
  "lastPayment": {
    "id": "af6029f80f5fc73a8ad2753eea0b1be0",
    "status": "PENDING",
    "statusCode": "E000",
    "statusMessage": "Transaction approved"
  },
  "paymentMethod": {
    "method": "card",
    "card": {
      "country": "ES",
      "brand": "visa",
      "type": "credit",
      "threeDSecure": false,
      "threeDSecureVersion": "2.1.0",
      "threeDSecureFlow": "CHALLENGE",
      "expiration": 2048544000,
      "last4": "0004",
      "fingerprint": "7f2afde1566286c5fb126bb7e79bef549755cce6033dc429013c46d1365ff0e9",
      "tokenizationMethod": "applePay",
      "cardholderName": "John Doe",
      "cardholderEmail": "email@example.com"
    },
    "bizum": {
      "phoneNumber": null
    }
  },
  "currentPeriodStart": 1636366897,
  "currentPeriodEnd": 1636366897,
  "trialPeriodEnd": 1636366897,
  "nextPaymentAt": 1636366897,
  "retryCount": 1,
  "retrySchedule": [
    {
      "interval": "day",
      "intervalCount": 1
    },
    {
      "interval": "day",
      "intervalCount": 3
    },
    {
      "interval": "week",
      "intervalCount": 1
    }
  ],
  "cancelAtPeriodEnd": false,
  "pauseAtPeriodEnd": false,
  "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"
  },
  "sequenceId": "62b23b9f3627cc38b08ff471ccd313ad",
  "callbackUrl": "https://example.com/subscriptions/callback",
  "paymentCallbackUrl": "https://example.com/payments/callback",
  "metadata": {
    "systemId": "12345"
  },
  "createdAt": 1636366897,
  "updatedAt": 1636366897
}
```


---

# UnauthorizedError

**status**stringrequired

Error type identifier

**Example:&#x20;**`UnauthorizedError`

**statusCode**integer\<int32>required

HTTP status code

**Example:&#x20;**`401`

**message**stringrequired

Human-readable error message

**Example:&#x20;**`Unauthorized access`

**requestId**stringrequired

Unique identifier for the request

**Example:&#x20;**`df011689-bd3e-4953-95ca-c7bbdacaf6f8`

**requestTime**string\<date-time>required

Timestamp when the request was processed

**Example:&#x20;**`2025-03-05T10:25:52Z`

UnauthorizedError

```
{
  "status": "UnauthorizedError",
  "statusCode": 401,
  "message": "Unauthorized access",
  "requestId": "df011689-bd3e-4953-95ca-c7bbdacaf6f8",
  "requestTime": "2025-03-05T10:25:52Z"
}
```


---

# UnprocessableEntityError

**status**stringrequired

Error type identifier

**Example:&#x20;**`UnprocessableEntityError`

**statusCode**integer\<int32>required

HTTP status code

**Example:&#x20;**`422`

**message**stringrequired

Human-readable error message

**Example:&#x20;**`Unprocessable entity`

**requestId**stringrequired

Unique identifier for the request

**Example:&#x20;**`df011689-bd3e-4953-95ca-c7bbdacaf6f8`

**requestTime**string\<date-time>required

Timestamp when the request was processed

**Example:&#x20;**`2025-03-05T10:25:52Z`

UnprocessableEntityError

```
{
  "status": "UnprocessableEntityError",
  "statusCode": 422,
  "message": "Unprocessable entity",
  "requestId": "df011689-bd3e-4953-95ca-c7bbdacaf6f8",
  "requestTime": "2025-03-05T10:25:52Z"
}
```


---

# UpdateApplePayCertificateRequest

**active**booleanrequired

Set to true to enable or false to disable the certificate.

**Example:&#x20;**`true`

UpdateApplePayCertificateRequest

```
{
  "active": true
}
```


---

# UpdatedAt

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

**integer**integer\<int64>

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

**Example:&#x20;**`1636366897`

UpdatedAt

```
1636366897
```


---

# UpdateSubscriptionRequest

**amount**integer\<int32>

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:&#x20;**`110`

**interval**Subscription-Interval (string)

Subscription interval. The `minute` and `hour` intervals are only available in test mode.

| Enum Value | Description |
| ---------- | ----------- |
| minute     | Minutely    |
| hour       | Hourly      |
| day        | Daily       |
| week       | Weekly      |
| month      | Monthly     |
| year       | Yearly      |

**Possible values:** \[`minute`, `hour`, `day`, `week`, `month`, `year`]

**Example:&#x20;**`month`

**intervalCount**integer\<int32>

Number of intervals between subscription payments.

**Example:&#x20;**`1`

**allowedPaymentMethods**string\[]

List of payment methods allowed for subscriptions.

| Enum Value | Description |
| ---------- | ----------- |
| card       | Card        |
| bizum      | Bizum       |

**Example:&#x20;**`["card","bizum"]`

**description**Subscription-Description (string)

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

**Example:&#x20;**`MoonMail Monthly Lite`

**customer** <!-- -->object

**email**string

The customer's email address.

**Example:&#x20;**`john.doe@example.com`

**name**string

The customer's full name or business name.

**Example:&#x20;**`John Doe`

**phone**string

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

**Example:&#x20;**`null`

**billingDetails** <!-- -->object

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

**name**string

The customer's billing full name.

**Example:&#x20;**`John Doe`

**email**string

The customer's billing email address.

**Example:&#x20;**`john.doe@example.com`

**phone**string

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

**Example:&#x20;**`null`

**company**string

Billing company name.

**Example:&#x20;**`null`

**taxId**string

Company tax ID.

**Example:&#x20;**`null`

**address** <!-- -->object

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**city**string

City, district, suburb, town, or village.

**Example:&#x20;**`Málaga`

**line1**string

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

**Example:&#x20;**`Fake Street 123`

**line2**string

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

**Example:&#x20;**`null`

**zip**string

ZIP or postal code.

**Example:&#x20;**`1234`

**state**string

State, county, province, or region.

**Example:&#x20;**`Málaga`

**shippingDetails** <!-- -->object

Shipping information associated with the payment.

**name**string

The shipping customer's full name.

**Example:&#x20;**`John Doe`

**email**string

The shipping customer's email address.

**Example:&#x20;**`john.doe@example.com`

**phone**string

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

**Example:&#x20;**`null`

**company**string

Name of the company where the shipment is going.

**Example:&#x20;**`null`

**taxId**string

Company tax ID.

**Example:&#x20;**`null`

**address** <!-- -->object

**country**Country (string)

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

**Example:&#x20;**`ES`

**city**string

City, district, suburb, town, or village.

**Example:&#x20;**`Málaga`

**line1**string

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

**Example:&#x20;**`Fake Street 123`

**line2**string

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

**Example:&#x20;**`null`

**zip**string

ZIP or postal code.

**Example:&#x20;**`1234`

**state**string

State, county, province, or region.

**Example:&#x20;**`Málaga`

**trialPeriodEnd**number\<int64>

The end date of the trial period. Measured in seconds since the Unix epoch.

**Example:&#x20;**`1636366897`

**callbackUrl**Subscription-CallbackUrl (string)

The URL will be called each time subscription status changes. You will receive a subscription object in the body of the request.

**Example:&#x20;**`https://example.com/subscriptions/callback`

**paymentCallbackUrl**Subscription-PaymentCallbackUrl (string)

The URL will be called each time subscription creates a new payments. You will receive the payment object in the body of the request.

**Example:&#x20;**`https://example.com/payments/callback`

**pauseAtPeriodEnd**Subscription-PauseAtPeriodEnd (boolean)

If true, the subscription will be paused at the end of the current period.

**Example:&#x20;**`false`

**cancelAtPeriodEnd**Subscription-CancelAtPeriodEnd (boolean)

If true, the subscription will be canceled at the end of the current period.

**Example:&#x20;**`false`

**pauseIntervalCount**integer\<int32>

Number of intervals when subscription will be paused before it activates again.

**Example:&#x20;**`1`

**skipIntervalCount**integer\<int32>

The number of intervals during which the subscription billing cycle will be skipped without altering the subscription status. This is useful when payment for a specific period is received through different methods.

**Example:&#x20;**`1`

**retrySchedule** <!-- -->object\[]

Defines a custom schedule for retrying failed subscription payments. Each entry in the array specifies how long to wait before attempting the next payment retry. If not specified, the system's default retry schedule will be used.

* Array \[

**interval**stringrequired

The unit of time to wait before the retry attempt.

| Enum Value | Description |
| ---------- | ----------- |
| day        | Daily       |
| week       | Weekly      |
| month      | Monthly     |
| year       | Yearly      |

**Possible values:** \[`day`, `week`, `month`, `year`]

**Example:&#x20;**`day`

**intervalCount**integer\<int32>required

The number of intervals to wait before the retry attempt.

**Possible values:** `>= 1` and `<= 31`

**Example:&#x20;**`3`

* ]

**metadata**object

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:&#x20;**`{"systemId":"12345"}`

UpdateSubscriptionRequest

```
{
  "amount": 110,
  "interval": "month",
  "intervalCount": 1,
  "allowedPaymentMethods": [
    "card",
    "bizum"
  ],
  "description": "MoonMail Monthly Lite",
  "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"
    }
  },
  "trialPeriodEnd": 1636366897,
  "callbackUrl": "https://example.com/subscriptions/callback",
  "paymentCallbackUrl": "https://example.com/payments/callback",
  "pauseAtPeriodEnd": false,
  "cancelAtPeriodEnd": false,
  "pauseIntervalCount": 1,
  "skipIntervalCount": 1,
  "retrySchedule": [
    {
      "interval": "day",
      "intervalCount": 1
    },
    {
      "interval": "day",
      "intervalCount": 3
    },
    {
      "interval": "week",
      "intervalCount": 1
    }
  ],
  "metadata": {
    "systemId": "12345"
  }
}
```


---

# UserAgent

Full user agent string of the browser session.

**string**UserAgent (string)

Full user agent string of the browser session.

**Example:&#x20;**`Mozilla/5.0 (Windows NT 10.0; Win64; x64) ...`

UserAgent

```
"Mozilla/5.0 (Windows NT 10.0; Win64; x64) ..."
```


---

# ValidateBizumPhoneRequest

**accountId**AccountId (string)required

MONEI Account identifier.

**Example:&#x20;**`aa9333ba-82de-400c-9ae7-087b9f8d2242`

**paymentId**Payment-Id (string)

Unique identifier for the payment.

**Example:&#x20;**`af6029f80f5fc73a8ad2753eea0b1be0`

**phoneNumber**stringrequired

Phone number in E.164 format.

**Example:&#x20;**`+34500000000`

ValidateBizumPhoneRequest

```
{
  "accountId": "aa9333ba-82de-400c-9ae7-087b9f8d2242",
  "paymentId": "af6029f80f5fc73a8ad2753eea0b1be0",
  "phoneNumber": "+34500000000"
}
```


---

# Activate Subscription

```
POST 
/subscriptions/:id/activate
```

Activates a subscription by attaching a payment method and initiating the billing cycle.

**Activation Process**:

1. This endpoint transitions a `PENDING` subscription to `ACTIVE` status

2. An initial payment is created to validate the payment method:

   <!-- -->

   * For regular subscriptions: First billing cycle payment is processed immediately
   * For trial subscriptions: A zero-amount payment is created to verify the payment method

**Payment Method Updates**: If the subscription is already active, this endpoint can be used to update the payment method. The update process creates a zero-amount payment to verify the new payment method works correctly.

**Important Notes**:

* Subscription billing begins immediately upon successful activation (unless in trial period)
* The payment method provided will be used for all future recurring charges
* Activation failures (due to invalid payment method) will keep the subscription in `PENDING` status
* You can specify `allowedPaymentMethods` to restrict which payment methods (e.g., `card`, `bizum`) are accepted for the subscription

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A payment object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Cancel Subscription

```
POST 
/subscriptions/:id/cancel
```

Cancels an active subscription, permanently stopping the billing cycle.

**Cancellation Effects**:

* The subscription status changes to `CANCELED`
* No further charges will be processed
* Access to subscription services typically ends immediately or at period end (depending on your business rules)

**Important Notes**:

* Cancellation is permanent and cannot be undone
* To restart service, a new subscription must be created
* Consider using `pauseAtPeriodEnd` or `cancelAtPeriodEnd` for softer transitions

Use this endpoint when a customer wishes to completely terminate their subscription.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A subscription object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Create Subscription

```
POST 
/subscriptions
```

Creates a new subscription with the specified parameters.

**Subscription Lifecycle**:

1. When first created, the subscription has a `PENDING` status
2. To initiate billing, you must call the [activate endpoint](https://docs.monei.com/apis/rest/subscriptions-activate/) with payment details
3. Once activated, the subscription will automatically bill according to the configured interval

**Key Configuration Parameters**:

* **Billing settings**: Amount, currency, interval (daily, weekly, monthly, yearly)
* **Schedule customization**: Interval count, trial period duration
* **Allowed payment methods**: An array of strings specifying which payment methods are allowed for this subscription (e.g., `card`, `bizum`)
* **Customer information**: Contact details, billing and shipping addresses
* **Communication**: Callback URLs for webhook notifications about subscription events

**Best Practices**:

* Set clear, descriptive names for subscriptions to help with identification
* Configure appropriate webhook notifications to monitor subscription status changes
* Consider offering trial periods to increase customer conversion rates
* Use metadata to store additional information relevant to your business logic

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A subscription object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Get Subscription

```
GET 
/subscriptions/:id
```

Retrieves the complete details of an existing subscription by its unique ID.

This endpoint returns comprehensive information about the subscription, including:

* Current status and lifecycle details (active, paused, canceled)
* Billing configuration (amount, currency, interval)
* Schedule information (current period, next payment date)
* Customer and payment method details
* Payment history (including last payment status)
* Trial period information (if applicable)

Use this endpoint to check subscription status, verify billing details, or retrieve information needed for customer support inquiries.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A subscription object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Pause Subscription

```
POST 
/subscriptions/:id/pause
```

Pauses an active subscription, temporarily halting the billing cycle.

**Pause Effects**:

* Billing is immediately suspended
* The subscription status changes to `PAUSED`
* No charges will be processed while the subscription remains paused
* The current billing period end date remains unchanged

**Use Cases**:

* Temporary service interruptions
* Customer vacation or absence periods
* Account maintenance or dispute resolution

To resume billing, use the [resume endpoint](https://docs.monei.com/apis/rest/subscriptions-resume/).

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A subscription object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Resume Subscription

```
POST 
/subscriptions/:id/resume
```

Resumes a previously paused subscription, reactivating the billing cycle.

**Resume Effects**:

* Billing is immediately reactivated
* The subscription status changes from `PAUSED` to `ACTIVE`
* The next billing date is recalculated based on the current date
* Regular charging schedule resumes according to the subscription interval

**Important Notes**:

* No immediate charge is created when resuming (billing continues on next scheduled date)
* Any pause duration is added to the current billing period, maintaining the expected number of billing cycles
* If a significant time has passed, verify that the payment method is still valid

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A subscription object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Send Subscription Link

```
POST 
/subscriptions/:id/link
```

Sends a subscription activation link to the customer through their preferred communication channel.

**This API can only be used for subscriptions with the following status:**

* Pending

**Delivery channels are automatically selected based on available customer information:**

* If customer email is available: Link is sent via email
* If customer phone is available: Link is sent via WhatsApp
* If WhatsApp delivery fails: Link is sent via SMS as a fallback

The subscription activation link allows customers to complete their subscription setup by providing payment details on the secure MONEI payment page. If no customer contact information is provided, the system will use the details stored in the subscription record.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A subscription object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Send Subscription Status

```
POST 
/subscriptions/:id/status
```

Sends subscription status information to the customer through their preferred communication channel.

**This API can only be used for subscriptions with the following statuses:**

* Active
* Trialing
* Past due

**Delivery channels are automatically selected based on available customer information:**

* If customer email is available: Status is sent via email
* If customer phone is available: Status is sent via WhatsApp
* If WhatsApp delivery fails: Status is sent via SMS as a fallback

The status notification includes subscription details such as current status, upcoming payments, and recent changes. If no customer contact information is provided, the system will use the details stored in the subscription record.

**Email notifications include contextual action links based on subscription status:**

* For past due subscriptions: A link to reactivate the subscription
* For active and trialing subscriptions: A link to update the payment method

You can specify the customer's email or phone number, the preferred communication channel (email or SMS), and the language for the message.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A subscription object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Update Subscription

```
PUT 
/subscriptions/:id
```

Updates the configuration of an existing subscription.

**Modifiable Parameters**:

* Billing information (amount, description, allowedPaymentMethods)
* Customer details (contact information, billing/shipping addresses)
* Subscription settings (cancelAtPeriodEnd, pauseAtPeriodEnd, skipIntervalCount)
* Metadata (for your internal tracking)

**Update Effects**:

* Amount changes apply to the next billing cycle
* Customer information updates take effect immediately
* Setting `cancelAtPeriodEnd` to true will end the subscription after the current period
* Setting `pauseAtPeriodEnd` to true will pause billing after the current period
* Setting `skipIntervalCount` skips billing for the specified number of intervals without changing subscription status

**Note**: Some fundamental properties cannot be changed once a subscription is created, including currency and billing interval. To modify these, you would need to cancel the existing subscription and create a new one.

## Request[​](#request "Direct link to Request")

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404
* 422
* 500
* 503

A subscription object

The request is incorrect or could not be processed

Unauthorized error. Please check your auth credentials

The specified resource was not found

The request was well-formed but could not be processed due to semantic errors

Unexpected server error

The service is temporarily unavailable


---

# Subscriptions

The Subscriptions API provides a powerful solution for managing recurring billing and subscription-based business models.

## Key Features[​](#key-features "Direct link to Key Features")

### Flexible Billing Options[​](#flexible-billing-options "Direct link to Flexible Billing Options")

* **Multiple billing intervals**: Daily, weekly, monthly, or yearly billing cycles
* **Custom intervals**: Configure non-standard periods using intervalCount (e.g., every 3 months)
* **Trial periods**: Offer free trials before the first billing cycle begins
* **Variable amounts**: Update subscription amounts for pricing changes or upgrades

### Complete Lifecycle Management[​](#complete-lifecycle-management "Direct link to Complete Lifecycle Management")

* **Create subscriptions**: Set up recurring billing plans with customizable parameters
* **Activate subscriptions**: Begin billing cycles with customer payment information
* **Pause/Resume**: Temporarily halt billing without cancellation
* **Update subscriptions**: Modify pricing, billing details, or subscription parameters
* **Cancel subscriptions**: End recurring billing permanently or at period end

### Customer-Friendly Features[​](#customer-friendly-features "Direct link to Customer-Friendly Features")

* **Automated recurring payments**: No manual action required for subsequent billing
* **Consistent billing dates**: Predictable billing on the same day of each period
* **Payment retry mechanism**: Automatic retries for failed payments
* **Customer control**: Enable customers to manage their own subscriptions

### Integration Benefits[​](#integration-benefits "Direct link to Integration Benefits")

* **Webhook notifications**: Get real-time updates on subscription status changes
* **Detailed reporting**: Track subscription metrics and performance
* **Simplified compliance**: Handle recurring billing requirements automatically
* **Reduced churn**: Automatic billing helps prevent missed payments

## Testing[​](#testing "Direct link to Testing")

### Test Mode Limitations[​](#test-mode-limitations "Direct link to Test Mode Limitations")

* **Active subscription limit**: In test mode, you can have only three active subscriptions at any time
* **Automatic cancellation**: All subscriptions are automatically canceled after twelve payments (except when using the 5565 test card)

### Test Mode Intervals[​](#test-mode-intervals "Direct link to Test Mode Intervals")

* **Minute and hour intervals**: Only available in test mode for rapid testing of subscription cycles

### Testing Failed Payments[​](#testing-failed-payments "Direct link to Testing Failed Payments")

For testing subscription payment failures, use a test card with the following characteristics:

* **Test card ending in 5565**: Use test card that ending in 5565 (see [Test card numbers](https://docs.monei.com/testing/#test-card-numbers))

* **Payment behavior**:

  <!-- -->

  * The first payment for the subscription will be successful
  * All subsequent payments will fail
  * After the first failed payment, the subscription status changes to `Past due`
  * After three consecutive failed payments, the subscription will be automatically cancelled

<!-- -->

## [📄️<!-- --> <!-- -->Create Subscription](https://docs.monei.com/apis/rest/subscriptions-create/.md)

[Creates a new subscription with the specified parameters.](https://docs.monei.com/apis/rest/subscriptions-create/.md)

## [📄️<!-- --> <!-- -->Get Subscription](https://docs.monei.com/apis/rest/subscriptions-get/.md)

[Retrieves the complete details of an existing subscription by its unique ID.](https://docs.monei.com/apis/rest/subscriptions-get/.md)

## [📄️<!-- --> <!-- -->Update Subscription](https://docs.monei.com/apis/rest/subscriptions-update/.md)

[Updates the configuration of an existing subscription.](https://docs.monei.com/apis/rest/subscriptions-update/.md)

## [📄️<!-- --> <!-- -->Activate Subscription](https://docs.monei.com/apis/rest/subscriptions-activate/.md)

[Activates a subscription by attaching a payment method and initiating the billing cycle.](https://docs.monei.com/apis/rest/subscriptions-activate/.md)

## [📄️<!-- --> <!-- -->Cancel Subscription](https://docs.monei.com/apis/rest/subscriptions-cancel/.md)

[Cancels an active subscription, permanently stopping the billing cycle.](https://docs.monei.com/apis/rest/subscriptions-cancel/.md)

## [📄️<!-- --> <!-- -->Pause Subscription](https://docs.monei.com/apis/rest/subscriptions-pause/.md)

[Pauses an active subscription, temporarily halting the billing cycle.](https://docs.monei.com/apis/rest/subscriptions-pause/.md)

## [📄️<!-- --> <!-- -->Resume Subscription](https://docs.monei.com/apis/rest/subscriptions-resume/.md)

[Resumes a previously paused subscription, reactivating the billing cycle.](https://docs.monei.com/apis/rest/subscriptions-resume/.md)

## [📄️<!-- --> <!-- -->Send Subscription Link](https://docs.monei.com/apis/rest/subscriptions-send-link/.md)

[Sends a subscription activation link to the customer through their preferred communication channel.](https://docs.monei.com/apis/rest/subscriptions-send-link/.md)

## [📄️<!-- --> <!-- -->Send Subscription Status](https://docs.monei.com/apis/rest/subscriptions-send-status/.md)

[Sends subscription status information to the customer through their preferred communication channel.](https://docs.monei.com/apis/rest/subscriptions-send-status/.md)


---

# Hotels Channel Managers

## Before you begin[​](#before-you-begin "Direct link to Before you begin")

This document outlines the process of payment card tokenization, where card information is received, tokenized, and the tokens are returned for secure payment processing. The integration involves making a request to MONEI's endpoint, specifying the channel manager for retrieving this information.

Payment card tokenization is a secure process where card information is replaced with tokens for enhanced security during payment transactions. This document details the tokenization process, supported channel managers, and provides integration guidelines.

## Tokenization Process Overview[​](#tokenization-process-overview "Direct link to Tokenization Process Overview")

The payment card tokenization for our side involves the following key steps:

1. **Request Channel Manager Information:** Make a request to our endpoint, specifying the desired channel manager to retrieve the cards information.
2. **Receive Card Information:** As a PCI-compliant company, the system receives card information securely.
3. **Tokenization:** The received card information is tokenized, and a response containing the tokens is generated.
4. **Return Tokens:** The generated tokens are returned to the requesting entity for secure payment processing.

## Integration[​](#integration "Direct link to Integration")

important

You will have to add your [MONEI API Key](http://localhost:3000/api/#section/Authentication) on your request header in order to authenticate the request.

You can enable **test mode and we will use Siteminder and Channex preprod URLs**, you can enable it on your dashboard.

### [Siteminder](https://www.siteminder.com/)[​](#siteminder "Direct link to siteminder")

Siteminder is a widely used channel management system. We support payment card tokenization through the following API endpoint:

**Endpoint:** `https://api.monei.com/v1/partner/tokens`

**Method:** `POST`

#### Request:[​](#request "Direct link to Request:")

```
{
  "accountId": "<monei_account_id>",
  "hotelCode": "<hotel_code>",
  "sessionId": "<uuid4>",
  "channelManagerType": "SITEMINDER",
  "siteminderName": "<siteminder_name>",
  "username": "<username>",
  "password": "<password>",
  "echoToken": "<uuid4>"
}
```

* **accountId** `string` - Unique identifier representing the **account ID from MONEI which the payment will be transfered**. It is a UUID (Universal Unique Identifier).
* **hotelCode** `string` - Code that uniquely identifies the hotel. **This is provided from Siteminder**
* **sessionId** `string` - A universally unique identifier (UUID) representing the session.
* **channelManagerType** `string` - Indicates the **name of channel manager**. It is a String with two possible values: `SITEMINDER` or `CHANNEX`. In this case we're going to use `SITEMINDER`.
* **siteminderName** `string` - The name of your account with Siteminder.
* **username** `string` - The username used for authentication. **This is provided from Siteminder**.
* **password** `string` - The password associated with the provided username, for authentication purposes. **This is provided from Siteminder**.
* **echoToken** `string` - Globally unique identifier for the request, **value will be returned as an EchoToken in the response**.

note

When acting as a [**proxy for Siteminder**](https://siteminder.atlassian.net/wiki/spaces/PMSXCHANGEV2/pages/1875838050/PMS+Tokenization+in+SiteMinder), the same response is returned as if directly interacting with them, with the addition of the `<MoneiResponse>` field containing the **payment token information**.

#### Response:[​](#response "Direct link to Response:")

```
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header />
    <SOAP-ENV:Body>
        <OTA_ResRetrieveRS xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0"
            TimeStamp="2024-01-17T11:38:03+00:00" EchoToken="uuid4">
            <Success />
            <ReservationsList>
                <HotelReservation CreateDateTime="2024-01-16T16:47:07+00:00" ResStatus="Book">
                        <!--
                        All the siteminder response
                        <POS>
                        <RoomStays>
                        <ResGuests>
                        ... -->
                        <MoneiResponse>
                            <payment_token>298b7c3bc2951ca0513e0e07d495b33ddf29d7ae</payment_token>
                            <expiration>1843430400</expiration>
                            <type>credit</type>
                            <last4>4414</last4>
                            <brand>MC</brand>
                            <cardHolderName>Joan Sanfeliu</cardHolderName>
                        </MoneiResponse>
                    </ResGlobalInfo>
                </HotelReservation>
            </ReservationsList>
        </OTA_ResRetrieveRS>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
```

* `<MoneiResponse>`: This is a container element that **encapsulates the Monei response** information.
* `<payment_token>`: **MONEI's created token of booking card information**. This token is typically used in [subsequent transactions](https://docs.monei.com/apis/rest/payments-create/.md) instead of the actual card details for security reasons.
* `<expiration>`: Indicates the **expiration date** of the payment token.
* `<type>`: Specifies the type of the payment method, in this case, "credit." It indicates that the tokenized information is related to a credit card.
* `<last4>`: Represents the **last four digits** of the card number.
* `<brand>`: Denotes the **brand or card network** associated with the card. In this example, "MC" likely stands for MasterCard.
* `<cardHolderName>`: Provides the name of the cardholder associated with the card, this field contains the\*\* name of the person to whom the card belongs\*\*.

These elements collectively provide details about a tokenized payment method, allowing for secure and privacy-enhanced transactions without exposing sensitive card information.

### [Channex](https://channex.io/)[​](#channex "Direct link to channex")

Channex is another channel management system that seamlessly integrates with the tokenization process. **We expose the same endpoint, but changing the channelManagerType parameter to `CHANNEX`**:

**Endpoint:** `https://api.monei.com/v1/partner/tokens`

**Method:** `POST`

#### Request:[​](#request-1 "Direct link to Request:")

```
{
  "accountId": "<monei_account_id>",
  "sessionId": "<uuid4>",
  "channelManagerType": "CHANNEX",
  "channexId": "<your_channex_api_key>",
  "propertyId": "<property_id>"
}
```

* **accountId** `string` - Unique identifier representing the **account ID from MONEI which the payment will be transfered**. It is a UUID (Universal Unique Identifier).
* **sessionId** `string` - A universally unique identifier (UUID) representing the session.
* **channelManagerType** `string` - Indicates the **name of channel manager**. It is a String with two possible values: `SITEMINDER` or `CHANNEX`. In this case we're going to use `CHANNEX`.
* **channexId** `string` - [Channex API key](https://docs.channex.io/application-documentation/api-key-access).
* **propertyId** `string` - **Optional**. The ID of the property you want to filter by, if not provided will return all the [Booking Revision Feed](https://docs.channex.io/api-v.1-documentation/bookings-collection#booking-revisions-feed).

#### Response:[​](#response-1 "Direct link to Response:")

```
[
  {
    "paymentToken": "b27b97a729ab9cefa8765eccf25d636b13f887cc",
    "expireAt": 2678401,
    "paymentMethod": {
      "method": "card",
      "card": {
        "country": "US",
        "last4": "8164",
        "bank": "Wex Bank",
        "bin": "53463306",
        "cardholderName": "Joan Sanfeliu",
        "expiration": 1767225600,
        "type": "credit",
        "brand": "mastercard"
      }
    },
    "attributes": {
      "id": "cbc57822-912c-4663-a9e5-3930b7539958",
      "meta": {
        "ruid": "Ykc2RlIyh9YUA66gHNu0pFCmOkmrTcr9qWngFe1gY4xjUlSmD+RVGXDjWrLMNL75u7DwI7i7eM9Vu047Nzj/TuNw+WkXmHOFc="
      },
      "status": "new",
      "currency": "GBP",
      "amount": "615.00",
      All the rest of the channex response without card number exposed ...
    }
  }
]
```

* `payment_token`: **MONEI's created token of booking card information**. This token is typically used in [subsequent transactions](https://docs.monei.com/apis/rest/payments-create/.md) instead of the actual card details for security reasons.
* `expireAt`: Indicates the **expiration date** of the payment token.
* `paymentMethod`: Indicates **more information** about the payment method that the user used on his booking.


---

# Adobe Commerce (Magento 2)

MONEI Payments for Adobe Commerce (Magento 2) allows you to seamlessly integrate MONEI's payment processing capabilities into your Magento store. This official module provides a secure, reliable, and user-friendly payment experience for your customers.

[Live demo](https://magento2-demo.monei.com/)

## Before you begin[​](#before-you-begin "Direct link to Before you begin")

To test your integration:

* Use your [test mode](https://docs.monei.com/testing/.md) API Key. You can find them in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api)
* You can check the status of a test payment in your [MONEI Dashboard → Payments](https://dashboard.monei.com/payments) (in test mode).

## Install[​](#install "Direct link to Install")

<!-- -->

* Using composer (recommended)
* From the raw package

You can install MONEI Adobe Commerce Extension using composer by adding it to your composer file using following command:

Go to your Adobe Commerce (Magento 2) root directory and run the following commands:

1. Add the package to your Magento installation:

```
composer require monei/module-monei-payment
```

2. Enable the module:

```
bin/magento module:enable Monei_MoneiPayment
```

3. Run the following commands to upgrade and compile the module:

```
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy
bin/magento cache:clean
```

Go to your Adobe Commerce (Magento 2) root directory.

1. Download the latest release from the [GitHub repository](https://github.com/MONEI/MONEI-AdobeCommerce-Magento2/releases)
2. Extract the contents to your `app/code/Monei/MoneiPayment` directory
3. Install the MONEI PHP SDK:

```
composer require monei/monei-php-sdk:^2.6
```

4. Go to your Adobe Commerce (Magento 2) root directory and run:

```
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
```

Alternatively, you can use this one-line command to download and extract the latest release:

```
curl -L https://github.com/MONEI/MONEI-AdobeCommerce-Magento2/releases/latest/download/monei-module-monei-payment.zip -o monei.zip && \
mkdir -p app/code/Monei/MoneiPayment && \
unzip monei.zip -d app/code/Monei/MoneiPayment && \
rm monei.zip
```

## Configure[​](#configure "Direct link to Configure")

To configure the extension you have to go to **Stores → Configuration→ Payment Methods (under Sales section) → MONEI**

![Configure MONEI Adobe Commerce](/assets/images/configure-magento-0-b412ddb6188c101361e865f26d8e0a75.png)

Enter your API Key. You can find your API Key in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api).

For more information on how to configure the extension, please refer to the [MONEI Adobe Commerce Extension documentation](https://github.com/MONEI/MONEI-AdobeCommerce-Magento2/blob/main/README.md).

## Before you go live[​](#before-you-go-live "Direct link to Before you go live")

* Make sure that you are using [live (production) mode](https://docs.monei.com/testing/.md) API Key.
* Make sure that you have at least one active [payment method](https://dashboard.monei.com/settings/payment-methods)


---

# PrestaShop

To accept payments through MONEI in your PrestaShop store you simply need to install and configure MONEI PrestaShop Module.

[Live demo](https://prestashop-demo.monei.com/)

## Before you begin[​](#before-you-begin "Direct link to Before you begin")

To test your integration:

* Use your [test mode](https://docs.monei.com/testing/.md) API Key. You can find them in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api)
* You can check the status of a test payment in your [MONEI Dashboard → Payments](https://dashboard.monei.com/payments) (in test mode).

## Install[​](#install "Direct link to Install")

* Download the latest version of the [MONEI PrestaShop module](https://github.com/MONEI/MONEI-PrestaShop/releases/latest/download/monei.zip)
* Go to your PrestaShop admin panel
* Navigate to **Modules → Module Manager**
* Click on **Upload a module**
* Select the downloaded `monei.zip` file

![Configure MONEI PrestaShop](/assets/images/configure-prestashop-0-3a4c2ea73553c2db32389837f73c7849.png)

## Configure[​](#configure "Direct link to Configure")

Go to **PrestaShop → Payment → Payment Methods → MONEI → Configure**

![Configure Card Payments](/assets/images/configure-prestashop-1-839c442b2e12c43d01cc736a1629dded.png)

Enter your API Key. You can find your API Key in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api).

## Before you go live[​](#before-you-go-live "Direct link to Before you go live")

* Make sure that you are using [live (production) mode](https://docs.monei.com/testing/.md) API Key.
* Make sure that you have at least one active [payment method](https://dashboard.monei.com/settings/payment-methods)


---

# Salesforce Commerce Cloud

To accept payments through MONEI in your SalesForce Commerce Cloud store you simply need to install and configure the MONEI SalesForce Plugin.

## Before you begin[​](#before-you-begin "Direct link to Before you begin")

To test your integration:

* Use your [test mode](https://docs.monei.com/testing/.md) Account ID and Password. You can find them in [MONEI Dashboard → Settings](https://dashboard.monei.com/settings)
* You can check the status of a test payment in your [MONEI Dashboard → Payments](https://dashboard.monei.com/payments) (in test mode).

## Install[​](#install "Direct link to Install")

Search for **MONEI SalesForce** Plugin in your SalesForce Commerce Cloud site. Alternatively you can [download the GitHub repo of the same.](https://github.com/MONEI/MONEI-Salesforce-Commerce-Cloud)

## Configure[​](#configure "Direct link to Configure")

Enter your Account ID and Password. You can find your Account ID and Password in [MONEI Dashboard → Settings](https://dashboard.monei.com/settings) and click "Activate".

## Before you go live[​](#before-you-go-live "Direct link to Before you go live")

* Make sure that you are using [live (production) mode](https://docs.monei.com/testing/.md) Account ID and Password.
* Make sure that you have at least one active [payment method](https://dashboard.monei.com/settings/payment-methods)


---

# Hide Payment Methods by Country

You can hide specific payment methods on your Shopify checkout page based on the customer's country location. This is useful when you have region-specific payment methods like MONEI Bizum (Spain) or MONEI Multibanco (Portugal) that should only be shown to customers in those countries.

## Overview[​](#overview "Direct link to Overview")

When you have multiple MONEI payment methods installed, you can use conditional logic to show only the relevant payment methods to customers based on their country. The approach depends on your Shopify plan:

* **Shopify Plus**: Use Checkout Blocks (official Shopify app)
* **Other Plans for Shopify**: Use Puco or ETP Sort Hide Payment Methods (third-party apps)

## Shopify Plus: Using Checkout Blocks[​](#shopify-plus-using-checkout-blocks "Direct link to Shopify Plus: Using Checkout Blocks")

Checkout Blocks is the official Shopify app for customizing checkout experiences and includes conditional payment method functionality.

### Installation[​](#installation "Direct link to Installation")

1. Go to [**Shopify App Store**](https://apps.shopify.com/)
2. Search for "Checkout Blocks"
3. Install the official app by Shopify
4. Configure your conditional rules following the [official Shopify documentation](https://help.shopify.com/en/manual/checkout-settings/checkout-blocks/customizations/payment-methods)

Alternatively, install it from [Shopify's apps page](https://apps.shopify.com/partners/shopify)

### Quick Download[​](#quick-download "Direct link to Quick Download")

Download the pre-configured JSON files to import directly into Checkout Blocks:

[📥 Download Bizum Rule](https://docs.monei.com/checkout-bizum-rule.json)

[📥 Download MB Rule](https://docs.monei.com/checkout-mb-rule.json)

How to use downloaded JSON files

1. Download the JSON file(s) you need
2. Go to **Apps → Checkout Blocks → Functions**
3. Click **Create function → Payment/Hide → Import from file**
4. Upload the downloaded JSON file
5. Review and activate the function

### Create rule: Hide Bizum[​](#create-rule-hide-bizum "Direct link to Create rule: Hide Bizum")

**Use Case:** Hide MONEI Bizum for customers outside Spain or Andorra

**Steps:**

1. Go to **Apps → Checkout Blocks → Functions**

2. Click on **Create function → Payment/Hide → Create from blank template**

3. Create the rule:

   <!-- -->

   * **Function title:** Hide Bizum if not Spain/Andorra

   * **Type:** Advanced rules editor

   * **Hidden payment methods:** Add method

     <!-- -->

     * **Contains:** Bizum
     * **Add rule:** Shipping country is not
     * **Select a country:** Andorra, Spain

4. Save the rule

5. Change status to **Active**

**The function can also be imported using this JSON file:**

![Hide Bizum](/assets/images/checkout-bizum-rule-a5b4d059e9ca2060b1d989dcfc78a992.png)

### Create rule: Hide Multibanco and MBWay[​](#create-rule-hide-multibanco-and-mbway "Direct link to Create rule: Hide Multibanco and MBWay")

**Use Case:** Hide MONEI Multibanco and MONEI MBWay for customers outside Portugal

**Steps:**

1. Go to **Apps → Checkout Blocks → Functions**

2. Click on **Create function → Payment/Hide → Create from blank template**

3. Create the rule:

   <!-- -->

   * **Function title:** Hide MB if not Portugal

   * **Type:** Advanced rules editor

   * **Hidden payment methods:** Add method

     <!-- -->

     * **Contains:** Multibanco
     * **Add rule:** Shipping country is not
     * **Select a country:** Portugal

   * **Hidden payment methods:** Add method

     <!-- -->

     * **Contains:** MBWay
     * **Add rule:** Shipping country is not
     * **Select a country:** Portugal

4. Save the rule

5. Change status to **Active**

**The function can also be imported using this JSON file:**

![Hide Multibanco and MBWay](/assets/images/checkout-mb-rule-b4f9746188712ab87e8f00403da257c8.png)

## Other Plans for Shopify: Puco Checkout Rules[​](#other-plans-for-shopify-puco-checkout-rules "Direct link to Other Plans for Shopify: Puco Checkout Rules")

Puco is a third-party app specifically designed for conditional payment method management that works on all Shopify plans. It has a free plan that allows for one checkout rule and a paid one that allows infinite rules

### Installation[​](#installation-1 "Direct link to Installation")

1. Go to [**Shopify App Store**](https://apps.shopify.com/)
2. Search for "Puco Checkout Rules"
3. Install the app
4. Set up your conditional rules

Alternatively, install it from [Puco.io's Shopify partner page](https://apps.shopify.com/partners/puco)

### Setup: Hide Bizum[​](#setup-hide-bizum "Direct link to Setup: Hide Bizum")

**Use Case:** Hide MONEI Bizum for customers outside Spain or Andorra

**Steps:**

1. Go to **Apps → Puco Checkout Rules → Payment**

2. Create a new rule:

   <!-- -->

   * **Customization title:** Hide Bizum if not Spain/Andorra

   * **Based on:**

     * **Condition:** Country Code
     * **Operator:** does not contain
     * **Country list:** Es, Ad

   * **Customization type:** Hide payment methods

   * **Select payment methods to hide:** Pay with Bizum

3. Save the rule

![Hide Bizum](/assets/images/puco-bizum-rule-e4e8d52c014ff62192af6c40a0c2c861.png)

### Setup: Hide Multibanco and MONEI MBWay[​](#setup-hide-multibanco-and-monei-mbway "Direct link to Setup: Hide Multibanco and MONEI MBWay")

**Use Case:** Hide MONEI Multibanco and MONEI MBWay for customers outside Portugal

**Steps:**

1. Go to **Apps → Puco Checkout Rules → Payment**

2. Create a new rule:

   <!-- -->

   * **Customization title:** Hide MB if not Portugal

   * **Based on:**

     * **Condition:** Country Code
     * **Operator:** does not contain
     * **Country list:** Pt

   * **Customization type:** Hide payment methods

   * **Select payment methods to hide:** MBWay, Multibanco (add both manually)

3. Save the rule

![Hide Multibanco and MBWay](/assets/images/puco-mb-rule-af110b8922b14d8f541e87253e523ce6.png)

## Other Plans for Shopify: ETP Sort Hide Payment Methods[​](#other-plans-for-shopify-etp-sort-hide-payment-methods "Direct link to Other Plans for Shopify: ETP Sort Hide Payment Methods")

ETP Sort Hide Payment Methods is a third-party app specifically designed for conditional payment method management that works on all Shopify plans.

### Installation[​](#installation-2 "Direct link to Installation")

1. Go to [**Shopify App Store**](https://apps.shopify.com/)
2. Search for "ETP Hide Sort Payment Methods"
3. Install the app
4. Set up your conditional rules

Alternatively, install it from [E-TRADE PARTNER's Shopify partner page](https://apps.shopify.com/partners/e-trade-partner-p-s-a)

### Setup: Hide Bizum[​](#setup-hide-bizum-1 "Direct link to Setup: Hide Bizum")

**Use Case:** Hide MONEI Bizum for customers outside Spain or Andorra

**Steps:**

1. Go to **Apps → Hide & Sort Payments**

2. Create new:

   <!-- -->

   * **General settings:**

     * **Status:** Active
     * **Customization name:** Hide Bizum if not Spain/Andorra
     * **When do you want this customization to work?:** When certain conditions are met
     * **Which condition set would you like to use?:** Address conditions

   * **Conditions:**

     * **When...:** Country
     * **Operator:** is not one of
     * **Country list:** Spain, Andorra

   * **Customization actions:**

     * **Action:** Hide specific payment method(s)
     * **Operator:** which name(s) contains/contain
     * **Values:** Bizum

3. Save the rule

![Hide Bizum](/assets/images/etp-bizum-rule-9f1f6aed57fb1796731b7fffb0b0eee4.png)

### Setup: Hide Multibanco and MONEI MBWay[​](#setup-hide-multibanco-and-monei-mbway-1 "Direct link to Setup: Hide Multibanco and MONEI MBWay")

**Use Case:** Hide MONEI Multibanco and MONEI MBWay for customers outside Portugal

**Steps:**

1. Go to **Apps → Hide & Sort Payments**

2. Create new:

   <!-- -->

   * **General settings:**

     * **Status:** Active
     * **Customization name:** Hide MB if not Portugal
     * **When do you want this customization to work?:** When certain conditions are met
     * **Which condition set would you like to use?:** Address conditions

   * **Conditions:**

     * **When...:** Country
     * **Operator:** is not one of
     * **Country list:** Portugal

   * **Customization actions:**

     * **Action:** Hide specific payment method(s)
     * **Operator:** which name(s) contains/contain
     * **Values:** Multibanco, MBWay

3. Save the rule

![Hide Multibanco and MBWay](/assets/images/etp-mb-rule-07de1bdca48c3d1d5e0a5ea27366b8e0.png)


---

# MONEI Bizum

To accept Bizum payments through MONEI in your Shopify store you simply need to install and configure MONEI Pay · Bizum Shopify App.

[](https://monei-demo.myshopify.com/)

[Live demo](https://monei-demo.myshopify.com/)

Password: `demo`

## Before you begin[​](#before-you-begin "Direct link to Before you begin")

To test your integration:

* Use your [test mode](https://docs.monei.com/testing/.md) API Key. You can find them in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api)
* You can check the status of a test payment in your [MONEI Dashboard → Payments](https://dashboard.monei.com/payments) (in test mode).

## Install[​](#install "Direct link to Install")

[](https://apps.shopify.com/monei-bizum)

[Install from Shopify App Store](https://apps.shopify.com/monei-bizum)

## Configure[​](#configure "Direct link to Configure")

### First time install[​](#first-time-install "Direct link to First time install")

When you install the app for the first time:

1. You will be automatically redirected to the configuration page

2. Enter your API Key. You can find your API Key in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api)

   ![Configure MONEI App](/assets/images/configuration-b48b96fc64136d7ec3419afe79b0ce04.png)

3. After saving your API Key, you will be redirected to the Payments Settings

4. Click on **Activate** to enable the payment method

   ![Configure MONEI Payments](/assets/images/activate-c353ab63a04b2bb994207ff7fcf2bf49.png)

### Modify configuration[​](#modify-configuration "Direct link to Modify configuration")

To modify payment method settings or switch between test/live mode:

1. Go to **Shopify Admin → Settings**

   ![Shopify Settings](/assets/images/settings-button-a18498071e1a4b09a390769d5744b58f.png)

2. Navigate to **Payments → MONEI Pay · Bizum**

   ![Shopify Payments](/assets/images/payments-section-5a1845721ff4a8f37828204bbd31b5eb.png)

3. Modify your configuration as needed

4. Click on **Activate** to apply your changes

   ![Configure MONEI Payments](/assets/images/activate-c353ab63a04b2bb994207ff7fcf2bf49.png)

### Modify API Key[​](#modify-api-key "Direct link to Modify API Key")

To change your API Key:

1. Go to **Shopify Admin → Settings**

   ![Shopify Settings](/assets/images/settings-button-a18498071e1a4b09a390769d5744b58f.png)

2. Navigate to **Payments → MONEI Pay · Bizum**

   ![Shopify Payments](/assets/images/payments-section-5a1845721ff4a8f37828204bbd31b5eb.png)

3. Click on the **More actions** dropdown menu in the top right corner and select **Manage**

   ![Shopify Manage App](/assets/images/manage-app-button-91885e7bf9daa6345780858fed296236.png)

4. Enter your new API Key

   ![Configure MONEI App](/assets/images/configuration-b48b96fc64136d7ec3419afe79b0ce04.png)

5. After saving, you will be redirected to the Payments Settings

6. Click on **Activate** to apply your changes

## Before you go live[​](#before-you-go-live "Direct link to Before you go live")

* Make sure that you are using [live (production) mode](https://docs.monei.com/testing/.md) API Key.
* Make sure that you have Bizum activated as a [payment method](https://dashboard.monei.com/settings/payment-methods)

## How to find the Shopify Order[​](#how-to-find-the-shopify-order "Direct link to How to find the Shopify Order")

To find the order in Shopify Admin use the Order ID from MONEI Dashboard

![Find MONEI Payment](/assets/images/find-order-id-62a737a72ff51e52a96cdcbab6375d90.png)

Enter the following query in Shopify Admin -> Orders

`receipt.payment_id:{{ MONEI_ORDER_ID }}`

![Find MONEI Payment in Shopify](/assets/images/search-order-443a0cf4056af9d7e4e526d10e766515.png)

You can find the MONEI Order ID in the **Information from the gateway** section in the Shopify order.

![Find Payment in MONEI](/assets/images/order-details-59f75f804c9ca0822b37127a15928d00.png)


---

# MONEI MB Way

To accept MB Way payments through MONEI in your Shopify store you simply need to install and configure MONEI MB Way Shopify App.

[](https://monei-demo.myshopify.com/)

[Live demo](https://monei-demo.myshopify.com/)

Password: `demo`

## Before you begin[​](#before-you-begin "Direct link to Before you begin")

To test your integration:

* Use your [test mode](https://docs.monei.com/testing/.md) API Key. You can find them in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api)
* You can check the status of a test payment in your [MONEI Dashboard → Payments](https://dashboard.monei.com/payments) (in test mode).

## Install[​](#install "Direct link to Install")

[](https://apps.shopify.com/monei-mbway)

[Install from Shopify App Store](https://apps.shopify.com/monei-mbway)

## Configure[​](#configure "Direct link to Configure")

### First time install[​](#first-time-install "Direct link to First time install")

When you install the app for the first time:

1. You will be automatically redirected to the configuration page

2. Enter your API Key. You can find your API Key in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api)

   ![Configure MONEI App](/assets/images/configuration-510f077bc0b053d794a3c27bd1d1f829.png)

3. After saving your API Key, you will be redirected to the Payments Settings

4. Click on **Activate** to enable the payment method

   ![Configure MONEI Payments](/assets/images/activate-f33054a25d305a756c0859d86bf9fda9.png)

### Modify configuration[​](#modify-configuration "Direct link to Modify configuration")

To modify payment method settings or switch between test/live mode:

1. Go to **Shopify Admin → Settings**

   ![Shopify Settings](/assets/images/settings-button-a18498071e1a4b09a390769d5744b58f.png)

2. Navigate to **Payments → MONEI MB Way**

   ![Shopify Payments](/assets/images/payments-section-20a9bd112fd82db646fee2a5c861dabc.png)

3. Modify your configuration as needed

4. Click on **Activate** to apply your changes

   ![Configure MONEI Payments](/assets/images/activate-f33054a25d305a756c0859d86bf9fda9.png)

### Modify API Key[​](#modify-api-key "Direct link to Modify API Key")

To change your API Key:

1. Go to **Shopify Admin → Settings**

   ![Shopify Settings](/assets/images/settings-button-a18498071e1a4b09a390769d5744b58f.png)

2. Navigate to **Payments → MONEI MB Way**

   ![Shopify Payments](/assets/images/payments-section-20a9bd112fd82db646fee2a5c861dabc.png)

3. Click on the **More actions** dropdown menu in the top right corner and select **Manage**

   ![Shopify Manage App](/assets/images/manage-app-button-22e2c07d1d5addc0f9bfdf4641bb8d3f.png)

4. Enter your new API Key

   ![Configure MONEI App](/assets/images/configuration-510f077bc0b053d794a3c27bd1d1f829.png)

5. After saving, you will be redirected to the Payments Settings

6. Click on **Activate** to apply your changes

## Before you go live[​](#before-you-go-live "Direct link to Before you go live")

* Make sure that you are using [live (production) mode](https://docs.monei.com/testing/.md) API Key.
* Make sure that you have MB Way activated as a [payment method](https://dashboard.monei.com/settings/payment-methods)

## How to find the Shopify Order[​](#how-to-find-the-shopify-order "Direct link to How to find the Shopify Order")

To find the order in Shopify Admin use the Order ID from MONEI Dashboard

![Find MONEI Payment](/assets/images/find-order-id-62a737a72ff51e52a96cdcbab6375d90.png)

Enter the following query in Shopify Admin -> Orders

`receipt.payment_id:{{ MONEI_ORDER_ID }}`

![Find MONEI Payment in Shopify](/assets/images/search-order-443a0cf4056af9d7e4e526d10e766515.png)

You can find the MONEI Order ID in the **Information from the gateway** section in the Shopify order.

![Find Payment in MONEI](/assets/images/order-details-59f75f804c9ca0822b37127a15928d00.png)


---

# MONEI Multibanco

To accept Multibanco payments through MONEI in your Shopify store you simply need to install and configure MONEI Multibanco Shopify App.

[](https://monei-demo.myshopify.com/)

[Live demo](https://monei-demo.myshopify.com/)

Password: `demo`

## Before you begin[​](#before-you-begin "Direct link to Before you begin")

To test your integration:

* Use your [test mode](https://docs.monei.com/testing/.md) API Key. You can find them in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api)
* You can check the status of a test payment in your [MONEI Dashboard → Payments](https://dashboard.monei.com/payments) (in test mode).

## Install[​](#install "Direct link to Install")

[](https://apps.shopify.com/monei-multibanco)

[Install from Shopify App Store](https://apps.shopify.com/monei-multibanco)

## Configure[​](#configure "Direct link to Configure")

### First time install[​](#first-time-install "Direct link to First time install")

When you install the app for the first time:

1. You will be automatically redirected to the configuration page

2. Enter your API Key. You can find your API Key in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api)

   ![Configure MONEI App](/assets/images/configuration-97da41731dc30bb46d9b3c66def370dd.png)

3. After saving your API Key, you will be redirected to the Payments Settings

4. Click on **Activate** to enable the payment method

   ![Configure MONEI Payments](/assets/images/activate-c5e3e3881f7141a9ef4de63a3531ea34.png)

### Modify configuration[​](#modify-configuration "Direct link to Modify configuration")

To modify payment method settings or switch between test/live mode:

1. Go to **Shopify Admin → Settings**

   ![Shopify Settings](/assets/images/settings-button-a18498071e1a4b09a390769d5744b58f.png)

2. Navigate to **Payments → MONEI Multibanco**

   ![Shopify Payments](/assets/images/payments-section-f05e5ab026694545878a3726d8926625.png)

3. Modify your configuration as needed

4. Click on **Activate** to apply your changes

   ![Configure MONEI Payments](/assets/images/activate-c5e3e3881f7141a9ef4de63a3531ea34.png)

### Modify API Key[​](#modify-api-key "Direct link to Modify API Key")

To change your API Key:

1. Go to **Shopify Admin → Settings**

   ![Shopify Settings](/assets/images/settings-button-a18498071e1a4b09a390769d5744b58f.png)

2. Navigate to **Payments → MONEI Multibanco**

   ![Shopify Payments](/assets/images/payments-section-f05e5ab026694545878a3726d8926625.png)

3. Click on the **More actions** dropdown menu in the top right corner and select **Manage**

   ![Shopify Manage App](/assets/images/manage-app-button-cc8580049da93ff7f90aebbe340e9215.png)

4. Enter your new API Key

   ![Configure MONEI App](/assets/images/configuration-97da41731dc30bb46d9b3c66def370dd.png)

5. After saving, you will be redirected to the Payments Settings

6. Click on **Activate** to apply your changes

## Before you go live[​](#before-you-go-live "Direct link to Before you go live")

* Make sure that you are using [live (production) mode](https://docs.monei.com/testing/.md) API Key.
* Make sure that you have Multibanco activated as a [payment method](https://dashboard.monei.com/settings/payment-methods)

## How to find the Shopify Order[​](#how-to-find-the-shopify-order "Direct link to How to find the Shopify Order")

To find the order in Shopify Admin use the Order ID from MONEI Dashboard

![Find MONEI Payment](/assets/images/find-order-id-62a737a72ff51e52a96cdcbab6375d90.png)

Enter the following query in Shopify Admin -> Orders

`receipt.payment_id:{{ MONEI_ORDER_ID }}`

![Find MONEI Payment in Shopify](/assets/images/search-order-443a0cf4056af9d7e4e526d10e766515.png)

You can find the MONEI Order ID in the **Information from the gateway** section in the Shopify order.

![Find Payment in MONEI](/assets/images/order-details-59f75f804c9ca0822b37127a15928d00.png)


---

# MONEI Onsite

To accept payments directly on your Shopify store you simply need to install and configure MONEI Onsite Shopify App.

[](https://monei-demo.myshopify.com/)

[Live demo](https://monei-demo.myshopify.com/)

Password: `demo`

## Before you begin[​](#before-you-begin "Direct link to Before you begin")

To test your integration:

* Use your [test mode](https://docs.monei.com/testing/.md) API Key. You can find them in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api)
* You can check the status of a test payment in your [MONEI Dashboard → Payments](https://dashboard.monei.com/payments) (in test mode).

## Install[​](#install "Direct link to Install")

[](https://apps.shopify.com/monei-onsite)

[Install from Shopify App Store](https://apps.shopify.com/monei-onsite)

## Configure[​](#configure "Direct link to Configure")

### First time install[​](#first-time-install "Direct link to First time install")

When you install the app for the first time:

1. You will be automatically redirected to the configuration page

2. Enter your API Key. You can find your API Key in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api)

   ![Configure MONEI App](/assets/images/configuration-4ae0f9789aff2a4cc8092c6fa0944d35.png)

3. After saving your API Key, you will be redirected to the Payments Settings

4. Click on **Activate** to enable the payment method

   ![Configure MONEI Payments](/assets/images/activate-75ec69e26dea5f4e69e9eaae7807e702.png)

### Modify configuration[​](#modify-configuration "Direct link to Modify configuration")

To modify payment method settings or switch between test/live mode:

1. Go to **Shopify Admin → Settings**

   ![Shopify Settings](/assets/images/settings-button-a18498071e1a4b09a390769d5744b58f.png)

2. Navigate to **Payments → MONEI Onsite**

   ![Shopify Payments](/assets/images/payments-section-02c44d6fdb5a6a9b1d80f2223e362e9a.png)

3. Modify your configuration as needed

4. Click on **Activate** to apply your changes

   ![Configure MONEI Payments](/assets/images/activate-75ec69e26dea5f4e69e9eaae7807e702.png)

### Modify API Key[​](#modify-api-key "Direct link to Modify API Key")

To change your API Key:

1. Go to **Shopify Admin → Settings**

   ![Shopify Settings](/assets/images/settings-button-a18498071e1a4b09a390769d5744b58f.png)

2. Navigate to **Payments → MONEI Onsite**

   ![Shopify Payments](/assets/images/payments-section-02c44d6fdb5a6a9b1d80f2223e362e9a.png)

3. Click on the **More actions** dropdown menu in the top right corner and select **Manage**

   ![Shopify Manage App](/assets/images/manage-app-button-a688e33b99e776804483df565685295b.png)

4. Enter your new API Key

   ![Configure MONEI App](/assets/images/configuration-4ae0f9789aff2a4cc8092c6fa0944d35.png)

5. After saving, you will be redirected to the Payments Settings

6. Click on **Activate** to apply your changes

## Before you go live[​](#before-you-go-live "Direct link to Before you go live")

* Make sure that you are using [live (production) mode](https://docs.monei.com/testing/.md) API Key.
* Make sure that you have at least one active [payment method](https://dashboard.monei.com/settings/payment-methods)

## How to find the Shopify Order[​](#how-to-find-the-shopify-order "Direct link to How to find the Shopify Order")

To find the order in Shopify Admin use the Order ID from MONEI Dashboard

![Find MONEI Payment](/assets/images/find-order-id-62a737a72ff51e52a96cdcbab6375d90.png)

Enter the following query in Shopify Admin -> Orders

`receipt.payment_id:{{ MONEI_ORDER_ID }}`

![Find MONEI Payment in Shopify](/assets/images/search-order-443a0cf4056af9d7e4e526d10e766515.png)

You can find the MONEI Order ID in the **Information from the gateway** section in the Shopify order.

![Find Payment in MONEI](/assets/images/order-details-59f75f804c9ca0822b37127a15928d00.png)


---

# MONEI Payments

To accept payments through MONEI in your Shopify store you simply need to install and configure MONEI Payments Shopify App.

[](https://monei-demo.myshopify.com/)

[Live demo](https://monei-demo.myshopify.com/)

Password: `demo`

## Before you begin[​](#before-you-begin "Direct link to Before you begin")

To test your integration:

* Use your [test mode](https://docs.monei.com/testing/.md) API Key. You can find them in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api)
* You can check the status of a test payment in your [MONEI Dashboard → Payments](https://dashboard.monei.com/payments) (in test mode).

## Install[​](#install "Direct link to Install")

[](https://apps.shopify.com/monei-payments)

[Install from Shopify App Store](https://apps.shopify.com/monei-payments)

## Configure[​](#configure "Direct link to Configure")

### First time install[​](#first-time-install "Direct link to First time install")

When you install the app for the first time:

1. You will be automatically redirected to the configuration page

2. Enter your API Key. You can find your API Key in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api)

   ![Configure MONEI App](/assets/images/configuration-3d7416e8d1497acb387058ee1cfcee13.png)

3. After saving your API Key, you will be redirected to the Payments Settings

4. Click on **Activate** to enable the payment method

   ![Configure MONEI Payments](/assets/images/activate-da47e55fa029018ba4e8f3435b79438b.png)

### Modify configuration[​](#modify-configuration "Direct link to Modify configuration")

To modify payment method settings or switch between test/live mode:

1. Go to **Shopify Admin → Settings**

   ![Shopify Settings](/assets/images/settings-button-a18498071e1a4b09a390769d5744b58f.png)

2. Navigate to **Payments → MONEI Payments**

   ![Shopify Payments](/assets/images/payments-section-75c2015057a4954b0500922ac98aa6a6.png)

3. Modify your configuration as needed

4. Click on **Activate** to apply your changes

   ![Configure MONEI Payments](/assets/images/activate-da47e55fa029018ba4e8f3435b79438b.png)

### Modify API Key[​](#modify-api-key "Direct link to Modify API Key")

To change your API Key:

1. Go to **Shopify Admin → Settings**

   ![Shopify Settings](/assets/images/settings-button-a18498071e1a4b09a390769d5744b58f.png)

2. Navigate to **Payments → MONEI Payments**

   ![Shopify Payments](/assets/images/payments-section-75c2015057a4954b0500922ac98aa6a6.png)

3. Click on the **More actions** dropdown menu in the top right corner and select **Manage**

   ![Shopify Manage App](/assets/images/manage-app-button-64f43da069b0c2a240da2c212fdcc20f.png)

4. Enter your new API Key

   ![Configure MONEI App](/assets/images/configuration-3d7416e8d1497acb387058ee1cfcee13.png)

5. After saving, you will be redirected to the Payments Settings

6. Click on **Activate** to apply your changes

## Before you go live[​](#before-you-go-live "Direct link to Before you go live")

* Make sure that you are using [live (production) mode](https://docs.monei.com/testing/.md) API Key.
* Make sure that you have at least one active [payment method](https://dashboard.monei.com/settings/payment-methods)

## How to find the Shopify Order[​](#how-to-find-the-shopify-order "Direct link to How to find the Shopify Order")

To find the order in Shopify Admin use the Order ID from MONEI Dashboard

![Find MONEI Payment](/assets/images/find-order-id-62a737a72ff51e52a96cdcbab6375d90.png)

Enter the following query in Shopify Admin -> Orders

`receipt.payment_id:{{ MONEI_ORDER_ID }}`

![Find MONEI Payment in Shopify](/assets/images/search-order-443a0cf4056af9d7e4e526d10e766515.png)

You can find the MONEI Order ID in the **Information from the gateway** section in the Shopify order.

![Find Payment in MONEI](/assets/images/order-details-59f75f804c9ca0822b37127a15928d00.png)


---

# WIX

To accept payments through MONEI in your WIX store you simply need to install MONEI in WIX App Market.

## Before you begin[​](#before-you-begin "Direct link to Before you begin")

To test your integration:

* Use your [test mode](https://docs.monei.com/testing/.md) API Key. You can find them in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api)
* You can check the status of a test payment in your [MONEI Dashboard → Payments](https://dashboard.monei.com/payments) (in test mode).

## Install[​](#install "Direct link to Install")

* Go to [Accept Payments](https://www.wix.com/my-account/site-selector/?buttonText=Set%20Up%20Payments\&title=Select%20a%20Site\&autoSelectOnSingleSite=true\&actionUrl=https://www.wix.com/dashboard/%7b%7bmetaSiteId%7d%7d/payments/) on your site's dashboard.

  note

  Check your business location at the top right. If incorrect, click the drop-down menu to change it.

* Click **See More Payment Options**.

* Click **Connect** beside **MONEI**.

  ![Connect MONEI to WIX](/assets/images/configure-wix-0-6a9f425a67a8250c98102820542dd97f.png)

* Enter your API Key. You can find your API Key in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api) and click **Connect**

You can also install [MONEI from WIX App Market](https://www.wix.com/market?appMarketParams=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoie1wicm91dGVcIjpcInRlc3RBcHBcIixcImFwcERlZklkXCI6XCJiZWQyMTg3OS0xMmUyLTQyNjYtYWQyYy01MGM5ZmQ1ODkyMTZcIixcInZlcnNpb25cIjpcIjAuMC4xOTZcIn0iLCJpYXQiOjE2MjgxNTM4NTF9.XfNlLXXNwmN7IrGE4Co5IOCp0Dq6MHDGNZ5Zxkowero). Get more info at [WIX Support Portal](https://support.wix.com/en/article/connecting-monei-as-a-payment-provider).

## Before you go live[​](#before-you-go-live "Direct link to Before you go live")

* Make sure that you are using [live (production) mode](https://docs.monei.com/testing/.md) API Key.
* Make sure that you have at least one active [payment method](https://dashboard.monei.com/settings/payment-methods)


---

# WooCommerce

To accept payments through MONEI in your WooCommerce store you simply need to install and configure MONEI WooCommerce Plugin.

[Live demo](https://woocommerce-demo.monei.com)

## Before you begin[​](#before-you-begin "Direct link to Before you begin")

To test your integration:

* Use your [test mode](https://docs.monei.com/testing/.md) API Key. You can find them in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api)
* You can check the status of a test payment in your [MONEI Dashboard → Payments](https://dashboard.monei.com/payments) (in test mode).

## Install[​](#install "Direct link to Install")

![Install MONEI WooCommerce](/assets/images/configure-woo-0-2225e48f0e2ae37695063d05f930a8ee.png)

[](https://wordpress.org/plugins/monei/)

[Download from wordpress.org](https://wordpress.org/plugins/monei/)

## Configure[​](#configure "Direct link to Configure")

Go to **WooCommerce → Settings → MONEI Settings**

Enter your Account ID and API Key. You can find your Account ID and API Key in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api).

![Configure MONEI WooCommerce](/assets/images/configure-woo-1-7cbac5ff60b4c3092ee478d388e2b0c2.png)

Go to **WooCommerce → Settings → Payments**

Configure payment methods that you want to accept in your store.

![Configure Card Payments](/assets/images/configure-woo-2-025f30aade6a206acd63266e44598795.png)

## Migration to WooCommerce Blocks[​](#migration-to-woocommerce-blocks "Direct link to Migration to WooCommerce Blocks")

Starting from **version 6.0**, our plugin supports [WooCommerce Blocks](https://woocommerce.com/document/woocommerce-blocks/). To enable new user experience, you need to update the checkout page and cart page templates.

Go to **Pages**and find the **Checkout** page. Remove old shortcode and add **Checkout** block to the page.

![Configure Checkout Page](/assets/images/configure-woo-3-8a636d28f76456cb8833c97d276006df.png)

Go to **Pages** and find the **Cart** page. Remove old shortcode and add **Cart** block to the page.

![Configure Cart Page](/assets/images/configure-woo-4-9a987623e70fc009f8060c63fc792e1e.png)

## Before you go live[​](#before-you-go-live "Direct link to Before you go live")

* Make sure that you are using [live (production) mode](https://docs.monei.com/testing/.md) API Key.
* Make sure that you have at least one active [payment method](https://dashboard.monei.com/settings/payment-methods)


---

# EURM Stablecoin

EURM is a stablecoin developed by MONEI, designed to facilitate digital payments by maintaining a 1:1 parity with the euro. Technically, EURM operates on blockchain technology, specifically utilizing Ethereum and Polygon networks, to ensure secure and efficient transactions. 

## Key Technical Features[​](#key-technical-features "Direct link to Key Technical Features")

* **Blockchain Integration:** EURM leverages the Ethereum and Polygon blockchains, enabling decentralized and transparent transactions. This integration ensures high security and scalability, accommodating a large volume of transactions with minimal latency. 
* **Smart Contracts:** The use of smart contracts automates transaction processes, reducing the need for intermediaries and minimizing the risk of human error. This automation enhances the efficiency and reliability of financial operations.
* **Stablecoin Mechanism:** Each EURM token is backed by an equivalent euro held in reserve accounts at reputable Spanish financial institutions, such as BBVA and Caixabank. This backing ensures stability and trustworthiness, making EURM a reliable medium for digital transactions. 
* **Regulatory Compliance:** EURM operates under the supervision of the Bank of Spain’s Financial Sandbox, ensuring adherence to regulatory standards and fostering trust among users and financial institutions. 

## Potential Benefits for Financial Institutions:[​](#potential-benefits-for-financial-institutions "Direct link to Potential Benefits for Financial Institutions:")

* **Enhanced Transaction Efficiency:** The integration of blockchain technology allows for near-instantaneous transactions, improving the speed and efficiency of payment processing.
* **Cost Reduction:** By automating processes through smart contracts, EURM reduces operational costs associated with traditional payment systems.
* **Increased Security:** The decentralized nature of blockchain technology provides robust security measures, protecting against fraud and unauthorized transactions.
* **Regulatory Alignment:** Operating within the Bank of Spain’s Financial Sandbox ensures that EURM complies with existing financial regulations, facilitating smoother integration with traditional financial systems.

note

**Collaborating with MONEI to implement EURM can position financial institutions at the forefront of digital payment innovation,** offering clients a secure, efficient, and modern transaction solution.

**Here are several key programming-related aspects that detail how EURM functions on a technical level:**

### Smart Contract Architecture[​](#smart-contract-architecture "Direct link to Smart Contract Architecture")

* **Language:** EURM’s smart contracts are primarily written in Solidity, the standard language for Ethereum-compatible blockchain development. Solidity enables the creation of complex, immutable, and highly efficient contracts that can process transactions automatically.

### Key Contract Components[​](#key-contract-components "Direct link to Key Contract Components")

* **Minting/Burning Logic:** Functions handle minting new EURM tokens when euros are added to the reserve and burning them when euros are withdrawn. This logic ensures that EURM tokens remain fully collateralized by real euros.
* **Account Management:** Contracts include features for creating and managing wallet addresses linked to accounts at financial institutions. This allows EURM tokens to map transparently and securely to each user’s unique ID.
* **Compliance and Permissions:** Additional contract modules may enforce KYC (Know Your Customer) compliance by restricting token transfers to authorized accounts or ensuring users are verified. This modular structure makes it easier to adapt to changing regulatory requirements.

### Gas Optimization[​](#gas-optimization "Direct link to Gas Optimization")

* **Polygon for Lower Costs:** EURM primarily operates on Polygon to minimize gas fees associated with token transfers and smart contract executions, while maintaining Ethereum compatibility. This allows for high transaction volumes with significantly lower costs compared to the Ethereum mainnet.
* **Efficient Contract Design:** Smart contracts are optimized to minimize storage usage and computational requirements, as these contribute to gas costs. For example, instead of writing multiple small transactions, contracts batch transactions where possible to reduce network calls.

### Token Standards and Interoperability[​](#token-standards-and-interoperability "Direct link to Token Standards and Interoperability")

* **ERC-20 Standard Compliance:** EURM implements the ERC-20 token standard, ensuring compatibility with Ethereum and Polygon ecosystems. This enables seamless integration with compatible wallets, exchanges, and DeFi platforms while maintaining the necessary regulatory compliance features.
* **Custom Extensions:** MONEI has likely added extensions to the ERC-20 contract, such as pausing or freezing tokens in compliance cases or enhancing security by restricting the functions that certain accounts can perform (e.g., non-compliant addresses can’t transfer tokens).

### API and SDK for Integration[​](#api-and-sdk-for-integration "Direct link to API and SDK for Integration")

* **REST and GraphQL APIs:** MONEI provides a comprehensive REST API that enables developers to interact with EURM services, including balance checks, transaction execution, and history retrieval. The API is designed with security and ease of integration in mind.
* **SDKs for Popular Languages:** To simplify integration, MONEI provides Software Development Kits (SDKs) for popular languages like JavaScript, Python, and Java. These SDKs abstract the complex interactions with the Ethereum or Polygon blockchains, allowing developers to integrate EURM with minimal blockchain knowledge.

### Security and Auditing[​](#security-and-auditing "Direct link to Security and Auditing")

* **Automated Auditing Tools:** EURM’s smart contracts undergo automated audits using tools like MythX and CertiK, which detect vulnerabilities in smart contract code. This helps prevent issues like reentrancy attacks or integer overflows.
* **Manual Code Audits:** Before any major release, EURM’s contracts are manually reviewed by blockchain security experts to ensure they meet the highest security standards.
* **Multisig Wallets and Governance:** EURM employs multisignature wallets for handling reserves and approving major contract updates. This adds a layer of security by requiring multiple approvals from trusted individuals before significant actions are taken.

### Data Privacy and Compliance[​](#data-privacy-and-compliance "Direct link to Data Privacy and Compliance")

* **Encrypted User Data:** While the blockchain records transactions publicly, EURM employs off-chain solutions for sensitive user data, which is encrypted and stored in secure databases compliant with GDPR and other privacy laws.
* **Compliance via Oracles:** Compliance requirements, such as real-time checks of sanctioned addresses, are enforced through oracles that interact with off-chain compliance data. Oracles may prevent transactions from non-compliant addresses and provide automatic alerts for suspicious activities.

### On-Chain and Off-Chain Reconciliation[​](#on-chain-and-off-chain-reconciliation "Direct link to On-Chain and Off-Chain Reconciliation")

* **Real-Time Euro Collateral Tracking:** Off-chain systems regularly update and reconcile the euros held in reserve to ensure that each EURM token remains fully backed. These updates are verified by third-party auditors and use secure APIs to record changes in reserve accounts.
* **Blockchain-Linked Ledger:** MONEI maintains a distributed ledger that logs all EURM transactions, both on-chain and off-chain. This hybrid approach helps track regulatory data while leveraging blockchain for security and transparency.

### Scalability and Future-Proofing[​](#scalability-and-future-proofing "Direct link to Scalability and Future-Proofing")

* **Layer-2 Integration:** EURM primarily utilizes Polygon as its Layer-2 solution, offering scalability and cost-efficiency while maintaining security. The modular architecture allows for potential integration with other scaling solutions if needed in the future.
* **Upgradeable Contracts:** Through an upgradable smart contract pattern (e.g., using the OpenZeppelin upgradeable proxy), EURM can adopt improvements or regulatory updates without having to redeploy entirely new contracts, making it adaptable over time.

note

By implementing these programming principles, **EURM provides a robust, secure, and flexible foundation for digital euro transactions that can adapt to regulatory changes and scaling demands.** This technical infrastructure, combined with MONEI’s expertise, makes EURM a valuable tool for financial institutions looking to enter the digital currency space securely and efficiently.


---

# Getting started

### Ways to Integrate[​](#ways-to-integrate "Direct link to Ways to Integrate")

Choose the integration method that best suits your needs:

* **[Use a prebuilt payment page](https://docs.monei.com/integrations/use-prebuilt-payment-page/.md)** The simplest way to securely collect payments with multiple payment methods.
* **[Build a custom checkout](https://docs.monei.com/integrations/build-custom-checkout/.md)** Use MONEI Components to build your custom checkout experience.
* **[Payments API](https://docs.monei.com/apis/rest/payments/.md)** Securely perform server-to-server payments.

### Become a Partner (MONEI Connect)[​](#become-a-partner-monei-connect "Direct link to Become a Partner (MONEI Connect)")

Enable payment processing for users on your platform or marketplace.

* **[Learn about MONEI Connect](https://docs.monei.com/monei-connect/.md)**: Integrate payments directly into your platform for your merchants.

### E-commerce Platforms[​](#e-commerce-platforms "Direct link to E-commerce Platforms")

Integrate MONEI with your e-commerce platform:

* **[Shopify](https://docs.monei.com/e-commerce/shopify/monei-payments/.md)**
* **[WooCommerce](https://docs.monei.com/e-commerce/woocommerce/.md)**
* **[Wix](https://docs.monei.com/e-commerce/wix/.md)**
* **[Salesforce Commerce Cloud](https://docs.monei.com/e-commerce/salesforce/.md)**
* **[Spreedly](https://docs.spreedly.com/payment-gateways/monei/)**
* **[Adobe Commerce (Magento 2)](https://docs.monei.com/e-commerce/adobe-commerce/.md)**
* **[PrestaShop](https://docs.monei.com/e-commerce/prestashop/.md)**

### Hotel Channel Managers[​](#hotel-channel-managers "Direct link to Hotel Channel Managers")

Connect with hotel booking systems:

* **[Siteminder](https://docs.monei.com/channel-tokenization/.md)**
* **[Channex](https://docs.monei.com/channel-tokenization/.md)**

### AI-Friendly Documentation[​](#ai-friendly-documentation "Direct link to AI-Friendly Documentation")

Use our machine-readable documentation with LLMs and AI coding assistants:

* **[llms.txt](https://docs.monei.com/llms.txt)** — index of all documentation pages in markdown format
* **[llms-full.txt](https://docs.monei.com/llms-full.txt)** — all documentation concatenated into a single file
* **[openapi.json](https://docs.monei.com/openapi.json)** — OpenAPI spec with full REST API schemas, parameters, and responses
* Use the **"Copy page"** button on any page to copy its content as markdown
* Feed the copied markdown to your AI assistant for context-aware help with MONEI integration


---

# Ethoca & Verifi Sync

To further enhance the security and reliability of payment processes, MONEI offers critical support for integrating [Ethoca](https://www.ethoca.com/) and [Verifi](https://www.verifi.com/) services. These integrations are essential for merchants looking to improve oversight and control of their transaction environments, significantly reducing the risk of chargebacks.

By implementing these services, merchants can detect and respond to potential fraud and disputes more effectively and efficiently.

The specific details provided by MONEI for this integration are crucial and include the following:

* **Merchant Name** - The official name of the business registered with MONEI.
* **Merchant ID** - A unique identifier assigned to the merchant by MONEI for transaction tracking and account management.
* **VISA Acquirer BIN** - The Bank Identification Number associated with VISA transactions, necessary for processing VISA payments.
* **Mastercard Acquirer BIN** - Similarly, the BIN required for processing Mastercard transactions.

To obtain this information, please contact <support@monei.com>.

If you have any questions, please contact our [Support Team](https://support.monei.com/hc/requests/new).


---

# Managing Multiple Stores

With MONEI, you can manage multiple stores within a single account, providing centralized and simplified transaction management. This functionality is particularly valuable for businesses with several points of sale or business units that require detailed control over their operations.

### Creating a Store from the Dashboard[​](#creating-a-store-from-the-dashboard "Direct link to Creating a Store from the Dashboard")

You can create new stores directly from the MONEI dashboard. To do this, you should go to [MONEI Dashboard → Settings → Stores](https://dashboard.monei.com/settings/stores). Here, you’ll be able to add important store details, such as the store name, email, phone number, website, and address information. This makes it easier for you to manage and keep track of all your stores from one place.

Additionally, your dashboard allows you to search for specific stores, making it quick and efficient to find the data you need and manage store-related transactions. This is especially useful if you’re handling multiple points of sale and need to track each store’s activity individually.

Once a store is created, the storeId (a unique identifier crucial for API operations) will be displayed on the store management screen. This identifier is necessary for linking payments to individual stores. Furthermore, you have the capability to update store details or remove stores as needed, ensuring complete flexibility and control over your store configurations.

![Configure Stores](/assets/images/configure-stores-db6ac00672765528ff2c77e6cf8b0100.png)

### Assigning Payments to Stores[​](#assigning-payments-to-stores "Direct link to Assigning Payments to Stores")

To link a payment to a specific store, the storeId parameter must be included in the API request when creating a payment. This unique identifier ensures that the transaction is explicitly associated with the designated store, enabling precise financial reporting and analytics.

Notably, the storeId only needs to be specified during the payment creation process; subsequent operations such as confirmation, capture, or refund inherit the store association by default. This approach minimizes redundancy and optimizes API interaction by simplifying follow-up transaction requests.

note

The ability to assign payments using the `storeId` parameter is not available for standard integrations with e-commerce platforms such as Shopify, Prestashop, Wix, and WooCommerce. This option is only applicable in custom implementations.

### Create a payment with storeId on your server[​](#create-a-payment-with-storeid-on-your-server "Direct link to Create a payment with storeId on your server")

<!-- -->

* cURL
* Node.js
* PHP

POST https\://api.monei.com/v1/payments

```
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",
    "description": "Test Store - #14379133960355",
    "storeId": "e5f28150d9e8974c58ab5ec9c4a880f8734dcf05",
}'
```

server.js

```
const {Monei, TransactionTypes} = require('@monei-js/node-sdk');
const monei = new Monei('pk_test_36cf3e8a15eff3f5be983562ea6b13ec');
monei.payments.create({
  amount: 110,
  currency: 'EUR',
  orderId: '14379133960355',
  description: 'Test Store - #14379133960355',
  storeId: 'e5f28150d9e8974c58ab5ec9c4a880f8734dcf05'
});
```

server.php

```
$monei = new Monei\MoneiClient('pk_test_36cf3e8a15eff3f5be983562ea6b13ec');
$monei->payments->create([
  'amount' => 110,
  'currency' => 'EUR',
  'orderId' => '14379133960355',
  'description' => 'Test Store - #14379133960355',
  'storeId' => 'e5f28150d9e8974c58ab5ec9c4a880f8734dcf05'
]);
```

The following parameters are required:

* **amount** `positive integer` - 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)
* **currency** `string` - Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase. Must be a supported currency.
* **orderId** `string` - An order ID from your system. A unique identifier that can be used to reconcile the payment with your internal system.
* **storeId** `string` - `A unique identifier of the Store. If specified the payment is attached to this Store.`

Check all available [request parameters](https://docs.monei.com/apis/rest/payments-create/.md).

### Configuring IBAN for Settlements[​](#configuring-iban-for-settlements "Direct link to Configuring IBAN for Settlements")

MONEI offers the possibility of setting up a unique IBAN for each store, allowing payment settlements to be directed to the corresponding bank account. To enable this functionality, you need to contact MONEI's [Support Team](https://support.monei.com/hc/requests/new) for assistance in completing the IBAN configuration.


---

# Migrate your tokenized cards to MONEI

If you have cards tokenized by your payment processor or in your own database, you can securely migrate them to MONEI. This way, you can use them to create payments and subscriptions without requesting your customers to confirm their card details again.

Contact your payment processor to perform PCI-compliant migration. The payment processor should use MONEI Public PGP Key downloaded from <https://assets.monei.com/keys/pgp-public-key> to securely encrypt the card details and send them directly to MONEI - <support@monei.com>.

We will need the following information for each card:

* **PAN number** - the full card number
* **Cardholder name** - optional
* **Expiration date** - month and year
* **Initial transaction ID** - the identifier returned by the card network when the initial transaction was confirmed by the customer, also known as COF (Credential On File) ID

### Encrypting file with MONEI PGP Key[​](#encrypting-file-with-monei-pgp-key "Direct link to Encrypting file with MONEI PGP Key")

If you’re unfamiliar with PGP, see [GPG](http://gnupg.org/) and start by [importing a public key](http://www.gnupg.org/gph/en/manual.html#AEN84). Use the MONEI Public PGP key downloaded from <https://assets.monei.com/keys/pgp-public-key> to encrypt sensitive data for PCI-compliant migration.

```
gpg --import pgp-public-key
gpg --encrypt --recipient admin@monei.com SENSITIVE_DATA
```

This creates SENSITIVE\_DATA.gpg with the following information:

* **Key ID**: `D1EAC68D28C86E2A7DDD360AC6B156F9C06E825A`
* **Key type**: `RSA`
* **Key size**: `4096 bits`
* **Fingerprint**: `D1EA C68D 28C8 6E2A 7DDD 360A C6B1 56F9 C06E 825A`
* **User ID**: `MONEI DIGITAL PAYMENTS SL <admin@monei.com>`

Send the encrypted file to <support@monei.com>.

If you have any questions, please contact our [Support Team](https://support.monei.com/hc/requests/new).


---

# MONEI POD WiFi Setup

Follow these steps to configure WiFi on your MONEI POD:

* Android
* iOS

1. Install [MFAPLink](https://play.google.com/store/apps/details?id=com.morefun.aplinkdemo) on your phone.

2. Long press the **M** key for 2 seconds on your MONEI POD to enter **Configure Network Mode**.

   ![MONEI POD Configure Network Mode screen](/img/monei-pod-wifi/monei-pod-1.jpg)

3. Press **+** to select **WIFI** and enter WiFi configuration mode.

   ![MONEI POD WIFI Network Mode selection](/img/monei-pod-wifi/monei-pod-2.jpg)

4. Connect your phone to the WiFi network you want to configure on the MONEI POD (must be 2.4GHz, 5GHz is not supported).

5. Open MFAPLink app and select **KM\_AP CONNECTION**.

   ![MFAPLink Android app KM\_AP CONNECTION option](/img/monei-pod-wifi/android-1.jpg)

6. Verify the WiFi name is correct, enter the WiFi password, and tap **CONNECT**.

   ![MFAPLink Android WiFi configuration screen](/img/monei-pod-wifi/android-2.jpg)

7. Allow MFAPLink to join the MONEI POD's network when prompted.

   ![Android permission dialog to join MONEI POD network](/img/monei-pod-wifi/android-3.jpg)

8. Wait for the success message: **Ap network configuration information is sent successfully**. The device will restart and connect to the WiFi network.

   ![MFAPLink Android success message confirmation](/img/monei-pod-wifi/android-4.jpg)

1) Install [MFAPLink](https://apps.apple.com/es/app/mfaplink/id1645497573) on your phone.

2) Long press the **M** key for 2 seconds on your MONEI POD to enter **Configure Network Mode**.

   ![MONEI POD Configure Network Mode screen](/img/monei-pod-wifi/monei-pod-1.jpg)

3) Press **+** to select **WIFI** and enter WiFi configuration mode.

   ![MONEI POD WIFI Network Mode selection](/img/monei-pod-wifi/monei-pod-2.jpg)

4) Connect your phone to the WiFi network you want to configure on the MONEI POD (must be 2.4GHz, 5GHz is not supported).

5) Open MFAPLink app and select **Default AP Mode**.

6) Verify the WiFi name is correct, enter the WiFi password, and tap **Connect**.

   ![MFAPLink iOS WiFi configuration screen](/img/monei-pod-wifi/iphone-1.jpg)

7) Allow MFAPLink to join the MONEI POD's network when prompted.

   ![iOS permission dialog to join MONEI POD network](/img/monei-pod-wifi/iphone-2.jpg)

8) Wait for the success message: **Connecting device successfully**. The device will restart and connect to the WiFi network.

   ![MFAPLink iOS success message confirmation](/img/monei-pod-wifi/iphone-3.jpg)


---

# Payouts (beta)

The MONEI Payouts API allows you to send money to individuals via Bizum or Cards.

warning

The Payouts API is currently in closed beta. To request access, please contact our [Support Team](https://support.monei.com/hc/requests/new). Please note that the Payouts API is not available in the test environment.

## Before you begin[​](#before-you-begin "Direct link to Before you begin")

To enable MONEI payouts, it is essential to maintain a positive balance in the merchant account at all times. Additionally, a minimum initial top-up of €5,000 to the merchant account balance is required to fully activate the payout functionality.

## Payouts with Bizum[​](#payouts-with-bizum "Direct link to Payouts with Bizum")

Before you start, you need to make sure that you have Bizum enabled in [MONEI Dashboard → Settings → Payment Methods](https://dashboard.monei.com/settings/payment-methods). If you don't have Bizum configured, please contact our [Support Team](https://support.monei.com/hc/requests/new).

To test your Bizum payout integration:

You can use the [MONEI API endpoint](https://docs.monei.com/apis/rest/bizum/.md) to verify if the phone number is registered with Bizum before sending the money to the end user.

Bizum payouts do not require client's confirmation. You only need to know their phone number.

### 1. Create a new payment on your server.[​](#1-create-a-new-payment-on-your-server "Direct link to 1. Create a new payment on your server.")

<!-- -->

* cURL
* Node.js
* PHP

POST https\://api.monei.com/v1/payments

```
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",
    "description": "Test Shop - #14379133960355",
    "transactionType": "PAYOUT",
    "paymentMethod": {
      "bizum": {
        "phoneNumber": "+34500000000"
      }
    }
}'
```

server.js

```
const {Monei, TransactionTypes} = require('@monei-js/node-sdk');
const monei = new Monei('pk_test_36cf3e8a15eff3f5be983562ea6b13ec');
monei.payments.create({
  amount: 110,
  currency: 'EUR',
  orderId: '14379133960355',
  description: 'Test Shop - #14379133960355',
  transactionType: TransactionTypes.PAYOUT,
  paymentMethod: {
    bizum: {
      phoneNumber: '+34500000000'
    }
  }
});
```

server.php

```
$monei = new Monei\MoneiClient('pk_test_36cf3e8a15eff3f5be983562ea6b13ec');
$monei->payments->create([
  'amount' => 110,
  'currency' => 'EUR',
  'orderId' => '14379133960355',
  'description' => 'Test Shop - #14379133960355',
  'transactionType' => 'PAYOUT',
  'paymentMethod' => [
    'bizum' => [
      'phoneNumber' => '+34500000000'
    ]
  ]
]);
```

The following parameters are required:

* **amount** `positive integer` - 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)
* **currency** `string` - Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase. Must be a supported currency.
* **orderId** `string` - An order ID from your system. A unique identifier that can be used to reconcile the payment with your internal system.
* **transactionType** `string` - `PAYOUT`
* **paymentMethod** `object` - Payment method object. It must contain `bizum` object with `phoneNumber` property.

Check all available [request parameters](https://docs.monei.com/apis/rest/payments-create/.md).

### 2. Handle the response[​](#2-handle-the-response "Direct link to 2. Handle the response")

Example response:

Bizum payouts are executed immediately. If the request is successful, you will receive a `PAID_OUT` status in the response.

```
{
  "id": "af6029f80f5fc73a8ad2753eea0b1be0",
  "amount": 110,
  "currency": "EUR",
  "orderId": "14379133960355",
  "description": "Test Shop - #14379133960355",
  "livemode": true,
  "status": "PAID_OUT",
  "statusCode": "E000",
  "statusMessage": "Transaction approved",
  "createdAt": 1685430038,
  "updatedAt": 1685430039,
  "paymentMethod": {
    "method": "bizum",
    "bizum": {
      "phoneNumber": "+34500000000",
      "integrationType": "REST"
    }
  },
  "nextAction": {
    "type": "COMPLETE",
    "redirectUrl": "https://secure.monei.com/payments/af6029f80f5fc73a8ad2753eea0b1be0/receipt"
  }
}
```

Check the full list of returned [response parameters](https://docs.monei.com/apis/rest/schemas/payment/.md).

Optionally, you can redirect the client to the `nextAction.redirectUrl` to show the payout status or receipt.

## Payouts with Cards[​](#payouts-with-cards "Direct link to Payouts with Cards")

Payouts are supported by all our integrations. You can use a prebuilt payment page or build a custom checkout to let your client enter their Card details to receive the payout.

Pass the `transactionType` parameter with the value `PAYOUT` to create a payout in the first step of our guides.

* [Use a prebuilt payment page](https://docs.monei.com/integrations/use-prebuilt-payment-page/.md)
* [Build a custom checkout](https://docs.monei.com/integrations/build-custom-checkout/.md)

Payouts are only supported for Cards and Bizum payments so, you need to pass the `allowedPaymentMethods` parameter with the values of `card` or `bizum` (in case you have more payment methods enabled)


---

# Save payment method

To save a payment method for the future use you need to generate `paymentToken` when you create or confirm the payment and then save it on your server. This process is often called **tokenization**.

Tokenization protects sensitive data through a process of replacing the data with a non-sensitive equivalent, known as a token. The token has no external significance or value. It’s a reference — or identifier — that through a tokenization system, maps back to the sensitive data. This process securely collects sensitive card information and prevents data theft.

## 1. Generate payment token[​](#1-generate-payment-token "Direct link to 1. Generate payment token")

### When you create a payment `Server-side`[​](#when-you-create-a-payment-server-side "Direct link to when-you-create-a-payment-server-side")

<!-- -->

* cURL
* Node.js
* PHP

POST https\://api.monei.com/v1/payments

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

server.js

```
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'
});
```

server.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'
]);
```

Check all available [request parameters](https://docs.monei.com/apis/rest/.md).

note

To retrieve the payment token for future use without charging your customer, create a payment with the following parameters:

```
{
  "amount": 0,
  "currency": "EUR",
  "orderId": "14379133960355",
  "transactionType": "VERIF",
  "generatePaymentToken": true,
  "callbackUrl": "https://example.com/checkout/callback",
  "completeUrl": "https://example.com/checkout/complete"
}
```

### When you confirm a payment `Server-side`[​](#when-you-confirm-a-payment-server-side "Direct link to when-you-confirm-a-payment-server-side")

* cURL
* Node.js
* PHP

POST https\://api.monei.com/v1/payments/:id/confirm

```
curl --request POST 'https://api.monei.com/v1/payments/26d1f09c42bb59a29b06e280f9553cd5/confirm' \
--header 'Authorization: pk_test_3c140607778e1217f56ccb8b50540e00' \
--header 'Content-Type: application/json' \
--data-raw '{
    "paymentToken": "7cc38b08ff471ccd313ad62b23b9f362b107560b",
    "generatePaymentToken": true
}'
```

server.js

```
const {Monei} = require('@monei-js/node-sdk');
const monei = new Monei('pk_test_36cf3e8a15eff3f5be983562ea6b13ec');
monei.payments.confirm({
  paymentToken: '7cc38b08ff471ccd313ad62b23b9f362b107560b',
  generatePaymentToken: true
});
```

server.php

```
$monei = new Monei\MoneiClient('pk_test_36cf3e8a15eff3f5be983562ea6b13ec');
$monei->payments->confirm(
  '832b77d1a4b372349a7ae0bb1b2af059',
  [
    'paymentToken' => '7cc38b08ff471ccd313ad62b23b9f362b107560b',
    'generatePaymentToken' => true
  ]
);
```

Check all available [request parameters](https://docs.monei.com/apis/rest/payments-confirm/.md).

### When you submit a payment form `Client-side`[​](#when-you-submit-a-payment-form-client-side "Direct link to when-you-submit-a-payment-form-client-side")

You can pass `generatePaymentToken: true` when you submit a payment form. This is useful for allowing your customers to select if they want to save payment method for future use.

checkout.html

```
<form
  action="https://secure.monei.com/payments/{{payment_id}}/confirm"
  method="post"
  id="payment-form"
>
  <div class="card-field">
    <div id="card-input">
      <!-- A MONEI Card Input Component will be inserted here. -->
    </div>
    <!-- Used to display card errors. -->
    <div id="card-error"></div>
  </div>
  <label>
    <!-- A checkbox to save payment method -->
    <input type="checkbox" name="generatePaymentToken" value="true" />
    save payment method
  </label>
  <button type="submit" id="payment-button">Submit payment</button>
</form>
```

Check [card payment method](https://docs.monei.com/payment-methods/card/.md) integration for more details.

## 2. Obtain and store payment token[​](#2-obtain-and-store-payment-token "Direct link to 2. Obtain and store payment token")

After the payment is completed the customer is redirected to the `completeUrl` with **payment\_id** query parameter, you can obtain permanent `paymentToken` by calling [get payment](https://docs.monei.com/apis/rest/payments-get/.md) endpoint.

Store this `paymentToken` in your database along with customer information. Next time the customer does a purchase, [create a payment](https://docs.monei.com/apis/rest/payments-create/.md) with this token to skip payment form. Keep in mind that the customer will still need to complete 3d secure verification.

note

MONEI will not return **paymentToken** in the HTTP POST request to the **callbackUrl** for security reasons. You have to call [get payment](https://docs.monei.com/apis/rest/payments-get/.md) endpoint to retrieve the token. Generated **paymentToken** does not expire and should only be used **server-side**.


---

# Send cardholder name

note

Strong CustomerAuthentication and PSD2 normative requires cardholder name to be sent for each transaction.

You can send cardholder name when you are confirming your payment on the client or on the server.

### Confirm the payment (monei.js) `Client-side`[​](#confirm-the-payment-moneijs-client-side "Direct link to confirm-the-payment-moneijs-client-side")

client.js

```
// Confirm the payment
function moneiTokenHandler(token) {
  return monei
    .confirmPayment({
      paymentId: '{{payment_id}}',
      paymentToken: token,
      paymentMethod: {card: {cardholderName: 'JOHN DOE'}}
    })
    .then(function (result) {
      // At this moment you can show a customer the payment result
      // But you should always rely on the result passed to the callback endpoint on your server
      // to update the order status
      console.log(result);
    })
    .catch(function (error) {
      console.log(error);
    });
}
```

### Confirm the payment (html form) `Client-side`[​](#confirm-the-payment-html-form-client-side "Direct link to confirm-the-payment-html-form-client-side")

checkout.html

```
<form
  action="https://secure.monei.com/payments/{{payment_id}}/confirm"
  method="post"
  id="payment-form"
>
  <input type="hidden" name="paymentToken" value="7cc38b08ff471ccd313ad62b23b9f362b107560b" />
  <input type="hidden" name="paymentMethod.card.cardholderName" value="JOHN DOE" />
  <button type="submit" id="payment-button">Submit payment</button>
</form>
```

### Confirm the payment `Server-side`[​](#confirm-the-payment-server-side "Direct link to confirm-the-payment-server-side")

<!-- -->

* cURL
* Node.js
* PHP

POST https\://api.monei.com/v1/payments/{id}/confirm

```
curl --request POST 'https://api.monei.com/v1/payments/832b77d1a4b372349a7ae0bb1b2af059/confirm' \
--header 'Authorization: pk_test_3c140607778e1217f56ccb8b50540e00' \
--header 'Content-Type: application/json' \
--data-raw '{
  "paymentToken": "7cc38b08ff471ccd313ad62b23b9f362b107560b",
  "paymentMethod": {
    "card": {
      "cardholderName": "JOHN DOE"
    }
  }
}'
```

server.js

```
const {Monei} = require('@monei-js/node-sdk');
const monei = new Monei('pk_test_36cf3e8a15eff3f5be983562ea6b13ec');
monei.payments.confirm('832b77d1a4b372349a7ae0bb1b2af059', {
  paymentToken: '7cc38b08ff471ccd313ad62b23b9f362b107560b',
  paymentMethod: {
    card: {
      cardholderName: 'JOHN DOE'
    }
  }
});
```

server.php

```
$monei = new Monei\MoneiClient('pk_test_36cf3e8a15eff3f5be983562ea6b13ec');
  $monei->payments->confirm(
  '832b77d1a4b372349a7ae0bb1b2af059',
  [
    'paymentToken' => '7cc38b08ff471ccd313ad62b23b9f362b107560b',
    'paymentMethod' => [
      'card' => [
        'cardholderName' => 'JOHN DOE'
      ]
    ]
  ]
]);
```


---

# Verify signature

The `MONEI-Signature` header included in each signed request contains a timestamp and one or more signatures. The timestamp is prefixed by `t=`, and each signature is prefixed by a scheme. Schemes start with `v`, followed by an integer. Currently, the only valid live signature scheme is `v1`.

```
MONEI-Signature: t=1492774577,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd
```

MONEI generates signatures using a hash-based message authentication code ([HMAC](https://en.wikipedia.org/wiki/HMAC)) with [SHA-256](https://en.wikipedia.org/wiki/SHA-2). To prevent [downgrade attacks](https://en.wikipedia.org/wiki/Downgrade_attack), you should ignore all schemes that are not `v1`.

## Verifying signatures using our official libraries[​](#verifying-signatures-using-our-official-libraries "Direct link to Verifying signatures using our official libraries")

Use one of our official libraries to verify signatures. You perform the verification by providing the request payload and the `MONEI-Signature` header. If verification fails, MONEI returns an error.

<!-- -->

* Node.js
* PHP
* Python

server.js

```
import express from 'express';
import {Monei, PaymentStatus} from '@monei-js/node-sdk';

// Set your api key. Remember to switch to your live api key in production!
// See your api key here: https://dashboard.monei.com/settings/api
const monei = new Monei('YOUR_API_KEY');

// This example uses Express to receive webhooks
const app = express();

// Endpoint to handle MONEI webhooks
app.post('/checkout/callback', express.raw({type: 'application/json'}), (req, res) => {
  const signature = req.headers['MONEI-Signature'];

  try {
    // Verify the signature using the raw request body and the header
    const payment = monei.verifySignature(req.body.toString(), signature);

    // Optional: Log the received payment status
    console.log(`Webhook received for Payment ID: ${payment.id}, Status: ${payment.status}`);

    // Update your order status based on the payment status
    if (payment.status === PaymentStatus.SUCCEEDED) {
      // Payment successful - fulfill the order
      console.log(`Payment ${payment.id} succeeded. Fulfilling order...`);
      // Update your database, send confirmation email, etc.
    } else if (payment.status === PaymentStatus.FAILED) {
      // Payment failed - notify the customer
      console.log(`Payment ${payment.id} failed. Notifying customer...`);
      // Log the failure, update your database, etc.
    } else if (payment.status === PaymentStatus.AUTHORIZED) {
      // Payment is authorized but not yet captured
      console.log(`Payment ${payment.id} authorized. Capture if needed.`);
      // You might want to capture it later using monei.payments.capture()
    } else if (payment.status === PaymentStatus.CANCELED) {
      // Payment was canceled by the user or system
      console.log(`Payment ${payment.id} was canceled.`);
      // Update your database accordingly
    } else {
      // Handle other potential statuses if necessary
      console.log(`Unhandled payment status: ${payment.status} for Payment ${payment.id}`);
    }

    // Acknowledge receipt of the webhook with a 200 OK status
    res.status(200).json({received: true});
  } catch (error) {
    // Handle signature verification failure
    console.error('Invalid webhook signature:', error.message);
    // Respond with 401 Unauthorized if the signature is invalid
    res.status(401).json({error: 'Invalid signature'});
  }
});

// Start the server
app.listen(3000, () => {
  console.log(`Server listening on port 3000`);
});
```

server.php

```
<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Monei\\Model\\PaymentStatus;
use Monei\\ApiException;

// Replace YOUR_API_KEY with your actual MONEI API key
$monei = new Monei\\MoneiClient('YOUR_API_KEY');

// Parse raw body for signature verification
$rawBody = file_get_contents('php://input');
$signature = $_SERVER['HTTP_MONEI_SIGNATURE'] ?? '';

try {
    // Verify the signature
    // verifySignature returns the validated Payment object or throws ApiException
    $payment = $monei->verifySignature($rawBody, $signature);

    // Optional: Log the received payment status
    error_log('Webhook received for Payment ID: ' . $payment->getId() . ', Status: ' . $payment->getStatus());

    // Update your order status based on the payment status
    if ($payment->getStatus() === PaymentStatus::SUCCEEDED) {
        // Payment successful - fulfill the order
        error_log('Payment ' . $payment->getId() . ' succeeded. Fulfilling order...');
        // Update your database, send confirmation email, etc.
    } else if ($payment->getStatus() === PaymentStatus::FAILED) {
        // Payment failed - notify the customer
        error_log('Payment ' . $payment->getId() . ' failed. Notifying customer...');
        // Log the failure, update your database, etc.
    } else if ($payment->getStatus() === PaymentStatus::AUTHORIZED) {
        // Payment is authorized but not yet captured
        error_log('Payment ' . $payment->getId() . ' authorized. Capture if needed.');
        // You can capture it later using $monei->payments->capture(...)
    } else if ($payment->getStatus() === PaymentStatus::CANCELED) {
        // Payment was canceled
        error_log('Payment ' . $payment->getId() . ' was canceled.');
        // Update your database accordingly
    } else {
        // Handle other potential statuses if necessary
        error_log('Unhandled payment status: ' . $payment->getStatus() . ' for Payment ' . $payment->getId());
    }

    // Acknowledge receipt of the webhook with a 200 OK status
    http_response_code(200);
    header('Content-Type: application/json'); // Ensure JSON header
    echo json_encode(['received' => true]);

} catch (ApiException $e) {
    // Handle signature verification failure (ApiException specifically)
    error_log('Invalid webhook signature: ' . $e->getMessage());
    http_response_code(401); // Respond with 401 Unauthorized
    header('Content-Type: application/json'); // Ensure JSON header
    echo json_encode(['error' => 'Invalid signature']);
    exit(); // Stop script execution after sending error response
} catch (Exception $e) {
    // Handle any other unexpected errors during processing
    error_log('Webhook processing error: ' . $e->getMessage());
    http_response_code(500); // Respond with 500 Internal Server Error
    header('Content-Type: application/json');
    echo json_encode(['error' => 'Internal server error']);
    exit();
}
?>
```

server.py

```
import os
import Monei
from Monei.errors import SignatureVerificationError
from flask import Flask, request, abort, jsonify

# Replace YOUR_API_KEY with your actual MONEI API key
monei_client = Monei.MoneiClient(api_key="YOUR_API_KEY")

app = Flask(__name__)

# Update route and function name
@app.route('/checkout/callback', methods=['POST'])
def callback():
    signature = request.headers.get('MONEI-Signature') # Use correct header key

    # Check if signature header exists (optional but good practice)
    if not signature:
        print("MONEI-Signature header missing")
        return jsonify({'error': 'Missing MONEI-Signature header'}), 400

    try:
        # Verify the signature using raw request data (bytes)
        payment = monei_client.verify_signature(request.data, signature)

        # Optional: Log the received payment status
        payment_id = payment.get('id')
        payment_status = payment.get('status')
        print(f"Webhook received for Payment ID: {payment_id}, Status: {payment_status}")

        # Update your order status based on the payment status
        if payment_status == 'SUCCEEDED':
            # Payment successful - fulfill the order
            print(f"Payment {payment_id} succeeded. Fulfilling order...")
            # Update your database, send confirmation email, etc.
            pass # Placeholder from user snippet
        elif payment_status == 'FAILED':
            # Payment failed - notify the customer
            print(f"Payment {payment_id} failed. Notifying customer...")
            # Log the failure, update your database, etc.
            pass # Placeholder from user snippet
        elif payment_status == 'AUTHORIZED':
            # Payment is authorized but not yet captured
            print(f"Payment {payment_id} authorized. Capture if needed.")
            # You can capture it later
            pass # Placeholder from user snippet
        elif payment_status == 'CANCELED':
            # Payment was canceled
            print(f"Payment {payment_id} was canceled.")
            pass # Placeholder from user snippet
        else:
             print(f"Unhandled payment status: {payment_status} for Payment {payment_id}")

        # Acknowledge receipt of the webhook
        return jsonify({'received': True}), 200

    except SignatureVerificationError as e: # Catch specific signature error
        print(f"Invalid webhook signature: {e}")
        # Return 401 Unauthorized as requested
        return jsonify({'error': 'Invalid signature'}), 401
    except Exception as e: # Catch other potential errors during processing
        print(f"Webhook processing error: {e}")
        # Return 500 Internal Server Error for other issues
        return jsonify({'error': 'Internal server error'}), 500

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

## Verifying signatures manually[​](#verifying-signatures-manually "Direct link to Verifying signatures manually")

### Step 1: Extract the timestamp and the signature from the header[​](#step-1-extract-the-timestamp-and-the-signature-from-the-header "Direct link to Step 1: Extract the timestamp and the signature from the header")

Split the header, using the `,` character as the separator, to get a list of elements. Then split each element, using the `=` character as the separator, to get a prefix and value pair.

The value for the prefix `t` corresponds to the timestamp, and `v1` corresponds to the signature (or signatures). You can discard all other elements.

### Step 2: Prepare the `signed_payload` string[​](#step-2-prepare-the-signed_payload-string "Direct link to step-2-prepare-the-signed_payload-string")

The `signed_payload` string is created by concatenating:

* The timestamp (as a string)
* The character `.`
* The actual JSON payload (i.e., the request body)

### Step 3: Determine the expected signature[​](#step-3-determine-the-expected-signature "Direct link to Step 3: Determine the expected signature")

Compute an HMAC with the SHA256 hash function. Use your account's API Key as the key, and use the `signed_payload` string as the message.

You can get your accounts password in [MONEI Dashboard → Settings → API](https://dashboard.monei.com/settings/api).

### Step 4: Compare the signatures[​](#step-4-compare-the-signatures "Direct link to Step 4: Compare the signatures")

Compare the signature in the header to the expected signature. For an equality match, compute the difference between the current timestamp and the received timestamp, then decide if the difference is within your tolerance.

To protect against timing attacks, use a constant-time string comparison to compare the expected signature to the received signature.


---

# Build a custom checkout

Build your own custom checkout experience using [MONEI Components](https://docs.monei.com/monei-js/overview/.md) to securely collect payment details for various methods directly on your site.

![MONEI Payments Demo](/assets/images/custom-checkout-demo-eee8eb56f146ccd3e664abc174a19e75.png)

[](https://payments-demo.monei.com)

[Live demo](https://payments-demo.monei.com)

[Source code](https://github.com/MONEI/monei-payments-demo)

**MONEI Components Key Features:**

* Securely collect payment details via iframes hosted by MONEI.
* Generate a one-time `paymentToken` for secure server-side processing.
* Available for plain JavaScript, React, Vue, and Angular.
* Support styling, language customization, and multiple payment methods.
* Helps meet PCI DSS compliance requirements as sensitive data doesn't touch your server.

## Before You Begin[​](#before-you-begin "Direct link to Before You Begin")

* This guide covers integrating various payment method Components. If you prefer a simpler, no-code solution, consider the [Prebuilt Payment Page](https://docs.monei.com/integrations/use-prebuilt-payment-page/.md).
* You'll need a MONEI account and your API keys (test or live). Find them in your [MONEI Dashboard](https://dashboard.monei.com/settings/api).
* Use your [test mode keys](https://docs.monei.com/testing/.md) for integration testing.
* Ensure relevant payment methods are enabled in your account settings.
* You can monitor test payments in your [MONEI Dashboard → Payments](https://dashboard.monei.com/payments) (ensure Test Mode is active).

## Integration Steps[​](#integration-steps "Direct link to Integration Steps")

Integrating MONEI Components involves creating a Payment on your server, mounting the Component on your client-side, creating a token, confirming the payment, and processing the webhook notification.

<!-- -->

### 1. Create Payment (Server-side)[​](#1-create-payment-server-side "Direct link to 1. Create Payment (Server-side)")

Create a [Payment](https://docs.monei.com/apis/rest/schemas/payment/.md) on your server with an amount and currency. Always decide the amount on the server side.

* cURL
* Node.js
* PHP
* Python

POST https\://api.monei.com/v1/payments

```
curl --request POST 'https://api.monei.com/v1/payments' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "amount": 110,
  "currency": "EUR",
  "orderId": "14379133960355",
  "description": "Test Shop - #14379133960355",
  "customer": {
    "email": "email@example.com"
   },
  "callbackUrl": "https://example.com/checkout/callback"
}'
```

(Replace `YOUR_API_KEY` with your actual MONEI API key)

server.js

```
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 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'
});

// Pass payment.id to your client-side
const paymentId = payment.id;
```

server.php

```
<?php
require_once 'vendor/autoload.php';

use Monei\Model\CreatePaymentRequest;
use Monei\Model\PaymentCustomer;
use Monei\MoneiClient;

// Replace YOUR_API_KEY with your actual MONEI API key
$monei = new MoneiClient('YOUR_API_KEY');

$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'
  ])
);

// Pass payment ID to your client-side
$paymentId = $payment->getId();
?>
```

server.py

```
import Monei
from Monei import CreatePaymentRequest, PaymentCustomer

# Replace YOUR_API_KEY with your actual MONEI API key
monei = Monei.MoneiClient(api_key="YOUR_API_KEY")

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

# Pass payment ID to your client-side
payment_id = payment.id
```

**Key Parameters:**

* **amount** `positive integer`: Amount in the smallest currency unit.
* **currency** `string`: Three-letter ISO currency code.
* **orderId** `string`: Your unique order identifier.
* **callbackUrl** `string`: Your server endpoint for webhook notifications.

Check all available [request parameters](https://docs.monei.com/apis/rest/payments-create/.md).

The response contains `payment.id`. Pass this securely to your client-side for the next step.

### 2. Add Component to your payment page (Client-side)[​](#2-add-component-to-your-payment-page-client-side "Direct link to 2. Add Component to your payment page (Client-side)")

Include `monei.js` on your checkout page by adding the script tag to the `head` of your HTML file.

checkout.html

```
<head>
  <title>Checkout</title>
  <script src="https://js.monei.com/v2/monei.js"></script>
</head>
<body>
  <!-- Create an empty container for the card input -->
  <div id="card-element">
    <!-- A MONEI Card Input Component will be inserted here. -->
  </div>
  <!-- Your client-side script -->
  <script src="client.js"></script>
</body>
```

Create an empty DOM node (container) with a unique ID in your checkout page. Then, initialize the Component:

client.js

```
// Get paymentId passed securely from your server
const paymentId = '{{payment_id}}'; // Replace with actual paymentId

// Create an instance of the Card Input Component using the paymentId.
const cardElement = monei.CardInput({
  paymentId: paymentId
  // You can add other options like style, onFocus, onChange here
  // See MONEI Components reference for details
});

// Render the Component into the container
cardElement.render('#card-element');

// Next step: Confirm the payment (see below)
```

### 3. Confirm the payment (Client-side)[​](#3-confirm-the-payment-client-side "Direct link to 3. Confirm the payment (Client-side)")

To complete the payment, you need to confirm it using the `monei.confirmPayment` function.

You need to provide the `paymentId` (obtained in Step 1) and a `paymentToken` generated with the Component.

client.js

```
// Assumes cardElement is the initialized CardInput component from Step 2

// Function to create a token and then confirm the payment
function handlePayment() {
  monei
    .createToken(cardElement) // Create token from the card input
    .then(function (result) {
      console.log('Token creation result:', result);
      if (result.error) {
        // Inform the user if there was an error creating the token.
        console.error('Token Error:', result.error.message);
      } else {
        // Token created successfully, now confirm the payment.
        confirmPaymentWithToken(result.token);
      }
    })
    .catch(function (error) {
      console.error('Error during token creation:', error);
    });
}

// Function to handle the payment confirmation using the generated token
function confirmPaymentWithToken(paymentToken) {
  monei
    .confirmPayment({paymentId: paymentId, paymentToken: paymentToken})
    .then(function (result) {
      console.log('Payment confirmation result:', result);
      // At this moment you can show a customer the payment result (e.g., redirect)
      // But you should ALWAYS rely on the result passed to the callback endpoint
      // on your server (Step 4) to update the final order status.
      if (result.error) {
        console.error('Confirmation Error:', result.error.message);
      } else {
        console.log('Payment status (client-side):', result.status);
        // Example: window.location.href = '/thank-you?paymentId=' + paymentId;
      }
    })
    .catch(function (error) {
      console.error('Error during payment confirmation:', error);
    });
}

// You would typically call handlePayment() when the user clicks your pay button.
// Example: document.getElementById('your-pay-button').addEventListener('click', handlePayment);
```

After you confirm the payment, MONEI handles any necessary steps like 3D Secure authentication.

Alternative Flow

As an alternative process, you can submit the generated `paymentToken` to your server and then [confirm the payment server-side](https://docs.monei.com/apis/rest/payments-confirm/.md).

### 4. Process Webhook Notification (Server-side)[​](#4-process-webhook-notification-server-side "Direct link to 4. Process Webhook Notification (Server-side)")

After the client-side interaction and any necessary background processing (like 3D Secure or bank authorization), MONEI sends the final, authoritative payment status via an asynchronous HTTP POST request to the `callbackUrl` you provided in Step 1.

The request body contains the full [Payment object](https://docs.monei.com/apis/rest/schemas/payment/.md) in JSON format.

This webhook is the **only reliable way** to confirm the definitive payment outcome.

**Crucially, you must:**

1. **Verify the `MONEI-Signature` header** included in the request. This confirms the webhook genuinely came from MONEI. See the [Verify Signatures guide](https://docs.monei.com/guides/verify-signature/.md) for implementation details.
2. **Return a `200 OK` HTTP status code** immediately upon receiving the webhook to acknowledge receipt. Any other status code tells MONEI the notification failed.

If MONEI doesn't receive a `200 OK`, it will retry sending the webhook.

Once the signature is verified, inspect the `status` field in the Payment object (`SUCCEEDED`, `FAILED`, `CANCELED`, etc.) to determine whether to fulfill the order or handle the failure.

## Before you go live[​](#before-you-go-live "Direct link to Before you go live")

* Make sure you are using [live (production) mode](https://docs.monei.com/testing/.md) Account ID and API Key.
* Make sure you have a [payment method configured and enabled](https://dashboard.monei.com/settings/payment-methods) in live mode.


---

# Pay By Link

Send your customers a unique link via email, WhatsApp or SMS to pay online in one click!

![Pay By Link](/assets/images/pay-by-link-preview-4d556971cae5fec9a877bc19f8001a04.png)

## Overview[​](#overview "Direct link to Overview")

This page explains how to create payment links programmatically using the [MONEI Payments API](https://docs.monei.com/apis/rest/payments-create/.md). You can also create and manage payment links manually via your [MONEI Dashboard](https://dashboard.monei.com/).

Pay By Link generates a unique URL for a specific payment amount that directs the customer to a secure MONEI-hosted payment page.

## Before You Begin[​](#before-you-begin "Direct link to Before You Begin")

* You'll need a MONEI account and your API keys (test or live). Find them in your [MONEI Dashboard](https://dashboard.monei.com/settings/api).
* Use your [test mode keys](https://docs.monei.com/testing/.md) for integration testing.
* Ensure relevant payment methods are enabled in your account settings for the hosted page.
* You can monitor test payments in your [MONEI Dashboard → Payments](https://dashboard.monei.com/payments) (ensure Test Mode is active).

## Integration Steps[​](#integration-steps "Direct link to Integration Steps")

Creating and processing a Pay By Link payment involves creating a payment on your server, sending the generated link to the customer, and processing the final payment status via webhooks.

### 1. Create Payment (Server-side)[​](#1-create-payment-server-side "Direct link to 1. Create Payment (Server-side)")

Create a [Payment](https://docs.monei.com/apis/rest/schemas/payment/.md) on your server with an amount, currency, and optionally customer details.

<!-- -->

* cURL
* Node.js
* PHP
* Python

POST https\://api.monei.com/v1/payments

```
curl --request POST 'https://api.monei.com/v1/payments' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "amount": 110,
  "currency": "EUR",
  "orderId": "14379133960355",
  "description": "Test Shop - #14379133960355",
  "customer": {
    "email": "email@example.com",
    "phone": "+34666555444"
   },
  "callbackUrl": "https://example.com/checkout/callback",
  "completeUrl": "https://example.com/checkout/complete", // Optional: Redirect after payment attempt
  "cancelUrl": "https://example.com/checkout/cancel"     // Optional: Redirect if user cancels
}'
```

(Replace `YOUR_API_KEY` with your actual MONEI API key)

server.js

```
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 payment = await monei.payments.create({
  amount: 110,
  currency: 'EUR',
  orderId: '14379133960355',
  description: 'Test Shop - #14379133960355',
  customer: {
    email: 'email@example.com',
    phone: '+34666555444'
  },
  callbackUrl: 'https://example.com/checkout/callback',
  completeUrl: 'https://example.com/checkout/complete', // Optional
  cancelUrl: 'https://example.com/checkout/cancel' // Optional
});

// You will need the paymentId from the response in the next step
const paymentId = payment.id;
```

server.php

```
<?php
require_once 'vendor/autoload.php';

use Monei\Model\CreatePaymentRequest;
use Monei\Model\PaymentCustomer;
use Monei\MoneiClient;

// Replace YOUR_API_KEY with your actual MONEI API key
$monei = new MoneiClient('YOUR_API_KEY');

$payment = $monei->payments->create(
  new CreatePaymentRequest([
    'amount' => 110,
    'currency' => 'EUR',
    'order_id' => '14379133960355',
    'description' => 'Test Shop - #14379133960355',
    'customer' => new PaymentCustomer([
      'email' => 'email@example.com',
      'phone' => '+34666555444'
    ]),
    'callback_url' => 'https://example.com/checkout/callback',
    'complete_url' => 'https://example.com/checkout/complete', // Optional
    'cancel_url' => 'https://example.com/checkout/cancel'     // Optional
  ])
);

// You will need the paymentId from the response in the next step
$paymentId = $payment->getId();
?>
```

server.py

```
import Monei
from Monei import CreatePaymentRequest, PaymentCustomer

# Replace YOUR_API_KEY with your actual MONEI API key
monei = Monei.MoneiClient(api_key="YOUR_API_KEY")

payment = monei.payments.create(
    CreatePaymentRequest(
        amount=110,
        currency="EUR",
        order_id="14379133960355",
        description="Test Shop - #14379133960355",
        customer=PaymentCustomer(
          email="email@example.com",
          phone="+34666555444"
        ),
        callback_url="https://example.com/checkout/callback",
        complete_url="https://example.com/checkout/complete", // Optional
        cancel_url="https://example.com/checkout/cancel"     // Optional
    )
)

// You will need the paymentId from the response in the next step
payment_id = payment.id
```

**Key Parameters:**

* **amount** `positive integer`: Amount in the smallest currency unit.
* **currency** `string`: Three-letter ISO currency code.
* **orderId** `string`: Your unique order identifier.
* **customer.email** / **customer.phone** `string`: At least one is required if you want MONEI to send the link automatically (Step 2).
* **callbackUrl** `string`: Your server endpoint for webhook notifications (crucial for final status).
* **completeUrl** / **cancelUrl** `string` (Optional): URLs for redirecting the customer after interaction.

Check all available [request parameters](https://docs.monei.com/apis/rest/payments-create/.md).

The response contains the `payment.id`, needed for the next step.

### 2. Send Link & Handle Interaction (Server-side / Client-side)[​](#2-send-link--handle-interaction-server-side--client-side "Direct link to 2. Send Link & Handle Interaction (Server-side / Client-side)")

You have two main options to get the link to the customer:

**Option A: MONEI Sends the Link (Recommended for Simplicity)**

Make a POST request to the `/v1/payments/{payment_id}/link` endpoint. If you provided `customer.email` or `customer.phone` in Step 1, MONEI will automatically send the link via the appropriate channel (email, WhatsApp, or SMS).

* cURL
* Node.js
* PHP
* Python

POST https\://api.monei.com/v1/payments/{payment\_id}/link

```
curl --request POST 'https://api.monei.com/v1/payments/{payment_id}/link' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "language": "es", // Optional: Set language for email/SMS template
  "channel": "email" // Optional: Force channel (email, whatsapp, sms)
}'
```

(Replace `{payment_id}` and `YOUR_API_KEY`)

server.js

```
// Assumes paymentId is obtained from the previous step
await monei.payments.sendLink(paymentId, {
  language: 'es', // Optional
  channel: 'email' // Optional
});
```

server.php

```
<?php
// Assumes $paymentId is obtained from the previous step
$monei->payments->sendLink($paymentId, [
  'language' => 'es', // Optional
  'channel' => 'email' // Optional
]);
?>
```

server.py

```
# Assumes payment_id is obtained from the previous step
monei.payments.sendLink(payment_id, language='es', channel='email') # Optional params
```

**Option B: You Send the Link**

The [Payment object](https://docs.monei.com/apis/rest/schemas/payment/.md) returned in Step 1 contains `payment.nextAction.redirectUrl`. This is the payment link.

Example Partial Response from Step 1

```
{
  "id": "af6029f80f5fc73a8ad2753eea0b1be0",
  // ... other fields ...
  "nextAction": {
    "type": "CONFIRM",
    "mustRedirect": true,
    "redirectUrl": "https://secure.monei.com/payments/af6029f80f5fc73a8ad2753eea0b1be0" // <-- This is the Pay By Link URL
  }
}
```

You can take this `redirectUrl` and send it to your customer through your own communication channels (email, SMS, in-app message, etc.).

**Customer Interaction:**

1. The customer clicks the link.
2. They are taken to the secure MONEI payment page.
3. They choose a payment method, enter details, and complete any required authentication (like 3D Secure).
4. After attempting payment or cancelling, they might be redirected to your `completeUrl` or `cancelUrl` if you provided them in Step 1.

### 3. Process Webhook Notification (Server-side)[​](#3-process-webhook-notification-server-side "Direct link to 3. Process Webhook Notification (Server-side)")

Regardless of whether the customer is redirected, MONEI sends the final, authoritative payment status via an asynchronous HTTP POST request to the `callbackUrl` you provided in Step 1. The request body contains the full [Payment object](https://docs.monei.com/apis/rest/schemas/payment/.md) in JSON format.

This webhook is the **only reliable way** to confirm the definitive payment outcome.

**Crucially, you must:**

1. **Verify the `MONEI-Signature` header** included in the request. This confirms the webhook genuinely came from MONEI. See the [Verify Signatures guide](https://docs.monei.com/guides/verify-signature/.md) for implementation details.
2. **Return a `200 OK` HTTP status code** immediately upon receiving the webhook to acknowledge receipt. Any other status code tells MONEI the notification failed.

If MONEI doesn't receive a `200 OK`, it will retry sending the webhook.

Once the signature is verified, inspect the `status` field in the Payment object (`SUCCEEDED`, `FAILED`, `CANCELED`, etc.) to determine whether to fulfill the order or handle the failure.


---

# Use payment modal

MONEI Payment Modal is the simplest way to securely collect payments from your customers without them leaving your website.

![MONEI Payment Modal preview](/assets/images/payment-modal-cbb30083effbd94b0d01dfdd45e6d94d.png)

Collecting payments on your website consists of creating a payment object, and confirming the payment.

important

Apple Pay is not available when using MONEI Payment Modal integration.

## Before You Begin[​](#before-you-begin "Direct link to Before You Begin")

* You'll need a MONEI account and your API keys (test or live). Find them in your [MONEI Dashboard](https://dashboard.monei.com/settings/api).
* Use your [test mode keys](https://docs.monei.com/testing/.md) for integration testing.
* Ensure relevant payment methods are enabled in your account settings.
* You can monitor test payments in your [MONEI Dashboard → Payments](https://dashboard.monei.com/payments) (ensure Test Mode is active).

## Integration Steps[​](#integration-steps "Direct link to Integration Steps")

Integrating the Payment Modal involves creating a payment on your server, using `monei.js` to handle the modal on the client-side, and processing the final payment status via webhooks.

### 1. Create Payment (Server-side)[​](#1-create-payment-server-side "Direct link to 1. Create Payment (Server-side)")

Create a [Payment](https://docs.monei.com/apis/rest/schemas/payment/.md) on your server with an amount and currency. Always decide how much to charge on the server side, a trusted environment, as opposed to the client. This prevents malicious customers from being able to choose their own prices.

<!-- -->

* cURL
* Node.js
* PHP
* Python

POST https\://api.monei.com/v1/payments

```
curl --request POST 'https://api.monei.com/v1/payments' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "amount": 110,
  "currency": "EUR",
  "orderId": "14379133960355",
  "description": "Test Shop - #14379133960355",
  "customer": {
    "email": "email@example.com"
   },
  "callbackUrl": "https://example.com/checkout/callback"
}'
```

(Replace `YOUR_API_KEY` with your actual MONEI API key)

server.js

```
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 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'
});

// You will need the paymentId from the response in the next step
const paymentId = payment.id;
```

server.php

```
<?php
require_once 'vendor/autoload.php';

use Monei\Model\CreatePaymentRequest;
use Monei\Model\PaymentCustomer;
use Monei\MoneiClient;

// Replace YOUR_API_KEY with your actual MONEI API key
$monei = new MoneiClient('YOUR_API_KEY');

$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'
  ])
);

// You will need the paymentId from the response in the next step
$paymentId = $payment->getId();
?>
```

server.py

```
import Monei
from Monei import CreatePaymentRequest, PaymentCustomer

# Replace YOUR_API_KEY with your actual MONEI API key
monei = Monei.MoneiClient(api_key="YOUR_API_KEY")

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

# You will need the paymentId from the response in the next step
payment_id = payment.id
```

**Key Parameters:**

* **amount** `positive integer`: Amount in the smallest currency unit (e.g., 110 for €1.10).
* **currency** `string`: Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) (e.g., `EUR`).
* **orderId** `string`: Your unique order identifier.
* **callbackUrl** `string`: Your server endpoint URL for asynchronous webhook notifications.

Check all available [request parameters](https://docs.monei.com/apis/rest/payments-create/.md).

Included in the returned Payment object is a payment `id`. You will use this `paymentId` on the client-side in the next step.

### 2. Handle Payment Interaction (Client-side)[​](#2-handle-payment-interaction-client-side "Direct link to 2. Handle Payment Interaction (Client-side)")

Use [`monei.js`](https://docs.monei.com/monei-js/reference/.md) to confirm the payment. This will trigger the payment modal pop-up.

Include `monei.js` on your checkout page:

checkout.html

```
<head>
  <title>Checkout</title>
  <script src="https://js.monei.com/v2/monei.js"></script>
</head>
<body>
  <form id="payment-form">
    <button id="payment-button" type="submit">Pay</button>
  </form>
  <script>
    // Initialize client-side script here (see below)
  </script>
</body>
```

Use the `paymentId` obtained in Step 1 to call `monei.confirmPayment`. You can also provide additional parameters like `customer.email`. Check all available [parameters](https://docs.monei.com/monei-js/reference/.md#confirmpayment-function).

client.js

```
// Get the paymentId passed from your server
const paymentId = '{{payment_id}}'; // Replace with the actual paymentId

const paymentForm = document.getElementById('payment-form');
const paymentButton = document.getElementById('payment-button');

paymentForm.addEventListener('submit', function (event) {
  event.preventDefault();
  paymentButton.disabled = true;

  monei
    .confirmPayment({paymentId: paymentId}) // Pass the paymentId here
    .then(function (result) {
      paymentButton.disabled = false;
      // This result reflects the immediate outcome of the modal interaction (e.g., user closed, initial success).
      // Always rely on the webhook (Step 3) for the definitive final payment status.
      console.log('Payment confirmation result:', result);
      if (result.status === 'SUCCEEDED' || result.status === 'PENDING') {
        // Optionally, inform the user that payment is processing.
        handleResult(result);
      } else {
        // Handle errors like user cancellation or immediate failures.
        handleError(result);
      }
    })
    .catch(function (error) {
      paymentButton.disabled = false;
      console.error('Error confirming payment:', error);
      // Handle network errors or other issues.
    });
});

function handleResult(result) {
  // Redirect to a success/pending page or update UI.
  // Remember: Final confirmation comes via webhook.
  console.log('Handling result:', result);
  alert('Payment status: ' + result.status + '. Waiting for final confirmation.');
}

function handleError(result) {
  // Show error message to the user.
  console.error('Handling error:', result);
  alert('Payment failed or was cancelled. Status: ' + result.status);
}
```

After the form is submitted, MONEI automatically shows a pop-up window with a payment page to collect payment details and handle any necessary 3D Secure confirmation.

Alternative: Prebuilt Page

If you prefer redirecting the customer instead of using an on-site modal, see the [Prebuilt Payment Page guide](https://docs.monei.com/integrations/use-prebuilt-payment-page/.md).

### 3. Process Webhook Notification (Server-side)[​](#3-process-webhook-notification-server-side "Direct link to 3. Process Webhook Notification (Server-side)")

MONEI sends the final, authoritative payment status via an asynchronous HTTP POST request to the `callbackUrl` you provided in Step 1. The request body contains the full [Payment object](https://docs.monei.com/apis/rest/schemas/payment/.md) in JSON format.

This webhook ensures you get the definitive status even if the customer closes their browser prematurely.

**Crucially, you must:**

1. **Verify the `MONEI-Signature` header** included in the request. This confirms the webhook genuinely came from MONEI. See the [Verify Signatures guide](https://docs.monei.com/guides/verify-signature/.md) for implementation details.
2. **Return a `200 OK` HTTP status code** immediately upon receiving the webhook to acknowledge receipt. Any other status code (including `3xx` redirects) tells MONEI the notification failed.

If MONEI doesn't receive a `200 OK`, it will retry sending the webhook multiple times over several days before marking it as failed.

Example Webhook Payload (POST to your callbackUrl)

```
{
  "id": "af6029f80f5fc73a8ad2753eea0b1be0",
  "amount": 110,
  "currency": "EUR",
  "orderId": "14379133960355",
  "status": "SUCCEEDED", // Or FAILED, CANCELED, EXPIRED etc.
  "customer": { ... },
  // ... other payment details ...
  "createdAt": 1594215339,
  "updatedAt": 1594215345
}
```

Once the signature is verified, inspect the `status` field in the Payment object to determine whether to fulfill the order or handle a failure.


---

# Use a prebuilt payment page

MONEI's Hosted Payment Page offers the simplest, PCI-compliant way to securely collect payments from your customers using various methods.

![Hosted payments preview](/assets/images/payment-page-preview-d18ed094bf6323e0f15ac584d5b656e2.png)

[](https://js.monei.com/v2/payment-page/#ewogICJzaG9wTG9nb1VybCI6ICJodHRwczovL21vbmVpLXByb2Qtc2VydmljZS1idWNrZXQuczMuZXUtd2VzdC0xLmFtYXpvbmF3cy5jb20vcHJvdGVjdGVkL2V1LXdlc3QtMTo3NjU5Zjc4ZS1kZDA0LTRiYjItYTE2My1jOWVhYzk3ZmNkMzIvcmMtdXBsb2FkLTE3NDM0MzgxMTU1MjgtMi5zdmciLAogICJhY2NlbnRDb2xvciI6ICIjMDAwMDAwIiwKICAiYW1vdW50IjogMTUwMDAsCiAgImJnQ29sb3IiOiAiI2YwZjRmNSIsCiAgInRlc3QiOiB0cnVlLAogICJwYXltZW50TWV0aG9kcyI6IFsiYml6dW0iLCAiYXBwbGVQYXkiLCAiZ29vbGdlUGF5IiwgImNsaWNrVG9QYXkiLCAicGF5cGFsIiwgImNhcmQiXSwKICAiYWNjb3VudElkIjogIjI5NzViY2ZhLTdiYmMtNDIyZC1hZjQ4LWM2Njc1OWQ4N2I2OSIsCiAgInBheW1lbnRJZCI6ICI0NDMyMzI5MmJkNzdlNDY1ZWVkMmZkM2E1ZTQ4NjQ5MzA1N2I1OGM2IiwKICAic2hvcE5hbWUiOiAiWkFSQSIKfQo=)

[Live demo](https://js.monei.com/v2/payment-page/#ewogICJzaG9wTG9nb1VybCI6ICJodHRwczovL21vbmVpLXByb2Qtc2VydmljZS1idWNrZXQuczMuZXUtd2VzdC0xLmFtYXpvbmF3cy5jb20vcHJvdGVjdGVkL2V1LXdlc3QtMTo3NjU5Zjc4ZS1kZDA0LTRiYjItYTE2My1jOWVhYzk3ZmNkMzIvcmMtdXBsb2FkLTE3NDM0MzgxMTU1MjgtMi5zdmciLAogICJhY2NlbnRDb2xvciI6ICIjMDAwMDAwIiwKICAiYW1vdW50IjogMTUwMDAsCiAgImJnQ29sb3IiOiAiI2YwZjRmNSIsCiAgInRlc3QiOiB0cnVlLAogICJwYXltZW50TWV0aG9kcyI6IFsiYml6dW0iLCAiYXBwbGVQYXkiLCAiZ29vbGdlUGF5IiwgImNsaWNrVG9QYXkiLCAicGF5cGFsIiwgImNhcmQiXSwKICAiYWNjb3VudElkIjogIjI5NzViY2ZhLTdiYmMtNDIyZC1hZjQ4LWM2Njc1OWQ4N2I2OSIsCiAgInBheW1lbnRJZCI6ICI0NDMyMzI5MmJkNzdlNDY1ZWVkMmZkM2E1ZTQ4NjQ5MzA1N2I1OGM2IiwKICAic2hvcE5hbWUiOiAiWkFSQSIKfQo=)

**Key Features:**

* **Designed to remove friction:** Real-time card validation with built-in error messaging.
* **Mobile-ready:** Fully responsive design.
* **International:** Supports 13 languages.
* **Multiple payment methods:** Supports various [payments methods](https://monei.com/blog/multiple-payment-options/).
* **Customization and branding:** Customizable logo, buttons, and background color via your [MONEI Dashboard](https://dashboard.monei.com/settings/branding).
* **3D Secure:** Built-in support for SCA verification.
* **Fraud and compliance:** Simplified PCI compliance and SCA-ready.

You can customize the appearance in your [MONEI Dashboard → Settings → Branding](https://dashboard.monei.com/settings/branding).

## Before You Begin[​](#before-you-begin "Direct link to Before You Begin")

* You'll need a MONEI account and your API keys (test or live). Find them in your [MONEI Dashboard](https://dashboard.monei.com/settings/api).
* Use your [test mode keys](https://docs.monei.com/testing/.md) for integration testing.
* Ensure relevant payment methods are enabled in your account settings.
* You can monitor test payments in your [MONEI Dashboard → Payments](https://dashboard.monei.com/payments) (ensure Test Mode is active).

## Integration Steps[​](#integration-steps "Direct link to Integration Steps")

The integration involves creating a payment on your server, redirecting your customer to MONEI's secure page, and handling their return to your site via redirects and webhooks.

### 1. Create Payment (Server-side)[​](#1-create-payment-server-side "Direct link to 1. Create Payment (Server-side)")

First, make a server-side API call to create a new [Payment object](https://docs.monei.com/apis/rest/schemas/payment/.md). This registers the payment intent with MONEI.

<!-- -->

* cURL
* Node.js
* PHP
* Python

POST https\://api.monei.com/v1/payments

```
curl --request POST 'https://api.monei.com/v1/payments' \\
--header 'Authorization: YOUR_API_KEY' \\
--header 'Content-Type: application/json' \\
--data-raw '{
    "amount": 110,
    "currency": "EUR",
    "orderId": "14379133960355",
    "description": "Test Shop - #14379133960355",
    "customer": {
       "name": "John Doe",
       "email": "email@example.com",
       "phone": "+34666555444"
    },
    "billingDetails": {
       "name": "John Doe",
       "address": {
          "country": "ES",
          "city": "Malaga",
          "line1": "Fake Street 123",
          "zip": "29001"
       }
    },
    "callbackUrl": "https://example.com/checkout/callback",
    "completeUrl": "https://example.com/checkout/complete",
    "cancelUrl": "https://example.com/checkout/cancel"
}'
```

(Replace `YOUR_API_KEY` with your actual MONEI API key)

server.js

```
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 payment = await monei.payments.create({
  amount: 110,
  currency: 'EUR',
  orderId: '14379133960355',
  description: 'Test Shop - #14379133960355',
  customer: {
    name: 'John Doe',
    email: 'email@example.com',
    phone: '+34666555444'
  },
  billingDetails: {
    name: 'John Doe',
    address: {
      country: 'ES',
      city: 'Malaga',
      line1: 'Fake Street 123',
      zip: '29001'
    }
  },
  callbackUrl: 'https://example.com/checkout/callback',
  completeUrl: 'https://example.com/checkout/complete',
  cancelUrl: 'https://example.com/checkout/cancel'
});

// You will need the redirectUrl from the response in the next step
const redirectUrl = payment.nextAction.redirectUrl;
```

server.php

```
<?php
require_once 'vendor/autoload.php';

use Monei\Model\CreatePaymentRequest;
use Monei\Model\PaymentCustomer;
use Monei\Model\PaymentBillingDetails;
use Monei\Model\Address;
use Monei\MoneiClient;

// Replace YOUR_API_KEY with your actual MONEI API key
$monei = new MoneiClient('YOUR_API_KEY');

$payment = $monei->payments->create(
    new CreatePaymentRequest([
      'amount' => 110,
      'currency' => 'EUR',
      'order_id' => '14379133960355',
      'description' => 'Test Shop - #14379133960355',
      'customer' => new PaymentCustomer([
        'name' => 'John Doe',
        'email' => 'email@example.com',
        'phone' => '+34666555444'
      ]),
      'billing_details' => new PaymentBillingDetails([
        'name' => 'John Doe',
        'address' => new Address([
          'country' => 'ES',
          'city' => 'Malaga',
          'line1' => 'Fake Street 123',
          'zip' => '29001'
        ])
      ]),
      'callback_url' => 'https://example.com/checkout/callback',
      'complete_url' => 'https://example.com/checkout/complete',
      'cancel_url' => 'https://example.com/checkout/cancel'
    ])
);

// You will need the redirectUrl from the response in the next step
$redirectUrl = $payment->getNextAction()->getRedirectUrl();
?>
```

server.py

```
import Monei
from Monei import CreatePaymentRequest, PaymentCustomer, PaymentBillingDetails, Address

# Replace YOUR_API_KEY with your actual MONEI API key
monei = Monei.MoneiClient(api_key="YOUR_API_KEY")

payment = monei.payments.create(
    CreatePaymentRequest(
        amount=110,
        currency="EUR",
        order_id="14379133960355",
        description="Test Shop - #14379133960355",
        customer=PaymentCustomer(
            name="John Doe",
            email="email@example.com",
            phone="+34666555444"
        ),
        billing_details=PaymentBillingDetails(
            name="John Doe",
            address=Address(
                country="ES",
                city="Malaga",
                line1="Fake Street 123",
                zip="29001"
            )
        ),
        callback_url="https://example.com/checkout/callback",
        complete_url="https://example.com/checkout/complete",
        cancel_url="https://example.com/checkout/cancel"
    )
)

// You will need the redirectUrl from the response in the next step
redirect_url = payment.next_action.redirect_url
```

**Key Parameters:**

* **amount** `positive integer`: Amount in the smallest currency unit (e.g., 110 for €1.10).
* **currency** `string`: Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) (e.g., `EUR`).
* **orderId** `string`: Your unique order identifier.
* **completeUrl** `string`: Where the customer is redirected **after** attempting payment (success or failure).
* **callbackUrl** `string`: Your server endpoint URL for asynchronous webhook notifications (crucial for final status).
* **cancelUrl** \`string\*\*: Where the customer is redirected if they click **cancel** or \*\*"Back to shop"\*\*.

Check all available [request parameters](https://docs.monei.com/apis/rest/payments-create/.md).

The API response includes the `payment.id` and, importantly, `payment.nextAction.redirectUrl`.

### 2. Handle Payment Interaction (Client-side via Redirect)[​](#2-handle-payment-interaction-client-side-via-redirect "Direct link to 2. Handle Payment Interaction (Client-side via Redirect)")

The API response from Step 1 contains a `nextAction` object with a `redirectUrl`. You **must** redirect your customer's browser to this URL.

Example Partial API Response

```
{
  "id": "af6029f80f5fc73a8ad2753eea0b1be0", // MONEI Payment ID
  // ... other fields ...
  "status": "PENDING", // Initial status
  "nextAction": {
    "type": "CONFIRM",
    "mustRedirect": true, // Indicates redirection is needed
    "redirectUrl": "https://secure.monei.com/payments/af6029f80f5fc73a8ad2753eea0b1be0" // <-- REDIRECT CUSTOMER HERE
  }
}
```

This `redirectUrl` leads the customer to the secure, MONEI-hosted payment page where they will select a payment method and enter their details.

Alternative: Payment Modal

Instead of a full page redirect, you can use [`monei.js`](https://docs.monei.com/monei-js/reference/.md) to present payment options within a modal on your own site. See the [Payment Modal Guide](https://docs.monei.com/integrations/use-payment-modal/.md) for details.

**Customer Actions:**

* The customer completes the payment details on the MONEI page.

* They might undergo 3D Secure verification if required by their bank.

* After completion, failure, or cancellation, they are redirected back to your site:

  <!-- -->

  * To the `completeUrl` if they attempted payment.
  * To the `cancelUrl` if they explicitly cancelled.

**Important:** The redirect to `completeUrl` **does not** guarantee payment success. You must rely on the webhook (Step 3) for the final status.

### 3. Process Webhook Notification (Server-side)[​](#3-process-webhook-notification-server-side "Direct link to 3. Process Webhook Notification (Server-side)")

MONEI sends the final, authoritative payment status via an asynchronous HTTP POST request to the `callbackUrl` you provided in Step 1. The request body contains the full [Payment object](https://docs.monei.com/apis/rest/schemas/payment/.md) in JSON format.

This webhook is the **only reliable way** to confirm the definitive payment outcome, regardless of customer browser actions or redirects.

**Crucially, you must:**

1. **Verify the `MONEI-Signature` header** included in the request. This confirms the webhook genuinely came from MONEI. See the [Verify Signatures guide](https://docs.monei.com/guides/verify-signature/.md) for implementation details.
2. **Return a `200 OK` HTTP status code** immediately upon receiving the webhook to acknowledge receipt. Any other status code tells MONEI the notification failed.

If MONEI doesn't receive a `200 OK`, it will retry sending the webhook.

Once the signature is verified, inspect the `status` field in the Payment object (`SUCCEEDED`, `FAILED`, `CANCELED`, etc.) to determine whether to fulfill the order or handle the failure.

Example Webhook Payload (POST to your callbackUrl)

```
{
  "id": "af6029f80f5fc73a8ad2753eea0b1be0",
  "amount": 110,
  // ... other fields ...
  "status": "SUCCEEDED", // <-- Check this for final status
  "createdAt": 1594215339,
  "updatedAt": 1594215345
}
```


---

# Use QR code payments

Accept in-store contactless payments with QR codes. Choose between the MONEI Pay app, Dashboard Points of Sale, or the Payments API.

## Permanent vs One-Time QR Codes[​](#permanent-vs-one-time-qr-codes "Direct link to Permanent vs One-Time QR Codes")

|                 | Permanent                                  | One-Time                                            |
| --------------- | ------------------------------------------ | --------------------------------------------------- |
| **Created via** | Dashboard Points of Sale                   | MONEI Pay App / Payments API                        |
| **URL format**  | `https://secure.monei.com/codes/{code_id}` | `https://secure.monei.com/payments/{payment_id}/qr` |
| **Reusable**    | Yes, same QR for multiple transactions     | No, one payment per QR                              |
| **Amount**      | Customer enters (manual) or fixed          | Pre-set per payment                                 |
| **Expiration**  | Never (can be disabled)                    | 5 minutes (or custom `expireAt` via API)            |
| **Best for**    | Static displays, printed materials, tables | Dynamic checkout, invoices, mobile POS              |

## Before You Begin[​](#before-you-begin "Direct link to Before You Begin")

* You'll need a MONEI account. Find your API keys in [MONEI Dashboard → Settings → API](https://dashboard.monei.com/settings/api).
* Use [test mode keys](https://docs.monei.com/testing/.md) for integration testing.
* Ensure relevant payment methods are enabled in your account settings.
* Monitor test payments in [Dashboard → Payments](https://dashboard.monei.com/payments) (enable Test Mode toggle).

- MONEI Pay & Dashboard
- Payments API

## MONEI Pay App[​](#monei-pay-app "Direct link to MONEI Pay App")

MONEI Pay provides the easiest way to accept payments in-store using a dedicated app.

[YouTube video player](https://www.youtube.com/embed/ZVmXRUFWqno)

Login into [pay.monei.com](https://pay.monei.com/) or download the **MONEI Pay** app using your MONEI Dashboard credentials to start creating QR payment codes.

[![App Store](/img/app-store-icon.svg)](https://apps.apple.com/es/app/monei-pay/id1624647668)[![Google Play](/img/google-play-icon.svg)](https://play.google.com/store/apps/details?id=com.monei.moneibusiness)

## Dashboard Points of Sale[​](#dashboard-points-of-sale "Direct link to Dashboard Points of Sale")

Create and manage QR-based Points of Sale directly in your MONEI Dashboard.

### Creating a Point of Sale[​](#creating-a-point-of-sale "Direct link to Creating a Point of Sale")

1. Go to [Dashboard → Settings → Points of Sale](https://dashboard.monei.com/settings/points-of-sale)
2. Click **Create Point of Sale**
3. Select **QR Code** as the type
4. Configure your POS settings (see options below)

### Configuration Options[​](#configuration-options "Direct link to Configuration Options")

| Option                      | Description                                                                                             |
| --------------------------- | ------------------------------------------------------------------------------------------------------- |
| **Name**                    | Identifier for this POS (e.g., "Store Entrance", "Table 5")                                             |
| **Store**                   | Associate with a store for multi-location tracking                                                      |
| **Payment Flow**            | **Manual Amount**: Customer enters amount each time. **Fixed Amount**: Same amount for all transactions |
| **Fixed Amount/Currency**   | Pre-set amount when using Fixed Amount flow                                                             |
| **Allowed Payment Methods** | Restrict which payment methods appear (Card, Bizum, PayPal, etc.)                                       |
| **Manual Capture**          | Place hold on funds (auth-only), capture later. Only for Card and PayPal                                |
| **Require Email**           | Force customers to enter email before paying                                                            |
| **Require Tax ID**          | Require NIF/CIF for invoicing purposes                                                                  |
| **Callback URL**            | Webhook URL for payment notifications                                                                   |
| **Include QR in Email**     | Add QR code containing order ID to confirmation email (useful for ticketing/events)                     |
| **QR Code Text**            | Custom text shown alongside QR in confirmation email                                                    |
| **Description**             | Description passed to all payments from this POS                                                        |

### Managing QR Codes[​](#managing-qr-codes "Direct link to Managing QR Codes")

Each POS can have multiple QR codes. From the POS detail page:

* **Generate new codes** for different locations or displays
* **Download QR codes** as SVG or PNG (300px, 500px, or 1000px)
* **Enable/disable codes** without deleting them
* **Copy permalink** for embedding: `https://secure.monei.com/codes/{code_id}`

### Use Cases[​](#use-cases "Direct link to Use Cases")

* **Retail**: Manual amount flow, enable multiple payment methods
* **Events/Ticketing**: Fixed amount, require email, enable "QR in confirmation email"
* **Table service**: Create multiple POS per store for tracking
* **Kiosk**: Fixed amount, restrict to card-only

### User Access Control & Payment Grouping[​](#user-access-control--payment-grouping "Direct link to User Access Control & Payment Grouping")

Stores and Points of Sale enable user access control and payment grouping:

* **Assign users to stores/POS**: In [Dashboard → Settings → Users](https://dashboard.monei.com/settings/users), bind users (e.g., waiters, cashiers) to a store or POS
* **Restricted visibility**: Bound users only see payments from their assigned store/POS
* **Automatic inheritance**: When a bound user creates a payment via Dashboard or MONEI Pay, it inherits their store/POS ID
* **API grouping**: Pass `storeId` or `pointOfSaleId` when creating payments via API to group them for reporting
* **Traceability**: Admins can filter and track payments by store or POS origin

## Creating QR Payments Programmatically[​](#creating-qr-payments-programmatically "Direct link to Creating QR Payments Programmatically")

Generate QR payment codes using the MONEI API for custom integrations.

![QR](/img/qr.png)![QR demo](/img/qr-demo.png)

### 1. Create Payment (Server-side)[​](#1-create-payment-server-side "Direct link to 1. Create Payment (Server-side)")

Create a [Payment](https://docs.monei.com/apis/rest/schemas/payment/.md) on your server with an amount and currency.

* cURL
* Node.js
* PHP
* Python

POST https\://api.monei.com/v1/payments

```
curl --request POST 'https://api.monei.com/v1/payments' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 110,
    "currency": "EUR",
    "orderId": "14379133960355",
    "callbackUrl": "https://example.com/checkout/callback"
}'
```

(Replace `YOUR_API_KEY` with your actual MONEI API key)

server.js

```
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 payment = await monei.payments.create({
  amount: 110,
  currency: 'EUR',
  orderId: '14379133960355',
  callbackUrl: 'https://example.com/checkout/callback'
});

// You will need the paymentId from the response to generate the QR code URL
const paymentId = payment.id;

// Construct the QR code URL
const qrCodeUrl = `https://secure.monei.com/payments/${paymentId}/qr`;
```

server.php

```
<?php
require_once 'vendor/autoload.php';

use Monei\Model\CreatePaymentRequest;
use Monei\MoneiClient;

// Replace YOUR_API_KEY with your actual MONEI API key
$monei = new MoneiClient('YOUR_API_KEY');

$payment = $monei->payments->create(
  new CreatePaymentRequest([
    'amount' => 110,
    'currency' => 'EUR',
    'order_id' => '14379133960355',
    'callback_url' => 'https://example.com/checkout/callback'
  ])
);

// You will need the paymentId from the response to generate the QR code URL
$paymentId = $payment->getId();

// Construct the QR code URL
$qrCodeUrl = "https://secure.monei.com/payments/{$paymentId}/qr";
?>
```

server.py

```
import Monei
from Monei import CreatePaymentRequest

# Replace YOUR_API_KEY with your actual MONEI API key
monei = Monei.MoneiClient(api_key="YOUR_API_KEY")

payment = monei.payments.create(
    CreatePaymentRequest(
        amount=110,
        currency="EUR",
        order_id="14379133960355",
        callback_url="https://example.com/checkout/callback"
    )
)

# You will need the paymentId from the response to generate the QR code URL
payment_id = payment.id

# Construct the QR code URL
qr_code_url = f"https://secure.monei.com/payments/{payment_id}/qr"
```

**Required Parameters:**

* **amount** `positive integer`: Amount in the smallest currency unit (e.g., 110 for €1.10).
* **currency** `string`: Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) (e.g., `EUR`).
* **orderId** `string`: Your unique order identifier.
* **callbackUrl** `string`: Your server endpoint URL for asynchronous webhook notifications.

**Optional Parameters:**

* **allowedPaymentMethods** `array`: Restrict available payment methods (e.g., `["card", "bizum"]`)
* **description** `string`: Payment description shown on the payment page
* **customer** `object`: Pre-fill customer info (`email`, `name`, `phone`)
* **metadata** `object`: Custom key-value pairs for tracking/reconciliation
* **storeId** `string`: Associate payment with a store (for grouping and user access control)
* **pointOfSaleId** `string`: Link payment to a POS (for grouping and user access control)
* **expireAt** `integer`: Unix timestamp for custom expiration (default: 5 minutes from creation)

Check all available [request parameters](https://docs.monei.com/apis/rest/payments-create/.md).

The API response includes the `payment.id`, which you'll use in the next step.

### 2. Display QR Code & Handle Interaction (Client-side/Physical)[​](#2-display-qr-code--handle-interaction-client-sidephysical "Direct link to 2. Display QR Code & Handle Interaction (Client-side/Physical)")

Use the `payment.id` from Step 1 to present the QR code to your customer.

**Option 1: Embed QR Image Directly**

Construct the QR code image URL: `https://secure.monei.com/payments/{payment_id}/qr`

You can render it directly on a webpage or display:

```
<img
  src="https://secure.monei.com/payments/{{payment_id}}/qr?format=svg&size=300"
  alt="Scan to Pay"
  width="300"
  height="300"
/>
```

* Replace `{{payment_id}}` with the actual ID.
* Use `?format=svg` for SVG (default is `png`).
* Use `?size=400` to specify size (min: 100, max: 1000, default: 300).

![Example QR](https://secure.monei.com/codes/RYGJ0ZFK/qr?format=svg\&size=300)

**Option 2: Redirect to Hosted Page with QR**

The [Payment object](https://docs.monei.com/apis/rest/schemas/payment/.md) returned in Step 1 also contains `payment.nextAction.redirectUrl`. Append `?qr=1` to this URL to get a link to a MONEI-hosted page displaying the QR code.

Example: `https://secure.monei.com/payments/{payment_id}?qr=1`

![Hosted Payment Page QR](/assets/images/qr-demo-2-b5f9696c05e4207feb175d4824de5b0a.png)

**Customer Interaction:**

The customer scans the QR code with their phone and completes the payment on the MONEI payment page using their chosen method.

Important

The QR code payment link is valid for **5 minutes**. After that, you must create a new payment request.

### 3. Process Webhook Notification (Server-side)[​](#3-process-webhook-notification-server-side "Direct link to 3. Process Webhook Notification (Server-side)")

MONEI sends the final, authoritative payment status via an asynchronous HTTP POST request to the `callbackUrl` you provided in Step 1. The request body contains the full [Payment object](https://docs.monei.com/apis/rest/schemas/payment/.md) in JSON format.

This webhook ensures you get the definitive status even if the customer closes their browser or loses connection after scanning.

**Crucially, you must:**

1. **Verify the `MONEI-Signature` header** included in the request. This confirms the webhook genuinely came from MONEI. See the [Verify Signatures guide](https://docs.monei.com/guides/verify-signature/.md) for implementation details.
2. **Return a `200 OK` HTTP status code** immediately upon receiving the webhook to acknowledge receipt. Any other status code tells MONEI the notification failed.

If MONEI doesn't receive a `200 OK`, it will retry sending the webhook.

Once the signature is verified, inspect the `status` field in the Payment object to confirm payment success (`SUCCEEDED`) and fulfill the order, or handle failures.

### Alternative: Poll Payment Status[​](#alternative-poll-payment-status "Direct link to Alternative: Poll Payment Status")

For kiosk or display scenarios where you need real-time status updates, poll the payment status instead of (or in addition to) webhooks.

* cURL
* Node.js
* PHP
* Python

GET https\://api.monei.com/v1/payments/{payment\_id}

```
curl --request GET 'https://api.monei.com/v1/payments/{payment_id}' \
--header 'Authorization: YOUR_API_KEY'
```

server.js

```
const payment = await monei.payments.get(paymentId);
console.log(payment.status);
```

server.php

```
<?php
$payment = $monei->payments->get($paymentId);
echo $payment->getStatus();
?>
```

server.py

```
payment = monei.payments.get(payment_id)
print(payment.status)
```

**Status values:** `PENDING`, `PENDING_PROCESSING`, `SUCCEEDED`, `FAILED`, `CANCELED`, `EXPIRED`

Polling Best Practice

Poll every 2-3 seconds. Stop when status is no longer `PENDING`/`PENDING_PROCESSING` or when the QR expires.

## Customization[​](#customization "Direct link to Customization")

You can customize the appearance of the QR code (color, icon) and the hosted payment page in your [MONEI Dashboard → Settings → Branding](https://dashboard.monei.com/settings/branding).

## Testing[​](#testing "Direct link to Testing")

* Use your [test mode API keys](https://docs.monei.com/testing/.md) for development
* Enable **Test Mode** in your [Dashboard](https://dashboard.monei.com/payments) to view test payments
* Use [test card numbers](https://docs.monei.com/testing/.md#test-card-numbers) to simulate different scenarios
* Verify webhook delivery in Dashboard → Developers → Webhooks

## Troubleshooting[​](#troubleshooting "Direct link to Troubleshooting")

**QR code expired** QR codes are valid for 5 minutes. Create a new payment if the code expires.

**Payment method not showing** Check that the method is enabled in your account and not filtered by `allowedPaymentMethods`.

**Webhook not received** Verify your `callbackUrl` is publicly accessible, returns `200 OK`, and check webhook logs in Dashboard.


---

# MONEI Connect

Become an integrated payments partner to quickly and easily provide payment services to your platform or marketplace users with [MONEI Connect](https://monei.com/connect/).

## Before you begin[​](#before-you-begin "Direct link to Before you begin")

📌 Please contact <connect@monei.com> to register as a partner. The following information is required:

* IPs of your servers so we can add them to our whitelist
* Email address that we can send the partner API Key to
* Email address or URL for partner account notifications (choose 1): With the MONEI Connect integration you'll receive notifications via email or webhook when your users/merchants register for a MONEI account via your linked partner account. When your users/merchants register, you'll receive the company details and the associated account ID. You'll receive notifications when the account is pending approval and when it is approved or rejected

**The following data must be provided for all users that require access to your partner account:**

* First name
* Last name
* Email
* Business name
* Website
* Tax Identification Number (CIF)
* Services Description
* Phone number

note

In the same email to <connect@monei.com> please let us know whether you want the daily fee to be charged by MONEI to your users/merchants or to your master partner account. MONEI daily fees are:

* MONEI Pay 0,03 €/day
* MONEI X 0,1 €/day
* MONEI PLUS 39,99 €/day

**Once you've completed registration for your partner account, you'll receive:**

* Partner API Key that lets you access our APIs on behalf of each MONEI account bound to your partner account.
* Unique registration link that lets your users/merchants register their MONEI account. Every user that registers with this link will be bound to your partner account.
* Access to the Partner Dashboard, where you can see payments, aggregated analytics, and details about each MONEI account bound to your partner account.

## Integration[​](#integration "Direct link to Integration")

To access the MONEI APIs, you need to provide your Partner API Key in the `Authorization` header of each request as well as `MONEI-Account-ID` header with the ID of the MONEI Account to indicate which account you are acting on behalf of.

### [REST API](https://docs.monei.com/apis/rest/.md)[​](#rest-api "Direct link to rest-api")

<!-- -->

* cURL
* Node.js
* PHP
* Python

POST https\://api.monei.com/v1/payments

```
curl --request POST 'https://api.monei.com/v1/payments' \
--header 'Authorization: <PARTNER_API_KEY>' \
--header 'MONEI-Account-ID: <MONEI_ACCOUNT_ID>' \
--header 'Content-Type: application/json' \
--header 'User-Agent: MONEI/<PARTNER_NAME>/0.1.0' \
--data-raw '{
  "amount": 110,
  "currency": "EUR",
  "orderId": "14379133960355",
  "description": "Test Shop - #14379133960355",
  "customer": {
    "email": "email@example.com"
   },
  "callbackUrl": "https://example.com/checkout/callback"
}'
```

server.js

```
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();
```

server.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();
}
?>
```

server.py

```
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}')
```

### [GraphQL API](https://docs.monei.com/apis/graphql/.md)[​](#graphql-api "Direct link to graphql-api")

POST https\://graphql.monei.com

```
curl --request POST 'https://graphql.monei.com' \
--header 'Authorization: <PARTNER_API_KEY>' \
--header 'MONEI-Account-ID: <MONEI_ACCOUNT_ID>' \
--header 'Content-Type: application/json' \
--header 'User-Agent: MONEI/<PARTNER_NAME>/0.1.0' \
--data-raw '{"query":"{account {name status}}"}'
```

caution

The Partner shall, under no circumstances, instruct refunds ("Refunds") in an automated manner and shall only provide instructions to MONEI to execute a Refund when a clear, concise, and written order, traceable by the Merchant/User, is in place. In the event that an instruction for a Refund originates from the Partner without express authorization from the Merchant/User, the Partner shall assume full responsibility for the said amount, and in such case, MONEI may immediately terminate the contract entered into with the Partner.

## Registration link[​](#registration-link "Direct link to Registration link")

The registration link is unique to your partner account and lets your users/merchants register their MONEI account. Every user that registers with this link will be bound to your partner account.

The registration link is in the following format:

```
https://dashboard.monei.com/?action=signUp&promo=<PARTNER_CODE>
```

Optionally you can pass an external ID to the registration link. This ID will be returned in the webhook notifications and can be used to identify the user/merchant in your system.

```
https://dashboard.monei.com/?action=signUp&promo=<PARTNER_CODE>&mid=<EXTERNAL_ID>&h=<HASH>
```

* `mid` - External ID
* `h` - Hash of the external ID. The hash is calculated as `HMAC-SHA256(<EXTERNAL_ID>, <PARTNER_API_KEY>)`

note

Your account can be configured to make external ID mandatory. In this case, the registration link must contain the external ID and the hash.

## Webhook notifications[​](#webhook-notifications "Direct link to Webhook notifications")

MONEI will notify you when your users/merchants register for a MONEI account via your linked partner account by sending an HTTP POST request to the url provided during partner onboarding. The request body will contain the account information in JSON format.

The request also contains a `MONEI-Signature` header. [Verify this signature](https://docs.monei.com/guides/verify-signature/.md) to confirm that the received request is sent from MONEI. You need to use the same `PARTNER_API_KEY` to verify the signature that you use to authenticate your API requests.

To acknowledge receipt of the request, your endpoint must return a `200` HTTP status code to MONEI. All other response codes, including `3xx` codes, indicate to MONEI that you did not receive the event.

If MONEI does not receive a `200` HTTP status code, the notification attempt is repeated. After multiple failures to send the notification over multiple days, MONEI marks the request as failed and stops trying to send it to your endpoint.

The account information sent in the webhook:

* **id** `string` - Account ID

* **name** `string` - Account name

* **status** `enum` - Account status

  <!-- -->

  * **PENDING\_CONTRACT** - Account is created but the contract is not signed yet
  * **PENDING\_APPROVAL** - Account has signed the contract but is not approved yet
  * **APPROVED** - Account is approved and ready to accept payments
  * **REJECTED** - Account is rejected

* **externalId** `string` - External ID

* **business** `object`

  * **country** `string` - Business country code

  * **legalName** `string` - Business legal name

  * **documentNumber** `string` - Business document number

  * **email** `string` - Business email

  * **website** `string` - Business website

  * **address** `object`

    * **line1** `string` - Address line 1
    * **line2** `string` - Address line 2
    * **city** `string` - City
    * **state** `string` - State
    * **zip** `string` - Postal code
    * **country** `string` - Country


---

# MONEI Components

MONEI Components is a set of rich, prebuilt Components that help you create your own checkout flows across desktop and mobile.

Components include features like:

* Format Card information automatically as it's entered
* Translate placeholders to your customer's preferred language
* Use responsive design to fit the width of your customer's screen or mobile device
* Customize the styling to match the look and feel of your checkout flow
* Apple Pay, Google Pay, PayPal, Bizum Сomponents for easy integration into your checkout flow
* All MONEI Components are available in JavaScript, ReactJS, Vue and Angular

## Setup monei.js[​](#setup-moneijs "Direct link to Setup monei.js")

You need to include `monei.js` in your checkout page by either adding the script tag to the `head` of your HTML file, or by importing it from the `monei-js` [module](https://www.npmjs.com/package/@monei-js/components):

<!-- -->

* HTML
* ES Module

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

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

## Card Input Component[​](#card-input-component "Direct link to Card Input Component")

* HTML + JS
* React JS
* Vue JS

The Card Input Component lets you collect card information all within one Component. It includes a dynamically-updating card brand icon as well as inputs for number, expiry and CVC.

* Result
* HTML
* CSS
* JavaScript

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

<form
  action="https://secure.monei.com/payments/{{payment_id}}/confirm"
  method="post"
  id="payment-form"
>
  <div class="card-field">
    <div id="card-input">
      <!-- A MONEI Card Input Component will be inserted here. -->
    </div>
    <!-- Used to display card errors. -->
    <div id="card-error"></div>
  </div>
  <button type="submit" id="payment-button">Submit payment</button>
</form>
```

```
#card-input {
  border: 1px solid transparent;
  border-radius: 4px;
  background-color: white;
  box-shadow: 0 1px 3px 0 #e6ebf1;
  height: 38px;
  box-sizing: border-box;
  -webkit-transition: box-shadow 150ms ease;
  transition: box-shadow 150ms ease;
}
#card-input.is-focused {
  box-shadow: 0 1px 3px 0 #cfd7df;
}
#card-input.is-invalid {
  border-color: #fa755a;
}
#card-error {
  color: #fa755a;
  padding: 4px 0;
  font-size: 14px;
}
```

```
const container = document.getElementById('card-input');
const errorText = document.getElementById('card-error');

// Custom styling can be passed to options when creating a Card Input Component.
const style = {
  input: {
    color: '#8961a5',
    fontFamily: '"Helvetica Neue", Helvetica, sans-serif',
    fontSmoothing: 'antialiased',
    fontSize: '16px',
    '::placeholder': {
      color: '#848589'
    },
    '-webkit-autofill': {
      backgroundColor: '#FAFFBD'
    }
  },
  invalid: {
    color: '#fa755a'
  }
};

// Create an instance of the Card Input.
const cardInput = monei.CardInput({
  paymentId: 'af6029f80f5fc73a8ad2753eea0b1be0',
  style: style,
  onFocus: function () {
    container.classList.add('is-focused');
  },
  onBlur: function () {
    container.classList.remove('is-focused');
  },
  onChange: function (event) {
    // Handle real-time validation errors.
    if (event.isTouched && event.error) {
      container.classList.add('is-invalid');
      errorText.innerText = event.error;
    } else {
      container.classList.remove('is-invalid');
      errorText.innerText = '';
    }
  }
});

// Render an instance of the Card Input into the `card_input` <div>.
cardInput.render(container);

// Handle form submission.
const paymentForm = document.getElementById('payment-form');
const paymentButton = document.getElementById('payment-button');
paymentForm.addEventListener('submit', function (event) {
  event.preventDefault();
  paymentButton.disabled = true;
  monei
    .createToken(cardInput)
    .then(function (result) {
      console.log(result);
      if (result.error) {
        // Inform the user if there was an error.
        container.classList.add('is-invalid');
        errorText.innerText = result.error;
      } else {
        // Send the token to your server.
        moneiTokenHandler(result.token);
      }
      paymentButton.disabled = false;
    })
    .catch(function (error) {
      paymentButton.disabled = false;
      console.log(error);
    });
});

// Submit the form with the token ID.
function moneiTokenHandler(token) {
  // Insert the token ID into the form so it gets submitted to the server
  const hiddenInput = document.createElement('input');
  hiddenInput.setAttribute('type', 'hidden');
  hiddenInput.setAttribute('name', 'paymentToken');
  hiddenInput.setAttribute('value', token);
  paymentForm.appendChild(hiddenInput);

  // Submit the form
  paymentForm.submit();
}
```

[![Edit monei-card-input-js](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/monei-card-input-js-u5p5h?fontsize=14\&hidenavigation=1\&theme=dark)

The Card Input Component lets you collect Credit Card information all within one single Component. It includes a dynamically-updating card brand icon as well as inputs for Credit Card number (PAN), Expiry Date and CVC.

* TypeScript TSX
* CSS

```
import * as React from 'react';
import * as ReactDOM from 'react-dom';
import cn from 'classnames';
import {CardInput, CardInputProps, createToken} from '@monei-js/components';

// Set React driver for Card Input Component
const CardInputComponent: React.FC<CardInputProps> = CardInput.driver('react', {
  React: React,
  ReactDOM: ReactDOM
});

// Custom styling can be passed to options when creating a Card Input Component.
const style = {
  input: {
    color: '#8961a5',
    fontFamily: '"Helvetica Neue", Helvetica, sans-serif',
    fontSmoothing: 'antialiased',
    fontSize: '16px',
    '::placeholder': {
      color: '#848589'
    },
    '-webkit-autofill': {
      backgroundColor: '#FAFFBD'
    }
  },
  invalid: {
    color: '#fa755a'
  }
};

const App = () => {
  // Create ref for CardInputComponent
  const ref = React.useRef();
  const [isFocused, setFocused] = React.useState(false);
  const [isLoading, setLoading] = React.useState(false);
  const [error, setError] = React.useState<string | null>(null);

  // POST the token ID to your backend.
  const moneiTokenHandler = async (paymentToken) => {
    const response = await fetch('/payment', {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({paymentToken})
    });

    return response.json();
  };

  const handleSubmit = async (event: React.FormEvent<HTMLFormElement>) => {
    setLoading(true);
    event.preventDefault();
    // Pass current CardInputComponent ref to create token
    const result = await createToken(ref.current);
    setLoading(false);
    if (result.error) {
      // Inform the user if there was an error.
      setError(result.error);
    } else {
      setError(null);
      // Send the token to your server.
      return moneiTokenHandler(result.token);
    }
  };

  return (
    <form id="payment-form" onSubmit={handleSubmit}>
      <div className="card-field">
        <div
          id="card-input"
          className={cn({'is-focused': isFocused, 'is-invalid': error !== null})}
        >
          <CardInputComponent
            ref={ref}
            accountId="fe6432a7-8a24-4288-a3a3-545c3205b549"
            style={style}
            onFocus={() => setFocused(true)}
            onBlur={() => setFocused(false)}
            onChange={(event) => {
              // Handle real-time validation errors.
              if (event.isTouched && event.error) {
                setError(event.error);
              } else {
                setError(null);
              }
            }}
          />
        </div>
        <div id="card-error">{error}</div>
      </div>
      <button type="submit" disabled={isLoading}>
        Submit payment
      </button>
    </form>
  );
};

ReactDOM.render(<App />, document.getElementById('root'));
```

Temporary Fix for React 19

If you're using React 19 and experiencing issues with MONEI Components, you can use the following temporary fix:

```
// Import findDOMNode from external library
import {findDOMNode} from 'find-dom-node-polyfill';

// Set Find DOM Node before driver
ReactDOM.findDOMNode = findDOMNode;

const CardInputComponent: React.FC<CardInputProps> = CardInput.driver('react', {
  React: React,
  ReactDOM: ReactDOM
});
```

This workaround addresses the removal of `ReactDOM.findDOMNode` in React 19 by using the external library. We're working on a permanent solution that will be available in the next major version of MONEI Components.

```
#card-input {
  border: 1px solid transparent;
  border-radius: 4px;
  background-color: white;
  box-shadow: 0 1px 3px 0 #e6ebf1;
  height: 38px;
  box-sizing: border-box;
  -webkit-transition: box-shadow 150ms ease;
  transition: box-shadow 150ms ease;
}
#card-input.is-focused {
  box-shadow: 0 1px 3px 0 #cfd7df;
}
#card-input.is-invalid {
  border-color: #fa755a;
}
#card-error {
  color: #fa755a;
  padding: 4px 0;
  font-size: 14px;
}
```

[![Edit monei-card-input-react-19](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/p/sandbox/monei-card-input-react-forked-8cm7qm?file=/src/index.tsx:10,1-16,4)

The Card Input Component lets you collect Credit Card information all within one single Component. It includes a dynamically-updating card brand icon as well as inputs for Credit Card number (PAN), Expiry Date and CVC.

* Vue JS
* CSS

```
<template>
  <form action="/payment" method="post" id="payment-form" @submit="onSubmit">
    <div class="card-field">
      <div id="card-input" :class="{'is-focused': isFocused, 'is-invalid': error !== null}">
        <CardInput
          ref="cardInput"
          :accountId="accountId"
          :innerStyle="innerStyle"
          :onFocus="onFocus"
          :onBlur="onBlur"
          :onChange="onChange"
        />
      </div>
      <!-- Used to display card errors. -->
      <div id="card-error">{{ error }}</div>
    </div>
    <button type="submit" id="payment-button" :disabled="isLoading">Submit payment</button>
  </form>
</template>

<script>
  import Vue from 'vue';
  import {CardInput, createToken} from '@monei-js/components';

  // POST the token ID to your backend.
  const moneiTokenHandler = async (paymentToken) => {
    const response = await fetch('/payment', {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({paymentToken})
    });

    return response.json();
  };

  export default {
    name: 'App',
    components: {
      // Set Vue driver for Card Input Component
      // If you have Vue 2.x or lower use CardInput.driver('vue', Vue)
      CardInput: CardInput.driver('vue3', Vue)
    },
    data() {
      return {
        accountId: 'fe6432a7-8a24-4288-a3a3-545c3205b549',
        isFocused: false,
        isLoading: false,
        error: null,
        onChange: (event) => {
          // Handle real-time validation errors.
          if (event.isTouched && event.error) {
            this.error = event.error;
          } else {
            this.error = null;
          }
        },
        onFocus: (event) => {
          this.isFocused = true;
        },
        onBlur: () => {
          this.isFocused = false;
        },
        // Custom styling can be passed to options when creating a Card Input Component
        innerStyle: {
          input: {
            color: '#8961a5',
            fontFamily: '"Helvetica Neue", Helvetica, sans-serif',
            fontSmoothing: 'antialiased',
            fontSize: '16px',
            '::placeholder': {
              color: '#848589'
            },
            '-webkit-autofill': {
              backgroundColor: '#FAFFBD'
            }
          },
          invalid: {
            color: '#fa755a'
          }
        }
      };
    },
    methods: {
      async onSubmit(event) {
        this.isLoading = true;
        event.preventDefault();
        // Pass current CardInputComponent ref to create token
        const result = await createToken(this.$refs.cardInput);
        this.isLoading = false;
        if (result.error) {
          // Inform the user if there was an error.
          this.error = result.error;
        } else {
          this.error = null;
          // Send the token to your server.
          return moneiTokenHandler(result.token);
        }
      }
    }
  };
</script>
```

```
#card-input {
  border: 1px solid transparent;
  border-radius: 4px;
  background-color: white;
  box-shadow: 0 1px 3px 0 #e6ebf1;
  height: 38px;
  box-sizing: border-box;
  -webkit-transition: box-shadow 150ms ease;
  transition: box-shadow 150ms ease;
}
#card-input.is-focused {
  box-shadow: 0 1px 3px 0 #cfd7df;
}
#card-input.is-invalid {
  border-color: #fa755a;
}
#card-error {
  color: #fa755a;
  padding: 4px 0;
  font-size: 14px;
}
```

[![Edit monei-card-input-vue](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/monei-card-input-vue-iw2kr?fontsize=14\&hidenavigation=1\&theme=dark)

Card Input Component is completely customizable. You can style it to match the look and feel of your site, providing a seamless checkout experience for your customers. It's also possible to style various input states, for example when the input has focus.

To see all available MONEI Components check the [API docummentation](https://docs.monei.com/monei-js/reference/.md) or our integration guides for individual payment methods.


---

# Payment Request Component

MONEI [Payment Request Component](https://docs.monei.com/monei-js/reference/.md#paymentrequest-component) gives you a single integration for Apple Pay and Google Pay. Customers see a Google Pay or an Apple Pay button, depending on what their device and browser combination supports.

note

Apple Pay with the Payment Request Component requires macOS 10.12.1+ or iOS 10.1+.

## Before you begin[​](#before-you-begin "Direct link to Before you begin")

This page explains how to add Payment Request Component to your payment page. To accept Apple Pay and Google Pay payments you need to have at least one configured card processor.

To configure card processors go to [MONEI Dashboard → Settings → Payment Methods → Card payments](https://dashboard.monei.com/settings/payment-methods/card).

Before you start, you need to:

* Add a payment method to your browser. For example, you can save a card in Chrome, or add a card to your Wallet for Safari.
* Serve your application over HTTPS. This is a requirement both in development and in production. One way to get up and running is to use a service like [ngrok](https://ngrok.com/).
* [Register your domain with Apple Pay](#register-your-domain-with-apple-pay), both in development and production.

To test your integration:

* Use your [test mode](https://docs.monei.com/testing/.md) Account ID and API Key.
* You can use any real card details, you will not be charged in the test mode (card details are automatically replaced with the test card).
* You can check the status of the test payment in your [MONEI Dashboard → Payments](https://dashboard.monei.com/payments) (in test mode).

## Register your domain with Apple Pay[​](#register-your-domain-with-apple-pay "Direct link to Register your domain with Apple Pay")

If you are using [WooCommerce Plugin](https://docs.monei.com/e-commerce/woocommerce/.md) or [custom domain](https://dashboard.monei.com/settings/custom-domain) with [MONEI Hosted Payment Page](https://docs.monei.com/integrations/use-prebuilt-payment-page/.md) your domain is verified automatically.

In order to register your domain with Apple, you will need to first verify your ownership of the domain. Go to your [MONEI Dashboard → Settings → Payment Methods](https://dashboard.monei.com/settings/payment-methods), choose **Register domain with Apple** and follow the instructions in the popup.

You can also verify your domain with Apple using [MONEI REST API](https://docs.monei.com/apis/rest/apple-pay-domain-register/.md).

## Integration[​](#integration "Direct link to Integration")

### 1. Create a Payment `Server-side`[​](#1-create-a-payment-server-side "Direct link to 1-create-a-payment-server-side")

Create a [Payment](https://docs.monei.com/apis/rest/schemas/payment/.md) on your server with an amount and currency. Always decide how much to charge on the server side, a trusted environment, as opposed to the client. This prevents malicious customers from being able to choose their own prices.

<!-- -->

* cURL
* Node.js
* PHP

POST https\://api.monei.com/v1/payments

```
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",
  "description": "Test Shop - #14379133960355",
  "customer": {
    "email": "email@example.com"
   },
  "callbackUrl": "https://example.com/checkout/callback"
}'
```

server.js

```
const {Monei} = require('@monei-js/node-sdk');
const monei = new Monei('pk_test_36cf3e8a15eff3f5be983562ea6b13ec');
monei.payments.create({
  amount: 110,
  currency: 'EUR',
  orderId: '14379133960355',
  description: 'Test Shop - #14379133960355',
  customer: {
    email: 'email@example.com'
  },
  callbackUrl: 'https://example.com/checkout/callback'
});
```

server.php

```
$monei = new Monei\MoneiClient('pk_test_36cf3e8a15eff3f5be983562ea6b13ec');
$monei->payments->create([
  'amount' => 110,
  'currency' => 'EUR',
  'orderId' => '14379133960355',
  'description' => 'Test Shop - #14379133960355',
  'customer' => [
    'email' => 'email@example.com'
  ],
  'callbackUrl' => 'https://example.com/checkout/callback'
]);
```

The following parameters are required:

* **amount** `positive integer` - 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)
* **currency** `string` - Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase. Must be a supported currency.
* **orderId** `string` - An order ID from your system. A unique identifier that can be used to reconcile the payment with your internal system.
* **callbackUrl** `string` - The URL to which a payment result should be sent asynchronously.

note

Payment Request Component is also available as a React and Vue component. [Check out our examples](https://docs.monei.com/monei-js/overview/.md#card-input-component).

Check all available [request parameters](https://docs.monei.com/apis/rest/payments-create/.md).

Included in the returned Payment object is a payment `id`, which is used on the client side to securely complete the payment process instead of passing the entire Payment object.

### 2. Add Payment Request Component to your payment page `Client-side`[​](#2-add-payment-request-component-to-your-payment-page-client-side "Direct link to 2-add-payment-request-component-to-your-payment-page-client-side")

Include `monei.js` on your checkout page by adding the script tag to the `head` of your HTML file.

checkout.html

```
<head>
  <title>Checkout</title>
  <script src="https://js.monei.com/v2/monei.js"></script>
</head>
```

Add MONEI [Payment Request Component](https://docs.monei.com/monei-js/reference/.md#paymentrequest-component) to your payment page. Create empty DOM node (container) with unique ID in your payment form.

checkout.html

```
<div id="payment_request_container">
  <!-- Payment Request Component will be inserted here. -->
</div>
```

Initialize Payment Request Component

client.js

```
// Create an instance of the Google Pay component.
const paymentRequest = monei.PaymentRequest({
  paymentId: '{{payment_id}}',
  onSubmit(result) {
    moneiTokenHandler(result.token);
  },
  onError(error) {
    console.log(error);
  }
});

// Render an instance of the Payment Request Component into the `payment_request_container` <div>.
paymentRequest.render('#payment_request_container');
```

Check the [MONEI JS Reference](https://docs.monei.com/monei-js/reference/.md#paymentrequest-component) for more options.

### 3. Confirm the payment `Client-side`[​](#3-confirm-the-payment-client-side "Direct link to 3-confirm-the-payment-client-side")

To complete the payment you need to confirm it using monei.js [confirmPayment](https://docs.monei.com/monei-js/reference/.md#confirmpayment-function) function

You need to provide a `paymentId` (obtained in [step 1](#1-create-a-payment-server-side)) and `paymentToken` generated with Payment Request Component. You can also provide additional parameters like `customer.email`. Check all available [parameters](https://docs.monei.com/apis/rest/payments-confirm/.md).

client.js

```
// Confirm the payment
function moneiTokenHandler(token) {
  return monei
    .confirmPayment({paymentId: '{{payment_id}}', paymentToken: token})
    .then(function (result) {
      // At this moment you can show a customer the payment result
      // But you should always rely on the result passed to the callback endpoint on your server
      // to update the order status
      console.log(result);
    })
    .catch(function (error) {
      console.log(error);
    });
}
```

note

As an alternative process you can submit generated `paymentToken` to your sever and then [confirm payment](https://docs.monei.com/apis/rest/payments-confirm/.md) on the server-side.

### 4. An asynchronous request is sent to your server.[​](#4-an-asynchronous-request-is-sent-to-your-server "Direct link to 4. An asynchronous request is sent to your server.")

MONEI will notify you about the payment status by sending an HTTP POST request to the `callbackUrl`. The request body will contain full [payment object](https://docs.monei.com/apis/rest/schemas/payment/.md) in JSON format.

This ensures that you get the payment status even when customer closed the browser window or lost internet connection.

The request also contains a `MONEI-Signature` header. [Verify this signature](https://docs.monei.com/guides/verify-signature/.md) to confirm that received request is sent from MONEI.

To acknowledge receipt of the request, your endpoint must return a `200` HTTP status code to MONEI. All other response codes, including `3xx` codes, indicate to MONEI that you did not receive the event.

If MONEI does not receive a `200` HTTP status code, the notification attempt is repeated. After multiple failures to send the notification over multiple days, MONEI marks the request as failed and stops trying to send it to your endpoint.

## Before you go live[​](#before-you-go-live "Direct link to Before you go live")

* Make sure that you are using [live (production) mode](https://docs.monei.com/testing/.md) Account ID and API Key.
* Make sure that you have at least one [enabled card processor](https://dashboard.monei.com/settings/payment-methods/card).
* Contact our [Support Team](https://support.monei.com/hc/requests/new) to configure Apple Pay in production.


---

# MONEI JS Reference

This reference documents every object and method available in MONEI’s browser-side JavaScript library, monei.js.

You can use monei.js’ APIs to integrate prebuilt Components for different payment methods into your own checkout flows across desktop and mobile.

## Including monei.js[​](#including-moneijs "Direct link to Including monei.js")

Include the **monei.js** script on the checkout page of your site — it should always be loaded directly from `https://js.monei.com`, rather than included in a bundle or hosted yourself.

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

### Using monei.js as a module[​](#using-moneijs-as-a-module "Direct link to Using monei.js as a module")

We also provide an npm package that makes it easier to load and use monei.js as a module.

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

## `monei` object[​](#monei-object "Direct link to monei-object")

The monei object is your entrypoint to the rest of the monei.js SDK.

## `CardInput` Component[​](#cardinput-component "Direct link to cardinput-component")

CardInput is a customizable Component used to collect sensitive card information in your payment forms.

### Create an instance of the CardInput Component.[​](#create-an-instance-of-the-cardinput-component "Direct link to Create an instance of the CardInput Component.")

```
const cardInput = monei.CardInput({
  paymentId: 'af6029f80f5fc73a8ad2753eea0b1be0',
  ...otherOptions
});

// render Component on the page
cardInput.render('#card_input_container');
```

### CardInput options[​](#cardinput-options "Direct link to CardInput options")

* **paymentId** `string` - A payment ID provided by MONEI in [create payment](https://docs.monei.com/apis/rest/payments-create/.md) request. Generated payment token will be bound to this payment.

* **accountId** `string` - Your MONEI account ID. Required if you're initializing card input with account ID. Instead of passing **paymentId** you can initialize a card input with the **accountId** and **sessionId** (optional). Generate a payment token before you create the payment itself.

* **sessionId** `string` - Unique session ID in your system. Provide a different **sessionId** for each customer. Use this parameter to ensure that the customer who generated the token is the same as the one making the payment. Only required if you pass a token to your server. If you provide a **sessionId** when initializing MONEI Component you will need to provide the same value when you [create a payment](https://docs.monei.com/apis/rest/schemas/payment/.md) on your server.

* **style** `object` - Customize the appearance of this Component using CSS properties passed in a [Style](#cardinput-style-object) object.

* **language** `string` - The [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code represents the desired component language. Supported locales include `en`, `es`, `ca`, `pt`, `de`, `it`, `fr`, `nl`, `et`, `fi`, `lv`, `no`, `pl` and `ru`. By default, MONEI smartly detects the correct language for the buyer based on their geolocation and browser preferences.

* **placeholders** `object` - Customize input placeholders

  <!-- -->

  * **cardNumber** `string` - Card number placeholder. Default: "Card number"
  * **expiryDate** `string`- Expiry date placeholder. Default: "MM/YY"
  * **cvc** `string` - CVC placeholder. Default: "CVC"

* **errorMessages** `object` - Customize error messages

  <!-- -->

  * **emptyCardNumber** `string` - Default: "Enter a card number"
  * **invalidCardNumber** `string` - Default: "Card number is invalid"
  * **emptyExpiryDate** `string` - Default: "Enter an expiry date"
  * **monthOutOfRange** `string` - Default: "Expiry month must be between 01 and 12"
  * **yearOutOfRange** `string` - Default: "Expiry year cannot be in the past"
  * **dateOutOfRange** `string` - Default: "Expiry date cannot be in the past"
  * **invalidExpiryDate** `string` - Default: "Expiry date is invalid"
  * **emptyCVC** `string` - Default: "Enter a CVC"
  * **invalidCVC** `string` - Default: "CVC is invalid"

* **onFocus:() => void** `function` - Callback function that is called when card input is focused

* **onBlur:() => void** `function` - Callback function that is called when card input is blurred

* **onLoad:() => void** `function` - Callback function that is called when card input is fully loaded

* **onEnter:() => void** `function` - Callback function that is called when user presses **Enter** key on the keyboard inside card input.

* **onChange:(event: CardInputOnChangeEvent) => void** `function` - Callback function that is called on every user input. Used for real-time validation.

  <!-- -->

  * **event.isTouched** `boolean` - Indicates if card input was touched.
  * **event.focused** `string` - Indicates what input is focused. Possible values: `cardNumber`, `expiryDate`, `cvc`
  * **cardType** `string` - Detected card type.
  * **error** `string` - Card input error. Use this attribute to show an error to a user.

* **onError: (error: Error) => void** `function` - Callback function that is called when there is an error.

### CardInput Style object[​](#cardinput-style-object "Direct link to CardInput Style object")

components are styled using a Style object. It consists of CSS properties nested under objects for any of the following variants:

* **base** `object` - base Component style
* **loading** `object` - base Component style when Component is loading
* **invalid** `object` - applied when the Component has invalid input
* **input** `object` - applied to individual inputs
* **cardNumber** `object` - applied to card number input
* **expiryDate** `object` - applied to expiry date input
* **cvc** `object` - applied to cvc input
* **icon** `object` - applied to icon

The following pseudo-classes and pseudo-elements can also be styled using a nested object inside of a variant:

* `:focus`
* `:hover`
* `::placeholder`
* `::selection`
* `:-webkit-autofill`

```
const style = {
  base: {
    height: '44px',
    padding: '8px 12px'
  },
  loading: {
    backgroundColor: '#F4F4F4'
  },
  input: {
    color: '#8961a5',
    fontFamily: '"Helvetica Neue", Helvetica, sans-serif',
    fontSmoothing: 'antialiased',
    fontSize: '16px',
    '::placeholder': {
      color: '#848589'
    },
    '-webkit-autofill': {
      backgroundColor: '#FAFFBD'
    }
  },
  invalid: {
    color: '#fa755a'
  }
};

const cardInput = monei.CardInput({
  paymentId: 'af6029f80f5fc73a8ad2753eea0b1be0',
  style: style,
  ...otherOptions
});

// render Component on the page
cardInput.render('#card_input_container');
```

## `createToken` function[​](#createtoken-function "Direct link to createtoken-function")

Use this function to generate payment token.

note

Payment tokens generated by monei.js Components expire as soon as they are used or 5 days after creation.

Pass an instance of CardInput Component.

```
declare const createToken: (Component: MoneiComponent) => Promise<{
  token?: string; // payment token
  error?: string; // validation error
}>;
```

Example:

```
monei
  .createToken(cardInput) // pass a reference to an instance of your CardInput Component
  .then(function (result) {
    console.log(result);
    if (result.error) {
      // Inform the user if there was an error.
    } else {
      // Confirm payment using the token.
      moneiTokenHandler(result.token);
    }
  })
  .catch(function (error) {
    // Something went wrong while generating token
    console.log(error);
  });
```

## `PayPal` Component[​](#paypal-component "Direct link to paypal-component")

PayPal is a customizable Component that renders a PayPal payment button.

### Create an instance of the PayPal Component.[​](#create-an-instance-of-the-paypal-component "Direct link to Create an instance of the PayPal Component.")

```
const paypal = monei.PayPal({
  paymentId: 'af6029f80f5fc73a8ad2753eea0b1be0',
  onSubmit(result) {
    if (result.error) {
      // Inform the user if there was an error.
    } else {
      // Confirm payment using the token.
      moneiTokenHandler(result.token);
    }
  },
  onError(error) {
    console.log(error);
  },
  ...otherOptions
});

// render Component on the page
paypal.render('#paypal_container');
```

### PayPal options[​](#paypal-options "Direct link to PayPal options")

* **paymentId** `string` - A payment ID provided by MONEI in [create payment](https://docs.monei.com/apis/rest/payments-create/.md) request. Generated payment token will be bound to this payment.

* **accountId** `string` - Your MONEI account ID. Required if you're initializing the Component with account ID. Instead of passing **paymentId** you can initialize the Component with the **accountId** and **sessionId** (optional). Generate a payment token before you create the payment itself.

* **sessionId** `string` - Unique session ID in your system. Provide a different **sessionId** for each customer. Use this parameter to ensure that the customer who generated the token is the same as the one making the payment. Only required if you pass a token to your server. If you provide a **sessionId** when initializing MONEI Component you will need to provide the same value when you [create a payment](https://docs.monei.com/apis/rest/schemas/payment/.md) on your server.

* **amount** `positive integer` - 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). Required if you initialize a Component with **accountId**. You'll need to pass the same value when creating the payment.

* **currency** `string` - Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase. Must be a supported currency. Required if you initialize a Component with **accountId**. You'll need to pass the same value when creating the payment.

* **transactionType** `string` - Controls when the funds will be captured. Required if you initialize a Component with **accountId**. You'll need to pass the same value when creating the payment.

  <!-- -->

  * **SALE** - `default`. MONEI automatically captures funds when the customer authorizes the payment.
  * **AUTH** - Place a hold on the funds when the customer authorizes the payment, but don’t capture the funds until later.

* **language** `string` - The language of the Component. By default, MONEI smartly detects the correct language for the buyer based on their geolocation and browser preferences. It is recommended to pass this parameter only if you need the PayPal button to render in the same language as the rest of your site. [List of supported languages](https://developer.paypal.com/docs/checkout/reference/customize-sdk/#locale).

* **style** `object` - Customize the appearance of [PayPal button](https://developer.paypal.com/docs/archive/checkout/how-to/customize-button/#button-styles).

  <!-- -->

  * **height** `string` - By default, the button adapts to the size of its container element. To customize the button width, alter the width of the container element. To customize the button height, set the style.height option to a value from `25` to `55`.
  * **shape** `string` - Set button shape. Possible values: `rect`, `pill`
  * **color** `string` - Set button color. Possible values: `gold`, `blue`, `silver`, `white`, `black`
  * **layout** `string` - Determine the button layout when multiple buttons are available Possible values: `vertical`, `horizontal`
  * **label** `string`- Set button label. Possible values: `checkout`, `credit`, `pay`, `buynow`, `paypal`, `installment`

* **onLoad:(isSupported: boolean) => void** `function` - Callback function that is called when paypal is fully loaded. If this payment method is not supported, the Component will not show up, and `onLoad` callback will be triggered with `isSupported: false`

* **onBeforeOpen:() => boolean** `function` - Callback function that is called before the PayPal window is opened. If the function returns `false`, the PayPal window will not be opened.

* **onSubmit:(result: {token?: string; error?: string}) => void** `function` - Callback function that is called when customer approves the payment.

  <!-- -->

  * **result.token** `string` - Payment token
  * **result.error** `string` - Payment error. Use this attribute to show an error to a user.

* **onError: (error: Error) => void** `function` - Callback function that is called when there is an error.

## `PaymentRequest` Component[​](#paymentrequest-component "Direct link to paymentrequest-component")

PaymentRequest is a customizable Component that renders a Google Pay or Apple Pay payment button depending on the browser and operating system of the user.

### Create an instance of the PaymentRequest Component.[​](#create-an-instance-of-the-paymentrequest-component "Direct link to Create an instance of the PaymentRequest Component.")

```
const paymentRequest = monei.PaymentRequest({
  paymentId: 'af6029f80f5fc73a8ad2753eea0b1be0',
  onSubmit(result) {
    if (result.error) {
      // Inform the user if there was an error.
    } else {
      // Confirm payment using the token.
      moneiTokenHandler(result.token);
    }
  },
  onError(error) {
    console.log(error);
  },
  ...otherOptions
});

// render Component on the page
paymentRequest.render('#payment_request');
```

### PaymentRequest options[​](#paymentrequest-options "Direct link to PaymentRequest options")

* **paymentId** `string` - A payment ID provided by MONEI in [create payment](https://docs.monei.com/apis/rest/payments-create/.md) request. Generated payment token will be bound to this payment.

* **accountId** `string` - Your MONEI account ID. Required if you're initializing the Component with account ID. Instead of passing **paymentId** you can initialize the Component with the **accountId** and **sessionId** (optional). Generate a payment token before you create the payment itself.

* **sessionId** `string` - Unique session ID in your system. Provide a different **sessionId** for each customer. Use this parameter to ensure that the customer who generated the token is the same as the one making the payment. Only required if you pass a token to your server. If you provide a **sessionId** when initializing MONEI Component you will need to provide the same value when you [create a payment](https://docs.monei.com/apis/rest/schemas/payment/.md) on your server.

* **amount** `positive integer` - 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). Required if you initialize a Component with **accountId**. You'll need to pass the same value when creating the payment.

* **currency** `string` - Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase. Must be a supported currency. Required if you initialize a Component with **accountId**. You'll need to pass the same value when creating the payment.

* **language** `string` - The [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code represents the desired button language. Supported locales include `en`, `es`, `ca`, `pt`, `de`, `it`, `fr`, `nl`, `et`, `fi`, `lv`, `no`, `pl` and `ru`.

* **style** `object` - Customize the appearance of Google Pay button.

  <!-- -->

  * **height** `string` - By default, the button adapts to the size of its container element. To customize the button width, alter the width of the container element. To customize the button height, set the style.height option to a value from `25` to `55`.

  * **type** `string` - Set button type. Possible values:

    <!-- -->

    * **buy** - "Buy with Google Pay / Apple Pay" button.
    * **donate** - "Donate with Google Pay / Apple Pay" button.
    * **plain** - button without additional text (default).

  * **color** `string` - Set button color. Possible values: `default`, `black`, `white`

* **onLoad:(isSupported: boolean) => void** `function` - Callback function that is called when payment request is fully loaded. If this payment method is not supported, the Component will not show up, and `onLoad` callback will be triggered with `isSupported: false`

* **onBeforeOpen:() => boolean** `function` - Callback function that is called before the payment window is opened. If the function returns `false`, the payment window will not be opened.

* **onSubmit:(result: {token?: string; error?: string}) => void** `function` - Callback function that is called when customer approves the payment.

  <!-- -->

  * **result.token** `string` - Payment token
  * **result.error** `string` - Payment error. Use this attribute to show an error to a user.

* **onError: (error: Error) => void** `function` - Callback function that is called when there is an error.

## `Bizum` Component[​](#bizum-component "Direct link to bizum-component")

Bizum is a customizable Component that renders a Bizum payment button.

### Create an instance of the Bizum Component.[​](#create-an-instance-of-the-bizum-component "Direct link to Create an instance of the Bizum Component.")

```
const bizum = monei.Bizum({
  paymentId: 'af6029f80f5fc73a8ad2753eea0b1be0',
  onSubmit(result) {
    if (result.error) {
      // Inform the user if there was an error.
    } else {
      // Confirm payment using the token.
      moneiTokenHandler(result.token);
    }
  },
  onError(error) {
    console.log(error);
  },
  ...otherOptions
});

// render Component on the page
bizum.render('#bizum');
```

### Bizum options[​](#bizum-options "Direct link to Bizum options")

* **paymentId** `string` - A payment ID provided by MONEI in [create payment](https://docs.monei.com/apis/rest/payments-create/.md) request. Generated payment token will be bound to this payment.

* **accountId** `string` - Your MONEI account ID. Required if you're initializing the Component with account ID. Instead of passing **paymentId** you can initialize the Component with the **accountId** and **sessionId** (optional). Generate a payment token before you create the payment itself.

* **sessionId** `string` - Unique session ID in your system. Provide a different **sessionId** for each customer. Use this parameter to ensure that the customer who generated the token is the same as the one making the payment. Only required if you pass a token to your server. If you provide a **sessionId** when initializing MONEI Component you will need to provide the same value when you [create a payment](https://docs.monei.com/apis/rest/schemas/payment/.md) on your server.

* **amount** `positive integer` - 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). Required if you initialize a Component with **accountId**. You'll need to pass the same value when creating the payment.

* **currency** `string` - Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase. Must be a supported currency. Required if you initialize a Component with **accountId**. You'll need to pass the same value when creating the payment.

* **language** `string` - The [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code represents the desired button language. Supported locales include `en`, `es`, `ca`, `pt`, `de`, `it`, `fr`, `nl`, `et`, `fi`, `lv`, `no`, `pl` and `ru`.

* **style** `object` - Customize the appearance of Google Pay button.

  <!-- -->

  * **height** `string` - By default, the button adapts to the size of its container element. To customize the button width, alter the width of the container element. To customize the button height, set the style.height option to a value from `25` to `55`.

  * **type** `string` - Set button type. Possible values:

    <!-- -->

    * **pay** - "Pay with Bizum" button.
    * **plain** - button without additional text (default).

* **onLoad:(isSupported: boolean) => void** `function` - Callback function that is called when payment request is fully loaded. If this payment method is not supported, the Component will not show up, and `onLoad` callback will be triggered with `isSupported: false`

* **onBeforeOpen:() => boolean** `function` - Callback function that is called before the Bizum window is opened. If the function returns `false`, the payment window will not be opened.

* **onSubmit:(result: {token?: string; error?: string}) => void** `function` - Callback function that is called when customer approves the payment.

  <!-- -->

  * **result.token** `string` - Payment token
  * **result.error** `string` - Payment error. Use this attribute to show an error to a user.

* **onError: (error: Error) => void** `function` - Callback function that is called when there is an error.

## `confirmPayment` function[​](#confirmpayment-function "Direct link to confirmpayment-function")

After you generate the **paymentToken** using one of the Components, use this function to confirm the payment passing the obtained `paymentToken`. It will automatically show a popup window with a 3D Secure confirmation screen if required.

You can also use this function without a **paymentToken** attribute. It will show a payment popup window.

You can provide additional customer information in parameters.

```
declare const confirmPayment: (params: ConfirmPaymentParams) => Promise<PaymentResult>;
```

### Confirm payment params[​](#confirm-payment-params "Direct link to Confirm payment params")

* **paymentId** `string` `required` - A payment ID provided by MONEI in [create payment](https://docs.monei.com/apis/rest/payments-create/.md) request
* **paymentToken** `string` - A payment token generated by monei.js. If **paymentToken** is present the popup window will open directly to a 3D Secure confirmation screen (if needed).
* **generatePaymentToken** `boolean` - If set to true a permanent token that represents a payment method used in the payment will be generated.
* **fullscreen** `boolean` - Set this parameter to true to open a fullscreen confirmation window.
* **language** `string` - Two-letter language code ([ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1)). Supported locales include `en`, `es`, `ca`, `pt`, `de`, `it`, `fr`, `nl`, `et`, `fi`, `lv`, `no`, `pl` and `ru`. If provided overrides browser detected user language.
* **allowedPaymentMethods** `string[]` - List of allowed payment methods. If provided overrides payment methods allowed in the payment. Supported payment methods: `card`, `googlePay`,`clickToPay`, `bizum`, `paypal`.
* **customDomain** `string` - Custom domain to use for the payment popup window. If you have custom domain configured this option is required for the popup window to work.

Check [confirm payment](https://docs.monei.com/apis/rest/payments-confirm/.md) for the full list of parameters.

### Payment result[​](#payment-result "Direct link to Payment result")

* **id** `string` - Unique identifier for the payment.

* **status** `string` - The status of the payment.

* **amount** `positive integer` - 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).

* **currency** `string` - Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase.

* **accountId** `string` - MONEI account ID.

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

* **statusCode** `string` - Payment status code.

* **statusMessage** `string` - Human readable status message, can be displayed to a user.

* **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.

  <!-- -->

  * **type** `string`
  * **mustRedirect** `boolean`
  * **redirectUrl** `string`

Check [payment object](https://docs.monei.com/apis/rest/schemas/payment/.md) for the full description of each field

Example:

```
monei
  .confirmPayment({
    paymentId: 'af6029f80f5fc73a8ad2753eea0b1be0',
    paymentToken: 'fe6786e08ded3191cf2f623e120a0bacda715bf2',
    ...otherOptions
  })
  .then(function (result) {
    // Payment result
    console.log(result);
  })
  .catch(function (error) {
    // Something went wrong while confirming payment
    console.log(error);
  });
```


---

# Apple Pay

* Web
* Native iOS App

## Web Integration[​](#web-integration "Direct link to Web Integration")

You can start accepting Apple Pay payments on the Web using [Hosted Payment Page](https://docs.monei.com/integrations/use-prebuilt-payment-page/.md) or [Payment Request Component](https://docs.monei.com/monei-js/payment-request/.md). No additional configuration is required to use Apple Pay in Hosted Payment Page.

Our [Payment Request Component](https://docs.monei.com/monei-js/payment-request/.md) gives you a single integration for Apple Pay and Google Pay. Customers see a Google Pay or an Apple Pay button, depending on what their device and browser combination supports.

info

Open this page in Safari to see the Apple Pay button.

If you prefer to integrate directly against the Apple Pay API, follow the [direct API integration guide](#direct-api-integration) below.

### Direct API Integration[​](#direct-api-integration "Direct link to Direct API Integration")

Before you start, you need to:

* Add a card to your Wallet for Safari.
* Serve your application over HTTPS. This is a requirement both in development and in production. One way to get up and running is to use a service like [ngrok](https://ngrok.com/).
* [Register your domain with Apple Pay](https://docs.monei.com/monei-js/payment-request/.md#register-your-domain-with-apple-pay), both in development and production.
* Follow [Apples's instructions](https://developer.apple.com/documentation/apple_pay_on_the_web).

Include `monei.js` on your checkout page by adding the script tag to the `head` of your HTML file.

checkout.html

```
<head>
  <title>Checkout</title>
  <script src="https://js.monei.com/v2/monei.js"></script>
</head>
```

Create Apple Pay Session

```
const session = new window.ApplePaySession(3, request);
session.onvalidatemerchant = async (event: any) => {
  try {
    const merchantSession = await monei.api.createApplePaySession({
      accountId: 'MONEI_ACCOUNT_ID',
      displayName: 'Test Merchant',
      domainName: 'example.com',
      validationUrl: event.validationURL
    });
    session.completeMerchantValidation(merchantSession);
  } catch (error) {
    session.abort();
  }
};
```

Exchange Apple Pay token for MONEI Payment Token that can be used to confirm payment.

```
session.onpaymentauthorized = async (event) => {
  // Encode Apple Pay token as a base64 string
  const paymentToken = JSON.stringify(event.payment.token);
  const token = window.btoa(paymentToken);
  try {
    const result = await monei.api.createToken({
      paymentId: '{{payment_id}}',
      paymentMethod: {
        applePay: {token}
      }
    });
    session.completePayment({
      status: window.ApplePaySession.STATUS_SUCCESS
    });
    return moneiTokenHandler(result.paymentToken);
  } catch (error) {
    session.completePayment({
      status: window.ApplePaySession.STATUS_FAILURE
    });
  }
};
session.begin();
```

### Confirm the Payment[​](#confirm-the-payment "Direct link to Confirm the Payment")

After you have obtained the MONEI Payment Token, you can confirm the payment using the token.

```
function moneiTokenHandler(token) {
  return monei
    .confirmPayment({paymentId: '{{payment_id}}', paymentToken: token})
    .then(function (result) {
      // At this moment you can show a customer the payment result
      // But you should always rely on the result passed to the callback endpoint on your server
      // to update the order status
      console.log(result);
    })
    .catch(function (error) {
      console.log(error);
    });
}
```

## Native iOS App Integration[​](#native-ios-app-integration "Direct link to Native iOS App Integration")

If you're building a native iOS application with Apple Pay, you need to create a custom Apple Pay Payment Processing Certificate. This certificate allows your app to decrypt Apple Pay tokens and process payments through MONEI.

### Create a Custom Certificate[​](#create-a-custom-certificate "Direct link to Create a Custom Certificate")

1. Go to [Apple Pay Certificates Settings](https://dashboard.monei.com/settings/apple-pay-certificates) in your MONEI Dashboard
2. Click **Create certificate** to generate a Certificate Signing Request (CSR)
3. Download the CSR file
4. Go to [Apple Developer Portal - Certificates](https://developer.apple.com/account/resources/certificates/list)
5. Click the **+** button to create a new certificate
6. Select **Apple Pay Payment Processing Certificate**
7. Select your Merchant ID and click Continue
8. Upload the CSR file you downloaded from MONEI
9. Download the generated certificate (.cer file)
10. Return to [MONEI Dashboard](https://dashboard.monei.com/settings/apple-pay-certificates) and upload the certificate to activate it

info

The private key is securely generated and stored by MONEI. You never need to handle private keys directly.

### Initialize Apple Pay[​](#initialize-apple-pay "Direct link to Initialize Apple Pay")

Create your `PKPaymentRequest` in Swift. The `merchantIdentifier` is provided by MONEI - obtain it from the [Get PaymentMethods](https://docs.monei.com/apis/rest/payment-methods-get/.md) API under `metadata.applePay.merchantId` (both test and production: `merchant.com.monei`):

```
let paymentRequest = PKPaymentRequest()
paymentRequest.merchantIdentifier = "merchant.com.monei" // From MONEI API
paymentRequest.countryCode = "ES"
paymentRequest.currencyCode = "EUR"
paymentRequest.supportedNetworks = [.visa, .masterCard, .amex]
paymentRequest.merchantCapabilities = .capability3DS
paymentRequest.paymentSummaryItems = [
    PKPaymentSummaryItem(label: "Your Store Name", amount: NSDecimalNumber(value: 10.00))
]
```

### Process Payments[​](#process-payments "Direct link to Process Payments")

Once the user authorizes the payment, you'll receive a `PKPayment` object. Send the payment token to your backend, then use the MONEI API to process it:

1. Base64 encode the Apple Pay token from `payment.token.paymentData`
2. Create a MONEI payment token using the Create Token API
3. Confirm the payment using the token

```
// In your PKPaymentAuthorizationViewControllerDelegate
func paymentAuthorizationViewController(
    _ controller: PKPaymentAuthorizationViewController,
    didAuthorizePayment payment: PKPayment,
    handler completion: @escaping (PKPaymentAuthorizationResult) -> Void
) {
    // Send payment.token.paymentData to your backend
    let tokenData = payment.token.paymentData.base64EncodedString()
    // Your backend calls MONEI API to process the payment
}
```

On your backend, exchange the Apple Pay token for a MONEI payment token and confirm the payment.

## Before you go live[​](#before-you-go-live "Direct link to Before you go live")

* Make sure that you are using [live (production) mode](https://docs.monei.com/testing/.md) Account ID and API Key.
* Make sure that you have at least one [enabled card processor](https://dashboard.monei.com/settings/payment-methods/card).
* Contact our [Support Team](https://support.monei.com/hc/requests/new) to configure Apple Pay in production.


---

# Bizum

Accept [Bizum](https://bizum.es/) payments to provide your customers with a secure and convenient way to make instant payments from their smartphones, desktops, or tablets. Bizum, a trusted Spanish mobile payment solution, ensures seamless transactions across multiple devices.

Easily start accepting Bizum payments on your website or mobile app with the [Hosted Payment Page](https://docs.monei.com/integrations/use-prebuilt-payment-page/.md) or [Bizum Component](https://docs.monei.com/monei-js/reference/.md#bizum-component). No extra configuration is needed to enable Bizum on the Hosted Payment Page.

The [Bizum Component](https://docs.monei.com/monei-js/reference/.md#bizum-component) adds a dedicated Bizum button to your payment page. When customers select Bizum, an overlay appears, allowing them to enter their registered phone number to complete the payment quickly and securely.

Online Bizum transactions do not have a maximum amount limit. However, if a transaction fails, it may be due to the issuing bank imposing its own limit or insufficient funds in the consumer's account. Unlike the peer-to-peer (P2P) limits imposed by Bizum, there is no monthly cap on the number of online purchases a customer can make using the service.

With Bizum, you can perform pre-authentications and capture payments at a later time. During pre-authentication, the Bizum number is verified to confirm it belongs to the account holder via an online API, without holding or authorizing any funds as done in card pre-authorizations. Once the account holder is authenticated successfully, you have up to 30 days to capture the payment for the specified amount. If insufficient funds are available in the linked IBAN at the time of capture, the transaction will not proceed. No additional Strong Customer Authentication (SCA) or challenge is required from the Bizum holder during the capture. Note that Bizum payment authentications are available only if the customer's bank supports the RTP (Request to Pay) flow.

Bizum transactions can be refunded within 365 days after the initial transaction has been processed. However, in some cases, the refund may fail due to one of the following reasons:

* The customer has disconnected their Bizum account.
* The customer has changed the link between their phone number and IBAN.
* The issuing bank is experiencing internal issues with Bizum notifications.

Bizum Payment Status Monitoring

The status of a payment is a critical aspect of a transaction, as any discrepancy between the payment gateway and the processor can have serious consequences for both the merchant and the consumer. An error in this area can result in failed transactions, financial losses, or trust issues between the involved parties. For this reason, MONEI has developed an exclusive internal technology that ensures the security of the status of each transaction made through the Bizum payment method at all times. This advanced technology allows MONEI to monitor and verify each transaction with precision, ensuring that payments are processed efficiently and without errors, thus providing greater peace of mind for both merchants and consumers.This functionality is exclusively available worldwide through the MONEI Bizum API, with no other tech companies having access to it.

<!-- -->

note

You can [send a payment request](https://docs.monei.com/apis/rest/payments-send-request/.md) directly to the customer’s phone. If the Bizum payment method is available and the phone number is registered with Bizum, the customer will receive a push notification to confirm the payment directly in their banking app. If not, they’ll receive a payment link via WhatsApp. This feature works independently of the UI Component.

Example of a Bizum push notification:

![Bizum Push Notification](/img/bizum-push-notification.png)

### Subscriptions with Bizum[​](#subscriptions-with-bizum "Direct link to Subscriptions with Bizum")

You can use Bizum to offer subscriptions or recurring payments in a similar way to card-based subscriptions. When creating a subscription or recurring payment through the MONEI API, simply set Bizum as the payment method instead of a card. The overall process is almost identical, with a few specific considerations:

* Currently, issuing banks are deploying the solution with the goal of reaching over 90% of coverage in terms of users by November 2025. If the customer's bank does not support Bizum subscriptions, the subscription will not work. Please make sure to confirm this directly with your customer, as MONEI does not have access to issuing bank information.

* The customer will only be asked to authorize the first payment. All subsequent payments will be processed automatically if you use the MONEI subscriptions engine, or you can manage them manually using MONEI’s recurring payments API.

* Keep in mind that only one recurring payment per month can be made through Bizum, and the subscription amount cannot be changed after the first payment. The initial amount remains fixed for all future billing cycles.

## Before you begin[​](#before-you-begin "Direct link to Before you begin")

This page explains how to add Bizum to your payment page. To accept Bizum payments please contact our [Support Team](https://support.monei.com/hc/requests/new) to configure Bizum.

Before you start, you need to make sure that you have Bizum enabled in [MONEI Dashboard → Settings → Payment Methods](https://dashboard.monei.com/settings/payment-methods).

To test your integration:

* Use your [test mode](https://docs.monei.com/testing/.md) Account ID and API Key.
* Use the test [phone numbers](https://docs.monei.com/testing/.md#test-bizum-phone-numbers).
* You can check the status of a test payment in your [MONEI Dashboard → Payments](https://dashboard.monei.com/payments) (in test mode).

## Integration[​](#integration "Direct link to Integration")

### 1. Create a Payment `Server-side`[​](#1-create-a-payment-server-side "Direct link to 1-create-a-payment-server-side")

Create a [Payment](https://docs.monei.com/apis/rest/schemas/payment/.md) on your server with an amount and currency. Always decide how much to charge on the server side, a trusted environment, as opposed to the client. This prevents malicious customers from being able to choose their own prices.

<!-- -->

* cURL
* Node.js
* PHP

POST https\://api.monei.com/v1/payments

```
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",
  "description": "Test Shop - #14379133960355",
  "customer": {
    "email": "email@example.com"
   },
  "callbackUrl": "https://example.com/checkout/callback"
}'
```

server.js

```
const {Monei} = require('@monei-js/node-sdk');
const monei = new Monei('pk_test_36cf3e8a15eff3f5be983562ea6b13ec');
monei.payments.create({
  amount: 110,
  currency: 'EUR',
  orderId: '14379133960355',
  description: 'Test Shop - #14379133960355',
  customer: {
    email: 'email@example.com'
  },
  callbackUrl: 'https://example.com/checkout/callback'
});
```

server.php

```
$monei = new Monei\MoneiClient('pk_test_36cf3e8a15eff3f5be983562ea6b13ec');
$monei->payments->create([
  'amount' => 110,
  'currency' => 'EUR',
  'orderId' => '14379133960355',
  'description' => 'Test Shop - #14379133960355',
  'customer' => [
    'email' => 'email@example.com'
  ],
  'callbackUrl' => 'https://example.com/checkout/callback'
]);
```

The following parameters are required:

* **amount** `positive integer` - 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)
* **currency** `string` - Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase. Must be a supported currency.
* **orderId** `string` - An order ID from your system. A unique identifier that can be used to reconcile the payment with your internal system.
* **callbackUrl** `string` - The URL to which a payment result should be sent asynchronously.

Check all available [request parameters](https://docs.monei.com/apis/rest/payments-create/.md).

Included in the returned Payment object is a payment `id`, which is used on the client side to securely complete the payment process instead of passing the entire Payment object.

### 2. Add Bizum to your payment page `Client-side`[​](#2-add-bizum-to-your-payment-page-client-side "Direct link to 2-add-bizum-to-your-payment-page-client-side")

Include `monei.js` on your checkout page by adding the script tag to the `head` of your HTML file.

checkout.html

```
<head>
  <title>Checkout</title>
  <script src="https://js.monei.com/v2/monei.js"></script>
</head>
```

Add MONEI [Bizun Component](https://docs.monei.com/monei-js/reference/.md#bizum-component) to your payment page. Create empty DOM node (container) with unique ID in your payment form.

checkout.html

```
<form
  action="https://secure.monei.com/payments/{{payment_id}}/confirm"
  method="post"
  id="payment-form"
>
  <div id="bizum_container">
    <!-- A MONEI Bizum Component will be inserted here. -->
  </div>
</form>
```

Initialize Bizum Component

client.js

```
// Create an instance of the Bizum component.
const bizum = monei.Bizum({
  paymentId: '{{payment_id}}',
  onSubmit(result) {
    moneiTokenHandler(result.token);
  },
  onError(error) {
    console.log(error);
  }
});

// Render an instance of the Bizum component into the `bizum_container` <div>.
bizum.render('#bizum_container');
```

note

Bizum Component is also available as a React and Vue component. [Check out our examples](https://docs.monei.com/monei-js/overview/.md#card-input-component).

Check the [MONEI JS Reference](https://docs.monei.com/monei-js/reference/.md#bizum-component) for more options.

### 3. Confirm the payment `Client-side`[​](#3-confirm-the-payment-client-side "Direct link to 3-confirm-the-payment-client-side")

To complete the payment you need to confirm it using monei.js [confirmPayment](https://docs.monei.com/monei-js/reference/.md#confirmpayment-function) function

You need to provide a `paymentId` (obtained in [step 1](#1-create-a-payment-server-side)) and `paymentToken` generated with PayPal Component. You can also provide additional parameters like `customer.email`. Check all available [parameters](https://docs.monei.com/apis/rest/payments-confirm/.md).

client.js

```
// Confirm the payment
function moneiTokenHandler(token) {
  return monei
    .confirmPayment({paymentId: '{{payment_id}}', paymentToken: token})
    .then(function (result) {
      // At this moment you can show a customer the payment result
      // But you should always rely on the result passed to the callback endpoint on your server
      // to update the order status
      console.log(result);
    })
    .catch(function (error) {
      console.log(error);
    });
}
```

note

As an alternative process you can submit generated `paymentToken` to your sever and then [confirm payment](https://docs.monei.com/apis/rest/payments-confirm/.md) on the server-side.

### 4. An asynchronous request is sent to your server.[​](#4-an-asynchronous-request-is-sent-to-your-server "Direct link to 4. An asynchronous request is sent to your server.")

MONEI will notify you about the payment status by sending an HTTP POST request to the `callbackUrl`. The request body will contain full [payment object](https://docs.monei.com/apis/rest/schemas/payment/.md) in JSON format.

This ensures that you get the payment status even when customer closed the browser window or lost internet connection.

The request also contains a `MONEI-Signature` header. [Verify this signature](https://docs.monei.com/guides/verify-signature/.md) to confirm that received request is sent from MONEI.

To acknowledge receipt of the request, your endpoint must return a `200` HTTP status code to MONEI. All other response codes, including `3xx` codes, indicate to MONEI that you did not receive the event.

If MONEI does not receive a `200` HTTP status code, the notification attempt is repeated. After multiple failures to send the notification over multiple days, MONEI marks the request as failed and stops trying to send it to your endpoint.

## Before you go live[​](#before-you-go-live "Direct link to Before you go live")

* Make sure that you are using [live (production) mode](https://docs.monei.com/testing/.md) Account ID and API Key.
* Make sure that you have connected your Bizum business account in [MONEI Dashboard](https://dashboard.monei.com/settings/payment-methods).


---

# Cards

You can start accepting Card payments on the Web using [Hosted Payment Page](https://docs.monei.com/integrations/use-prebuilt-payment-page/.md) or [Card Input Component](https://docs.monei.com/monei-js/reference/.md#cardinput-component). No additional configuration is required for the Hosted Payment Page. It already supports all available payment methods and does not require coding.

Our [Card Input Component](https://docs.monei.com/monei-js/reference/.md#cardinput-component) renders a card input to your custom payment page. The Card Input Component lets you securely collect card information all within one component. It includes a dynamically-updating card brand icon as well as inputs for number, expiry and CVC. It is responsive, optimized for mobile devices, completely customizable and localized to 14 languages.

Businesses can issue refunds directly through the [MONEI dashboard](https://dashboard.monei.com) within one year of the transaction date. For refunds on transactions older than a year, please contact our [Support Team](https://support.monei.com/hc/requests/new).

[](https://payments-demo.monei.com)

[Live demo](https://payments-demo.monei.com)

[Source code](https://github.com/MONEI/monei-payments-demo)

## Before you begin[​](#before-you-begin "Direct link to Before you begin")

This page explains how to add Card Input Component to your custom payment page. If you don't need a custom checkout experience we recommend using our [Hosted Payment Page](https://docs.monei.com/integrations/use-prebuilt-payment-page/.md).

To accept card payments you need to have at least one configured Card processor. To configure Card processors go to [MONEI Dashboard → Settings → Payment Methods → Card payments](https://dashboard.monei.com/settings/payment-methods/card).

To test your integration:

* Use your [test mode](https://docs.monei.com/testing/.md) Account ID and API Key.
* Use the test [card numbers](https://docs.monei.com/testing/.md#test-card-numbers).
* You can check the status of a test payment in your [MONEI Dashboard → Payments](https://dashboard.monei.com/payments) (in test mode).

## Integration[​](#integration "Direct link to Integration")

### 1. Create a Payment `Server-side`[​](#1-create-a-payment-server-side "Direct link to 1-create-a-payment-server-side")

Create a [Payment](https://docs.monei.com/apis/rest/schemas/payment/.md) on your server with an amount and currency. Always decide how much to charge on the server side, a trusted environment, as opposed to the client. This prevents malicious customers from being able to choose their own prices.

<!-- -->

* cURL
* Node.js
* PHP

POST https\://api.monei.com/v1/payments

```
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",
  "description": "Test Shop - #14379133960355",
  "customer": {
    "email": "email@example.com"
   },
  "callbackUrl": "https://example.com/checkout/callback"
}'
```

server.js

```
const {Monei} = require('@monei-js/node-sdk');
const monei = new Monei('pk_test_36cf3e8a15eff3f5be983562ea6b13ec');
monei.payments.create({
  amount: 110,
  currency: 'EUR',
  orderId: '14379133960355',
  description: 'Test Shop - #14379133960355',
  customer: {
    email: 'email@example.com'
  },
  callbackUrl: 'https://example.com/checkout/callback'
});
```

server.php

```
$monei = new Monei\MoneiClient('pk_test_36cf3e8a15eff3f5be983562ea6b13ec');
$monei->payments->create([
  'amount' => 110,
  'currency' => 'EUR',
  'orderId' => '14379133960355',
  'description' => 'Test Shop - #14379133960355',
  'customer' => [
    'email' => 'email@example.com'
  ],
  'callbackUrl' => 'https://example.com/checkout/callback'
]);
```

The following parameters are required:

* **amount** `positive integer` - 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)
* **currency** `string` - Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase. Must be a supported currency.
* **orderId** `string` - An order ID from your system. A unique identifier that can be used to reconcile the payment with your internal system.
* **callbackUrl** `string` - The URL to which a payment result should be sent asynchronously.

Check all available [request parameters](https://docs.monei.com/apis/rest/payments-create/.md).

Included in the returned Payment object is a payment `id`, which is used on the client side to securely complete the payment process instead of passing the entire Payment object.

### 2. Collect card details `Client-side`[​](#2-collect-card-details-client-side "Direct link to 2-collect-card-details-client-side")

Include `monei.js` on your checkout page by adding the script tag to the `head` of your HTML file.

checkout.html

```
<head>
  <title>Checkout</title>
  <script src="https://js.monei.com/v2/monei.js"></script>
</head>
```

Add MONEI [Card Input Component](https://docs.monei.com/monei-js/reference/.md#cardinput-component) to your payment page. Create empty DOM nodes (containers) with unique IDs in your payment form.

checkout.html

```
<form id="payment-form">
  <div class="card-field">
    <div id="card-input">
      <!-- A MONEI Card Input Component will be inserted here. -->
    </div>
    <!-- Used to display card errors. -->
    <div id="card-error"></div>
  </div>
  <button type="submit" id="payment-button">Submit payment</button>
</form>
```

Initialize Card Input Component

client.js

```
const container = document.getElementById('card-input');
const errorText = document.getElementById('card-error');

// Create an instance of the Card Input using payment_id.
const cardInput = monei.CardInput({
  paymentId: '{{payment_id}}',
  onChange: function (event) {
    // Handle real-time validation errors.
    if (event.isTouched && event.error) {
      container.classList.add('is-invalid');
      errorText.innerText = event.error;
    } else {
      container.classList.remove('is-invalid');
      errorText.innerText = '';
    }
  }
});

// Render an instance of the Card Input into the `card_input` <div>.
cardInput.render(container);
```

The Card Input Component simplifies the form and minimizes the number of required fields by inserting a single, flexible input field that securely collects all necessary card details.

note

Card Input Component is also available as a React and Vue component. [Check out our examples](https://docs.monei.com/monei-js/overview/.md#card-input-component).

Check the [MONEI JS Reference](https://docs.monei.com/monei-js/reference/.md#cardinput-component) for more options.

### 3. Confirm the payment `Client-side`[​](#3-confirm-the-payment-client-side "Direct link to 3-confirm-the-payment-client-side")

To complete the payment you need to confirm it using monei.js [confirmPayment](https://docs.monei.com/monei-js/reference/.md#confirmpayment-function) function

You need to provide a `paymentId` (obtained in [step 1](#1-create-a-payment-server-side)) and `paymentToken` generated with Card Input Component. You can also provide additional parameters like `customer.email`. Check all available [parameters](https://docs.monei.com/apis/rest/payments-confirm/.md).

client.js

```
// Handle form submission.
const paymentForm = document.getElementById('payment-form');
const paymentButton = document.getElementById('payment-button');
paymentForm.addEventListener('submit', function (event) {
  event.preventDefault();
  paymentButton.disabled = true;
  monei
    .createToken(cardInput)
    .then(function (result) {
      console.log(result);
      if (result.error) {
        // Inform the user if there was an error.
        container.classList.add('is-invalid');
        errorText.innerText = result.error;
      } else {
        // Send the token to MONEI.
        moneiTokenHandler(result.token);
      }
      paymentButton.disabled = false;
    })
    .catch(function (error) {
      paymentButton.disabled = false;
      console.log(error);
    });
});

// Confirm the payment
function moneiTokenHandler(token) {
  return monei
    .confirmPayment({
      paymentId: '{{payment_id}}',
      paymentToken: token,
      paymentMethod: {card: {cardholderName: 'JOHN DOE'}}
    })
    .then(function (result) {
      // At this moment you can show a customer the payment result
      // But you should always rely on the result passed to the callback endpoint on your server
      // to update the order status
      console.log(result);
    })
    .catch(function (error) {
      console.log(error);
    });
}
```

After the form is submitted MONEI will automatically show a popup window with 3d secure confirmation screen (if needed)

note

As an alternative process you can submit generated `paymentToken` to your sever and then [confirm payment](https://docs.monei.com/apis/rest/payments-confirm/.md) on the server-side.

### 4. An asynchronous request is sent to your server.[​](#4-an-asynchronous-request-is-sent-to-your-server "Direct link to 4. An asynchronous request is sent to your server.")

MONEI will notify you about the payment status by sending an HTTP POST request to the `callbackUrl`. The request body will contain full [payment object](https://docs.monei.com/apis/rest/schemas/payment/.md) in JSON format.

This ensures that you get the payment status even when customer closed the browser window or lost internet connection.

The request also contains a `MONEI-Signature` header. [Verify this signature](https://docs.monei.com/guides/verify-signature/.md) to confirm that received request is sent from MONEI.

To acknowledge receipt of the request, your endpoint must return a `200` HTTP status code to MONEI. All other response codes, including `3xx` codes, indicate to MONEI that you did not receive the event.

If MONEI does not receive a `200` HTTP status code, the notification attempt is repeated. After multiple failures to send the notification over multiple days, MONEI marks the request as failed and stops trying to send it to your endpoint.

## Before you go live[​](#before-you-go-live "Direct link to Before you go live")

* Make sure that you are using [live (production) mode](https://docs.monei.com/testing/.md) Account ID and API Key.
* Make sure that you have at least one [enabled card processor](https://dashboard.monei.com/settings/payment-methods/card).


---

# Click to Pay

Improve the checkout experience by letting customers save their payment details for future orders with Click to Pay - a fast, secure payment method supported by Mastercard, Visa, American Express and Discover

![Click to Pay](/assets/images/click-to-pay-preview-d8589d546f88c6a058a27eb85a2a376e.png)

* Improve the checkout experience by letting customers save their payment details for future orders with Click to Pay.
* Customers can choose to remember their device and browser for faster checkout.
* Click to Pay complies with industry standards for online transactions and is supported by global payment brands.

note

Currently Click to Pay is only available through our [Hosted Payment Page](https://docs.monei.com/integrations/use-prebuilt-payment-page/.md) and [Payment Modal](https://docs.monei.com/integrations/use-payment-modal/.md) integrations.

To enable Click to Pay payments please [contact our support](https://support.monei.com/hc/requests/new).


---

# Google Pay

* Web
* Native Android App

## Web Integration[​](#web-integration "Direct link to Web Integration")

You can start accepting Google Pay payments on the Web using [Hosted Payment Page](https://docs.monei.com/integrations/use-prebuilt-payment-page/.md) or [Payment Request Component](https://docs.monei.com/monei-js/payment-request/.md). No additional configuration is required.

Our [Payment Request Component](https://docs.monei.com/monei-js/payment-request/.md) gives you a single integration for Apple Pay and Google Pay. Customers see a Google Pay or an Apple Pay button, depending on what their device and browser combination supports.

If you prefer to integrate directly against the Google Pay API, follow the [direct API integration guide](#direct-api-integration) below.

### Before you begin[​](#before-you-begin "Direct link to Before you begin")

To accept Google Pay payments you need to have at least one configured card processor.

To configure card processors go to [MONEI Dashboard → Settings → Payment Methods → Card payments](https://dashboard.monei.com/settings/payment-methods/card).

Before you start, you need to:

* Make sure that you have Google Pay enabled in [MONEI Dashboard → Settings → Payment Methods](https://dashboard.monei.com/settings/payment-methods).
* Add a card in Chrome.
* Serve your application over HTTPS. This is a requirement both in development and in production. One way to get up and running is to use a service like [ngrok](https://ngrok.com/).

To test your integration:

* Use your [test mode](https://docs.monei.com/testing/.md) Account ID and API Key.
* You can use any real card details, you will not be charged in the test mode (card details are automatically replaced with the test card).
* You can check the status of the test payment in your [MONEI Dashboard → Payments](https://dashboard.monei.com/payments) (in test mode).

Google Pay Terms

By integrating Google Pay™, you adhere to the Google Pay APIs [Acceptable Use Policy](https://payments.developers.google.com/terms/aup) and accept the terms defined in the Google Pay API [Terms of Service](https://payments.developers.google.com/terms/sellertos).

### Direct API Integration[​](#direct-api-integration "Direct link to Direct API Integration")

If you prefer to integrate directly against the Google Pay API, follow [Google's instructions](https://developers.google.com/pay/api/web/guides/setup).

Specify following tokenization specification:

```
const tokenizationSpecification = {
  type: 'PAYMENT_GATEWAY',
  parameters: {
    gateway: 'monei',
    gatewayMerchantId: 'MONEI_ACCOUNT_ID'
  }
};
```

Use MONEI's `merchantId` from the [Get PaymentMethods](https://docs.monei.com/apis/rest/payment-methods-get/.md) API (`metadata.googlePay.merchantId`). No separate registration with Google is required.

```
paymentDataRequest.merchantInfo = {
  merchantName: 'Your Business Name',
  // Get merchantId from Get PaymentMethods API (metadata.googlePay.merchantId)
  // Test: 12345678901234567890, Production: BCR2DN6T37ENLJ3M
  merchantId: 'MONEI_GOOGLE_PAY_MERCHANT_ID'
};
```

Exchange Google Pay token for MONEI Payment Token that can be used to confirm payment:

```
function processPayment(paymentData) {
  // Encode Google Pay token as a base64 string
  const token = window.btoa(paymentData.paymentMethodData.tokenizationData.token);
  return monei.api
    .createToken({
      paymentId: '{{payment_id}}',
      paymentMethod: {
        googlePay: {
          token: token
        }
      }
    })
    .then(function (result) {
      return moneiTokenHandler(result.paymentToken);
    });
}
```

### Confirm the Payment[​](#confirm-the-payment "Direct link to Confirm the Payment")

After you have obtained the MONEI Payment Token, you can confirm the payment using the token.

```
function moneiTokenHandler(token) {
  return monei
    .confirmPayment({paymentId: '{{payment_id}}', paymentToken: token})
    .then(function (result) {
      // At this moment you can show a customer the payment result
      // But you should always rely on the result passed to the callback endpoint on your server
      // to update the order status
      console.log(result);
    })
    .catch(function (error) {
      console.log(error);
    });
}
```

## Native Android App Integration[​](#native-android-app-integration "Direct link to Native Android App Integration")

Google Pay works out of the box on Android with no additional certificate setup required. Simply integrate the Google Pay API and use MONEI as your payment gateway.

### Prerequisites[​](#prerequisites "Direct link to Prerequisites")

* Google Pay enabled in [MONEI Dashboard → Settings → Payment Methods](https://dashboard.monei.com/settings/payment-methods)
* At least one configured card processor in [MONEI Dashboard](https://dashboard.monei.com/settings/payment-methods/card)
* Android device or emulator with Google Play Services

### Add Dependencies[​](#add-dependencies "Direct link to Add Dependencies")

Add the Google Pay library to your app's `build.gradle`:

```
dependencies {
    implementation 'com.google.android.gms:play-services-wallet:19.2.1'
}
```

Add the Google Pay API meta-data to your `AndroidManifest.xml`:

```
<meta-data
    android:name="com.google.android.gms.wallet.api.enabled"
    android:value="true" />
```

### Check Google Pay Availability[​](#check-google-pay-availability "Direct link to Check Google Pay Availability")

Before showing the Google Pay button, verify it's available on the device:

```
val paymentsClient = Wallet.getPaymentsClient(
    this,
    Wallet.WalletOptions.Builder()
        .setEnvironment(WalletConstants.ENVIRONMENT_TEST) // Use ENVIRONMENT_PRODUCTION for live
        .build()
)

val isReadyToPayRequest = IsReadyToPayRequest.fromJson("""
    {
        "apiVersion": 2,
        "apiVersionMinor": 0,
        "allowedPaymentMethods": [{
            "type": "CARD",
            "parameters": {
                "allowedAuthMethods": ["PAN_ONLY", "CRYPTOGRAM_3DS"],
                "allowedCardNetworks": ["VISA", "MASTERCARD", "AMEX", "DISCOVER", "JCB"]
            }
        }]
    }
""")

paymentsClient.isReadyToPay(isReadyToPayRequest)
    .addOnCompleteListener { task ->
        if (task.isSuccessful) {
            // Show Google Pay button
        }
    }
```

### Configure Payment Request[​](#configure-payment-request "Direct link to Configure Payment Request")

Create a payment request with MONEI as the gateway. Use the `merchantId` from the [Get PaymentMethods](https://docs.monei.com/apis/rest/payment-methods-get/.md) API (`metadata.googlePay.merchantId`). No separate registration with Google is required:

```
val paymentDataRequest = PaymentDataRequest.fromJson("""
    {
        "apiVersion": 2,
        "apiVersionMinor": 0,
        "allowedPaymentMethods": [{
            "type": "CARD",
            "parameters": {
                "allowedAuthMethods": ["PAN_ONLY", "CRYPTOGRAM_3DS"],
                "allowedCardNetworks": ["VISA", "MASTERCARD", "AMEX", "DISCOVER", "JCB"]
            },
            "tokenizationSpecification": {
                "type": "PAYMENT_GATEWAY",
                "parameters": {
                    "gateway": "monei",
                    "gatewayMerchantId": "YOUR_MONEI_ACCOUNT_ID"
                }
            }
        }],
        "merchantInfo": {
            "merchantName": "Your Store Name",
            "merchantId": "MONEI_GOOGLE_PAY_MERCHANT_ID"
        },
        "transactionInfo": {
            "totalPrice": "10.00",
            "totalPriceStatus": "FINAL",
            "currencyCode": "EUR",
            "countryCode": "ES"
        }
    }
""")
```

### Launch Google Pay[​](#launch-google-pay "Direct link to Launch Google Pay")

Launch the Google Pay payment sheet when the user taps the button:

```
private val googlePayLauncher = registerForActivityResult(
    ActivityResultContracts.StartActivityForResult()
) { result ->
    when (result.resultCode) {
        Activity.RESULT_OK -> {
            result.data?.let { intent ->
                val paymentData = PaymentData.getFromIntent(intent)
                handlePaymentSuccess(paymentData)
            }
        }
        Activity.RESULT_CANCELED -> {
            // User cancelled
        }
        AutoResolveHelper.RESULT_ERROR -> {
            // Handle error
        }
    }
}

fun requestPayment() {
    val task = paymentsClient.loadPaymentData(paymentDataRequest)
    AutoResolveHelper.resolveTask(task, this, GOOGLE_PAY_REQUEST_CODE)
}
```

### Process the Payment[​](#process-the-payment "Direct link to Process the Payment")

Extract the token from the payment data and send it to your backend:

```
private fun handlePaymentSuccess(paymentData: PaymentData?) {
    val paymentInfo = paymentData?.toJson() ?: return
    val json = JSONObject(paymentInfo)

    // Extract the Google Pay token
    val token = json
        .getJSONObject("paymentMethodData")
        .getJSONObject("tokenizationData")
        .getString("token")

    // Base64 encode the token
    val encodedToken = Base64.encodeToString(token.toByteArray(), Base64.NO_WRAP)

    // Send to your backend to create MONEI payment token and confirm payment
    sendToBackend(encodedToken)
}
```

### Backend Integration[​](#backend-integration "Direct link to Backend Integration")

On your backend, exchange the Google Pay token for a MONEI payment token:

```
# 1. Create a payment
curl -X POST https://api.monei.com/v1/payments \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 1000,
    "currency": "EUR",
    "orderId": "order_123"
  }'

# 2. Create a token from Google Pay token
curl -X POST https://api.monei.com/v1/payment-tokens \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "paymentId": "PAYMENT_ID_FROM_STEP_1",
    "paymentMethod": {
      "googlePay": {
        "token": "BASE64_ENCODED_GOOGLE_PAY_TOKEN"
      }
    }
  }'

# 3. Confirm the payment
curl -X POST https://api.monei.com/v1/payments/PAYMENT_ID/confirm \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "paymentToken": "MONEI_TOKEN_FROM_STEP_2"
  }'
```

## Before you go live[​](#before-you-go-live "Direct link to Before you go live")

* Make sure that you are using [live (production) mode](https://docs.monei.com/testing/.md) Account ID and API Key.
* Make sure that you have at least one [enabled card processor](https://dashboard.monei.com/settings/payment-methods/card).
* Make sure that you have Google Pay enabled in [MONEI Dashboard → Settings → Payment Methods](https://dashboard.monei.com/settings/payment-methods).
* For direct API integration, use the `merchantId` from the [Get PaymentMethods](https://docs.monei.com/apis/rest/payment-methods-get/.md) API.


---

# Payment Methods Overview

MONEI supports a wide range of payment methods to help you maximize your conversion rates and reach customers globally. Below is an overview of all available payment methods:

## Card Payments[​](#card-payments "Direct link to Card Payments")

* [Cards](https://docs.monei.com/payment-methods/card/.md) - Accept all major credit and debit cards
* [Click to Pay](https://docs.monei.com/payment-methods/click-to-pay/.md) - Streamlined card payments with Click to Pay

## Digital Wallets[​](#digital-wallets "Direct link to Digital Wallets")

* [Apple Pay](https://docs.monei.com/payment-methods/apple-pay/.md) - Accept payments through Apple Pay
* [Google Pay](https://docs.monei.com/payment-methods/google-pay/.md) - Enable Google Pay payments
* [PayPal](https://docs.monei.com/payment-methods/paypal/.md) - Integrate PayPal payments

## Local Payment Methods[​](#local-payment-methods "Direct link to Local Payment Methods")

* [Bizum](https://docs.monei.com/payment-methods/bizum/.md) - Popular Spanish mobile payment method
* [SEPA Request to Pay](https://docs.monei.com/payment-methods/sepa-request-to-pay/.md) - European bank transfer payments

## Integration Options[​](#integration-options "Direct link to Integration Options")

You can integrate these payment methods in several ways:

1. [Build a Custom Checkout](https://docs.monei.com/integrations/build-custom-checkout/.md) - Full control over the checkout experience
2. [Use Payment Modal](https://docs.monei.com/integrations/use-payment-modal/.md) - Quick integration with a pre-built modal
3. [Use Prebuilt Payment Page](https://docs.monei.com/integrations/use-prebuilt-payment-page/.md) - Fastest way to start accepting payments
4. [Pay by Link](https://docs.monei.com/integrations/pay-by-link/.md) - Share payment links with customers
5. [QR Payments](https://docs.monei.com/integrations/use-qr-payments/.md) - Enable QR code-based payments

Each payment method has its own dedicated documentation page with detailed integration instructions, testing information, and best practices.


---

# PayPal

You can start accepting PayPal payments on the Web using [Hosted Payment Page](https://docs.monei.com/integrations/use-prebuilt-payment-page/.md) or [PayPal Component](https://docs.monei.com/monei-js/reference/.md#paypal-component). No additional configuration is required to use PayPal in Hosted Payment Page.

Our [PayPal Component](https://docs.monei.com/monei-js/reference/.md#paypal-component) renders PayPal button to your payment page. When a customer selects PayPal, the component presents a PayPal overlay, where a customer can log in with their PayPal account details to complete the payment process.

## Before you begin[​](#before-you-begin "Direct link to Before you begin")

This page explains how to add PayPal to your custom payment page. If you don't need a custom checkout experience we recommend using our [prebuilt payment page](https://docs.monei.com/integrations/use-prebuilt-payment-page/.md). It already supports all available payment methods and does not require coding.

To accept PayPal payments you need to connect your [PayPal business account](https://www.paypal.com/business). To connect your PayPal business account go to [MONEI Dashboard → Settings → Payment Methods](https://dashboard.monei.com/settings/payment-methods).

To test your integration:

* Use your [test mode](https://docs.monei.com/testing/.md) Account ID and API Key.
* Connect test [PayPal Business account](https://docs.monei.com/testing/.md#test-paypal-accounts) in your [MONEI Dashboard](https://dashboard.monei.com/settings/payment-methods) (in test mode)
* Use the test [PayPal Personal account](https://docs.monei.com/testing/.md#test-paypal-accounts) for payments.
* You can check the status of a test payment in your [MONEI Dashboard → Payments](https://dashboard.monei.com/payments) (in test mode).

## Integration[​](#integration "Direct link to Integration")

### 1. Create a Payment `Server-side`[​](#1-create-a-payment-server-side "Direct link to 1-create-a-payment-server-side")

Create a [Payment](https://docs.monei.com/apis/rest/schemas/payment/.md) on your server with an amount and currency. Always decide how much to charge on the server side, a trusted environment, as opposed to the client. This prevents malicious customers from being able to choose their own prices.

<!-- -->

* cURL
* Node.js
* PHP

POST https\://api.monei.com/v1/payments

```
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",
  "description": "Test Shop - #14379133960355",
  "customer": {
    "email": "email@example.com"
   },
  "callbackUrl": "https://example.com/checkout/callback"
}'
```

server.js

```
const {Monei} = require('@monei-js/node-sdk');
const monei = new Monei('pk_test_36cf3e8a15eff3f5be983562ea6b13ec');
monei.payments.create({
  amount: 110,
  currency: 'EUR',
  orderId: '14379133960355',
  description: 'Test Shop - #14379133960355',
  customer: {
    email: 'email@example.com'
  },
  callbackUrl: 'https://example.com/checkout/callback'
});
```

server.php

```
$monei = new Monei\MoneiClient('pk_test_36cf3e8a15eff3f5be983562ea6b13ec');
$monei->payments->create([
  'amount' => 110,
  'currency' => 'EUR',
  'orderId' => '14379133960355',
  'description' => 'Test Shop - #14379133960355',
  'customer' => [
    'email' => 'email@example.com'
  ],
  'callbackUrl' => 'https://example.com/checkout/callback'
]);
```

The following parameters are required:

* **amount** `positive integer` - 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)
* **currency** `string` - Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase. Must be a supported currency.
* **orderId** `string` - An order ID from your system. A unique identifier that can be used to reconcile the payment with your internal system.
* **callbackUrl** `string` - The URL to which a payment result should be sent asynchronously.

Check all available [request parameters](https://docs.monei.com/apis/rest/payments-create/.md).

Included in the returned Payment object is a payment `id`, which is used on the client side to securely complete the payment process instead of passing the entire Payment object.

### 2. Add PayPal to your payment page `Client-side`[​](#2-add-paypal-to-your-payment-page-client-side "Direct link to 2-add-paypal-to-your-payment-page-client-side")

Include `monei.js` on your checkout page by adding the script tag to the `head` of your HTML file.

checkout.html

```
<head>
  <title>Checkout</title>
  <script src="https://js.monei.com/v2/monei.js"></script>
</head>
```

Add MONEI [PayPal Component](https://docs.monei.com/monei-js/reference/.md#paypal-component) to your payment page. Create empty DOM node (container) with unique ID in your payment form.

checkout.html

```
<div id="paypal_container">
  <!-- A MONEI PayPal Component will be inserted here. -->
</div>
```

Initialize PayPal Component

client.js

```
// Create an instance of the PayPal component.
const payPal = monei.PayPal({
  paymentId: '{{payment_id}}',
  onSubmit(result) {
    moneiTokenHandler(result.token);
  },
  onError(error) {
    console.log(error);
  }
});

// Render an instance of the PayPal component into the `paypal_container` <div>.
payPal.render('#paypal_container');
```

note

PayPal Component is also available as a React and Vue component. [Check out our examples](https://docs.monei.com/monei-js/overview/.md#card-input-component).

Check the [MONEI JS Reference](https://docs.monei.com/monei-js/reference/.md#paypal-component) for more options.

### 3. Confirm the payment `Client-side`[​](#3-confirm-the-payment-client-side "Direct link to 3-confirm-the-payment-client-side")

To complete the payment you need to confirm it using monei.js [confirmPayment](https://docs.monei.com/monei-js/reference/.md#confirmpayment-function) function

You need to provide a `paymentId` (obtained in [step 1](#1-create-a-payment-server-side)) and `paymentToken` generated with PayPal Component. You can also provide additional parameters like `customer.email`. Check all available [parameters](https://docs.monei.com/apis/rest/payments-confirm/.md).

client.js

```
// Confirm the payment
function moneiTokenHandler(token) {
  return monei
    .confirmPayment({paymentId: '{{payment_id}}', paymentToken: token})
    .then(function (result) {
      // At this moment you can show a customer the payment result
      // But you should always rely on the result passed to the callback endpoint on your server
      // to update the order status
      console.log(result);
    })
    .catch(function (error) {
      console.log(error);
    });
}
```

note

As an alternative process you can submit generated `paymentToken` to your sever and then [confirm payment](https://docs.monei.com/apis/rest/payments-confirm/.md) on the server-side.

### 4. An asynchronous request is sent to your server.[​](#4-an-asynchronous-request-is-sent-to-your-server "Direct link to 4. An asynchronous request is sent to your server.")

MONEI will notify you about the payment status by sending an HTTP POST request to the `callbackUrl`. The request body will contain full [payment object](https://docs.monei.com/apis/rest/schemas/payment/.md) in JSON format.

This ensures that you get the payment status even when customer closed the browser window or lost internet connection.

The request also contains a `MONEI-Signature` header. [Verify this signature](https://docs.monei.com/guides/verify-signature/.md) to confirm that received request is sent from MONEI.

To acknowledge receipt of the request, your endpoint must return a `200` HTTP status code to MONEI. All other response codes, including `3xx` codes, indicate to MONEI that you did not receive the event.

If MONEI does not receive a `200` HTTP status code, the notification attempt is repeated. After multiple failures to send the notification over multiple days, MONEI marks the request as failed and stops trying to send it to your endpoint.

## Before you go live[​](#before-you-go-live "Direct link to Before you go live")

* Make sure that you are using [live (production) mode](https://docs.monei.com/testing/.md) Account ID and API Key.
* Make sure that you have connected your PayPal business account in [MONEI Dashboard](https://dashboard.monei.com/settings/payment-methods).


---

# SEPA Request to Pay (SRTP)

SEPA Request to Pay (SRTP) is an innovative payment scheme proposed by the European Payments Council (EPC) that uses a real-time messaging framework to simplify financial transactions. It allows a beneficiary (merchant or business) to send a payment request to a payer, who can then approve and execute the payment through SEPA channels. This method streamlines the process by reducing the need to exchange bank details and improving the security and traceability of payments. SRTP is well-suited for digital channels (e-commerce, mobile apps) as well as in-store transactions.

MONEI has incorporated the SRTP scheme into its infrastructure to offer merchants a more efficient and secure way to request and receive payments. By using SRTP, the end-user experience is enhanced (customers can pay with a simple approval) and opportunities for automation in payment processes are increased. This initiative underscores MONEI’s commitment to innovation and positions it at the forefront of digital payment solutions, acting as a key facilitator of secure and convenient transactions in the European market.

## Features and Benefits[​](#features-and-benefits "Direct link to Features and Benefits")

* **One-click payment approval:** Customers do not need to manually enter IBAN or other bank details. They receive a payment request from the merchant and can accept it with a single click, keeping their personal and financial data protected.
* **24/7 payment request initiation:** Merchants can create and send payment requests at any time, without being limited by banking hours. SRTP messages can be generated and sent around the clock.
* **Flexible payment timing for customers:** Customers have the option to approve the request immediately or at a later time before expiration, giving them control and flexibility in managing their payments.
* **Real-time transaction status tracking:** From MONEI’s dashboard, merchants can see a history of all SRTP transactions and their statuses (e.g. pending, accepted/processed, or rejected) in real time.
* **Seamless checkout integration:** Customers can choose SRTP as a payment method on the merchant’s checkout page (ideal for e-commerce), which provides a seamless and quick payment experience.
* **Improved cash flow management:** Individuals and businesses can better manage cash flow by deciding when to approve incoming payment requests, aligning with their financial planning.
* **No chargebacks:** SRTP leverages SEPA Instant Credit Transfer behind the scenes, so once a payment is approved and executed, it is irrevocable (no chargebacks), reducing fraud and chargeback-related issues for merchants.

## Messaging Flow[​](#messaging-flow "Direct link to Messaging Flow")

The diagram below shows the SRTP message flow in a four-corner model (payer and payee each with their own SRTP service provider), followed by a step-by-step explanation:

![SEPA Request to Pay](/assets/images/SEPA-Request-to-Pay-SRTP-03c1380728137e19fde5dd05f28c44cd.jpg)

1. **Payment method selection:** The payer selects **SEPA Request to Pay (SRTP)** as the payment method on the merchant’s payment page (checkout).
2. **Request initiation:** The payee (merchant) notifies MONEI (the payee’s SRTP service provider) of a new payment request, providing all necessary payment details. MONEI then creates an SRTP message for this request.
3. **Delivery to payer’s provider:** MONEI, acting on behalf of the payee, sends the SRTP message to the payer’s SRTP service provider (typically the payer’s bank or payment service).
4. **Payer notification:** The payer’s service provider notifies the payer (e.g. via mobile app or online banking) that a payment request is awaiting their approval. The payer can review the request details and choose to **accept** or **reject** the request.
5. **Status reporting:** Once the payer accepts or rejects the request, the outcome (approval or rejection status) is reported back to all parties. MONEI and the merchant receive a status update confirming whether the SRTP was accepted (and the payment initiated) or declined by the payer. This status update can occur in real-time or via a callback mechanism.

## API Endpoints[​](#api-endpoints "Direct link to API Endpoints")

MONEI provides a set of REST API endpoints to integrate the SRTP scheme, allowing creation and management of Request to Pay messages. Below are the main endpoints in the SRTP flow, with their details:

### Create a new SRTP[​](#create-a-new-srtp "Direct link to Create a new SRTP")

**Description:** This endpoint allows the payee’s SRTP service provider (e.g., MONEI on behalf of the merchant) to post a new SEPA Request-to-Pay to the payer’s SRTP service provider. In practice, it creates a payment request that will be delivered to the payer for approval.

**Endpoint:** `https://api.monei.com/v1/sepa-request-to-pay-requests`

**Instructions:**

* All parameters in the request must comply with the SRTP rulebook and the official *SRTP Implementation Guidelines*.
* The fields **ReqdExctnDt** (requested execution date/time) and **XpryDt** (expiration date/time) must be provided and must be in the future (not past dates), otherwise the request will be rejected.
* For each new SRTP creation call, use a unique **resourceId**. This ID acts as an idempotency key for the request; sending a duplicate **resourceId** will be treated as the same request.

**Example JSON Request:**

```
{
  "callbackUrl": "https://testing-srtp.com/005/callback",
  "Document": {
    "CdtrPmtActvtnReq": {
      "GrpHdr": {
        "MsgId": "Id20***3731",
        "CreDtTm": "2024-04-30T15:59:30.000Z",
        "NbOfTxs": "1",
        "InitgPty": {
          "Nm": "SRTPTestEPCXX                 ",
          "Id": {
            "OrgId": {
              "AnyBIC": "AAAAZZ12"
            }
          }
        }
      },
      "PmtInf": [
        {
          "PmtInfId": "Id20***3317",
          "PmtMtd": "TRF",
          "ReqdAdvcTp": {
            "CdtAdvc": {
              "Cd": "ADND"
            },
            "DbtAdvc": {
              "Cd": "ADND"
            }
          },
          "ReqdExctnDt": {
            "DtTm": "2024-06-26T15:59:14.000Z"
          },
          "XpryDt": {
            "DtTm": "2024-06-29T18:00:00.000Z"
          },
          "Dbtr": {
            "Nm": "Max140Text_EPC259-22_V3.0_DS02",
            "PstlAdr": {
              "Ctry": "FR",
              "AdrLine": ["01 Rue de Paris"]
            },
            "Id": {
              "OrgId": {
                "AnyBIC": "AAAAZZ12"
              }
            }
          },
          "DbtrAcct": {
            "Id": {
              "IBAN": "ES9131906664658225183334"
            },
            "Nm": "Nm"
          },
          "DbtrAgt": {
            "FinInstnId": {
              "BICFI": "MMMMES69"
            }
          },
          "CdtTrfTx": [
            {
              "PmtId": {
                "InstrId": "InstrId                 ",
                "EndToEndId": "Id20***5809"
              },
              "PmtTpInf": {
                "SvcLvl": {
                  "Cd": "SRTP"
                },
                "LclInstrm": {
                  "Cd": "CTP"
                },
                "CtgyPurp": {
                  "Cd": " "
                }
              },
              "PmtCond": {
                "AmtModAllwd": false,
                "EarlyPmtAllwd": true,
                "GrntedPmtReqd": false
              },
              "Amt": {
                "InstdAmt": 2001
              },
              "ChrgBr": "SLEV",
              "CdtrAgt": {
                "FinInstnId": {
                  "BICFI": "AAAAZZ11234"
                }
              },
              "Cdtr": {
                "Nm": "Max140Text_EPC259-22_V3.0_DS02",
                "PstlAdr": {
                  "Ctry": "FR",
                  "AdrLine": ["01 Rue de Paris"]
                },
                "Id": {
                  "OrgId": {
                    "AnyBIC": "AAAAZZ12"
                  }
                }
              },
              "CdtrAcct": {
                "Id": {
                  "IBAN": "ES9131906664658225183334"
                }
              },
              "InstrForCdtrAgt": [
                {
                  "InstrInf": "ATS007 Positive functional confirmation requested"
                }
              ],
              "Purp": {
                "Cd": "ADCS"
              },
              "RltdRmtInf": {
                "RmtId": "RmtId",
                "RmtLctnDtls": [
                  {
                    "Mtd": "URID",
                    "ElctrncAdr": "test@monei.com"
                  }
                ]
              },
              "RmtInf": {
                "Ustrd": ["Ustrd"]
              }
            }
          ]
        }
      ]
    }
  },
  "resourceId": "8410-8600-1312-3709"
}
```

**Example JSON Response:**

```
{
  "resourceId": "8410-8600-1312-3709",
  "Document": {
    "CdtrPmtActvtnReqStsRpt": {
      "GrpHdr": {
        "MsgId": "2f5424439ad4a3590203e9afbdc185762fe",
        "CreDtTm": "2024-06-25T09:36:45.764Z",
        "InitgPty": {
          "Id": {
            "OrgId": {
              "AnyBIC": "MMMMES69"
            }
          }
        }
      },
      "OrgnlGrpInfAndSts": {
        "OrgnlMsgId": "Id20***3731",
        "OrgnlMsgNmId": "pain.013.001.10",
        "OrgnlCreDtTm": "2024-04-30T15:59:30.000Z"
      },
      "OrgnlPmtInfAndSts": [
        {
          "OrgnlPmtInfId": "Id20***3317",
          "TxInfAndSts": {
            "StsId": "a6128f3fc0692ae3b3834c397555893baf1",
            "OrgnlInstrId": "InstrId                 ",
            "OrgnlEndToEndId": "Id20***5809",
            "TxSts": "ACTC",
            "StsRsnInf": {
              "Orgtr": {
                "Id": {
                  "OrgId": {
                    "AnyBIC": "MMMMES69"
                  }
                }
              },
              "Rsn": {
                "Cd": "EDTR"
              }
            },
            "OrgnlTxRef": {
              "Amt": {
                "InstdAmt": 2001
              },
              "ReqdExctnDt": {
                "DtTm": "2024-06-26T15:59:14.000Z"
              },
              "XpryDt": {
                "DtTm": "2024-06-29T18:00:00.000Z"
              },
              "PmtTpInf": {
                "SvcLvl": {
                  "Cd": "SRTP"
                },
                "LclInstrm": {
                  "Cd": "CTP"
                }
              },
              "DbtrAgt": {
                "FinInstnId": {
                  "BICFI": "MMMMES69"
                }
              },
              "CdtrAgt": {
                "FinInstnId": {
                  "BICFI": "AAAAZZ11234"
                }
              },
              "Cdtr": {
                "Nm": "Max140Text_EPC259-22_V3.0_DS02",
                "Id": {
                  "OrgId": {
                    "AnyBIC": "AAAAZZ12"
                  }
                }
              },
              "CdtrAcct": {
                "Id": {
                  "IBAN": "ES9131906664658225183334"
                }
              },
              "RmtInf": {
                "Ustrd": "Ustrd"
              }
            }
          }
        }
      ]
    }
  }
}
```

### Status-update[​](#status-update "Direct link to Status-update")

**Description:** This endpoint is used by the payee’s SRTP service provider to query the status of a previously created Request to Pay. It asks the payer’s SRTP service provider for an update on whether the payer has accepted, rejected, or not yet acted on the payment request.

**Endpoint:** `https://api.monei.com/v1/sepa-request-to-pay-requests/{{resourceId}}/status-update`

**Instructions:**

* All parameters must follow the SRTP rulebook and Implementation Guidelines.
* The `{resourceId}` path parameter in the endpoint URL should be the same **resourceId** that was returned when the SRTP was created. (In other words, you are requesting the status of that specific payment request.) For example, if the original resourceId is `8410-8600-1312-3709`, the status endpoint would be:
  <br />
  `.../sepa-request-to-pay-requests/8410-8600-1312-3709/status-update`
* If the status information is available, the API server will respond immediately with the current status. Otherwise (e.g. if the payer has not responded yet), the server will return a pending acknowledgment and later send the status update asynchronously to the provided callback URL.
* This call does not create any new resource, so using the same resourceId for multiple status queries will simply retrieve the same status (it’s idempotent in that sense).

**Example JSON Request:**

```
{
  "resourceId": "5427-9966-1810-4084",
  "callbackUrl": "https://testing-srtp.com/005/callback",
  "Document": {
    "FIToFIPmtStsReq": {
      "GrpHdr": {
        "MsgId": "Id20***6359",
        "CreDtTm": "2024-04-19T15:40:14.000Z",
        "InstgAgt": {
          "FinInstnId": {
            "BICFI": "AAAAZZ11",
            "LEI": "00000032411889200037",
            "Nm": "SRTPTestEPCXX                 ",
            "Othr": {
              "Id": "Id20***6848",
              "SchmeNm": {
                "Cd": "aaaa",
                "Prtry": "Max35Text"
              },
              "Issr": " Issr"
            }
          }
        }
      },
      "TxInf": [
        {
          "StsReqId": "StsReqId                ",
          "OrgnlGrpInf": {
            "OrgnlMsgId": "Id20***8079",
            "OrgnlMsgNmId": "pain.013.001.10",
            "OrgnlCreDtTm": "2024-04-13T15:02:05.000Z"
          },
          "OrgnlInstrId": "InstrId                 ",
          "OrgnlEndToEndId": "Id2024041915393549256381",
          "OrgnlTxId": "OrgnlTxId",
          "OrgnlTxRef": {
            "Amt": {
              "InstdAmt": 2013
            },
            "ReqdExctnDt": {
              "DtTm": "2024-05-02T15:02:04.000Z"
            },
            "PmtTpInf": {
              "SvcLvl": {
                "Cd": "SRTP"
              },
              "LclInstrm": {
                "Cd": "CTP"
              }
            },
            "RmtInf": {
              "Ustrd": ["Ustrd"]
            },
            "DbtrAgt": {
              "FinInstnId": {
                "BICFI": "MMMMES69"
              }
            },
            "CdtrAgt": {
              "FinInstnId": {
                "BICFI": "AAAAZZ11234"
              }
            },
            "Cdtr": {
              "Pty": {
                "Nm": "Max140Text_EPC259-22_V3.0_DS02",
                "Id": {
                  "OrgId": {
                    "AnyBIC": "AAAAZZ12"
                  }
                }
              }
            },
            "CdtrAcct": {
              "Id": {
                "IBAN": "FR7630003035710005023922834"
              }
            }
          }
        }
      ]
    }
  }
}
```

**Example JSON Response:**

```
{
  "resourceId": "5427-9966-1810-4084",
  "Document": {
    "CdtrPmtActvtnReqStsRpt": {
      "GrpHdr": {
        "MsgId": "a5f786c715aba67ab04e34ad62286c72fa1",
        "CreDtTm": "2024-06-25T09:39:17.015Z",
        "InitgPty": {
          "Id": {
            "OrgId": {
              "AnyBIC": "MMMMES69"
            }
          }
        }
      },
      "OrgnlGrpInfAndSts": {
        "OrgnlMsgId": "Id20***6359",
        "OrgnlMsgNmId": "pacs.028.001.03",
        "OrgnlCreDtTm": "2024-04-30T15:59:30.000Z"
      },
      "OrgnlPmtInfAndSts": [
        {
          "OrgnlPmtInfId": "Id20***3317",
          "TxInfAndSts": [
            {
              "StsId": "5f79f32400bf21b7053a91def757f7fc418",
              "OrgnlInstrId": "InstrId                 ",
              "OrgnlEndToEndId": "Id2024041915393549256381",
              "StsRsnInf": {
                "Orgtr": {
                  "Id": {
                    "OrgId": {
                      "AnyBIC": "MMMMES69"
                    }
                  }
                },
                "Rsn": {
                  "Cd": "AEXR"
                }
              },
              "OrgnlTxRef": {
                "Amt": {
                  "InstdAmt": 2013
                },
                "ReqdExctnDt": {
                  "DtTm": "2024-05-02T15:02:04.000Z"
                },
                "XpryDt": {
                  "DtTm": "2024-06-29T18:00:00.000Z"
                },
                "PmtTpInf": {
                  "SvcLvl": {
                    "Cd": "SRTP"
                  },
                  "LclInstrm": {
                    "Cd": "CTP"
                  }
                },
                "DbtrAgt": {
                  "FinInstnId": {
                    "BICFI": "MMMMES69"
                  }
                },
                "CdtrAgt": {
                  "FinInstnId": {
                    "BICFI": "AAAAZZ11234"
                  }
                },
                "Cdtr": {
                  "Nm": "Max140Text_EPC259-22_V3.0_DS02",
                  "Id": {
                    "OrgId": {
                      "AnyBIC": "AAAAZZ12"
                    }
                  }
                },
                "CdtrAcct": {
                  "Id": {
                    "IBAN": "FR7630003035710005023922834"
                  }
                },
                "RmtInf": {
                  "Ustrd": "Ustrd"
                }
              }
            }
          ]
        }
      ]
    }
  }
}
```

### Cancellation-request[​](#cancellation-request "Direct link to Cancellation-request")

**Description:** This endpoint is used by the payee’s SRTP service provider to request cancellation of a previously sent Request to Pay. Essentially, it sends a cancellation message to the payer’s SRTP service provider indicating that the payee (merchant) wishes to cancel the payment request.

**Endpoint:** `https://api.monei.com/v1/sepa-request-to-pay-requests/{{resourceId}}/cancellation-requests`

**Instructions:**

* All parameters must follow the SRTP rulebook and Implementation Guidelines for cancellation messages.
* The `{resourceId}` in the endpoint URL is the original SRTP’s resourceId (the same ID used when creating the Request to Pay). This identifies which payment request is being cancelled. For example:
  <br />
  `.../sepa-request-to-pay-requests/8410-8600-1312-3709/cancellation-requests`
* In the request body, provide a new unique **resourceId**. This will serve as the identifier for the cancellation request itself (often referred to as the **cancellationResourceId**). This ID must be different from the original payment’s resourceId, as it will be used in the cancellation status endpoint.
* When possible, the payer’s API may respond immediately with a cancellation result. If an immediate result is not available, the API will acknowledge the request and later send the cancellation outcome via the callback URL.

**Example JSON Request:**

```
{
  "callbackUrl": "https://testing-srtp.com/005/callback",
  "Document": {
    "CstmrPmtCxlReq": {
      "Assgnmt": {
        "Id": "Id20***7140",
        "Assgnr": {
          "Pty": {
            "Id": {
              "OrgId": {
                "AnyBIC": "AAAAZZ12"
              }
            }
          }
        },
        "Assgne": {
          "Pty": {
            "Id": {
              "OrgId": {
                "AnyBIC": "MMMMES69"
              }
            }
          }
        },
        "CreDtTm": "2024-04-23T15:58:37.000Z"
      },
      "Undrlyg": {
        "OrgnlPmtInfAndCxl": [
          {
            "PmtCxlId": "Id20***5990",
            "OrgnlPmtInfId": "Id20***9456",
            "OrgnlGrpInf": {
              "OrgnlMsgId": "Id20***8505",
              "OrgnlMsgNmId": "pain.013.001.10",
              "OrgnlCreDtTm": "2024-04-24T15:46:07.000Z"
            },
            "TxInf": [
              {
                "CxlId": "Id20***2849",
                "OrgnlInstrId": "InstrId                 ",
                "OrgnlEndToEndId": "Id20***4837",
                "CxlRsnInf": {
                  "Orgtr": {
                    "Nm": "SRTPTestEPCXX                 ",
                    "Id": {
                      "OrgId": {
                        "AnyBIC": "AAAAZZ12"
                      }
                    }
                  },
                  "Rsn": {
                    "Cd": "TECH"
                  },
                  "AddtlInf": ["ATS005/2024-05-08T15:46:06.000Z"]
                },
                "OrgnlTxRef": {
                  "Amt": {
                    "InstdAmt": 2018
                  },
                  "ReqdExctnDt": {
                    "DtTm": "2024-05-13T15:46:06.000Z"
                  },
                  "PmtTpInf": {
                    "SvcLvl": {
                      "Cd": "SRTP"
                    },
                    "LclInstrm": {
                      "Cd": "CTP"
                    }
                  },
                  "RmtInf": {
                    "Ustrd": "Ustrd"
                  },
                  "DbtrAgt": {
                    "FinInstnId": {
                      "BICFI": "MMMMES69"
                    }
                  },
                  "CdtrAgt": {
                    "FinInstnId": {
                      "BICFI": "AAAAZZ11234"
                    }
                  },
                  "Cdtr": {
                    "Pty": {
                      "Nm": "Max140Text_EPC259-22_V3.0_DS02",
                      "Id": {
                        "OrgId": {
                          "AnyBIC": "AAAAZZ12"
                        }
                      }
                    }
                  },
                  "CdtrAcct": {
                    "Id": {
                      "IBAN": "FR7630003035710005023922834"
                    }
                  }
                }
              }
            ]
          }
        ]
      }
    }
  },
  "resourceId": "8410-8600-1312-3592"
}
```

**Example JSON Response:**

```
{
  "resourceId": "8410-8600-1312-3593",
  "SepaRequestToPayCancellationResponse": {
    "Document": {
      "RsltnOfInvstgtn": {
        "Assgnmt": {
          "Id": "Id20***7140",
          "Assgnr": {
            "Pty": {
              "Id": {
                "OrgId": {
                  "AnyBIC": "MMMMES69"
                }
              }
            }
          },
          "Assgne": {
            "Pty": {
              "Id": {
                "OrgId": {
                  "AnyBIC": "AAAAZZ12"
                }
              }
            }
          },
          "CreDtTm": "2024-04-23T15:58:37.000Z"
        },
        "Sts": {
          "Conf": "CNCL"
        },
        "CxlDtls": {
          "OrgnlPmtInfAndSts": [
            {
              "OrgnlPmtInfId": "Id20***9456",
              "TxInfAndSts": [
                {
                  "OrgnlInstrId": "InstrId                 ",
                  "OrgnlEndToEndId": "Id20***4837"
                }
              ]
            }
          ],
          "TxInfAndSts": [
            {
              "CxlStsId": "f4c9c8dba13b1aa99f9aa9c6ebd9fe61b73",
              "OrgnlGrpInf": {
                "OrgnlMsgId": "Id20***8505",
                "OrgnlMsgNmId": "pain.013.001.10",
                "OrgnlCreDtTm": "2024-04-24T15:46:07.000Z"
              },
              "OrgnlInstrId": "InstrId                 ",
              "OrgnlEndToEndId": "Id20***4837",
              "TxCxlSts": "ACCR",
              "CxlStsRsnInf": {
                "Orgtr": {
                  "Id": {
                    "OrgId": {
                      "LEI": "95980008YL8WG2MZQQ40"
                    }
                  }
                },
                "AddtlInf": ["ATS005/2024-05-13T15:46:06.000Z"]
              },
              "OrgnlTxRef": {
                "Amt": {
                  "InstdAmt": 2018
                },
                "ReqdExctnDt": {
                  "DtTm": "2024-05-13T15:46:06.000Z"
                },
                "PmtTpInf": {
                  "SvcLvl": {
                    "Cd": "SRTP"
                  },
                  "LclInstrm": {
                    "Cd": "CTP"
                  }
                },
                "DbtrAgt": {
                  "FinInstnId": {
                    "BICFI": "MMMMES69"
                  }
                },
                "CdtrAgt": {
                  "FinInstnId": {
                    "BICFI": "AAAAZZ11234"
                  }
                },
                "Cdtr": {
                  "Pty": {
                    "Nm": "Max140Text_EPC259-22_V3.0_DS02",
                    "Id": {
                      "OrgId": {
                        "AnyBIC": "AAAAZZ12"
                      }
                    }
                  }
                },
                "CdtrAcct": {
                  "Id": {
                    "IBAN": "FR7630003035710005023922834"
                  }
                },
                "RmtInf": {
                  "Ustrd": "Ustrd"
                }
              }
            }
          ]
        }
      }
    }
  }
}
```

### Cancellation status-update[​](#cancellation-status-update "Direct link to Cancellation status-update")

**Description:** This endpoint allows the payee’s SRTP service provider to request a status update for a cancellation request that was previously made. In other words, after initiating a cancellation of an SRTP, the payee’s provider can use this endpoint to check whether that cancellation has been processed/acknowledged by the payer’s side.

**Endpoint:** `https://api.monei.com/v1/sepa-request-to-pay-requests/{{resourceId}}/cancellation-requests/{{cancellationResourceId}}/status-update`

**Instructions:**

* All parameters must follow the SRTP rulebook and Implementation Guidelines.
* The `{resourceId}` in the URL refers to the original payment’s SRTP resourceId (same as used in creation and cancellation-request). The `{cancellationResourceId}` corresponds to the unique resourceId that was used in the cancellation request. For example, if `resourceId = 8410-8600-1312-3709` and the cancellation’s resourceId was `8410-8600-1312-3593`, then:
  <br />
  `.../requests/8410-8600-1312-3709/cancellation-requests/8410-8600-1312-3593/status-update`
* This status query is idempotent – requesting the status of the same cancellation more than once will return the same result (once the cancellation outcome is known, it won’t change on subsequent queries).
* If the cancellation outcome is already available, the API will return it immediately. Otherwise, an acknowledgement is returned and the final status will be delivered later via the callback URL (as provided during the cancellation request).

**Example JSON Request:**

```
{
  "resourceId": "9813-7776-2938-9347",
  "Document": {
    "CstmrPmtCxlReq": {
      "Assgnmt": {
        "Id": "123456U",
        "Assgnr": {
          "Pty": {
            "Id": {
              "OrgId": {
                "AnyBIC": "AAAAZZ12"
              }
            }
          }
        },
        "Assgne": {
          "Pty": {
            "Id": {
              "OrgId": {
                "AnyBIC": "ZZZZAA12"
              }
            }
          }
        },
        "CreDtTm": "2024-01-16T13:33:53.000Z"
      },
      "Undrlyg": {
        "OrgnlPmtInfAndCxl": [
          {
            "PmtCxlId": "0***07",
            "OrgnlPmtInfId": "0***06",
            "OrgnlGrpInf": {
              "OrgnlMsgId": "202***1",
              "OrgnlMsgNmId": "SRTPTestEPC                   ",
              "OrgnlCreDtTm": "2024-01-16T13:33:53.000Z"
            },
            "TxInf": [
              {
                "CxlId": "123456789A",
                "OrgnlInstrId": "InstrId",
                "OrgnlEndToEndId": "EndtoEnd  ",
                "CxlRsnInf": {
                  "Orgtr": {
                    "Id": {
                      "OrgId": {
                        "AnyBIC": "MMMMES69"
                      }
                    }
                  },
                  "Rsn": {
                    "Cd": "AC02"
                  }
                },
                "OrgnlTxRef": {
                  "Amt": {
                    "InstdAmt": 2108
                  },
                  "ReqdExctnDt": {
                    "DtTm": "2024-02-04T13:33:52.000Z"
                  },
                  "PmtTpInf": {
                    "SvcLvl": {
                      "Cd": "SRTP"
                    },
                    "LclInstrm": {
                      "Cd": "CTP"
                    }
                  },
                  "DbtrAgt": {
                    "FinInstnId": {
                      "BICFI": "PECOFIHH"
                    }
                  },
                  "CdtrAgt": {
                    "FinInstnId": {
                      "BICFI": "AAAAZZ11"
                    }
                  },
                  "Cdtr": {
                    "Pty": {
                      "Nm": "Max140Text_EPC259-22_V3.0_DS02",
                      "Id": {
                        "OrgId": {
                          "AnyBIC": "AAAAZZ12"
                        }
                      }
                    }
                  },
                  "CdtrAcct": {
                    "Id": {
                      "IBAN": "ES9131906664658225183334"
                    }
                  }
                }
              }
            ]
          }
        ]
      }
    }
  },
  "callbackUrl": "https://testing-srtp.com/005/callback"
}
```

**Example JSON Response:**

```
{
  "resourceId": "9813-7776-2938-9347",
  "Document": {
    "RsltnOfInvstgtn": {
      "Assgnmt": {
        "Id": "6bd60078b1f08bef6f486a324225de4344b",
        "Assgnr": {
          "Pty": {
            "Id": {
              "OrgId": {
                "AnyBIC": "ZZZZAA12"
              }
            }
          }
        },
        "Assgne": {
          "Pty": {
            "Id": {
              "OrgId": {
                "AnyBIC": "AAAAZZ12"
              }
            }
          }
        },
        "CreDtTm": "2024-04-23T15:58:37.000Z"
      },
      "Sts": {
        "AssgnmtCxlConf": true
      },
      "CxlDtls": {
        "OrgnlPmtInfAndSts": [
          {
            "OrgnlPmtInfId": "Id20***9456",
            "TxInfAndSts": [
              {
                "OrgnlEndToEndId": "Id20***4837",
                "OrgnlInstrId": "InstrId                 "
              }
            ]
          }
        ],
        "TxInfAndSts": [
          {
            "CxlStsId": "a578f447abced8d534f42d29ee06fc7dd3e",
            "OrgnlGrpInf": {
              "OrgnlMsgId": "Id20***8505",
              "OrgnlMsgNmId": "camt.055.001.08",
              "OrgnlCreDtTm": "2024-04-23T15:58:37.000Z"
            },
            "OrgnlInstrId": "InstrId                 ",
            "OrgnlEndToEndId": "Id20***4837",
            "CxlStsRsnInf": {
              "Orgtr": {
                "Id": {
                  "OrgId": {
                    "LEI": "95980008YL8WG2MZQQ40"
                  }
                }
              },
              "AddtlInf": ["ATS005/2024-05-13T15:46:06.000Z"],
              "Rsn": {
                "Cd": "AEXR"
              }
            },
            "OrgnlTxRef": {
              "Cdtr": {
                "Pty": {
                  "Nm": "Max140Text_EPC259-22_V3.0_DS02",
                  "Id": {
                    "OrgId": {
                      "AnyBIC": "AAAAZZ12"
                    }
                  }
                }
              },
              "CdtrAgt": {
                "FinInstnId": {
                  "BICFI": "AAAAZZ11234"
                }
              },
              "PmtTpInf": {
                "SvcLvl": {
                  "Cd": "SRTP"
                },
                "LclInstrm": {
                  "Cd": "CTP"
                }
              },
              "ReqdExctnDt": {
                "DtTm": "2024-05-13T15:46:06.000Z"
              },
              "CdtrAcct": {
                "Id": {
                  "IBAN": "FR7630003035710005023922834"
                }
              },
              "DbtrAgt": {
                "FinInstnId": {
                  "BICFI": "MMMMES69"
                }
              },
              "Amt": {
                "InstdAmt": 2018
              },
              "RmtInf": {
                "Ustrd": "Ustrd"
              }
            }
          }
        ]
      }
    }
  }
}
```

## Adherence and Integration[​](#adherence-and-integration "Direct link to Adherence and Integration")

MONEI’s implementation of the SRTP scheme is provided through a secure REST API that handles the necessary messaging with banking systems. The endpoints described above enable the creation, status inquiry, and cancellation of Request to Pay messages in full compliance with the SRTP rulebook. This API ensures interoperability with banks and provides MONEI’s partners a smooth integration, abstracting much of the SRTP protocol complexity behind a simple web API.

Notably, MONEI offers an **SRTP Integration Service** that streamlines the adoption of the SRTP scheme for payment service providers. This service includes testing tools and a controlled sandbox environment, allowing both automated and manual tests of SRTP message flows. Because MONEI manages the SRTP messaging and compliance, a bank or payer’s service provider using this integration does not need to undergo the full formal SRTP certification on its own. MONEI takes on the responsibility for conforming to technical specifications, significantly simplifying the process of adhering to the SRTP scheme.

If you are a Payer’s SRTP Service Provider interested in SRTP integration, you can contact **MONEI** for detailed technical documentation and access credentials. MONEI will provide all the necessary information and support to connect to the SRTP API and begin testing the integration. With MONEI’s guidance, service providers can quickly incorporate SRTP into their offerings and start leveraging this new payment request scheme.


---

# Subscriptions integration

Subscriptions allow you to charge a customer on a recurring basis.

## Integration[​](#integration "Direct link to Integration")

### 1. Create a new subscription on your server.[​](#1-create-a-new-subscription-on-your-server "Direct link to 1. Create a new subscription on your server.")

<!-- -->

* cURL
* Node.js
* PHP
* Python

POST https\://api.monei.com/v1/subscriptions

```
curl --request POST 'https://api.monei.com/v1/subscriptions' \\
--header 'Authorization: YOUR_API_KEY' \\
--header 'Content-Type: application/json' \\
--data-raw '{
  "customer": {
    "name": "John Doe",
    "email": "john.doe@monei.com"
  },
  "amount": 110,
  "currency": "EUR",
  "interval": "month",
  "intervalCount": 1,
  "description": "MoonMail Lite Monthly",
  "callbackUrl": "https://example.com/subscription/callback",
  "paymentCallbackUrl": "https://example.com/payment/callback"
}'
```

(Replace `YOUR_API_KEY` with your actual MONEI API key)

server.js

```
const {Monei} = require('@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({
  customer: {
    name: 'John Doe',
    email: 'john.doe@monei.com'
  },
  amount: 110,
  currency: 'EUR',
  interval: 'month',
  intervalCount: 1,
  description: 'MoonMail Lite Monthly',
  callbackUrl: 'https://example.com/subscription/callback',
  paymentCallbackUrl: 'https://example.com/payment/callback'
});

// You will need the subscription id from the response in the next step
const subscriptionId = subscription.id;
```

server.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([
    'customer' => new PaymentCustomer([
      'name' => 'John Doe',
      'email' => 'john.doe@monei.com'
    ]),
    'amount' => 110,
    'currency' => 'EUR',
    'interval' => 'month',
    'interval_count' => 1,
    'description' => 'MoonMail Lite Monthly',
    'callback_url' => 'https://example.com/subscription/callback',
    'payment_callback_url' => 'https://example.com/payment/callback'
  ])
);

// You will need the subscription id from the response in the next step
$subscriptionId = $subscription->getId();
?>
```

server.py

```
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(
        customer=PaymentCustomer(
            name="John Doe",
            email="john.doe@monei.com"
        ),
        amount=110,
        currency="EUR",
        interval="month",
        interval_count=1,
        description="MoonMail Lite Monthly",
        callback_url="https://example.com/subscription/callback",
        payment_callback_url="https://example.com/payment/callback"
    )
)

# You will need the subscription id from the response in the next step
subscription_id = subscription.id
```

The following parameters are required:

* **amount** `positive integer` - 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)
* **currency** `string` - Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase. Must be a supported currency.
* **interval** `string` - Subscription interval, one of `day`, `week`, `month`, `year`
* **callbackUrl** `string` - The URL will be called each time subscription status changes.
* **paymentCallbackUrl** `string` - The URL will be called each time subscription creates a new payment.
* **intervalCount** `number` - Number of intervals between subscription payments.

Check all available [request parameters](https://docs.monei.com/apis/rest/subscriptions-create/.md).

### 2. Activate the subscription.[​](#2-activate-the-subscription "Direct link to 2. Activate the subscription.")

* cURL
* Node.js
* PHP
* Python

POST https\://api.monei.com/v1/subscriptions/{subscription\_id}/activate

```
curl --request POST 'https://api.monei.com/v1/subscriptions/YOUR_SUBSCRIPTION_ID/activate' \\
--header 'Authorization: YOUR_API_KEY' \\
--header 'Content-Type: application/json' \\
--data-raw '{
  "completeUrl": "https://example.com/checkout/complete",
  "cancelUrl": "https://example.com/checkout/cancel"
}'
```

(Replace `YOUR_SUBSCRIPTION_ID` and `YOUR_API_KEY`)

server.js

```
const {Monei} = require('@monei-js/node-sdk');
// Replace YOUR_API_KEY with your actual MONEI API key
const monei = new Monei('YOUR_API_KEY');
// Replace YOUR_SUBSCRIPTION_ID with the ID from the previous step
const activation = await monei.subscriptions.activate('YOUR_SUBSCRIPTION_ID', {
  completeUrl: 'https://example.com/checkout/complete',
  cancelUrl: 'https://example.com/checkout/cancel'
});

// You will need the redirectUrl from the response in the next step
const redirectUrl = activation.nextAction.redirectUrl;
```

server.php

```
<?php
require_once 'vendor/autoload.php';

use Monei\\MoneiClient;
use Monei\\Model\\ActivateSubscriptionRequest;

// Replace YOUR_API_KEY with your actual MONEI API key
$monei = new MoneiClient('YOUR_API_KEY');
// Replace YOUR_SUBSCRIPTION_ID with the ID from the previous step
$activation = $monei->subscriptions->activate(
  'YOUR_SUBSCRIPTION_ID',
  new ActivateSubscriptionRequest([
    'complete_url' => 'https://example.com/checkout/complete',
    'cancel_url' => 'https://example.com/checkout/cancel'
  ])
);

// You will need the redirectUrl from the response in the next step
$redirectUrl = $activation->getNextAction()->getRedirectUrl();
?>
```

server.py

```
import Monei
from Monei import ActivateSubscriptionRequest

# Replace YOUR_API_KEY with your actual MONEI API key
monei = Monei.MoneiClient(api_key="YOUR_API_KEY")

# Replace YOUR_SUBSCRIPTION_ID with the ID from the previous step
activation = monei.subscriptions.activate(
    subscription_id="YOUR_SUBSCRIPTION_ID",
    request=ActivateSubscriptionRequest(
        complete_url="https://example.com/checkout/complete",
        cancel_url="https://example.com/checkout/cancel"
    )
)

# You will need the redirectUrl from the response in the next step
redirect_url = activation.next_action.redirect_url
```

Check all available [request parameters](https://docs.monei.com/apis/rest/subscriptions-activate/.md).

### 3. Redirect the customer to the `redirectUrl` from the response[​](#3-redirect-the-customer-to-the-redirecturl-from-the-response "Direct link to 3-redirect-the-customer-to-the-redirecturl-from-the-response")

In the response from the [activate subscription](https://docs.monei.com/apis/rest/subscriptions-activate/.md) request you'll get the following response:

```
{
  "id": "af6029f80f5fc73a8ad2753eea0b1be0", // Payment ID
  "amount": 110,
  "currency": "EUR",
  "orderId": "84370745531439",
  "description": "Test Shop - #84370745531439",
  "accountId": "aa9333ba-82de-400c-9ae7-087b9f8d2242",
  "subscriptionId": "575bcd84-09fc-4a6e-8c4c-f88b8eb90bfa",
  "livemode": false,
  "status": "PENDING",
  "customer": {
    "email": "email@example.com",
    "name": "John Doe"
  },
  "nextAction": {
    "type": "CONFIRM",
    "mustRedirect": true, // Indicates redirection is needed
    "redirectUrl": "https://secure.monei.com/payments/af6029f80f5fc73a8ad2753eea0b1be0" // <-- REDIRECT CUSTOMER HERE
  },
  "createdAt": 1594215339
}
```

Redirect the customer to the `nextAction.redirectUrl` to show him the MONEI Hosted payment page. The response object here is actually a [Payment object](https://docs.monei.com/apis/rest/schemas/payment/.md) associated with the *initial activation* of the subscription.

note

As an alternative process you can confirm the payment by using monei.js on the client-side. Check our [build a custom checkout guide](https://docs.monei.com/integrations/build-custom-checkout/.md).

### 4. Customer completes the payment[​](#4-customer-completes-the-payment "Direct link to 4. Customer completes the payment")

Customer enters the Card information and goes through the 3D secure verification process (is redirected to the page provided by the issuer bank of the Card for confirmation of the transaction) if required.

### 5. Customer is redirected back to your server[​](#5-customer-is-redirected-back-to-your-server "Direct link to 5. Customer is redirected back to your server")

* if customer clicks **"Back to {{shop.name}}"** link (you can provide `shop.name` in the [public business details settings](https://dashboard.monei.com/settings)), s/he is redirected to `cancelUrl`. (Usually this url is the checkout page on your website, where the user had started a checkout process)
* in any other case the customer is redirected to the `completeUrl` with **payment\_id** and **subscription\_id** query parameters. Use [get payment](https://docs.monei.com/apis/rest/payments-get/.md) endpoint to check the initial payment status, and [get subscription](https://docs.monei.com/apis/rest/subscriptions-get/.md) endpoint to get the subscription status (it should move to `ACTIVE` or `TRIALING` if successful).

### 6. An asynchronous request is sent to your server[​](#6-an-asynchronous-request-is-sent-to-your-server "Direct link to 6. An asynchronous request is sent to your server")

MONEI will notify you about the *initial payment* status by sending an HTTP POST request to the `callbackUrl` defined in the **create payment** step (this is the `paymentCallbackUrl` from the *create subscription* request). The request body will contain the full [Payment object](https://docs.monei.com/apis/rest/schemas/payment/.md).

Additionally, MONEI will notify you about the *subscription status changes* (e.g., from `PENDING` to `ACTIVE`) by sending an HTTP POST request to the `callbackUrl` defined in the **create subscription** request. The request body will contain the full [Subscription object](https://docs.monei.com/apis/rest/schemas/subscription/.md).

This ensures that you get the status updates even when the customer closes the browser window or loses Internet connection.

The request also contains a `MONEI-Signature` header. [Verify this signature](https://docs.monei.com/guides/verify-signature/.md) to confirm that the received request is sent from MONEI.

To acknowledge the receipt of the request, your endpoint must return a `200` HTTP status code to MONEI. All other response codes, including `3xx` codes, indicate to MONEI that you did not receive the event.

If MONEI does not receive a `200` HTTP status code, the notification attempt is repeated. After multiple failures to send the notification over multiple days, MONEI marks the request as failed and stops trying to send it to your endpoint.


---

# Testing

## How to test your integrations[​](#how-to-test-your-integrations "Direct link to How to test your integrations")

To test your integrations you need to switch to a **test mode** using a switch in the header of your [MONEI Dashboard](https://dashboard.monei.com).

![MONEI Test Mode](/assets/images/test-mode-2bf011748369a7dea9aa5c4fd40ae774.jpg)

* Generate your test API key and get your test Account ID in [MONEI Dashboard → Settings → API Access](https://dashboard.monei.com/settings/api).
* Configure your payment methods using test credentials in [MONEI Dashboard → Settings → Payment Methods](https://dashboard.monei.com/settings/payment-methods)

Important

**Account ID** and **API key** you generate in test mode are **different from the live (production) mode** and can only be used for testing purposes.

## Test card numbers[​](#test-card-numbers "Direct link to Test card numbers")

Genuine card information cannot be used in test mode. Instead, use any of the following test card numbers.

* For all test card numbers use **12/34** as an expiration date and **123** as CVC code

| CARD NUMBER      | BRAND      | DESCRIPTION                               |
| ---------------- | ---------- | ----------------------------------------- |
| 4444444444444406 | Visa       | 3D Secure v2.1 Challenge                  |
| 4444444444444414 | Visa       | 3D Secure v2.1 Direct (no challenge)      |
| 4444444444444422 | Visa       | 3D Secure v2.1 Frictionless               |
| 4444444444444430 | Visa       | 3D Secure v2.1 Frictionless and Challenge |
| 5555555555555524 | Mastercard | 3D Secure v2.1 Direct (no challenge)      |
| 5555555555555532 | Mastercard | 3D Secure v2.1 Frictionless               |
| 5555555555555565 | Mastercard | 3D Secure v2.1 Challenge                  |
| 5555555555555573 | Mastercard | 3D Secure v2.1 Frictionless and Challenge |

## Test Bizum phone numbers[​](#test-bizum-phone-numbers "Direct link to Test Bizum phone numbers")

For all Bizum tests, the phone number to be used is +34500000000

| AMOUNT                    | STATUS CODE                                                 | FLOW     |
| ------------------------- | ----------------------------------------------------------- | -------- |
| Below 5 EUR               | E000 (Transaction approved)                                 | RTP      |
| Between 5 EUR and 10 EUR  | E506 (Error during payment authorization. Please try again) | RTP      |
| Between 10 EUR and 15 EUR | E000 (Transaction approved)                                 | REDIRECT |
| Above 15 EUR              | Phone number is not registered in Bizum                     |          |

### Test Bizum Payout transactions​[​](#test-bizum-payout-transactions "Direct link to Test Bizum Payout transactions​")

You can also test **Bizum Payout** transactions (outgoing payments to users).<br /><!-- -->In test mode, all Payout transactions with an amount **below 10 EUR** will be **approved automatically**.

| AMOUNT          | STATUS CODE                                                                                                         | FLOW |
| --------------- | ------------------------------------------------------------------------------------------------------------------- | ---- |
| Below 10 EUR    | E000 (Transaction approved)                                                                                         | RTP  |
| 10 EUR or above | E103 (Operation not allowed/configured for this merchant. Please contact the acquiring entity or MONEI for support) | RTP  |

**Note:**<br /><!-- -->Bizum Payout tests are only available in **test mode** and do not generate real fund transfers.<br /><!-- -->Make sure to use your **test Account ID** and **API key** when sending Payout requests via the API.

caution

**In test environment Bizum only supports transactions below 5 EUR**

## Test PayPal Accounts[​](#test-paypal-accounts "Direct link to Test PayPal Accounts")

| TYPE     | EMAIL                         | PASSWORD   | DESCRIPTION                                                                                                                                                                                     |
| -------- | ----------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Business | <paypal-business@monei.net>   | monei12345 | You can link this account in MONEI Dashboard to test PayPal payment method                                                                                                                      |
| Personal | <paypal-personal@monei.net>   | monei12345 | You can do test payments using this account                                                                                                                                                     |
| Personal | <CCREJECT-REFUSED@paypal.com> | PayPal2016 | Use this account to simulate a payment failure. PayPal credit and the card ending with 1111 in the PayPal wallet will lead to a successful transaction. The other cards will lead to a decline. |

You can register your own PayPal sandbox account [here](https://sandbox.paypal.com/).


---