Create a Refund

Initiates a refund process for a previously completed transaction. The POS application uses this endpoint to request a refund, which will then require action on the SmartPOS device specified by pos_uuid.

Path Parameters
pos_uuid uuid — REQUIRED Unique identifier of the Point of Sale (SmartPOS).

Request Body — REQUIRED Details for the refund request.
payment_intent uuid — REQUIRED Unique identifier of the payment intent.

Responses
201 Refund Process Initiated Successfully Schema — OPTIONAL payment_intent uuid Unique identifier of the payment intent. sale object Information about the original sale. reference_number uuid Reference number of the original parent transaction to be refunded. point_of_sale uuid Unique identifier of the Point of Sale (SmartPOS). amount double Transaction or refund amount. refund object Information about the refund operation. point_of_sale uuid Unique identifier of the Point of Sale (SmartPOS). amount double Transaction or refund amount. status string Possible values: [PENDING, APPROVED, DENIED, ERROR] Status of the refund process. authorization object — OPTIONAL Result of the refund authorization, if available. reference_number string — OPTIONAL Reference number of the refund authorization. transaction_type string — OPTIONAL authorization_code string — OPTIONAL batch_id string — OPTIONAL message_description string — OPTIONAL processor_ref_number string — OPTIONAL ticket_number string — OPTIONAL trace_number integer — OPTIONAL
400 Bad Request (e.g., missing data, invalid format)
404 Point of Sale or Parent Transaction Not Found
422 Unprocessable Entity (e.g., business rule violation, transaction not eligible for refund)