Direct API Reference
A detailed reference for transaction statuses and error codes for the Cycle Direct API.
Payment & Order Status
The top-level state that a transaction can be in.
| Type | Description |
|---|---|
AUTHORIZE_PENDING | A request for an AUTH has happened, but we are waiting for the status to be determined |
AUTHORIZED | A request for an AUTH has completed, the funds can now be captured (CHARGE) |
CHARGE_PENDING | A charge request is awaiting a response from the PSP |
AUTH_REVERSED | A transaction was voided by the merchant (auth, pending charge, pending refund, pending credit), or an AUTH timed out. |
CANCELLED | A charge was cancelled by the customer after redirecting to the PSP site, but before the charge |
DECLINED | A charge/credit was declined by our fraud system, or the PSP |
ERROR | A charge/credit request had a technical error before being charged |
CHARGED | A charge was successful. Note that partially refunded, or pending refunded charges are in CHARGED state until they are fully refunded |
REFUND_PENDING | A refund (for the full remaining amount of the charge) has been initiated but not completed |
REFUNDED | A charge has been fully refunded |
CHARGEBACK_PENDING | A chargeback has been initiated by the PSP, and has not been accepted or disputed yet |
CHARGED_BACK | A charge was chargedback by the PSP |
CHARGEBACK_REVERSED | A chargeback has been successfully disputed and reversed |
CREDIT_PENDING | A credit is awaiting a response from the PSP |
CREDITED | A credit is complete |
Hard Decline Codes
Hard declines are responses with an HTTP status code other than 2xx.
| Type | Description |
|---|---|
unrecognized_json_property | There are field error in the request Json |
json_mapping_error | Field value type does not match |
json_parse_error | Failed to parse the request json |
json_invalid_value_error | Field value is invalid |
validation_error | Field value is not allowed in the context |
bad_request_error | Other errors in the request, refer message for detail |
authentication_error | Failed to authenticate the caller |
user_locked | The caller is locked |
access_denied_error | The access is denied |
unauthorized_error | The caller does not have the authority |
internal_server_error | System error, please contact Cycle support if you see this |
service_unavailable_exception | Internal service outage, please contact Cycle support if you see this |
entity_conflict_error | Duplicate key provided in request |
entity_not_found_error | Resource not found |
Result Codes
Result codes for each transaction are found in the `transactions[n].resultCode` field.
| Type | Description |
|---|---|
0 | Success |
10 | Cancelled |
100 | The credentials, IP address, URL, signature or operation are invalid. |
110 | There was an error parsing the provided inputs |
120 | The requested operation cannot be performed on a charge in this state. |
130 | An SPP ID was supplied that does not belong to the customer or is marked as invalid. |
140 | The charge is initiated with the returring flag, but the method does not support recurring |
150 | The method, country or currency are invalid or not supported for this customer's trust level. |
155 | The provided charge ID already exists |
160 | The following required inputs are missing or invalid: xxx |
170 | The following required customer fields are missing or invalid:xxx |
171 | Failed to fetch customer data from 3rd party |
180 | The customer has an active block. |
190 | The IP address or country is blocked. |
200 | The payment information (card #, etc) is blocked |
210 | The customer has exceeded a velocity limit. |
220 | The fraud system declined this transaction. |
230 | The payment service is unavailable. |
240 | The payment failed for an unknown reason. |
500 | The provider declined to authorize this transaction. |
510 | The provided expiration date is incorrect. |
520 | The billing information provided has the following missing or invalid fields. |
530 | The processor has declined due to missing or insufficient funds. |
540 | The processor has declined the transaction as a duplicate. |
550 | The merchant ID or other information is incorrect. |
560 | The amount is outside the range accepted by this processor. |
570 | The operation cannot be performed on this charge. |
580 | The processor or issuer has placed a limit or restriction on this ID. |
590 | The processor has declined the transaction without providing a reason. |
1000 | The processor has permanently blocked this account ID or customer. |
1100 | The processor declined for an unknown reason. |
1200 | The authorization for this charge has expired. A new authorization is required. |