Voucher:payment

post

https://connect.pay.nl/v2/vouchers/payment

This endpoint initiates a voucher (gift card) payment in the Transaction Gateway Unit API. It allows your system to process a payment using a voucher as the payment method in a direct request.

Use this API when you want to charge a voucher for an order amount and begin a payment transaction using voucher credentials (e.g., card number and PIN). This is part of the voucher & gift card payment flow, enabling you to handle voucher-based payments directly through your backend integration.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The new Voucher resource

serviceId

string | null

Unique service location (SL-code) required when authenticating with Merchant API Tokens (AT-code + Token)

description

string | null

Is shown on the statement of the payer.

reference

string | null

A unique reference defined in the merchant’s system for this transaction. This field only allows alphanumeric characters.

returnUrl

uri | null

The URL where the payer will be sent to after the payment.

exchangeUrl

uri | null

The URL where we exchange the status of a transaction.

amount

object

required

pointOfInteraction

string | null

enum

voucher

object

required

customer

order

stats

transferData

object | null

Headers

Pay-Environment

string

enum

Defaults to prod

The environment that should be used to create the voucher payment.

Allowed:

Pay-Application

string

length ≤ 100

The application name that was used to create the voucher payment.

Pay-Application-Version

string

length ≤ 32

The application version that was used to create the voucher payment.

Pay-Plugin

string

length ≤ 100

The plugin name that was used to create the voucher payment.

Pay-Plugin-Version

string

length ≤ 32

The version of the plugin that was used to create the voucher payment.

Responses

400

Invalid input

422

Unprocessable entity

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Captured a voucher payment.