Expire a charge

POSThttps://api.omise.co/charges/:id/expire

Manually expire a pending charge that has not yet been authorized. Only applicable to certain payment methods with redirect-based flows.

---

🔑API Credentials

▼

---

Request Parameters

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

The charge ID to expire. Must be a pending charge that has not yet been authorized. Only works with supported payment sources (Alipay CN/HK, DANA, GCash, KakaoPay, PayPay, Touch 'n Go).

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

Constraints:Must start with chrg_, Charge status must be pending, Must be created via supported sources

---

Responses

200

Successfully expired

Charge has been marked as expired. Customer can no longer complete payment.

Key field changes after expiration:

• status - Changes from pending to expired
• expired - Changes from false to true
• expired_at - Set to current timestamp

400

Bad request

Request validation failed.

Common causes:

• Invalid charge ID format
• Charge not eligible for expiration

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key

404

Not found

Charge ID does not exist.

Common causes:

• Incorrect charge ID
• Charge from different account
• Using test key for live charge (or vice versa)

422

Unprocessable entity

Charge cannot be expired.

Common causes:

• Charge is not pending (already successful, failed, or expired)
• Charge already authorized
• Payment method not supported for manual expiration
• Charge created with card instead of supported source

---

Code samples

cURL

curl https://api.omise.co/charges/chrg_test_5xuy4w91xqz7d1w9u0t/expire \
  -X POST \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = Omise::Charge.expire('chrg_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = omise.Charge.expire('chrg_test_5xuy4w91xqz7d1w9u0t')

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const charge = await omise.charges.expire('chrg_test_5xuy4w91xqz7d1w9u0t');

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$charge = OmiseCharge::retrieve('chrg_test_5xuy4w91xqz7d1w9u0t');
$charge->expire();

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Charge charge = client.charges().expire("chrg_test_5xuy4w91xqz7d1w9u0t")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var charge = await client.Charges.Expire("chrg_test_5xuy4w91xqz7d1w9u0t");

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

charge, _ := client.ExpireCharge("chrg_test_5xuy4w91xqz7d1w9u0t", nil)

---

Error and result codes

Common Error Codes

Code	Description	Resolution
not_found	Charge ID doesn't exist	Verify charge ID is correct
not_pending	Charge is not pending	Can only expire pending charges
already_expired	Charge already expired	No action needed
not_expirable	Payment method not supported	Check supported sources
already_authorized	Charge already authorized	Cannot expire authorized charges

Supported Payment Methods

Payment Method	Supported	Notes
Alipay CN	Yes	Can expire pending charges
Alipay HK	Yes	Can expire pending charges
DANA	Yes	Can expire pending charges
GCash	Yes	Can expire pending charges
KakaoPay	Yes	Can expire pending charges
PayPay	Yes	Can expire pending charges
Touch 'n Go	Yes	Can expire pending charges
Credit Card	No	Cards have different flow
PromptPay	No	PromptPay expires automatically

---

Try it out

Required - 1 fields

▼

id(Required)