No results

POST/paybylink/{linkId}/cancels

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

Cancel a Pay-By-Link that has not yet been paid. For more information on the Pay-by-Link solution, please refer to the dedicated page Pay-by-Link.

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
linkId Unpaid Pay-By-Link ID to be canceled. String
Example: btid2384983
PARAM QUERY
NAME DESCRIPTION FORMAT
No param query
PARAM BODY

NAME DESCRIPTION FORMAT
No param body
Arrow RESPONSE 200
Link cancelled successful - No Header and Body for this response
Arrow RESPONSE 404
Link not found - No Header and Body for this response
Arrow RESPONSE 400
Request rejected - 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