Enable gift card issuer

Profiles API v2
POSThttps://api.mollie.com/v2/profiles/*id*/methods/giftcard/issuers/*issuer
Authentication:Organization access tokensApp access tokens
POSThttps://api.mollie.com/v2/profiles/me/methods/giftcard/issuers/*issuer*
Authentication:API keys

Enable a gift card issuer on a specific or authenticated profile to use it with payments.

Parameters

Replace id in the endpoint URL by the profile’s ID, for example pfl_v9hTwCvYqw and issuer with the name of the issuer’s ID you want to activate, for example festivalcadeau. There is no need to set body parameters in this POST request.

Response

201 application/hal+json

resourcestring
Indicates the response contains an issuer object. Will always contain issuer for this endpoint.
idstring
The unique identifier of the gift card issuer.
descriptionstring
The full name of the gift card issuer.
statusstring

The status that the issuer is in.

Possible values:

  • activated: The issuer is activated and ready for use.
  • pending-issuer: Activation of this issuer relies on you taking action with the issuer itself.
_linksobject

An object with several URL objects relevant to the gift card issuer. Every URL object will contain an href and a type field.

Show child parameters

selfURL object
The API resource URL of the gift card issuer itself.
documentationURL object
The URL to the gift card issuer retrieval endpoint documentation.

Request

cURLPHPPythonRubyNode.js
1
2
curl -X POST https://api.mollie.com/v2/profiles/pfl_v9hTwCvYqw/methods/giftcard/issuers/festivalcadeau \
     -H "Authorization: Bearer access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ"

1
2
3
4
5
6
7
from mollie.api.client import Client

mollie_client = Client()
mollie_client.set_access_token("access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ")

profile = mollie_client.profiles.get("pfl_v9hTwCvYqw")
issuer = profile.methods.enable_issuer("giftcard", "festivalcadeau")

1
2
3
4
We don't have a PHP code example for this API call yet.

If you have some time to spare, feel free to share suggestions on our Discord:
https://discord.gg/VaTVkXB4aQ

1
2
3
4
We don't have a Ruby code example for this API call yet.

If you have some time to spare, feel free to share suggestions on our Discord:
https://discord.gg/VaTVkXB4aQ

1
2
3
4
We don't have a Node.js code example for this API call yet.

If you have some time to spare, feel free to share suggestions on our Discord:
https://discord.gg/VaTVkXB4aQ

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
HTTP/1.1 201 Created
Content-Type: application/hal+json; charset=utf-8

 {
     "resource": "issuer",
     "id": "festivalcadeau",
     "description": "FestivalCadeau Giftcard",
     "status": "pending-issuer",
     "_links": {
         "self": {
             "href": "https://api.mollie.com/v2/issuers/festivalcadeau",
             "type": "application/hal+json"
         },
         "documentation": {
             "href": "https://docs.mollie.com/reference/v2/profiles-api/enable-giftcard-issuer",
             "type": "text/html"
         }
     }
 }