API Test Keys

Fetch Payment Downtime Details With ID

GET

/v1/payments/downtimes/:id

Click to copy

Use this endpoint to fetch downtime status if you have not received any webhook notifications due to technical issues. Usually, downtime webhook payloads are delivered within few seconds of the event. However, in some cases, this can be delayed by few minutes due to various reasons.

Watch Out!

Payment Downtime APIs are not available in Malaysia.

Is this page helpful?

FPX

Card - Issuer

Card - Network

Failure

1{
2  "id": "down_F1cxDoHWD4fkQt",
3  "method": "fpx",
4  "begin": 1591946222,
5  "end": null,
6  "status": "started",
7  "scheduled": false,
8  "severity": "high",
9  "instrument": {
10    "bank": "PHBM"
11  },
12  "created_at": 1591946223,
13  "updated_at": 1591946297
14}

Path Parameters

id

string

Unique identifier of the downtime.

Response Parameters

id

string

Unique identifier of the downtime's occurrence.

entity

string

Here, it will be payment.downtime.

method

string

The payment method that is experiencing downtime. Possible values include:

card
fpx

begin

integer

Timestamp (in Unix) that indicates the start of the downtime. Applicable for both scheduled and unscheduled downtimes.

end

integer

Timestamp (in Unix) that indicates the end of the downtime.
Available only for scheduled downtimes, where the end-time is known. Set to null when the end-time is unknown, possibly during unscheduled downtimes.

status

string

Status of the downtime.
Possible statuses are.

scheduled: A downtime is scheduled to happen at a later time.
started: The downtime has started and is ongoing.
resolved: The downtime is resolved.
updated: An ongoing downtime that has been updated after its start. For example, when the severity of the downtime changes from medium to high.

scheduled

boolean

Possible values:

true: This is a scheduled downtime by the issuer, network, or the bank, which was informed to Curlec.
false: This is an unscheduled downtime.

severity

string

Severity of the downtime.
Possible values:

high: Possible when all the payment methods are affected by downtime. Observed when the issuer, bank or network is down.
medium: Possible when a higher number of declines in transactions or low success rates are observed with the payment methods.
low: Possible when the reason for the downtime is unknown. Impact on payment methods is minimal.

instrument

string

Payment method that is underperforming.

Show child parameters (3)

created_at

integer

Timestamp (in Unix) that indicates the time at which the downtime was recorded in Curlec servers.

updated_at

integer

Timestamp (in Unix) that indicates the time at which the downtime record was updated in Curlec servers.

card_type

string

The card type used to process the payment. Possible values:

credit
debit

Errors

The API {key/secret} provided is invalid.

Error Status: 4xx

The API credentials passed in the API call differ from the ones generated on the Dashboard.

Solution

Fetch Payment Downtime Details With ID

GET

/v1/payments/downtimes/:id

Click to copy

Watch Out!

Payment Downtime APIs are not available in Malaysia.

Is this page helpful?

Path Parameters

id

string

Unique identifier of the downtime.

Response Parameters

id

string

Unique identifier of the downtime's occurrence.

entity

string

Here, it will be payment.downtime.

method

string

The payment method that is experiencing downtime. Possible values include:

card
fpx

begin

integer

Timestamp (in Unix) that indicates the start of the downtime. Applicable for both scheduled and unscheduled downtimes.

end

integer

status

string

Status of the downtime.
Possible statuses are.

scheduled: A downtime is scheduled to happen at a later time.
started: The downtime has started and is ongoing.
resolved: The downtime is resolved.
updated: An ongoing downtime that has been updated after its start. For example, when the severity of the downtime changes from medium to high.

scheduled

boolean

Possible values:

true: This is a scheduled downtime by the issuer, network, or the bank, which was informed to Curlec.
false: This is an unscheduled downtime.

severity

string

Severity of the downtime.
Possible values:

high: Possible when all the payment methods are affected by downtime. Observed when the issuer, bank or network is down.
medium: Possible when a higher number of declines in transactions or low success rates are observed with the payment methods.
low: Possible when the reason for the downtime is unknown. Impact on payment methods is minimal.

instrument

string

Payment method that is underperforming.

Show child parameters (3)

created_at

integer

Timestamp (in Unix) that indicates the time at which the downtime was recorded in Curlec servers.

updated_at

integer

Timestamp (in Unix) that indicates the time at which the downtime record was updated in Curlec servers.

card_type

string

The card type used to process the payment. Possible values:

credit
debit

Errors

The API {key/secret} provided is invalid.

Error Status: 4xx

The API credentials passed in the API call differ from the ones generated on the Dashboard.

Solution

FPX

Card - Issuer

Card - Network

Failure

1{
2  "id": "down_F1cxDoHWD4fkQt",
3  "method": "fpx",
4  "begin": 1591946222,
5  "end": null,
6  "status": "started",
7  "scheduled": false,
8  "severity": "high",
9  "instrument": {
10    "bank": "PHBM"
11  },
12  "created_at": 1591946223,
13  "updated_at": 1591946297
14}