Request single payment

1. Create payment request

Create a PIR. Send an HTTP POST request to the relevant endpoint + /api/v1/payments/ including the header Authorization: Bearer <payment_token>. You can use the same payment token generated previously.


curl --location --request POST ''
--header 'Authorization: Bearer <payment_token>'
--header 'Content-Type: application/json'
--data-raw '{
  	"amount": "5.95",
  	"currency": "GBP",
    "destinationAccount": "GBP1",
  	"description": "Web payment",
    "callbackUrl": "",
    "mediaType": "URL",
    "countries": ["GB"],
    "customerReference": "123",
    "merchantReference": "ABC",
    "expiration": {
    	"unit": "DAYS",
    	"value": 1
amountAmount to be paid.
currencyThe three-character payment currency using ISO 4217. Vyne supports GBP and EUR.
destinationAccountSpecifies the ID of the merchant's destination bank account (e.g. GBP1). More on bank accounts here. Use this to specify a settlement account in order to use confirmation of funds received, refunds, and payouts.
descriptionAn internal description - can be up to 250 characters alphanumeric.
callbackUrlThe URL the payer will be redirected back to after the authorisation is completed - can be up to 255 characters.
mediaTypeSpecifies if the response should contain a URL to the payment page or a QR code. Accepted values are QR and URL. Default value is URL.
countriesSpecifies the countries of which banks are available on the bank selection page. Default value is GB.
customerReferenceReference field for customer ID - can be up to 128 characters alphanumeric. Optional field, but required for use of payouts.
merchantReferenceReference field for order ID - can be up to 256 characters and alphanumeric.
serviceTypeDistinguishes between EUR connections supporting SCT (STANDARD) and SCT Inst (ENHANCED) payments. Default value is ENHANCED. Not required for GBP payments.
expirationThe validity duration parameter of the payment (can be set in DAYS, HOURS or MINUTES). Minimum value is 30 minutes and the maximum value is 31 days.

A successful PIR returns a 202 response code and an object.

If something unexpected happened during the request, the API returns an error response with the appropriate HTTP status code and a JSON response that contains detailed information about the problem.


  "redirectUrl": "<redirect_url>",
  "qrCodeUrl": "<qr_code_url>",
  "requestId": "adca2b6a077de1f5",
  "mediaType": "URL"
redirectUrlThe URL of the hosted checkout page to be presented to consumers. This value is returned when mediaType is URL.
qrCodeUrlThe URL of the QR code which encodes the URL of the payment page. This value is returned when mediaType is QR.
requestId16 digit alphanumeric unique payment identifier.
mediaTypeSpecifies the format the payment link was generated. Possible values URL and QR.


Be aware

If the expiration field was not specified in the Payment Initiation Request the URL and QR code are only valid for 30 minutes after the Payment Initiation Request was created.

2. Bank selection and consent

Redirect your consumer using the URL or QR code provided in the PIR redirectUrl response. For example, use the URL to redirect users in your application, send the URL as a link in an e-mail, or present the QR code for the consumer to scan on their device. Understand more about how the hosted checkout works and its use cases here.