API Reference mollie_api v0.1.0-20260303
View SourceModules
API calls for all endpoints tagged BalanceTransfersAPI.
API calls for all endpoints tagged BalancesAPI.
API calls for all endpoints tagged CapabilitiesAPI.
API calls for all endpoints tagged CapturesAPI.
API calls for all endpoints tagged ChargebacksAPI.
API calls for all endpoints tagged ClientLinksAPI.
API calls for all endpoints tagged ClientsAPI.
API calls for all endpoints tagged CustomersAPI.
API calls for all endpoints tagged DelayedRoutingAPI.
API calls for all endpoints tagged InvoicesAPI.
API calls for all endpoints tagged MandatesAPI.
API calls for all endpoints tagged MethodsAPI.
API calls for all endpoints tagged OnboardingAPI.
API calls for all endpoints tagged OrganizationsAPI.
API calls for all endpoints tagged PaymentLinksAPI.
API calls for all endpoints tagged PaymentsAPI.
API calls for all endpoints tagged PermissionsAPI.
API calls for all endpoints tagged ProfilesAPI.
API calls for all endpoints tagged RefundsAPI.
API calls for all endpoints tagged SalesInvoicesAPI.
API calls for all endpoints tagged SettlementsAPI.
API calls for all endpoints tagged SubscriptionsAPI.
API calls for all endpoints tagged TerminalsAPI.
API calls for all endpoints tagged WalletsAPI.
API calls for all endpoints tagged WebhookEventsAPI.
API calls for all endpoints tagged WebhooksAPI.
Handle Tesla connections for MollieAPI.
Helper functions for deserializing responses into models
In v2 endpoints, monetary amounts are represented as objects with a currency and value field.
In v2 endpoints, monetary amounts are represented as objects with a currency and value field.
Austria legal entities types. at-aktiengesellschaft - Aktiengesellschaft (AG) at-einzelunternehmen - Einzelunternehmen at-freie-berufe - Freie Berufe at-gesbr - Gesellschaft bürgerlichen Rechts (GesbR) at-gmbh - Gesellschaft mit beschränkter Haftung (GmbH) at-interessen-verienigung - Europäische Wirtschaftliche Interessenvereinigung at-keg - Kommandit - Erwerbsgesellschaft (KEG) at-kommanditgesellschaft - Kommanditgesellschaft (KG) at-korperschaft-offentlichen-rechts - Körperschaft öffentlichen Rechts at-oeg - Offene Erwerbsgesellschaft (OEG) at-offene-gesellschaft - Offene Gesellschaft (OG) at-offentliches-unternehmen - Öffentliches Unternehmen at-se - Europäische Gesellschaft (SE) at-stiftung - Stiftung at-trust - Trust at-verein - Verein
Austria legal entities types. at-aktiengesellschaft - Aktiengesellschaft (AG) at-einzelunternehmen - Einzelunternehmen at-freie-berufe - Freie Berufe at-gesbr - Gesellschaft bürgerlichen Rechts (GesbR) at-gmbh - Gesellschaft mit beschränkter Haftung (GmbH) at-interessen-verienigung - Europäische Wirtschaftliche Interessenvereinigung at-keg - Kommandit - Erwerbsgesellschaft (KEG) at-kommanditgesellschaft - Kommanditgesellschaft (KG) at-korperschaft-offentlichen-rechts - Körperschaft öffentlichen Rechts at-oeg - Offene Erwerbsgesellschaft (OEG) at-offene-gesellschaft - Offene Gesellschaft (OG) at-offentliches-unternehmen - Öffentliches Unternehmen at-se - Europäische Gesellschaft (SE) at-stiftung - Stiftung at-trust - Trust at-verein - Verein
The status of the balance.
The type of the transfer. Different fees may apply to different types of transfers.
The type of the transfer. Different fees may apply to different types of transfers.
The default destination of automatic scheduled transfers. Currently only bank-account is supported. * bank-account — Transfer the balance amount to an external bank account
The frequency with which the available amount on the balance will be settled to the configured transfer destination. Settlements created during weekends or on bank holidays will take place on the next business day.
Defines the type of the party. At the moment, only organization is supported.
Defines the type of the party. At the moment, only organization is supported.
The status of the transfer.
A machine-readable code that indicates the reason for the transfer's status.
A machine-readable code that indicates the reason for the transfer's status.
Belgium legal entities types. be-autonoom-gemeentebedrijf - Autonoom gemeentebedrijf be-belgische-staat - Belgische Staat be-bv - Besloten Vennootschap be-bvba - Besloten Vennootschap met Beperkte Aansprakelijkheid (BVBA) be-comm-v - Gewone Commanditaire Vennootschap (GCV / Comm. V) be-comm-va - Commanditaire Vennootschap op Aandelen (CVA / Comm. VA) be-cv - Coöperatieve Vennootschap be-cvoa - Coöperatieve Vennootschap met Onbeperkte Aansprakelijkheid (CVOA) be-cvoha - Coöperatieve Vennootschap met Onbeperkte en Hoofdelijke Aansprakelijkheid (CVOHA) be-cvba - Coöperatieve Vennootschap met Beperkte Aansprakelijkheid (CVBA) be-economisch-samenwerkingsverband - Europees Economisch Samenwerkingsverband (EESV) be-eenmanszaak - Eenmanszaak be-eenmans-bvba - Eénpersoons-BVBA (EBVBA) be-europese-cooperatieve-vennootschap - Europese Coöperatieve Vennootschap (SCE) be-europese-vennootschap - Europese Naamloze Vennootschap (SE) be-ivzw - Internationale Vereniging Zonder Winstoogmerk (IVZW) be-kerkgenootschap - Kerkgenootschap be-landbouwvennootschap - Landbouwvennootschap (LV) be-maatschap - Maatschap be-nv - Naamloze Vennootschap (NV) be-politiek-publiek-rechtspersoon - Politieke Publiekrechtelijke Rechtspersonen be-s-bvba - Starters-BVBA (S-BVBA) be-stichting - Stichting be-stille-handelsvennootschap - Stille Handelsvennootschap be-tijdelijke-handelsvennootschap - Tijdelijke Handelsvennootschap be-trust - Trust be-vereniging-zonder-winstoogmerk - Vereniging Zonder Winstoogmerk (VZW) be-vof - Vennootschap Onder Firma (VOF)
Belgium legal entities types. be-autonoom-gemeentebedrijf - Autonoom gemeentebedrijf be-belgische-staat - Belgische Staat be-bv - Besloten Vennootschap be-bvba - Besloten Vennootschap met Beperkte Aansprakelijkheid (BVBA) be-comm-v - Gewone Commanditaire Vennootschap (GCV / Comm. V) be-comm-va - Commanditaire Vennootschap op Aandelen (CVA / Comm. VA) be-cv - Coöperatieve Vennootschap be-cvoa - Coöperatieve Vennootschap met Onbeperkte Aansprakelijkheid (CVOA) be-cvoha - Coöperatieve Vennootschap met Onbeperkte en Hoofdelijke Aansprakelijkheid (CVOHA) be-cvba - Coöperatieve Vennootschap met Beperkte Aansprakelijkheid (CVBA) be-economisch-samenwerkingsverband - Europees Economisch Samenwerkingsverband (EESV) be-eenmanszaak - Eenmanszaak be-eenmans-bvba - Eénpersoons-BVBA (EBVBA) be-europese-cooperatieve-vennootschap - Europese Coöperatieve Vennootschap (SCE) be-europese-vennootschap - Europese Naamloze Vennootschap (SE) be-ivzw - Internationale Vereniging Zonder Winstoogmerk (IVZW) be-kerkgenootschap - Kerkgenootschap be-landbouwvennootschap - Landbouwvennootschap (LV) be-maatschap - Maatschap be-nv - Naamloze Vennootschap (NV) be-politiek-publiek-rechtspersoon - Politieke Publiekrechtelijke Rechtspersonen be-s-bvba - Starters-BVBA (S-BVBA) be-stichting - Stichting be-stille-handelsvennootschap - Stille Handelsvennootschap be-tijdelijke-handelsvennootschap - Tijdelijke Handelsvennootschap be-trust - Trust be-vereniging-zonder-winstoogmerk - Vereniging Zonder Winstoogmerk (VZW) be-vof - Vennootschap Onder Firma (VOF)
The customer's billing address details. We advise to provide these details to improve fraud protection and conversion. Should include email or a valid postal address consisting of streetAndNumber, postalCode, city and country. Required for payment method alma, in3, klarna, billie and riverty.
The status of the requirement depends on its due date. If no due date is given, the status will be requested.
Indicate if the funds should be captured immediately or if you want to place a hold and capture at a later time. This field needs to be set to manual for method riverty.
Indicate if the funds should be captured immediately or if you want to place a hold and capture at a later time. This field needs to be set to manual for method riverty.
The capture's status.
The capture's status.
Switzerland legal entities types. ch-ag - Aktiengesellschaft (AG) ch-eg - Einfache Gesellschaft (eG) ch-einzelunternehmen - Einzelunternehmen ch-genossenschaft - Genossenschaft ch-gmbh - Gesellschaft mit beschränkter Haftung (GmbH) ch-kg - Kommanditgesellschaft (KG) ch-kig - Kollektivgesellschaft (KIG) ch-kmag - Kommanditaktiengesellschaft (KmAG) ch-stiftung - Stiftung ch-trust - Trust * ch-verein - Verein
Switzerland legal entities types. ch-ag - Aktiengesellschaft (AG) ch-eg - Einfache Gesellschaft (eG) ch-einzelunternehmen - Einzelunternehmen ch-genossenschaft - Genossenschaft ch-gmbh - Gesellschaft mit beschränkter Haftung (GmbH) ch-kg - Kommanditgesellschaft (KG) ch-kig - Kollektivgesellschaft (KIG) ch-kmag - Kommanditaktiengesellschaft (KmAG) ch-stiftung - Stiftung ch-trust - Trust * ch-verein - Verein
With Mollie Connect you can charge fees on payment links that your app is processing on behalf of other Mollie merchants. If you use OAuth to create payment links on a connected merchant's account, you can charge a fee using this applicationFee parameter. If a payment on the payment link succeeds, the fee will be deducted from the merchant's balance and sent to your own account balance.
An object with several relevant URLs. Every URL object will contain an href and a type field.
Germany legal entities types. de-aktiengesellschaft - Aktiengesellschaft (AG) de-eingetragene-genossenschaft - Eingetragene Genossenschaft (e.G.) de-einzelunternehmen - Einzelunternehmen de-freiberufler - Freiberufler de-gesellschaft-burgerlichen-rechts - Gesellschaft bürgerlichen Rechts (GbR) de-gmbh - Gesellschaft mit beschränkter Haftung (GmbH) de-interessen-verienigung - Europäische Wirtschaftliche Interessenvereinigung de-kg - Kommanditgesellschaft (KG) de-kirchliche-stiftung - Kirchliche Stiftung de-korperschaft-offentlichen-rechts - Körperschaft öffentlichen Rechts de-nev - Nicht eingetragener Verein (n.e.V.) de-offentliches-unternehmen - Öffentliches Unternehmen de-ohg - Offene Handelsgesellschaft (OHG) de-partnergesellschaft - Partnergesellschaft de-se - Europäische Gesellschaft (SE) de-stiftung-des-privaten-rechts - Stiftung des privaten Rechts de-treuhandstiftung - Treuhandstiftung de-unternehmergesellschaft - Unternehmergesellschaft (UG) * de-verein - Verein (e.V.)
Germany legal entities types. de-aktiengesellschaft - Aktiengesellschaft (AG) de-eingetragene-genossenschaft - Eingetragene Genossenschaft (e.G.) de-einzelunternehmen - Einzelunternehmen de-freiberufler - Freiberufler de-gesellschaft-burgerlichen-rechts - Gesellschaft bürgerlichen Rechts (GbR) de-gmbh - Gesellschaft mit beschränkter Haftung (GmbH) de-interessen-verienigung - Europäische Wirtschaftliche Interessenvereinigung de-kg - Kommanditgesellschaft (KG) de-kirchliche-stiftung - Kirchliche Stiftung de-korperschaft-offentlichen-rechts - Körperschaft öffentlichen Rechts de-nev - Nicht eingetragener Verein (n.e.V.) de-offentliches-unternehmen - Öffentliches Unternehmen de-ohg - Offene Handelsgesellschaft (OHG) de-partnergesellschaft - Partnergesellschaft de-se - Europäische Gesellschaft (SE) de-stiftung-des-privaten-rechts - Stiftung des privaten Rechts de-treuhandstiftung - Treuhandstiftung de-unternehmergesellschaft - Unternehmergesellschaft (UG) * de-verein - Verein (e.V.)
Denmark legal entities types. dk-aktieselskab - Aktieselskab dk-anpartsselskab - Anpartsselskab dk-enkeltmandsvirksomhed - Enkeltmandsvirksomhed dk-interessentskab - Interessentskab dk-ivaerksaetterselskab - Iværksætterselskab dk-kommanditselskab - Kommanditselskab dk-stiftelse - Stiftelse dk-trust - Trust
Denmark legal entities types. dk-aktieselskab - Aktieselskab dk-anpartsselskab - Anpartsselskab dk-enkeltmandsvirksomhed - Enkeltmandsvirksomhed dk-interessentskab - Interessentskab dk-ivaerksaetterselskab - Iværksætterselskab dk-kommanditselskab - Kommanditselskab dk-stiftelse - Stiftelse dk-trust - Trust
An object with several relevant URLs. Every URL object will contain an href and a type field.
Totals are grouped according to the chosen grouping rule. The example response should give a good idea of what a typical grouping looks like. If grouping status-balances is chosen, the main grouping is as follows: pendingBalance containing an open, pending, movedToAvailable, and close sub-group availableBalance containing an open, movedFromPending, immediatelyAvailable, and close sub-group If grouping transaction-categories is chosen, the main grouping is as follows: open and close groups, each containing a pending and available sub-group Transaction type groups such as payments, refunds, chargebacks, capital, transfers, fee-prepayments, corrections, topups each containing a pending, movedToAvailable, and immediatelyAvailable sub-group Each sub-group typically has: An amount object containing the group's total amount A count integer if relevant (for example, counting the number of refunds) * A subtotals array containing more sub-group objects if applicable
The available balance. Only available if grouping is status-balances.
Only available on transaction-categories grouping.
Only available on transaction-categories grouping.
The pending balance. Only available if grouping is status-balances.
Depending on the type of the balance transaction, we will try to give more context about the specific event that triggered it. For example, the context object for a payment transaction will look like {"paymentId": "tr_5B8cwPMGnU6qLbRvo7qEZo", "paymentDescription": "Description"}. Below is a complete list of the context values that each type of transaction will have. Type payment: paymentId, paymentDescription Type capture: paymentId captureId, paymentDescription, captureDescription Type capture-commission: paymentId, paymentDescription, organizationId Type capture-rolling-reserve-release: paymentId, paymentDescription, captureId, captureDescription Type unauthorized-direct-debit: paymentId, paymentDescription Type failed-payment: paymentId, paymentDescription Type refund: paymentId refundId, paymentDescription, refundDescription Type refund-compensation: paymentId refundId, paymentDescription, refundDescription Type returned-refund: paymentId refundId, paymentDescription, refundDescription Type returned-refund-compensation: paymentId refundId, paymentDescription, refundDescription Type chargeback: paymentId chargebackId, paymentDescription, chargebackDescription Type chargeback-reversal: paymentId, chargebackId, paymentDescription, chargebackDescription Type chargeback-compensation: paymentId, chargebackId, paymentDescription, chargebackDescription Type reversed-chargeback-compensation: paymentId, chargebackId, paymentDescription, chargebackDescription Type outgoing-transfer: settlementId transferId Type canceled-outgoing-transfer: settlementId transferId Type returned-transfer: settlementId transferId Type invoice-compensation: invoiceId Type balance-correction: none Type application-fee: paymentId, paymentDescription, payingOwner Type split-payment: paymentId, paymentDescription, paymentOwner Type platform-payment-refund: paymentId refundId, paymentDescription, refundDescription Type returned-platform-payment-refund: paymentId refundId, paymentDescription, refundDescription Type platform-payment-chargeback: paymentId chargebackId, paymentDescription, chargebackDescription Type reversed-platform-payment-chargeback: paymentId chargebackId, paymentDescription, chargebackDescription Type payment-commission: paymentId, paymentDescription, organizationId Type reimbursement-fee: paymentId, paymentDescription Type failed-payment-fee: paymentId, paymentDescription Type payment-fee: paymentId, paymentDescription Type cash-advance-loan: none Type platform-connected-organizations-fee: none Type managed-fee: feeType, <name of the fee>Id Type returned-managed-fee: feeType, <name of the fee>Id Type topup: none Type balance-reserve: none Type balance-reserve-return: none Type movement: none Type post-payment-split-payment: paymentId Type cash-collateral-issuance: none Type cash-collateral-release: none
A detailed breakdown of the deductions withheld from the movement. Each field represents a specific type of deduction applied to the transaction. Only the applicable fields will be present.
The destination where the available amount will be automatically transferred to according to the configured transfer frequency.
A party involved in the balance transfer, either the sender or the receiver.
A party involved in the balance transfer, either the sender or the receiver.
The reason for the current status of the transfer, if applicable.
The reason for the current status of the transfer, if applicable.
An object with several relevant URLs. Every URL object will contain an href and a type field.
Reason for the chargeback as given by the bank. Only available for chargebacks of SEPA Direct Debit payments.
The commission object.
Address of the organization.
An object with several relevant URLs. Every URL object will contain an href and a type field.
Personal data of your customer.
The legal entity type of the organization, based on its country of origin.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
URLs of images representing the payment method.
URLs of images representing the issuer. required: - size1x - size2x - svg
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie merchants. If you use OAuth to create payments on a connected merchant's account, you can charge a fee using this applicationFee parameter. If the payment succeeds, the fee will be deducted from the merchant's balance and sent to your own account balance. If instead you want to split a payment on your own account between yourself and a connected merchant, refer to the routing parameter.
The customer's billing address details. We advise to provide these details to improve fraud protection and conversion. Should include email or a valid postal address consisting of streetAndNumber, postalCode, city and country. Required for payment method alma, in3, klarna, billie and riverty.
An object containing payment details collected during the payment process. For example, details may include the customer's card or bank details and a payment reference. For the full list of details, please refer to the method-specific parameters guide.
Optional include. If a QR code was requested during payment creation for a QR-compatible payment method, the QR code details will be available in this object. The QR code can be scanned by the customer to complete the payment on their mobile device. For example, Bancontact QR payments can be completed by the customer using the Bancontact app.
The Point of sale receipt object.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object containing payment details collected during the payment process. For example, details may include the customer's card or bank details and a payment reference. For the full list of details, please refer to the method-specific parameters guide.
The Point of sale receipt object.
The destination of this portion of the payment.
An object with several relevant URLs. Every URL object will contain an href and a type field.
The destination of this portion of the payment.
An object with several relevant URLs. Every URL object will contain an href and a type field.
Present if changes have been made that have not yet been approved by Mollie. Changes to test profiles are approved automatically, unless a switch to a live profile has been requested. The review object will therefore usually be null in test mode.
Present if changes have been made that have not yet been approved by Mollie. Changes to test profiles are approved automatically, unless a switch to a live profile has been requested. The review object will therefore usually be null in test mode.
An object with several relevant URLs. Every URL object will contain an href and a type field.
Where the funds will be pulled back from.
Where the funds will be pulled back from.
The destination of the route.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
The service rates, further divided into fixed and percentage costs.
With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie merchants. Setting an application fee on the subscription will ensure this fee is charged on each individual payment. Refer to the applicationFee parameter on the Get payment endpoint documentation for more information.
An object with several relevant URLs. Every URL object will contain an href and a type field.
Full payload of the event.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An error response object.
The URL to the generic Mollie API error handling guide.
Spain legal entities types. es-autonomo - Autonomo es-asociacion - Asociación es-cb - Comunidad de Bienes (C.B.) es-comerciante-individual - Comerciante individual es-fiducia - Fiducia es-fundacion - Fundacion es-sa - Sociedad Anónima (S.A.) es-sr-src - Sociedad Regular Colectiva (S.R/S.R.C) es-se - Sociedad Anónima Europea (SE) es-sociedad-civil - Sociedad Civil es-sociedad-cooperativa - Sociedad Cooperativa es-sociedad-comanditaria - Sociedad en Comanditaria es-srl-sl - Sociedad de Responsabilidad Limitada (SRL/SL) es-srlu - Sociedad de Responsabilidad Limitada Unipersonal (SRLU)
Spain legal entities types. es-autonomo - Autonomo es-asociacion - Asociación es-cb - Comunidad de Bienes (C.B.) es-comerciante-individual - Comerciante individual es-fiducia - Fiducia es-fundacion - Fundacion es-sa - Sociedad Anónima (S.A.) es-sr-src - Sociedad Regular Colectiva (S.R/S.R.C) es-se - Sociedad Anónima Europea (SE) es-sociedad-civil - Sociedad Civil es-sociedad-cooperativa - Sociedad Cooperativa es-sociedad-comanditaria - Sociedad en Comanditaria es-srl-sl - Sociedad de Responsabilidad Limitada (SRL/SL) es-srlu - Sociedad de Responsabilidad Limitada Unipersonal (SRLU)
Billie is a business-to-business (B2B) payment method. It requires extra information to identify the organization that is completing the payment. It is recommended to include these parameters up front for a seamless flow. Otherwise, Billie will ask the customer to complete the missing fields during checkout.
Finland legal entities types. fi-avoin-yhtio - Avoin yhtiö fi-julkinen-osakeyhtio - Julkinen Osakeyhtiö fi-kommandiittiyhtio - Kommandiittiyhtiö fi-osakeythio - Osakeythiö fi-osuuskunta - Osuuskunta fi-rekisteroity-yhdistys - Rekisteroity Yhdistys fi-saatio - Säätiö fi-toiminimi - Toiminimi
Finland legal entities types. fi-avoin-yhtio - Avoin yhtiö fi-julkinen-osakeyhtio - Julkinen Osakeyhtiö fi-kommandiittiyhtio - Kommandiittiyhtiö fi-osakeythio - Osakeythiö fi-osuuskunta - Osuuskunta fi-rekisteroity-yhdistys - Rekisteroity Yhdistys fi-saatio - Säätiö fi-toiminimi - Toiminimi
France legal entities types. fr-adl - Administration de l'état fr-association - Association fr-ct - Collectivité territoriale fr-entreprise-individuelle - Entreprise individuelle fr-auto-entrepreneur - Auto-entrepreneur fr-epa - Etablissement public administratif fr-fiducie - Fiducie fr-fondation - Fondation fr-gie - Groupement d'intérêt économique (GIE) fr-eurl - SARL unipersonnelle (ou EURL) fr-sarl - Société à responsabilité limitée (SARL) fr-sa - Société anonyme (SA) fr-sc - Société en commandite fr-sca - Société coopérative agricole (SCA) fr-sccp - Société coopérative commerciale particulière fr-sdm - Société d'assurance mutuelle fr-civile - Société civile fr-snc - Société en nom collectif (SNC) fr-se - Société européenne fr-sas - Société par actions simplifiée (SAS) * fr-sasu - Société par actions simplifiée unipersonnelle (SASU)
France legal entities types. fr-adl - Administration de l'état fr-association - Association fr-ct - Collectivité territoriale fr-entreprise-individuelle - Entreprise individuelle fr-auto-entrepreneur - Auto-entrepreneur fr-epa - Etablissement public administratif fr-fiducie - Fiducie fr-fondation - Fondation fr-gie - Groupement d'intérêt économique (GIE) fr-eurl - SARL unipersonnelle (ou EURL) fr-sarl - Société à responsabilité limitée (SARL) fr-sa - Société anonyme (SA) fr-sc - Société en commandite fr-sca - Société coopérative agricole (SCA) fr-sccp - Société coopérative commerciale particulière fr-sdm - Société d'assurance mutuelle fr-civile - Société civile fr-snc - Société en nom collectif (SNC) fr-se - Société européenne fr-sas - Société par actions simplifiée (SAS) * fr-sasu - Société par actions simplifiée unipersonnelle (SASU)
Great Britain legal entities types. gb-llp - Limited Liability Partnership (LLP) gb-lp - Limited Partnership (LP) gb-ltd - Private Limited Company (Ltd.) gb-plc - Public Limited Company (PLC) gb-charitable-company - Charitable Company gb-general-partnership - General Partnership (GP) gb-sole-trader - Sole trader gb-trust - Trust
Great Britain legal entities types. gb-llp - Limited Liability Partnership (LLP) gb-lp - Limited Partnership (LP) gb-ltd - Private Limited Company (Ltd.) gb-plc - Public Limited Company (PLC) gb-charitable-company - Charitable Company gb-general-partnership - General Partnership (GP) gb-sole-trader - Sole trader gb-trust - Trust
An object with several relevant URLs. Every URL object will contain an href and a type field.
Status of the invoice.
Italy legal entities types. it-associazione-non-riconosciuta - Associazione non riconosciuta it-associazione-riconosciuta - Associazione riconosciuta it-ditta-individuale - Ditta Individuale it-fondazione - Fondazione it-fondo-fiduciario - Fondo Fiduciario it-sapa - Società in accomandita per azioni (S.a.p.a.) it-sas - Società in accomandita semplice (S.a.s.) it-snc - Società in nome collettivo (S.n.c) it-societa-cooperativa - Società cooperativa it-spa - Società per azioni (S.p.A.) it-srl - Società a responsabilità limitata (S.r.l.) it-ss - Società semplice (S.s.)
Italy legal entities types. it-associazione-non-riconosciuta - Associazione non riconosciuta it-associazione-riconosciuta - Associazione riconosciuta it-ditta-individuale - Ditta Individuale it-fondazione - Fondazione it-fondo-fiduciario - Fondo Fiduciario it-sapa - Società in accomandita per azioni (S.a.p.a.) it-sas - Società in accomandita semplice (S.a.s.) it-snc - Società in nome collettivo (S.n.c) it-societa-cooperativa - Società cooperativa it-spa - Società per azioni (S.p.A.) it-srl - Società a responsabilità limitata (S.r.l.) it-ss - Società semplice (S.s.)
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object containing payment details collected during the payment process. For example, details may include the customer's card or bank details and a payment reference. For the full list of details, please refer to the method-specific parameters guide.
The Point of sale receipt object.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
Present if changes have been made that have not yet been approved by Mollie. Changes to test profiles are approved automatically, unless a switch to a live profile has been requested. The review object will therefore usually be null in test mode.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
Where the funds will be pulled back from.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
Links to help navigate through the lists of items. Every URL object will contain an href and a type field.
An object with several relevant URLs. Every URL object will contain an href and a type field.
Allows you to preset the language to be used.
Allows you to preset the language to be used.
Luxembourg legal entities types. lu-ei - Entreprise individuelle (EI) lu-lpf - Luxembourg Private Foundation (LPF) lu-sa - Société anonyme (S.A.) lu-sarl - Société à responsabilité limitée (SARL) lu-sarl-s - Société à responsabilité limitée simplifée (SARL-S) lu-sas - Société par actions simplifiée (SAS) lu-sc - Société civile (SC) lu-sca - Société en commandite par actions (SCA) lu-sci - Société civile immobilières (SCI) lu-scsp - Société en commandite special (SCSp) lu-secs - Société en commandite simple (SECS) lu-senc - Société en nom collectif (SENC) * lu-trust - Trust
Luxembourg legal entities types. lu-ei - Entreprise individuelle (EI) lu-lpf - Luxembourg Private Foundation (LPF) lu-sa - Société anonyme (S.A.) lu-sarl - Société à responsabilité limitée (SARL) lu-sarl-s - Société à responsabilité limitée simplifée (SARL-S) lu-sas - Société par actions simplifiée (SAS) lu-sc - Société civile (SC) lu-sca - Société en commandite par actions (SCA) lu-sci - Société civile immobilières (SCI) lu-scsp - Société en commandite special (SCSp) lu-secs - Société en commandite simple (SECS) lu-senc - Société en nom collectif (SENC) * lu-trust - Trust
The card's label. Available for card mandates, if the card label could be detected.
The card's label. Available for card mandates, if the card label could be detected.
Payment method of the mandate. SEPA Direct Debit and PayPal mandates can be created directly.
Payment method of the mandate. SEPA Direct Debit and PayPal mandates can be created directly.
The status of the mandate. A status can be pending for mandates when the first payment is not yet finalized, or when we did not received the IBAN yet from the first payment.
The status of the mandate. A status can be pending for mandates when the first payment is not yet finalized, or when we did not received the IBAN yet from the first payment.
Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
Normally, a payment method screen is shown. However, when using this parameter, you can choose a specific payment method and your customer will skip the selection screen and is sent directly to the chosen payment method. The parameter enables you to fully integrate the payment method selection into your website. You can also specify the methods in an array. By doing so we will still show the payment method selection screen but will only show the methods specified in the array. For example, you can use this functionality to only show payment methods from a specific country to your customer ['bancontact', 'belfius'].
Normally, a payment method screen is shown. However, when using this parameter, you can choose a specific payment method and your customer will skip the selection screen and is sent directly to the chosen payment method. The parameter enables you to fully integrate the payment method selection into your website. You can also specify the methods in an array. By doing so we will still show the payment method selection screen but will only show the methods specified in the array. For example, you can use this functionality to only show payment methods from a specific country to your customer ['bancontact', 'belfius'].
The status of the issuer. If the status is pending-issuer, an additional action from your side may be required with the issuer.
Normally, a payment method screen is shown. However, when using this parameter, you can choose a specific payment method and your customer will skip the selection screen and is sent directly to the chosen payment method. The parameter enables you to fully integrate the payment method selection into your website. You can also specify the methods in an array. By doing so we will still show the payment method selection screen but will only show the methods specified in the array. For example, you can use this functionality to only show payment methods from a specific country to your customer ['bancontact', 'belfius'].
The payment method's activation status for this profile.
Whether this entity was created in live mode or in test mode.
Netherlands legal entities types. nl-bv - Besloten Vennootschap (BV) nl-cooperatie - Coöperatie nl-cv - Commanditaire Vennootschap (CV) nl-eenmanszaak - Eenmanszaak nl-eesv - Europees Economisch Samenwerkingsverband (EESV) nl-kerkgenootschap - Kerkgenootschap nl-kroondomein - Kroondomein nl-maatschap - Maatschap nl-nv - Naamloze Vennootschap (NV) nl-overheid - Overheidsinstantie nl-sce - Europese Coöperatieve Vennootschap (SCE) nl-se - Europese Naamloze Vennootschap (SE) nl-stichting - Stichting nl-trust - Trust nl-vereniging - Vereniging nl-vof - Vennootschap Onder Firma (VOF) * nl-waarborgmaatschappij - Onderlinge Waarborgmaatschappij
Netherlands legal entities types. nl-bv - Besloten Vennootschap (BV) nl-cooperatie - Coöperatie nl-cv - Commanditaire Vennootschap (CV) nl-eenmanszaak - Eenmanszaak nl-eesv - Europees Economisch Samenwerkingsverband (EESV) nl-kerkgenootschap - Kerkgenootschap nl-kroondomein - Kroondomein nl-maatschap - Maatschap nl-nv - Naamloze Vennootschap (NV) nl-overheid - Overheidsinstantie nl-sce - Europese Coöperatieve Vennootschap (SCE) nl-se - Europese Naamloze Vennootschap (SE) nl-stichting - Stichting nl-trust - Trust nl-vereniging - Vereniging nl-vof - Vennootschap Onder Firma (VOF) * nl-waarborgmaatschappij - Onderlinge Waarborgmaatschappij
Norway legal entities types. no-ans-da - Ansvarlig selskap (ANS/DA) no-as - Aksjeselskap (AS) no-asa - Allmennaksjeselskap (ASA) no-da - Selskap med delt ansvar (DA) no-enk - Enkeltpersonsforetak (ENK) no-ks - Kommandittselskap (KS) no-nuf - Norskregistrert utenlandsk foretak (NUF) no-samvirkeforetak - Samvirkeforetak no-statesforetak - Statesforetak no-stiftelse - Stiftelse
Norway legal entities types. no-ans-da - Ansvarlig selskap (ANS/DA) no-as - Aksjeselskap (AS) no-asa - Allmennaksjeselskap (ASA) no-da - Selskap med delt ansvar (DA) no-enk - Enkeltpersonsforetak (ENK) no-ks - Kommandittselskap (KS) no-nuf - Norskregistrert utenlandsk foretak (NUF) no-samvirkeforetak - Samvirkeforetak no-statesforetak - Statesforetak no-stiftelse - Stiftelse
The current status of the organization's onboarding process.
Mollie applies Dutch VAT for merchants based in The Netherlands, British VAT for merchants based in The United Kingdom, and shifted VAT for merchants in the European Union. The field can be omitted for merchants residing in other countries.
Mollie applies Dutch VAT for merchants based in The Netherlands, British VAT for merchants based in The United Kingdom, and shifted VAT for merchants in the European Union. The field is not present for merchants residing in other countries.
Other business entity.
Other business entity.
The card's target audience, if known.
The card's target audience, if known.
The card type.
The card type.
The card's label, if known.
The card's label, if known.
The level of security applied during card processing.
The level of security applied during card processing.
A failure code to help understand why the payment failed.
A failure code to help understand why the payment failed.
The applicable card fee region.
The applicable card fee region.
The method by which the card was read by the terminal.
The method by which the card was read by the terminal.
The method used to verify the cardholder's identity.
The method used to verify the cardholder's identity.
Indicates to what extent the payment is eligible for PayPal's Seller Protection. Only available for PayPal payments, and if the information is made available by PayPal.
Indicates to what extent the payment is eligible for PayPal's Seller Protection. Only available for PayPal payments, and if the information is made available by PayPal.
The wallet used when creating the payment.
The wallet used when creating the payment.
The type of product purchased. For example, a physical or a digital product. The tip payment line type is not available when creating a payment.
The type of product purchased. For example, a physical or a digital product. The tip payment line type is not available when creating a payment.
Links to help navigate through the lists of items. Every URL object will contain an href and a type field.
The payment method, if applicable
The payment's status. Refer to the documentation regarding statuses for more info about which statuses occur at what point.
The status of the requested changes.
The status of the requested changes.
The profile status determines whether the profile is able to receive live payments. unverified: The profile has not been verified yet and can only be used to create test payments. verified: The profile has been verified and can be used to create live payments and test payments. * blocked: The profile is blocked and can no longer be used or changed.
The profile status determines whether the profile is able to receive live payments. unverified: The profile has not been verified yet and can only be used to create test payments. verified: The profile has been verified and can be used to create live payments and test payments. * blocked: The profile is blocked and can no longer be used or changed.
Portugal legal entities types. pt-cooperativa - Cooperativa pt-eirl - Estabelecimento Individual de Responsabilidade Limitada (EIRL) pt-empresario-nome-individual - Empresário em Nome individual pt-fondo-fiduciario - Fondo Fiduciario pt-fundacao - Fundação pt-sociedade-anonima - Sociedade Anónima pt-sociedade-comandita - Sociedade em Comandita pt-sociedade-nome-colectivo - Sociedade em Nome Colectivo pt-sociedade-quotas - Sociedade por Quotas pt-sociedade-unipessoal-quotas - Sociedade Unipessoal por Quotas
Portugal legal entities types. pt-cooperativa - Cooperativa pt-eirl - Estabelecimento Individual de Responsabilidade Limitada (EIRL) pt-empresario-nome-individual - Empresário em Nome individual pt-fondo-fiduciario - Fondo Fiduciario pt-fundacao - Fundação pt-sociedade-anonima - Sociedade Anónima pt-sociedade-comandita - Sociedade em Comandita pt-sociedade-nome-colectivo - Sociedade em Nome Colectivo pt-sociedade-quotas - Sociedade por Quotas pt-sociedade-unipessoal-quotas - Sociedade Unipessoal por Quotas
Specifies the reference type
Specifies the reference type
The type of source. Currently only the source type organization is supported.
The type of source. Currently only the source type organization is supported.
Payload to create a new delayed route for a payment.
The destination of the route.
The type of destination. Currently only the destination type organization is supported.
The type of destination. Currently only the destination type organization is supported.
The type of discount.
The type of discount.
The way through which the invoice is to be set to paid.
The way through which the invoice is to be set to paid.
The payment term to be set on the invoice.
The payment term to be set on the invoice.
The locale for the recipient, to be used for translations in PDF generation and payment pages.
The locale for the recipient, to be used for translations in PDF generation and payment pages.
The type of recipient, either consumer or business. This will determine what further fields are required on the recipient object.
The type of recipient, either consumer or business. This will determine what further fields are required on the recipient object.
The status for the invoice to end up in. A draft invoice is not paid or not sent and can be updated after creation. Setting it to issued sends it to the recipient so they may then pay through our payment system. To skip our payment process, set this to paid to mark it as paid. It can then subsequently be sent as well, same as with issued. A status value that cannot be set but can be returned is canceled, for invoices which were issued, but then canceled. Currently this can only be done for invoices created in the dashboard. Dependent parameters: - paymentDetails is required if invoice should be set directly to paid - customerId and mandateId are required if a recurring payment should be used to set the invoice to paid - emailDetails optional for issued and paid to send the invoice by email
The status for the invoice to end up in. A draft invoice is not paid or not sent and can be updated after creation. Setting it to issued sends it to the recipient so they may then pay through our payment system. To skip our payment process, set this to paid to mark it as paid. It can then subsequently be sent as well, same as with issued. A status value that cannot be set but can be returned is canceled, for invoices which were issued, but then canceled. Currently this can only be done for invoices created in the dashboard. Dependent parameters: - paymentDetails is required if invoice should be set directly to paid - customerId and mandateId are required if a recurring payment should be used to set the invoice to paid - emailDetails optional for issued and paid to send the invoice by email
The VAT mode to use for VAT calculation. exclusive mode means we will apply the relevant VAT on top of the price. inclusive means the prices you are providing to us already contain the VAT you want to apply.
The VAT mode to use for VAT calculation. exclusive mode means we will apply the relevant VAT on top of the price. inclusive means the prices you are providing to us already contain the VAT you want to apply.
The VAT scheme to create the invoice for. You must be enrolled with One Stop Shop enabled to use it.
The VAT scheme to create the invoice for. You must be enrolled with One Stop Shop enabled to use it.
Sweden legal entities types. se-ab - Aktiebolag (AB) se-ab-publ - AB (publ) se-ekonomisk-forening - Ekonomisk förening se-enkla-bolag - Enkla bolag se-enskild-firma - Enskild firma se-fillial-utlandskt-bolag - Fillial till utländskt bolag se-hb - Handelsbolag (HB) se-ideel-forening - Ideel förening se-kb - Kommanditbolag (KB) se-samriskforetag - Samriskföretag se-stiftelse - Stiftelse se-trust - Trust
Sweden legal entities types. se-ab - Aktiebolag (AB) se-ab-publ - AB (publ) se-ekonomisk-forening - Ekonomisk förening se-enkla-bolag - Enkla bolag se-enskild-firma - Enskild firma se-fillial-utlandskt-bolag - Fillial till utländskt bolag se-hb - Handelsbolag (HB) se-ideel-forening - Ideel förening se-kb - Kommanditbolag (KB) se-samriskforetag - Samriskföretag se-stiftelse - Stiftelse se-trust - Trust
The status of the settlement.
This object offers details about the status of a payment. Currently it is only available for point-of-sale payments. You can find more information about the possible values of this object on this page.**
The payment method used for this subscription. If omitted, any of the customer's valid mandates may be used.
The payment method used for this subscription. If omitted, any of the customer's valid mandates may be used.
The subscription's current status is directly related to the status of the underlying customer or mandate that is enabling the subscription.
The subscription's current status is directly related to the status of the underlying customer or mandate that is enabling the subscription.
The brand of the terminal.
The model of the terminal. For example for a PAX A920, this field's value will be A920.
The status of the terminal.
In v2 endpoints, URLs are commonly represented as objects with an href and type field.
In v2 endpoints, URLs are commonly represented as objects with an href and type field.
Information regarding the contractor. Only relevant for voucher issuers.
URLs of images representing the payment method issuer.
The list of events to enable for this webhook. You may specify '*' to add all events, except those that require explicit selection.
The list of events to enable for this webhook. You may specify '*' to add all events, except those that require explicit selection.
The subscription's current status.
Helper functions for building Tesla requests