API to the Hola Cash platform.

• Supports:
  • Tokenization: Create and get payment tokens for credit cards.
  • Transaction: Charge, capture, refunds or get payments.
  • Order: Create or get orders.
  • Checkout: Get the checkout button to embed in your app or web page.

Details of Error codes returned by the API in the StatusDetail object in detail.code

Error codes list

Error code	Description
success	Operation successful
generic_error	An error has occurred
invalid_response	An unexpected error occurred
unauthorized	You're not allowed to perform this operation
validation_error	The request contains validation errors
action_required	Further action is required
new_cvv_required	New CVV value required
blocked_by_hola_cash_fraud_detection	This action was blocked by hola.cash fraud detection
transaction_blocked	The transaction has been blocked
invalid_security_credentials	The security credentials are not valid
invalid_anti_fraud_header_multiple	Multiple instances of the anti-fraud header found. Just send one
invalid_anti_fraud_header_format	Invalid format for anti-fraud header, must be a valid JSON object that is converted to string and base64 encoded
invalid_anti_fraud_header_missing_ip_address	Invalid anti-fraud header, missing ip_address
invalid_anti_fraud_header_missing_device_id	Invalid anti-fraud header, missing device_id
invalid_anti_fraud_header_missing_user_timezone	Invalid anti-fraud header, missing user_timezone
invalid_anti_fraud_header_invalid_user_timezone	Invalid format for user_timezone in the anti-fraud header
invalid_anti_fraud_header_invalid_ip_address	Invalid format for ip_address in the anti-fraud header
bank_account_clabe_unrecognizable	CLABE is invalid
bank_account_clabe_already_exists	CLABE is already in use
bank_account_clabe_associated_with_hola_cash	You cannot use this CLABE with hola.cash
bank_account_clabe_not_supported_spei_with_hola_cash	This CLABE is not supported with hola.cash
transaction_not_owned_by_cashuser	You do not own this transaction
transaction_already_completed	Transaction is already completed
transaction_needs_more_information_to_complete	More information is required to complete the transaction
transaction_data_mismatch	Could not find this transaction
transaction_pending_information_missing	Pending transaction with missing information
transaction_version_mismatch	Version mismatch
transaction_tid_invalid	Transaction not found
transaction_pin_required	PIN required to perform the transaction
transaction_already_cancelled_or_completed	No more actions possible on the transaction. The transaction has already been completed or cancelled
target_subaccount_not_open	Merchant not valid
subaccount_not_verified	Invalid merchant configuration. Merchant hasn't been verified
subscription_not_created	Invalid merchant configuration. Missing information
merchant_payment_disabled	Invalid merchant configuration
merchant_is_cash_merchant	Invalid merchant configuration
payment_method_not_allowed	Payment method is not allowed
transaction_not_valid_capture_target	Cannot capture this charge
transaction_capture_amount_greater_than_transaction_amount	Cannot capture more than original amount
transaction_not_valid_capture_target_already_captured	Charge was already captured
transaction_not_valid_capture_target_already_settled	Charge was already settled
transaction_not_valid_capture_target_no_funds_to_capture	Cannot capture more than original amount
transaction_not_valid_capture_target_was_refunded	Charge was already refunded
transaction_not_valid_refund_target_no_funds_to_refund	Cannot refund more than original amount
transaction_not_valid_refund_target_has_chargeback	Cannot refund, transaction has a chargeback
transaction_not_valid_refund_target_payment_method_type_not_supported_for_refunds	Payment method type is not currently supported for refunds
transaction_not_valid_refund_target_transaction_created_date_invalid	The transaction exceeded the maximum time to make a refund.
transaction_not_valid_refund_target_subaccount_transacting_user_does_not_exists	Subaccount transacting_user is not available for this subaccount
transaction_not_valid_capture_target_payment_method_type_not_supported_for_captures	Payment method type is not currently supported for captures
transaction_not_valid_completion_target_was_not_pending	Transaction to be completed is not longer in pending status
transaction_not_valid_cancellation_target_was_not_pending	Transaction to be cancelled is not longer in pending status
amount_limit_exceeded	You have exceeded amount permitted on this card. Please use a different card or contact your bank
codi_transaction_blocked	This CODI transaction has been block, please try again later
credit_card_expired_year	Credit card is expired. Please correct the expiry information or use a different card
credit_card_expired_month	Credit card is expired. Please correct the expiry information or use a different card
incorrect_pin	The PIN is incorrect, please use a correct PIN and try again
credit_card_number_invalid	Credit card number invalid. Please correct the information or use a different card
credit_card_expired	Credit card is expired. Please correct the expiry information or use a different card
credit_card_validation_code_required	Enter a card validation code (CVV) and try again
test_credit_card	This is a test credit card. Use a different credit card and try again
credit_card_validation_code_invalid	Credit card validation code is not valid. Enter a valid code and try again
three_ds_authentication_failed	3DS card authentication failed. Enter valid authentication and try again
credit_card_insufficient_funds	This card does not have sufficient funds, please add fund or user a different card and try again
credit_card_stolen	The card was reported as stolen
credit_card_fraud_detected	This transaction was blocked by hola.cash fraud detection
credit_card_purchase_not_supported	This purchase is not permitted on this card. Please use a different card and try again or contact your bank
credit_card_not_supported_on_line	Online purchases are not permitted for this card. Please contact your bank or use a different card and try again
credit_card_lost	The card was reported as lost
credit_card_restricted_by_bank	The bank has restricted the card
credit_card_hold_card	The bank has requested the card to be retained
credit_card_call_bank_to_authorize	Bank authorization is required for this charge. Please contact your bank or use a different card and try again
refund_failed_retry_after_24_hour	Transaction can not be partially refunded today, try tomorrow.
temporary_error_try_again_later	There was an error completing this transaction, please try again
card_declined	This card has been declined by your bank. Please use a different card or contact your bank
order_not_found	The requested order was not found
payment_token_not_valid	The payment token is not valid
card_amount_high	Enter a lower amount for the purchase and try again
card_amount_low	Enter a higher amount for the purchase and try again
data_issues_contact_hola_cash	Your transaction has issues with the data submitted. Please contact hola.cash support to correct
merchant_email_address_already_exists	Merchant email already exists
merchant_phone_number_already_exists	Merchant phone number already exists
merchant_address_is_required	Merchant address is required
invalid_merchant_category	Invalid merchant category
merchant_username_already_exists	Merchant username already exists
merchant_generic_validation_error	Merchant form contains validation errors
create_processor_account_failed_retry	This transaction attempt failed. Please retry in a few minutes
funds_transfer_not_supported	Your bank does not allow this action
card_withdrawal_limit_exceeded	Your bank has declined the transaction as the withdrawal limit has been exceeded
issuer_not_supported	Your bank does not support this card issuer
card_already_register_with_user	This card cannot be used for this transaction. Please use another card
invalid_card_expiry	The expiration date on this card is not valid. Please review the expiration date
3D_authentication_failed	3DS authentication failed. Please try again or use another card
user_not_allowed_to_perform_transaction	You are not allowed to perform this action
service_error	Service error
generic_processing_error	The operation is not allowed for this customer or transaction
order_is_required	The hola.cash order id is required to be able to use use_order_payment_detail processing instruction as True
payment_detail_is_required	To create the charge you need to pass payment_detail and customer_details
order_payment_detail_and_customer_details_are_required	The provided hola.cash order should have associated the payment_detail and customer_details so we can execute the charge
order_already_associated_with_charge	The provided hola.cash order is already associated to an existing completed charge
continuation_not_found	The external reference id is not found.
invalid_query_param	The query param provided in the API call is invalid
merchant_sub_account_does_not_exist	The merchant does not have a subaccount related
merchant_does_not_exist	The merchant does not exist
limit_out_of_bounds	The limit query param is invalid
integrity_or_database_issue	There was an issue performing the query, make sure that the query parameters are correct
invalid_cursor_after_or_before	The query param `after_id` or `before_id` must be a base64 string
after_id_and_before_id_both_present	Make sure to only send one of the following query param [after_id, before_id]
store_card_token_validation_failed	store card token validation failed
invalid_email_address	Invalid email address
digital_service_purchase_failure	We couldn't process the digital service purchase
payment_link_cannot_be_updated	We cannot make this update to given payment link
payment_link_does_not_exists	This payment link does not exists.
payment_link_update_validation_error	The body of the payment link update request has some validation error
payment_link_cannot_be_disabled	To disable a payment link make sure the current status of the payment link is 'active'
payment_link_cannot_be_enabled	To enable a payment link make sure the current status of the payment link is 'disabled'
payment_link_cannot_be_enabled_already_paid_max_times	we cannot activate a payment link if it has already been paid maximum times
payment_link_cannot_be_enabled_past_expiration_date	we cannot activate a payment link if it has already been expired
amount_constraints_max_amount_exceeds_limit	amount_constraints.maximum_amount must be less than the established max amount limit stablish for your account for payment link creation
amount_exceeds_limit	The amount must be less than the established max amount limit stablish for your account for payment link creation
amount_constraints_min_amount_lesser_than_minimum_limit	amount_constraints.minimum_amount must be greater than the established min amount limit stablish for your account for payment link creation
amount_lesser_than_minimum_limit	The amount must be greater than the established min amount limit stablish for your account for payment link creation
create_charge_generic_validation_error	General validation error on create charge
create_charge_invalid_phone_number	Invalid phone_number error on create charge
subscriptions_customer_not_found	The customer provided was not found in the system. The subscription can not be created.
subscriptions_plan_not_found	The plan provided was not found in the system. The subscription can not be created
subscriptions_inactive_plan	You can not create a subscription with an inactive plan
plan_payment_link_creation_failed	Payment link creation failed during plan creation
customer_could_not_be_created	The customer could not be created in the system
subscription_could_not_be_created	The subscription could not be created in the system
subscription_not_found	The suscription was not found in the system
username_or_password_missing_error	Username and/or Password to create login user were not provided
username_validation_did_not_pass_error	Username validation did not pass, it must be a valid email address
password_validation_did_not_pass_error	Password validation did not pass
payment_method_could_not_be_created	The payment method could not be created in the system