Enable payment method issuer

Enable an issuer for a payment method on a specific profile.

Currently only the payment methods voucher and giftcard are supported.

When using a profile-specific API credential, the alias me can be used instead of the profile ID to refer to the current profile.

Access with

API key

Advanced access token with profiles.write

OAuth access with profiles.write

Path Params
required

Provide the ID of the related profile.


The identifier referring to the profile this entity belongs to.

Most API credentials are linked to a single profile. In these cases the profileId can be omitted in the creation request. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.

string
required

Provide the ID of the related payment method.

Possible values: voucher giftcard

string
required
length ≥ 1

Provide the ID of the related issuer.

Body Params
string | null

When enabling a voucher issuer, an inbetween party may be involved which you have a contract with. Provide the contract ID for the first time you enable an issuer via this contractor.

You can update the contract ID as long as it is not approved yet, by repeating the API call with a different contract ID.

Responses

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/hal+json