API Errors
Learn how to handle errors returned from the API
Error Response
An error response from areeba.simplify is a JSON object of the following format:reference
: Event reference IDerror
: The error object which contains the following fields:code
: error codemessage
: Description of the error
In addition, validation errors include a list callled fieldErrors
with each element being an object with the following fields
field
: Specific field that contained the errorcode
: Code for the errormessage
: Description of the error
Example
{
"reference" : "abcdef12-3456-7890-abcd-1234567890",
"error" : {
"code" : "validation",
"message" : "Request data is invalid",
"fieldErrors" : [
{
"field" : "currency",
"code" : "nullable",
"message" : "Field is required"
}
]
}
}
Reference
system
System error occurred processing a requestacquirer.not.found
no.payment.details
No token, card or customer details in payment requestexpYear.expired
The card expiry year is invalidexpMonth.expired
The card expiry month is invalidcard.invalid
The supplied card is invalidcard.magstripe.invalid
The supplied magnetic stripe data is invalid (or incompatible with the card entry mode)card.tlv.data.invalid
The supplied Tag-Length-Value data is invalid (or incompatible with the card entry mode and/or tlv data type)card.expired
The card has expiredcard.declined
The card has been declinedcard.unsupported
Unsupported card typecard.apple.pay.invalid
The supplied Apple Pay data is invalid (or incompatible with the card entry mode)card.android.pay.invalid
The supplied Android Pay data is invalid (or incompatible with the card entry mode)card.3dsecure.data.invalid
Unable to process transaction. 3D Secure authentication has not completed successfully.card.3dsecure.data.ucaf.invalid
UCAF value is invalid, it should be Base64 encoded or contain hexadecimal characters only.card.cvc.invalid
The card CVC is invalidonly.card.or.token
Cannot specify both a card and tokencurrency.invalid
The currency is invalid. A value of 'USD' is only allowedmerchant.currency.invalid
The currency is not supported on your merchant account.merchant.processing.suspended
The merchant has been suspended from processing transactions pending completion of registration.merchant.closed
The merchant account was closed..merchant.pending.configuration
Merchant processing is unavailable pending completion of registration.merchant.boarding.inprocess
Merchant payment processing is unavailable pending approval.customer.signature.invalid
The supplied customer signature is invalid. Content type should be image/jpeg, encoded using BASE64payment.status.not.approved
You can only update a signature if the payment has an APPROVED statuspayment.card.entry.mode.invalid
You can only update a signature for a card present paymentpayment.apple.pay.amount.invalid
Apple Pay original transaction amount is different to payment amount.payment.invalid.tax.id
The tax id provided is invalid.customer.does.not.exist
Customer does not existreceipt.customer.id.and.email
Cannot specify both customer ID and customer email in receiptreceipt.customer.id.and.name
Cannot specify both customer ID and customer name in receiptobject.not.found
Not Foundoperation.not.allowed
Operation Not Allowedsecured.operation.not.allowed
Action not allowed, please contact the support team.user.not.authorized
User not authorizedservice.unavailable
The service you requested is currently unavailablesdk.payments.not.enabled
SDK Payments are not enabled, please contact your Acquirer.auth.bad.jws
JWS encoding of request message is invalid or missingauth.bad.algol
Invalid JWS algorithm used in request messageauth.bad.kid
Invalid or missing public key in request messageauth.bad.uri
Invalid or missing URI in JWS request messageauth.bad.timestamp
Invalid or missing timestamp in JWS request messageauth.bad.nonce
Invalid of missing nonce in JWS request messageauth.invalid.keys
Invalid or missing API keysauth.bad.sig
Cannot verify JWS signature in request messageauth.invalid.account.mode
The account you are using is only in test mode. You can activate your account in the Dashboardauth.invalid.token
Card token is invalidauth.invalid.token.in.use
auth.invalid.data.token
Data token is invalidauth.access.denied
Access deniedauth.merchant.not.found
No merchant details records were found.account.mode.mismatch
Cannot mix account modesauth.invalid.source
Invalid source in API keysvalidation
Request data is invalidcoupon.does.not.exist
Coupon not foundplan.not.found
Subscription plan not foundcoupon.expired
Coupon has expiredcoupon.deleted
Coupon has been deletedanalytic.data.invalid
Analytic paramters invalidrefund.insufficient.balance
The amount you are trying to refund is greater than the remaining balancerefund.concurrent.refund
We are already performing a refund against the payment you are trying to refund. Wait and try refunding later.criteria.invalid
Invalid arguments in criteriarefund.payment.voided
The payment has been voided and cannot be refunded.refund.payment.declined
The payment has been declined and cannot be refunded.refund.payment.error
The payment has an unknown status and cannot be refunded.refund.invalid.payment.id
An invalid payment id was specified.action.not.authorized
oauth.expired.access_token
Your access token has expiredoauth.invalid.access_token
Your access token is invalidoauth.invalid.oauth.key.usage
OAuth keys cannot be used for non-OAuth requestsoauth.invalid.api.key.usage
Non-OAuth keys cannot be used for OAuth requestsamex.process.delay
Your merchant account is currently in the process of being set up to process Amex transactions. It usually takes 2 days to set up from the date of the merchant account creation.delete.sandbox.data.invalid
Delete sandbox data parameters invalidiban.invalid
Invalid IBAN specified.invoice.item.paid
You can not make changes to an invoice that is in a PAID status.invoice.email.failed
There was an issue sending the email to your customer. Please check the email address.invoice.invalid.tax.id
The tax id provided is invalid.invoice.invalid.status
You can not update an invoice that has a CANCELLED or PAID status.invoice.invalid.status.delete
Invoices can not be deleted when in an OPEN status. You can set the invoice to CANCELLED and then try deleting.invoice.invalid.status.cancelled
You can not update a CANCELLED invoice.invoice.invalid.status.draft
You can not set a DRAFT invoice to PAID. Try setting the invoice to OPEN before setting the PAID status.invoice.invalid.status.draft.update
You cannot change the invoice back to a DRAFT status.invoice.id.required
To update the invoice you must provide the invoice idinvoice.total.min
The invoice total amount must be greater than $0.50invoice.total.max
The invoice total must not exceed $999,999.99invoice.invalid.type
The action you are trying to perform is invalid for an invoice of this typeinvoice.email.invalid.mode
Invoices cannot be sent in Sandbox mode.invoice.line.invalid.operation.subscription
You can not perform delete or update operations on a subscription invoice line iteminvoice.not.found
Invoice cannot be found.invoice.cancelled
Invoice has been cancelled.invoice.invalid.update.customer
You can only update the customer when in a DRAFT state.invoice.not.allowed
Invoice not supported.order.not.allowed
Specifying an order is invalid when capturing a payment from an authorizationorder.invalid.product.id
To create an order you need to provide a valid product idorder.invalid.product.info
Order should not contain product information if name, description or price presentemail.send.limit
Number of email sent with application has reached the limit.unknown.state
Operation is in an unknown state.invalid.state
The state field should contain 2 characters only.payment.does.not.exist
Payment does not exist in the database.payment.already.captured
Payment has already been captured.payment.auth.expired
Payment authorization has expired and so the payment cannot be captured.payment.not.approved
Capture cannot be performed on an unapproved payment.payment.currency.not.matches
Capture cannot be performed in a different currency than the original payment.payment.capture.too.much
Capture amount cannot exceed approved authorization amount.reversal.currency.not.matches
Reversal cannot be performed in a different currency that the original authorization.reversal.amount.invalid
Reversal amount must match precisely the same amount as the authorization. Partial reversals are not allowed.auth.already.reversed
Authorization has already been reversed.auth.does.not.exist
No authorization was found.too.much.payment.create.data
If an authorization is specified in the payment create command, you do not need to provide card or customer information. These are linked to the original authorization.too.much.refund.create.data
If a payment is specified in the refund create command, you do not need to provide card or customer information. These are linked to the original payment.refund.currency.not.matches
Refund cannot be performed in a different currency than the original payment.invalid.phone.number
The phone number is invalid.account.change.locked
Account information cannot be updated at this time.xss.message
Scripts are not valid input for this field.invalid.card.number.location
A card number cannot be entered here.invalid.customer.name.value
The supplied customer name is invalid. Name contains script tag(s), which is not valid for this field.fraud.check.integrator.transaction.status.invalid
Transaction status is missing or invalidmerchant.name.not.unique
The merchant name must be unique.3dsecure.transaction.required
3D Secure transaction required.moto.payment.not.allowed
MOTO payments not allowed, please contact the support team.merchant.keypair.not.delete.last
This api key is the last of this type and can't be deleted.unsupported.file.extension
file.size.too.large