No results

GET/orders/paybylink

PROD
https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/orders/paybylink
TEST
https://xpaysandbox.nexigroup.com/api/phoenix-0.0/psp/api/v1/orders/paybylink

List of Pay-By-Link links created within the specified time interval.

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
No param path
PARAM QUERY
NAME DESCRIPTION FORMAT
fromTime Retrieve links created from this time. ISO 8601 format. Example 2022-01-01T13:10:00.000Z. String
toTime Retrieve links up to this time. ISO 8601 format A maximum interval of one month is allowed. Example 2022-01-01T13:10:00.000Z. String
maxRecords How many items to be returned in one search. Integer
Format: int32
status Status of the links in the search. String
PARAM BODY

NAME DESCRIPTION FORMAT
No param body
Arrow RESPONSE 200
OK - No Header for this response
BODY
NAME DESCRIPTION FORMAT
paymentLinks Array of objects containing the details of the Pay-By-Link links. Array
amount Transaction amount in smallest currency unit. 5000 corresponds to 50,00 €. Expressed in the currency of the payment. String
Example: 100
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
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