No results

POST/reservations/{reservationId}/paybylink

PROD
https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/reservations/{reservationId}/paybylink
TEST
https://xpaysandbox.nexigroup.com/api/phoenix-0.0/psp/api/v1/reservations/{reservationId}/paybylink

Generate PayByLink for a specific reservation. In case of the first payment for the reservation, a contractId is created. In case of the following payment the existing reservation contractId is used. The contractId is automatically created by the API, to be used later for any noshow, incremental; it is not necessary to send a specific object for its creation. The contractId is not returned in the API response, therefore it cannot be used to perform MIT operations.

PARAM HEADER
NAME DESCRIPTION FORMAT
Correlation-Id Mandatory field in UUID v4 format.
The purpose of this field is to trace the request across different systems, making debugging and request tracking easier.
 String
Format: uuid
Example: 123e4567-e89b-12d3-a456-426614174000
language language String
x-user x-user String
X-Api-Key Authentication API Key. String
Format: uuid
Example: 625b4884-38f8-11ed-a261-0242ac120002
PARAM PATH
NAME DESCRIPTION FORMAT
reservationId reservationId String
PARAM QUERY
NAME DESCRIPTION FORMAT
No param query
PARAM BODY

request

NAME DESCRIPTION FORMAT
captureType Overwrites the default confirmation method of the terminal, for card payments only:
* IMPLICIT - automatic confirmation
* EXPLICIT - authorization only

Default value depends on the terminal configuration.
1. Terminal set to EXPLICIT:
a. if the captureType is EXPLICIT the capture will be EXPLICIT
b. if the captureType is null the capture will be EXPLICIT
c. if the captureType is IMPLICIT the capture will be IMPLICIT

2. Terminal set to IMPLICIT:
a. if the captureType is EXPLICIT the capture will be an error
b. if the captureType is null the capture will be IMPLICIT
c. if the captureType is IMPLICIT the capture will be IMPLICIT
 String
Example: EXPLICIT
linkExpirationDate String
Arrow RESPONSE 200
Success - No Header for this response
BODY
NAME DESCRIPTION FORMAT
paymentLink Object containing the details of the Pay-By-Link link.
 Object
amount Transaction amount in smallest currency unit. 5000 corresponds to 50,00 €. Expressed in the currency of the payment.
 String
expirationDate Expiration date of the Pay-By-Link link.
 String
link Payment URL for Pay-By-Link.
 String
linkId Identifier of the Pay-By-Link link.
 String
paidByOperationId Operation identifier associated with payment through Pay-By-Link link.
 String
status Status of the Pay-By-Link link, possible values:
- ACTIVE
- DELETED
- EXPIRED
- INACTIVE
 String
securityToken Security token used by the merchant to validate the source of the notification. String
Example: f3b2c1d4e5a6b7c8d9e0f1a2b3c4d5e6
warnings Array
code Warning code. String
Example: TRA001
description Warning description. String
Example: 3DS warning
Arrow RESPONSE 201
Created - No Header and Body for this response
Arrow RESPONSE 401
Unauthorized - No Header and Body for this response
Arrow RESPONSE 403
Forbidden - No Header and Body for this response
Arrow RESPONSE 404
Not Found - No Header and Body for this response