Return URL Status Values
A brief description of the status of the user during/after the acquisition flow.
SUCCESS
A successful transaction/acquisition.
SUSPENDED
User is subscribed but we were unable to take payment.
Apaya will continue to attempt billing/billing renewals as normal. You are free to unsubscribe the user if you choose.
ABANDONED
User has cancelled the Checkout flow without completing.
INVALID PRICEPOINT
The price being requested to be charged is invalid. Please correct this parameter and retry.
If this persists please contact support using the details at the bottom of this page.
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.
Please contact your Account Manager.
INTERNAL ERROR
Apaya internal error. Please retry API/Checkout/Consent Setup.
If this persists please contact support using the details at the bottom of this page.
INSUFFICIENT CREDIT
The bill has not cleared due to insufficient credit.
BARRED
The bill 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.
CAP REACHED
The bill has not cleared due to the end-user's expenditure limit being reached.
Advise the end-user to try the transaction again after the time period mentioned in the error, if stated.
BILLING PERIOD ELAPSED
The attempt to bill this user on this transaction has failed due to unknown reasons.
A new transaction will need to be initiated to try for a successful billing attempt.
USER HAS PORTED
User has moved to another recognised mobile network/payment provider.
BLACKLISTED
This user is blacklisted and cannot be billed.
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.
REACTIVATED
The customer's subscription has now successfully been reactivated after being in a suspended or cancelled state.
The customer should be given access to their service.
ALREADY SUBSCRIBED
The user is already subscribed to the service and should therefore be given access to their service.
NETWORK NOT SUPPORTED
The mobile network (MCC/MNC) provided is not supported for this SubscriptionID.
CARRIER UNSUPPORTED
The service is not available on the mobile network selected.
INVALID AGGREGATOR REQUEST
The mobile network/payment provider deemed the request invalid.
AMOUNT_BELOW_LIMIT
Charge amount is below the minimum limit for this payment provider.
Adjust the price or instruct the end-user to try a different payment provider option.
BENEFICIARYCOOLDOWN
The customer's beneficiary setup has been initiated but they cannot transact until their payment provider's cooldown period has ended.
Instruct the end-user to retry their transaction after the cooldown period ends, or choose a different payment provider option.
ACCOUNT_LOCKED
The end-user's account has been locked out by their payment provider.
Instruct the end-user to contact their provider to remove the lock.
SETUP_SUCCESS
A successful consent setup.
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.
Escalating to Apaya
All escalations should be sent via support@apaya.io with as much of the following information as is available:
TXID/TransactionID
Date/Time of transaction
Payment provider/Mobile network
Any related API request/response data
Any related async webhook notification data