Methods

Overview

Available Operations

List - List payment methods
All - List all payment methods
Get - Get payment method

List

Retrieve all enabled payment methods. The results of this endpoint are not paginated — unlike most other list endpoints in our API.

For test mode, all pending and enabled payment methods are returned. If no payment methods are requested yet, the most popular payment methods are returned in the test mode. For live mode, only fully enabled payment methods are returned.

Payment methods can be requested and enabled via the Mollie Dashboard, or via the Enable payment method endpoint of the Profiles API.

The list can optionally be filtered using a number of parameters described below.

By default, only payment methods for the Euro currency are returned. If you wish to retrieve payment methods which exclusively support other currencies (e.g. Twint), you need to use the amount parameters.

ℹ️ Note: This endpoint only returns online payment methods. If you wish to retrieve the information about a non-online payment method, you can use the Get payment method endpoint.

Example Usage: list-method-200-3

package main

import(
	"context"
	"os"
	"github.com/mollie/mollie-api-golang/models/components"
	client "github.com/mollie/mollie-api-golang"
	"github.com/mollie/mollie-api-golang/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        client.WithProfileID("pfl_5B8cwPMGnU"),
        client.WithTestmode(false),
        client.WithSecurity(components.Security{
            APIKey: client.Pointer(os.Getenv("CLIENT_API_KEY")),
        }),
    )

    res, err := s.Methods.List(ctx, operations.ListMethodsRequest{
        SequenceType: components.SequenceTypeOneoff.ToPointer(),
        Locale: components.LocaleEnUs.ToPointer(),
        Amount: &components.Amount{
            Currency: "EUR",
            Value: "10.00",
        },
        BillingCountry: client.Pointer("DE"),
        IncludeWallets: components.MethodIncludeWalletsParameterApplepay.ToPointer(),
        OrderLineCategories: components.LineCategoriesEco.ToPointer(),
        Include: client.Pointer("issuers"),
        IdempotencyKey: client.Pointer("123e4567-e89b-12d3-a456-426"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Example Usage: list-methods-200-1

package main

import(
	"context"
	"os"
	"github.com/mollie/mollie-api-golang/models/components"
	client "github.com/mollie/mollie-api-golang"
	"github.com/mollie/mollie-api-golang/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        client.WithProfileID("pfl_5B8cwPMGnU"),
        client.WithTestmode(false),
        client.WithSecurity(components.Security{
            APIKey: client.Pointer(os.Getenv("CLIENT_API_KEY")),
        }),
    )

    res, err := s.Methods.List(ctx, operations.ListMethodsRequest{
        SequenceType: components.SequenceTypeOneoff.ToPointer(),
        Locale: components.LocaleEnUs.ToPointer(),
        Amount: &components.Amount{
            Currency: "EUR",
            Value: "10.00",
        },
        BillingCountry: client.Pointer("DE"),
        IncludeWallets: components.MethodIncludeWalletsParameterApplepay.ToPointer(),
        OrderLineCategories: components.LineCategoriesEco.ToPointer(),
        Include: client.Pointer("issuers"),
        IdempotencyKey: client.Pointer("123e4567-e89b-12d3-a456-426"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Example Usage: list-methods-200-2

package main

import(
	"context"
	"os"
	"github.com/mollie/mollie-api-golang/models/components"
	client "github.com/mollie/mollie-api-golang"
	"github.com/mollie/mollie-api-golang/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        client.WithProfileID("pfl_5B8cwPMGnU"),
        client.WithTestmode(false),
        client.WithSecurity(components.Security{
            APIKey: client.Pointer(os.Getenv("CLIENT_API_KEY")),
        }),
    )

    res, err := s.Methods.List(ctx, operations.ListMethodsRequest{
        SequenceType: components.SequenceTypeOneoff.ToPointer(),
        Locale: components.LocaleEnUs.ToPointer(),
        Amount: &components.Amount{
            Currency: "EUR",
            Value: "10.00",
        },
        BillingCountry: client.Pointer("DE"),
        IncludeWallets: components.MethodIncludeWalletsParameterApplepay.ToPointer(),
        OrderLineCategories: components.LineCategoriesEco.ToPointer(),
        Include: client.Pointer("issuers"),
        IdempotencyKey: client.Pointer("123e4567-e89b-12d3-a456-426"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.ListMethodsRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.ListMethodsResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.ErrorResponse	400	application/hal+json
apierrors.APIError	4XX, 5XX	/

All

Retrieve all payment methods that Mollie offers, regardless of the eligibility of the organization for the specific method. The results of this endpoint are not paginated — unlike most other list endpoints in our API.

The list can optionally be filtered using a number of parameters described below.

ℹ️ Note: This endpoint only returns online payment methods. If you wish to retrieve the information about a non-online payment method, you can use the Get payment method endpoint.

Example Usage: list-all-methods-200-1

package main

import(
	"context"
	"os"
	"github.com/mollie/mollie-api-golang/models/components"
	client "github.com/mollie/mollie-api-golang"
	"github.com/mollie/mollie-api-golang/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        client.WithProfileID("pfl_5B8cwPMGnU"),
        client.WithTestmode(false),
        client.WithSecurity(components.Security{
            APIKey: client.Pointer(os.Getenv("CLIENT_API_KEY")),
        }),
    )

    res, err := s.Methods.All(ctx, operations.ListAllMethodsRequest{
        Locale: components.LocaleEnUs.ToPointer(),
        Amount: &components.Amount{
            Currency: "EUR",
            Value: "10.00",
        },
        Include: client.Pointer("issuers"),
        SequenceType: components.SequenceTypeOneoff.ToPointer(),
        IdempotencyKey: client.Pointer("123e4567-e89b-12d3-a456-426"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Example Usage: list-all-methods-200-2

package main

import(
	"context"
	"os"
	"github.com/mollie/mollie-api-golang/models/components"
	client "github.com/mollie/mollie-api-golang"
	"github.com/mollie/mollie-api-golang/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        client.WithProfileID("pfl_5B8cwPMGnU"),
        client.WithTestmode(false),
        client.WithSecurity(components.Security{
            APIKey: client.Pointer(os.Getenv("CLIENT_API_KEY")),
        }),
    )

    res, err := s.Methods.All(ctx, operations.ListAllMethodsRequest{
        Locale: components.LocaleEnUs.ToPointer(),
        Amount: &components.Amount{
            Currency: "EUR",
            Value: "10.00",
        },
        Include: client.Pointer("issuers"),
        SequenceType: components.SequenceTypeOneoff.ToPointer(),
        IdempotencyKey: client.Pointer("123e4567-e89b-12d3-a456-426"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Example Usage: list-all-methods-200-3

package main

import(
	"context"
	"os"
	"github.com/mollie/mollie-api-golang/models/components"
	client "github.com/mollie/mollie-api-golang"
	"github.com/mollie/mollie-api-golang/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        client.WithProfileID("pfl_5B8cwPMGnU"),
        client.WithTestmode(false),
        client.WithSecurity(components.Security{
            APIKey: client.Pointer(os.Getenv("CLIENT_API_KEY")),
        }),
    )

    res, err := s.Methods.All(ctx, operations.ListAllMethodsRequest{
        Locale: components.LocaleEnUs.ToPointer(),
        Amount: &components.Amount{
            Currency: "EUR",
            Value: "10.00",
        },
        Include: client.Pointer("issuers"),
        SequenceType: components.SequenceTypeOneoff.ToPointer(),
        IdempotencyKey: client.Pointer("123e4567-e89b-12d3-a456-426"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Example Usage: list-all-methods-200-4

package main

import(
	"context"
	"os"
	"github.com/mollie/mollie-api-golang/models/components"
	client "github.com/mollie/mollie-api-golang"
	"github.com/mollie/mollie-api-golang/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        client.WithProfileID("pfl_5B8cwPMGnU"),
        client.WithTestmode(false),
        client.WithSecurity(components.Security{
            APIKey: client.Pointer(os.Getenv("CLIENT_API_KEY")),
        }),
    )

    res, err := s.Methods.All(ctx, operations.ListAllMethodsRequest{
        Locale: components.LocaleEnUs.ToPointer(),
        Amount: &components.Amount{
            Currency: "EUR",
            Value: "10.00",
        },
        Include: client.Pointer("issuers"),
        SequenceType: components.SequenceTypeOneoff.ToPointer(),
        IdempotencyKey: client.Pointer("123e4567-e89b-12d3-a456-426"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.ListAllMethodsRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.ListAllMethodsResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.ErrorResponse	400	application/hal+json
apierrors.APIError	4XX, 5XX	/

Get

Retrieve a single payment method by its ID.

If a method is not available on this profile, a 404 Not Found response is returned. If the method is available but not enabled yet, a status 403 Forbidden is returned. You can enable payments methods via the Enable payment method endpoint of the Profiles API, or via the Mollie Dashboard.

If you do not know the method's ID, you can use the methods list endpoint to retrieve all payment methods that are available.

Additionally, it is possible to check if wallet methods such as Apple Pay are enabled by passing the wallet ID (applepay) as the method ID.

Example Usage

package main

import(
	"context"
	"os"
	"github.com/mollie/mollie-api-golang/models/components"
	client "github.com/mollie/mollie-api-golang"
	"github.com/mollie/mollie-api-golang/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        client.WithProfileID("pfl_5B8cwPMGnU"),
        client.WithTestmode(false),
        client.WithSecurity(components.Security{
            APIKey: client.Pointer(os.Getenv("CLIENT_API_KEY")),
        }),
    )

    res, err := s.Methods.Get(ctx, operations.GetMethodRequest{
        MethodID: components.MethodEnumIdeal.ToPointer(),
        Locale: components.LocaleEnUs.ToPointer(),
        Currency: client.Pointer("EUR"),
        Include: client.Pointer("issuers"),
        SequenceType: components.SequenceTypeOneoff.ToPointer(),
        IdempotencyKey: client.Pointer("123e4567-e89b-12d3-a456-426"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.EntityMethodGet != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.GetMethodRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.GetMethodResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.ErrorResponse	400, 404	application/hal+json
apierrors.APIError	4XX, 5XX	/

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Methods

Overview

Available Operations

List

Example Usage: list-method-200-3

Example Usage: list-methods-200-1

Example Usage: list-methods-200-2

Parameters

Response

Errors

All

Example Usage: list-all-methods-200-1

Example Usage: list-all-methods-200-2

Example Usage: list-all-methods-200-3

Example Usage: list-all-methods-200-4

Parameters

Response

Errors

Get

Example Usage

Parameters

Response

Errors

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Methods

Overview

Available Operations

List

Example Usage: list-method-200-3

Example Usage: list-methods-200-1

Example Usage: list-methods-200-2

Parameters

Response

Errors

All

Example Usage: list-all-methods-200-1

Example Usage: list-all-methods-200-2

Example Usage: list-all-methods-200-3

Example Usage: list-all-methods-200-4

Parameters

Response

Errors

Get

Example Usage

Parameters

Response

Errors