No results

POST/operations/{operationId}/refunds

PROD
https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/operations/{operationId}/refunds
TEST
https://xpaysandbox.nexigroup.com/api/phoenix-0.0/psp/api/v1/operations/{operationId}/refunds

Partial/total refund or cancellation based on the order status. For more information on operations, please refer to the dedicated page 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
Idempotency-Key Idempotency key to ensure idempotent requests. It is used to prevent duplicate operations in case of network issues or retries.
The value must be unique for each request and can be up to 128 characters long.
 String
X-Api-Key Authentication API Key. String
Format: uuid
Example: 625b4884-38f8-11ed-a261-0242ac120002
PARAM PATH
NAME DESCRIPTION FORMAT
operationId Identification code of the operation.
 String
Example: 21345
PARAM QUERY
NAME DESCRIPTION FORMAT
No param query
PARAM BODY

refundRequest

NAME DESCRIPTION FORMAT
amount Transaction amount in smallest currency unit. 5000 corresponds to 50,00 €. Expressed in the currency of the payment.
 String
currency Transaction currency. ISO 4217 alphabetic code
 String
Example: EUR
description Free text message available to describe the rationale of the post operation.
 String
Max. length: 255
Arrow RESPONSE 200
Request successfully processed - No Header for this response
BODY
NAME DESCRIPTION FORMAT
operationId Operation ID.
 String
Example: 3470744
operationTime Post operation time.
 String
Example: 2022-09-01T01:20:00.001Z
Arrow RESPONSE 201
Created - 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 403
Forbidden - No Header and Body for this response
Arrow RESPONSE 404
Operation not found - 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

NOTES:
  • If a terminal is configured for explicit capture, any subsequent reversal via the above API must be executed using the operation identifier (operationId) generated during the capture performed via API or back office.
  • If a full refund is performed, a new operation is created within the order's "operations" object with "operationType": "REFUND" and "operationResult": "VOIDED".
    If a partial refund is performed, a new operation is created within the order's "operations" object with "operationType": "REFUND" and "operationResult": "EXECUTED".
    If, after a partial refund, the remaining amount is refunded, a new operation is created within the order's "operations" object with "operationType": "REFUND" and "operationResult": "REFUNDED".