Qodex.ai

Cancel / Refund Payment

DELETE {{baseUrl}}/payments?payment_id={{payment_reference}}

This API is called to Cancel / Refund your payment. Only use this API to cancel a payment in progress, e.g. a payment initiated on a payment terminal, or to refund a payment without cancelling the order.

In case you would like to cancel AND refund you can simply call the Cancel Reservation or the Cancel Order API (payment_refund:true) which will refund the payment automatically (also upon auto-cancellation due to reservation expiry). Any card authorizations or blocks will be released as well.

Either the order_reference, booking_reference, product_type_transaction_id, payment_id, payment_merchant_reference or payment_service_provider_reference is required to identify the payment(s) to refund. If provided, only the matching payment(s) will be refunded.

Request Params

KeyDatatypeRequiredDescription
order_referencestringA unique order / reservation reference. If provided, all payments linked to this order will be refunded.
booking_referencestring(ADVANCED) In case a booking_reference is provided, a partial refund will be registered. Only the specified booking will be refunded.
product_type_transaction_idnumber(ADVANCED) In case the product_type_transaction_id is provided, a partial refund will be made. Only the specified transaction(s) will be refunded.
payment_idstringUnique Payment ID set by the Prio system. This is an internal identifier.
payment_merchant_referencestringUnique (external) payment reference set by the merchant / (third) party / POS system initiating the payment.
payment_service_provider_referencestringReference set by payment service provider
refund_amountstring(ADVANCED) Amount of money to be refunded. If not provided, the full amount will be refunded.
refund_reasonstringReason for this refund.

RESPONSES

status: OK

{"api_version":"3.4.0","data":{"kind":"contact","payment":{"payment_currency_code":"EUR","payment_merchant_reference":"1478349849927_771663371","payment_method":"EXTERNAL","payment_status":"PAID","payment_type":"CAPTURE","payment_external_reference":"SHOPPER_REFERENCE","payment_order_reference":"ORDRREF123456","payment_scheme":"VISA","payment_recurring_type":"STORE","payment_refund_type":"SYSTEM","payment_refund_reason":"Guest reimbursement","payment_currency_rate":"2.5263","payment_gateway_details":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"payment_contact":{"contact_uid":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_external_uid":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_title":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_name_first":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_name_last":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_phone":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_mobile":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_language":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_nationality":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_flight_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_loyalty_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_birth_place":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_birth_date":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_passport":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_gender":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_age":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_room_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_website":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_classification":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_address":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_notes":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contact_custom_fields":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"payment_notes":[{"note_creator":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"note_date":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"note_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"note_value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"note_creator":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"note_date":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"note_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"note_value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}}}