POST
/api/alternative-payments/v1/refund
Refund transaction after confirmation.
Common response statuses:
Status: success Status Code: refund_successful - alternative payment installment was successfully refunded
Status: pending Status Code: pending - wait for bank refund, final status will be set via callback
Status: failure Status Code: any - depends on error
Select media type application/json object products
List of products for refund.
Required in case of partial refund for projects with enabled fiscalization.
For full refund products would be taken from create request.
Array<object>
object external_id
Id of the product on the merchant side.
string
tax_group
Tax group is required for projects with enabled fiscalization.
1: ПДВ 20%
2: Без ПДВ
3: ПДВ 20% + акциз 5%
4: ПДВ 7%
5: ПДВ 0%
6: Без ПДВ + акциз 5%
7: Не є об`єктом ПДВ
8: ПДВ 20% + ПФ 7.5%
9: ПДВ 14%
integer
POST
$request.body#/callback_url
Return operations data if order was processed successfully or occurred the business error
X-ROZETKAPAY-SIGNATURE
string
With this header, you can verify if the callback is from RozetkaPay.
Calculation algorithm:
signature=base64url_encode(sha1($password + base64url_encode($json_body) + $password))
Select media type application/json object details
object method
string
Allowed values: create confirm cancel refund
status
string
Allowed values: init pending success failure
status_code
Possible status codes grouped by status:
Status Status Code Description success transaction_successful Transaction successful. success contract_was_signed_on_client_side The contract was signed on the client side. success refund_successful Refund successful. pending pending Pending. failure failed_to_create_transaction Failed to create transaction. failure internal_error Internal error. failure transaction_not_found Transaction not found. failure wrong_cooperation_type Wrong cooperation type. failure transaction_rejected Transaction rejected. pending waiting_for_redirect Waiting for redirect. pending confirmation_required Confirmation required. failure order_expired Order expired. failure transaction_declined Transaction declined. failure user_not_found User not found. failure insufficient_funds Insufficient funds. failure transaction_is_canceled_by_payer Transaction is canceled by payer. failure transaction_limit_exceeded Transaction limit exceeded. failure transaction_not_supported Transaction not supported. failure wrong_payment_count Wrong number of payment count. failure wrong_installment_period Wrong installment period. failure banking_application_is_not_installed Banking application is not installed. failure bank_is_not_supported The bank is not supported. failure invalid_phone_number Invalid phone number. failure simultaneous_open_orders_not_supported_by_bank Simultaneous open orders are not supported by the bank. failure transaction_amount_limit Transaction amount limit. failure finmon_validation_failed Finmon validation failed. failure insufficient_funds_for_refund Insufficient funds on account for refund.
string
Allowed values: authorization_failed customer_auth_not_found request_failed internal_error access_not_allowed invalid_request_body payment_settings_not_found transaction_already_paid action_not_allowed action_already_done transaction_success_primary_not_found payment_method_not_allowed wallet_not_configured payment_method_already_confirmed payment_method_not_found invalid_card_token customer_auth_token_expired_or_invalid customer_profile_not_found customer_id_not_passed transaction_not_found waiting_for_verification transaction_amount_limit invalid_data transaction_declined authorization_error transaction_rejected transaction_successful anti_fraud_check card_not_supported confirmation_timeout invalid_card_data invalid_currency pending waiting_for_complete access_error card_expired receiver_info_error transaction_limit_exceeded transaction_not_supported 3ds_not_supported 3ds_required failed_to_create_transaction failed_to_finish_transaction insufficient_funds invalid_phone_number card_has_constraints pin_tries_exceeded session_expired timeout transaction_created waiting_for_redirect wrong_amount test_transaction subscription_successful unsubscribed_successfully wrong_pin wrong_authorization_code wrong_cavv wrong_cvv wrong_account_number confirm_required cvv_is_required confirmation_required sender_info_required missed_payout_method_data card_verification_required incorrect_refund_sum_or_currency payment_card_has_invalid_status wrong_card_number user_not_found failed_to_send_sms wrong_sms_password card_not_found payment_system_not_supported country_not_supported no_discount_found failed_to_load_wallet invalid_verification_code additional_information_is_pending transaction_is_not_recurring confirm_amount_cannot_be_more_than_the_transaction_amount card_bin_not_found currency_rate_not_found invalid_recipient_name daily_card_usage_limit_reached invalid_transaction_amount card_type_is_not_supported store_is_blocked store_is_not_active payment_method_not_found transaction_cannot_be_processed invalid_transaction_status public_key_not_found terminal_not_found fee_not_found failed_to_verify_card invalid_transaction_type restricted_ip invalid_token preauth_not_allowed token_does_not_exist reached_the_limit_of_attempts_for_ip card_branch_is_blocked card_branch_daily_limit_reached completion_limit_reached recurring_transactions_not_allowed transaction_is_canceled_by_payer payment_was_refunded card_is_lost_or_stolen plan_not_found plan_not_active plan_project_missing subscription_auto_renew_locked subscription_not_found subscription_not_active subscription_already_exists order_canceled
fiscalization
object fiscal_url
Fiscalization receipt URL
string
status
string
Allowed values: Pending Success Failed
status_code
Fiscalization status code
1000: Test result
1001: Operation successful
1002: Operation in progress
2001: Invalid fiscalization data. Please verify product information
2002: Internal error. Please contact support
2003: Not authorized. Please check your permissions
2004: Temporary failure. Please try again later
2005: Fiscalization service temporarily unavailable
2006: Not authorized. Please verify your token
3001: Required data not found
3002: Duplicate attempt detected
4001: Cash register not activated in tax system
4002: Cash register blocked. Please contact support
4003: Cash register data conflict detected. Please try again later
4004: Cash register processing another operation. Please try again later
4005: Cannot change cash register operating mode
4006: Cash register locked by another application. Please close all other fiscal software
4050: Fiscal shift not opened. Please open a shift in your cash register before processing transactions
4051: Fiscal shift is not closed. Please close the current shift
5001: Electronic signature key not registered with tax authorities. Please register your EDS key in the tax system before enabling fiscalization
5002: Electronic signature key has been revoked. Please obtain and register a new EDS certificate
5003: Electronic signature verification failed. Please check your EDS key validity and permissions
6001: Tax authority service error. Please contact support
6002: Tax authority service unavailable. Please try again later
6003: Tax authority response timeout. Please try again later
7001: Fiscal receipt validation failed. Receipt sequence broken. Please contact support
7002: Fiscal receipt generation failed. Please contact support
integer
status_description
Fiscalization status description
string
action_required
A boolean flag which indicates if action from the customer is required
boolean
action
Object which contains information about required post-request action. Will be null if action not required.
object value
Action value. Usually it’s a checkout url or 3ds verification url.
string
receipt_url
Link to the receipt for user
string
Shows that callback was accepted. No further callback after this response.
Select media type application/json object details
object method
string
Allowed values: create
status
string
Allowed values: init pending success failure
status_code
Possible status codes grouped by status:
Status Status Code Description success transaction_successful Transaction successful. success contract_was_signed_on_client_side The contract was signed on the client side. success refund_successful Refund successful. pending pending Pending. failure failed_to_create_transaction Failed to create transaction. failure internal_error Internal error. failure transaction_not_found Transaction not found. failure wrong_cooperation_type Wrong cooperation type. failure transaction_rejected Transaction rejected. pending waiting_for_redirect Waiting for redirect. pending confirmation_required Confirmation required. failure order_expired Order expired. failure transaction_declined Transaction declined. failure user_not_found User not found. failure insufficient_funds Insufficient funds. failure transaction_is_canceled_by_payer Transaction is canceled by payer. failure transaction_limit_exceeded Transaction limit exceeded. failure transaction_not_supported Transaction not supported. failure wrong_payment_count Wrong number of payment count. failure wrong_installment_period Wrong installment period. failure banking_application_is_not_installed Banking application is not installed. failure bank_is_not_supported The bank is not supported. failure invalid_phone_number Invalid phone number. failure simultaneous_open_orders_not_supported_by_bank Simultaneous open orders are not supported by the bank. failure transaction_amount_limit Transaction amount limit. failure finmon_validation_failed Finmon validation failed. failure insufficient_funds_for_refund Insufficient funds on account for refund.
string
Allowed values: authorization_failed customer_auth_not_found request_failed internal_error access_not_allowed invalid_request_body payment_settings_not_found transaction_already_paid action_not_allowed action_already_done transaction_success_primary_not_found payment_method_not_allowed wallet_not_configured payment_method_already_confirmed payment_method_not_found invalid_card_token customer_auth_token_expired_or_invalid customer_profile_not_found customer_id_not_passed transaction_not_found waiting_for_verification transaction_amount_limit invalid_data transaction_declined authorization_error transaction_rejected transaction_successful anti_fraud_check card_not_supported confirmation_timeout invalid_card_data invalid_currency pending waiting_for_complete access_error card_expired receiver_info_error transaction_limit_exceeded transaction_not_supported 3ds_not_supported 3ds_required failed_to_create_transaction failed_to_finish_transaction insufficient_funds invalid_phone_number card_has_constraints pin_tries_exceeded session_expired timeout transaction_created waiting_for_redirect wrong_amount test_transaction subscription_successful unsubscribed_successfully wrong_pin wrong_authorization_code wrong_cavv wrong_cvv wrong_account_number confirm_required cvv_is_required confirmation_required sender_info_required missed_payout_method_data card_verification_required incorrect_refund_sum_or_currency payment_card_has_invalid_status wrong_card_number user_not_found failed_to_send_sms wrong_sms_password card_not_found payment_system_not_supported country_not_supported no_discount_found failed_to_load_wallet invalid_verification_code additional_information_is_pending transaction_is_not_recurring confirm_amount_cannot_be_more_than_the_transaction_amount card_bin_not_found currency_rate_not_found invalid_recipient_name daily_card_usage_limit_reached invalid_transaction_amount card_type_is_not_supported store_is_blocked store_is_not_active payment_method_not_found transaction_cannot_be_processed invalid_transaction_status public_key_not_found terminal_not_found fee_not_found failed_to_verify_card invalid_transaction_type restricted_ip invalid_token preauth_not_allowed token_does_not_exist reached_the_limit_of_attempts_for_ip card_branch_is_blocked card_branch_daily_limit_reached completion_limit_reached recurring_transactions_not_allowed transaction_is_canceled_by_payer payment_was_refunded card_is_lost_or_stolen plan_not_found plan_not_active plan_project_missing subscription_auto_renew_locked subscription_not_found subscription_not_active subscription_already_exists order_canceled
action
Object which contains information about required post-request action. Will be null if action not required.
object value
Action value. Usually it’s a checkout url or 3ds verification url.
string
Select media type application/json object code
string
Allowed values: authorization_failed customer_auth_not_found request_failed internal_error access_not_allowed invalid_request_body payment_settings_not_found transaction_already_paid action_not_allowed action_already_done transaction_success_primary_not_found payment_method_not_allowed wallet_not_configured payment_method_already_confirmed payment_method_not_found invalid_card_token customer_auth_token_expired_or_invalid customer_profile_not_found customer_id_not_passed transaction_not_found waiting_for_verification transaction_amount_limit invalid_data transaction_declined authorization_error transaction_rejected transaction_successful anti_fraud_check card_not_supported confirmation_timeout invalid_card_data invalid_currency pending waiting_for_complete access_error card_expired receiver_info_error transaction_limit_exceeded transaction_not_supported 3ds_not_supported 3ds_required failed_to_create_transaction failed_to_finish_transaction insufficient_funds invalid_phone_number card_has_constraints pin_tries_exceeded session_expired timeout transaction_created waiting_for_redirect wrong_amount test_transaction subscription_successful unsubscribed_successfully wrong_pin wrong_authorization_code wrong_cavv wrong_cvv wrong_account_number confirm_required cvv_is_required confirmation_required sender_info_required missed_payout_method_data card_verification_required incorrect_refund_sum_or_currency payment_card_has_invalid_status wrong_card_number user_not_found failed_to_send_sms wrong_sms_password card_not_found payment_system_not_supported country_not_supported no_discount_found failed_to_load_wallet invalid_verification_code additional_information_is_pending transaction_is_not_recurring confirm_amount_cannot_be_more_than_the_transaction_amount card_bin_not_found currency_rate_not_found invalid_recipient_name daily_card_usage_limit_reached invalid_transaction_amount card_type_is_not_supported store_is_blocked store_is_not_active payment_method_not_found transaction_cannot_be_processed invalid_transaction_status public_key_not_found terminal_not_found fee_not_found failed_to_verify_card invalid_transaction_type restricted_ip invalid_token preauth_not_allowed token_does_not_exist reached_the_limit_of_attempts_for_ip card_branch_is_blocked card_branch_daily_limit_reached completion_limit_reached recurring_transactions_not_allowed transaction_is_canceled_by_payer payment_was_refunded card_is_lost_or_stolen plan_not_found plan_not_active plan_project_missing subscription_auto_renew_locked subscription_not_found subscription_not_active subscription_already_exists order_canceled
type
string
Allowed values: invalid_request_error payment_method_error payment_settings_error payment_error api_error customer_error
Select media type application/json object code
string
Allowed values: authorization_failed customer_auth_not_found request_failed internal_error access_not_allowed invalid_request_body payment_settings_not_found transaction_already_paid action_not_allowed action_already_done transaction_success_primary_not_found payment_method_not_allowed wallet_not_configured payment_method_already_confirmed payment_method_not_found invalid_card_token customer_auth_token_expired_or_invalid customer_profile_not_found customer_id_not_passed transaction_not_found waiting_for_verification transaction_amount_limit invalid_data transaction_declined authorization_error transaction_rejected transaction_successful anti_fraud_check card_not_supported confirmation_timeout invalid_card_data invalid_currency pending waiting_for_complete access_error card_expired receiver_info_error transaction_limit_exceeded transaction_not_supported 3ds_not_supported 3ds_required failed_to_create_transaction failed_to_finish_transaction insufficient_funds invalid_phone_number card_has_constraints pin_tries_exceeded session_expired timeout transaction_created waiting_for_redirect wrong_amount test_transaction subscription_successful unsubscribed_successfully wrong_pin wrong_authorization_code wrong_cavv wrong_cvv wrong_account_number confirm_required cvv_is_required confirmation_required sender_info_required missed_payout_method_data card_verification_required incorrect_refund_sum_or_currency payment_card_has_invalid_status wrong_card_number user_not_found failed_to_send_sms wrong_sms_password card_not_found payment_system_not_supported country_not_supported no_discount_found failed_to_load_wallet invalid_verification_code additional_information_is_pending transaction_is_not_recurring confirm_amount_cannot_be_more_than_the_transaction_amount card_bin_not_found currency_rate_not_found invalid_recipient_name daily_card_usage_limit_reached invalid_transaction_amount card_type_is_not_supported store_is_blocked store_is_not_active payment_method_not_found transaction_cannot_be_processed invalid_transaction_status public_key_not_found terminal_not_found fee_not_found failed_to_verify_card invalid_transaction_type restricted_ip invalid_token preauth_not_allowed token_does_not_exist reached_the_limit_of_attempts_for_ip card_branch_is_blocked card_branch_daily_limit_reached completion_limit_reached recurring_transactions_not_allowed transaction_is_canceled_by_payer payment_was_refunded card_is_lost_or_stolen plan_not_found plan_not_active plan_project_missing subscription_auto_renew_locked subscription_not_found subscription_not_active subscription_already_exists order_canceled
type
string
Allowed values: invalid_request_error payment_method_error payment_settings_error payment_error api_error customer_error
Select media type application/json object code
string
Allowed values: authorization_failed customer_auth_not_found request_failed internal_error access_not_allowed invalid_request_body payment_settings_not_found transaction_already_paid action_not_allowed action_already_done transaction_success_primary_not_found payment_method_not_allowed wallet_not_configured payment_method_already_confirmed payment_method_not_found invalid_card_token customer_auth_token_expired_or_invalid customer_profile_not_found customer_id_not_passed transaction_not_found waiting_for_verification transaction_amount_limit invalid_data transaction_declined authorization_error transaction_rejected transaction_successful anti_fraud_check card_not_supported confirmation_timeout invalid_card_data invalid_currency pending waiting_for_complete access_error card_expired receiver_info_error transaction_limit_exceeded transaction_not_supported 3ds_not_supported 3ds_required failed_to_create_transaction failed_to_finish_transaction insufficient_funds invalid_phone_number card_has_constraints pin_tries_exceeded session_expired timeout transaction_created waiting_for_redirect wrong_amount test_transaction subscription_successful unsubscribed_successfully wrong_pin wrong_authorization_code wrong_cavv wrong_cvv wrong_account_number confirm_required cvv_is_required confirmation_required sender_info_required missed_payout_method_data card_verification_required incorrect_refund_sum_or_currency payment_card_has_invalid_status wrong_card_number user_not_found failed_to_send_sms wrong_sms_password card_not_found payment_system_not_supported country_not_supported no_discount_found failed_to_load_wallet invalid_verification_code additional_information_is_pending transaction_is_not_recurring confirm_amount_cannot_be_more_than_the_transaction_amount card_bin_not_found currency_rate_not_found invalid_recipient_name daily_card_usage_limit_reached invalid_transaction_amount card_type_is_not_supported store_is_blocked store_is_not_active payment_method_not_found transaction_cannot_be_processed invalid_transaction_status public_key_not_found terminal_not_found fee_not_found failed_to_verify_card invalid_transaction_type restricted_ip invalid_token preauth_not_allowed token_does_not_exist reached_the_limit_of_attempts_for_ip card_branch_is_blocked card_branch_daily_limit_reached completion_limit_reached recurring_transactions_not_allowed transaction_is_canceled_by_payer payment_was_refunded card_is_lost_or_stolen plan_not_found plan_not_active plan_project_missing subscription_auto_renew_locked subscription_not_found subscription_not_active subscription_already_exists order_canceled
type
string
Allowed values: invalid_request_error payment_method_error payment_settings_error payment_error api_error customer_error
Select media type application/json object code
string
Allowed values: authorization_failed customer_auth_not_found request_failed internal_error access_not_allowed invalid_request_body payment_settings_not_found transaction_already_paid action_not_allowed action_already_done transaction_success_primary_not_found payment_method_not_allowed wallet_not_configured payment_method_already_confirmed payment_method_not_found invalid_card_token customer_auth_token_expired_or_invalid customer_profile_not_found customer_id_not_passed transaction_not_found waiting_for_verification transaction_amount_limit invalid_data transaction_declined authorization_error transaction_rejected transaction_successful anti_fraud_check card_not_supported confirmation_timeout invalid_card_data invalid_currency pending waiting_for_complete access_error card_expired receiver_info_error transaction_limit_exceeded transaction_not_supported 3ds_not_supported 3ds_required failed_to_create_transaction failed_to_finish_transaction insufficient_funds invalid_phone_number card_has_constraints pin_tries_exceeded session_expired timeout transaction_created waiting_for_redirect wrong_amount test_transaction subscription_successful unsubscribed_successfully wrong_pin wrong_authorization_code wrong_cavv wrong_cvv wrong_account_number confirm_required cvv_is_required confirmation_required sender_info_required missed_payout_method_data card_verification_required incorrect_refund_sum_or_currency payment_card_has_invalid_status wrong_card_number user_not_found failed_to_send_sms wrong_sms_password card_not_found payment_system_not_supported country_not_supported no_discount_found failed_to_load_wallet invalid_verification_code additional_information_is_pending transaction_is_not_recurring confirm_amount_cannot_be_more_than_the_transaction_amount card_bin_not_found currency_rate_not_found invalid_recipient_name daily_card_usage_limit_reached invalid_transaction_amount card_type_is_not_supported store_is_blocked store_is_not_active payment_method_not_found transaction_cannot_be_processed invalid_transaction_status public_key_not_found terminal_not_found fee_not_found failed_to_verify_card invalid_transaction_type restricted_ip invalid_token preauth_not_allowed token_does_not_exist reached_the_limit_of_attempts_for_ip card_branch_is_blocked card_branch_daily_limit_reached completion_limit_reached recurring_transactions_not_allowed transaction_is_canceled_by_payer payment_was_refunded card_is_lost_or_stolen plan_not_found plan_not_active plan_project_missing subscription_auto_renew_locked subscription_not_found subscription_not_active subscription_already_exists order_canceled
type
string
Allowed values: invalid_request_error payment_method_error payment_settings_error payment_error api_error customer_error