No results

POST/v3/paybylink/{id}/modify

PROD
https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v3/paybylink/{id}/modify
TEST
https://xpaysandbox.nexigroup.com/api/phoenix-0.0/psp/api/v3/paybylink/{id}/modify

Edit a PayByLink

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
X-Api-Key Authentication API Key. String
Format: uuid
Example: 625b4884-38f8-11ed-a261-0242ac120002
PARAM PATH
NAME DESCRIPTION FORMAT
id The unique identifier of the Pay By Link. String
PARAM QUERY
NAME DESCRIPTION FORMAT
No param query
PARAM BODY

modifyPayByLinkRequest

NAME DESCRIPTION FORMAT
expirationDateTime The date and time when the Pay By Link will expire. It is in ISO 8601 format. Up to 90 days from the current date.
 String
Example: 2023-12-31T23:59:59Z
maxNumberOfPayments The maximum number of payments that can be made using this Pay By Link. If set to null, there is no limit on the number of payments.
 Integer
status The status of the Pay By Link. It can be ACTIVE, INACTIVE, or DELETED. ACTIVE means the link is active and can be used for payments, INACTIVE means the link is not active and cannot be used for payments, DELETED means the link has been deleted.
 String
Arrow RESPONSE 200
OK - No Header for this response
BODY
NAME DESCRIPTION FORMAT
executedPayments The number of payments that have been executed using this Pay By Link.
 Integer
expirationDateTime The date and time when the Pay By Link will expire. It is in ISO 8601 format. Up to 90 days from the current date.
 String
Example: 2023-12-31T23:59:59Z
linkId The unique identifier of the Pay By Link that has been modified.
 String
maxNumberOfPayments The maximum number of payments that can be made using this Pay By Link. If set to null, there is no limit on the number of payments.
 Integer
pendingPayments The number of payments that are pending for this Pay By Link.
 Integer
status The status of the Pay By Link. It can be ACTIVE, INACTIVE, or DELETED. ACTIVE means the link is active and can be used for payments, INACTIVE means the link is not active and cannot be used for payments, DELETED means the link has been deleted.
 String
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