Return URL Status Values

A brief description of the status of the user during/after the acquisition flow.

SUCCESS - A successful transaction/acquisition.

ABANDONED - The transaction has been cancelled on the Apaya Checkout/Consent Setup flow without completing.

CANCELLED - The transaction has been cancelled by the customer on the Connector's platform.

INVALID REQUEST - The request to Apaya or to the Connector was invalid.

INVALID AGGREGATOR REQUEST - The Connector deemed the request invalid.

INVALID PAYMENT TYPE - The Connector deems the payment option requested as invalid.
You would need to contact your Connector directly as this can be due to improper Connector account setup

CONNECTOR ERROR - Error on the Connector's platform.
This may occur if you haven't correctly configured your Connector in the Apaya Portal. Otherwise contact the Connector directly.

CONNECTED TXID NOT FOUND - The transaction details were not found on the Connector's platform.

UNKNOWN ERROR - This should not occur, but if it does, please contact Apaya support.
This may occur if there are new statuses from the Connector which are not yet handled by Apaya.

UNKNOWN - Same as UNKNOWN ERROR.

UNSPECIFIED ERROR - Same as UNKNOWN ERROR.

AGGREGATOR TIMEOUT - The Connector platform had a timeout during this transaction.

NOT PAID PENDING - The transaction is in a pending state.

NOT PAID - The Connector has failed or declined the transaction.

INTERNAL ERROR - Apaya internal error, please retry your request. If this persists please contact support using the details at the bottom of this page.

INSUFFICIENT CREDIT - The charge has not cleared due to insufficient funds.

CAP REACHED - The charge has not cleared due to the customer's expenditure limit being reached.
Advise the customer to try the transaction again after the time period mentioned in the error, if stated.

ALREADY PROCESSED - The transaction requested is a duplicate and has previously been processed.

AUTHORISED - A successful Reserve API request has been performed. The transaction is authorised and can now be captured or voided.

UNAUTHORISED - The transaction is not authorised by the Connector. 
This can be due to incorrect Connector credentials on the Apaya Portal or improper Connector account setup

OTP INITIATED - A successful OTP request has been received by the Connector.
NOTE: This does not confirm that the OTP has been delivered to the customer.

PASSCODE INVALID - The OTP/Passcode provided is incorrect.

PASSCODE ALREADY USED - The OTP/Passcode provided has already been used in a successful transaction.

PASSCODE EXPIRED - The OTP/Passcode provided has expired.

AMOUNT_BELOW_LIMIT - Charge amount is below the minimum limit for this payment provider.

INVALID TARIFF - This an unsupported type of SIM, such as business/data.

INVALID IP - The IP Address of the client server has not been whitelisted by the Connector. 

BILLING PERIOD ELAPSED - The attempt to charge this user on this transaction has failed due to unknown reasons. 
A new transaction will need to be initiated.

TOKEN ALREADY USED - The token used to access the Apaya Checkout/Consent Page has previously been used in a successful transaction.
The customer will not be able to transact again, and instead will be redirected to the merchant's platform.

INVALID TOKEN - The token provided is invalid on the Connector's platform.

RISK RESPONSE RECEIVED - A fraud-related risk response has been received from the Connector.

REFUND REASON INVALID - The refund reason provided in the refund request is invalid.

INVALID REFUND AMOUNT - The refund value provided is invalid for this transaction.
This can be due to the value being greater than the initial transaction value, or that multiple partial-refunds have occurred, with this refund value going over the transaction value boundary

BARRED - The charge has not cleared due to an Operator Bar in place on the account.
Advise the customer to contact their mobile network/payment provider to have the restriction removed and try the transaction again. 
Note: Some mobile networks have an option in their customer app to remove this restriction

NETWORK NOT SUPPORTED - The mobile network/payment provider is not supported for this product.

USER HAS PORTED - User has moved to another mobile network/payment provider.

BLACKLISTED - This user is blacklisted and cannot be charged.
Advise the customer that their account is blacklisted and that they cannot use the chosen payment option. 
They should also be advised to contact their mobile network/payment provider if they want this blacklist status removed.

BENEFICIARYCOOLDOWN - The customer's beneficiary setup has been initiated but they cannot transact until their payment provider's cooldown period has ended. 
Instruct the customer to retry their transaction after the cooldown period ends, or choose a different payment provider option.

COOL DOWN PERIOD - Same as BENEFICIARYCOOLDOWN.

ACCOUNT_LOCKED - The customer's account has been locked out by their payment provider. 
Instruct the customer to contact their provider to remove the lock..

SETUP_SUCCESS - A successful consent setup.

SETUP_ERROR - Error occurred whilst performing the consent setup transaction.

SETUP_ABANDONED - User has cancelled the consent setup flow without completing.

SETUP_CONSENTALREADYEXISTS - The user has previously setup consent with the same details, using the same payment provider and on the same product.

CONSENT TOKEN MISMATCH - The userConsentToken provided does not applicable for this transaction.
This can be due to the token being provided with the incorrect productID or merchant credentials.

Escalating to Apaya

All escalations should be sent via support@apaya.io with as much of the following information as is available:

1. TXID/TransactionID

2. Date/Time of transaction

3. Payment provider/Mobile network

4. Any related API request/response data

5. Any related async webhook notification data