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
X-Api-Key Authentication API Key. String
Format: uuid
Example: 625b4884-38f8-11ed-a261-0242ac120002
Correlation-Id Unique identifier of the request. String
Format: uuid
Example: 4935e818-38e0-11ed-a261-0242ac120002
PARAM PATH
NAME DESCRIPTION FORMAT
reservationId Merchant reservation id, unique in the merchant domain String
Format: uuid
PARAM QUERY
NAME DESCRIPTION FORMAT
No param query
PARAM BODY

NAME DESCRIPTION FORMAT
linkExpirationDate Expiration date for Paybylink. String
Example: 2022-09-01
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
Arrow RESPONSE 200
Success - No Header for this response
BODY
NAME DESCRIPTION FORMAT
paymentLink Object containing the payment link detail. Object
linkId Unique identifier for this link. String
Example: 92864835
amount Transaction amount in smallest currency unit. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals). String
Example: 3545
expirationDate Expiration date. String
Example: 2022-09-01
link Link to be shared with the customer for doing the payment. String
Example: https://{gateway_hosted_page}
paidByOperationId Operation ID identifying the successful payment related to this link. String
Example: 3470744
securityToken Token which may be used for validating the notifications related. to this payment String
Example: 2f0ea5059b41414ca3744fe672327d85
Arrow RESPONSE 400
Invalid request data - No Header for this response
BODY
NAME DESCRIPTION FORMAT
errors Array containing the errors list. The possible values are shown in the table Error codes. Array
code Error code. String
Example: GW0001
description Error description. String
Example: Invalid merchant URL
Arrow RESPONSE 401
Unauthorized - No Header and Body for this response
Arrow RESPONSE 500
Internal Server Error - No Header for this response
BODY
NAME DESCRIPTION FORMAT
errors Array containing the errors list. The possible values are shown in the table Error codes. Array
code Error code. String
Example: GW0001
description Error description. String
Example: Invalid merchant URL