Cancel a Pending Transaction
POST
Cancel a pending transaction
https://api.moltin.com/v2/orders/:orderId/transactions/:transactionId/cancel
Use this endpoint to cancel or void a pending transaction. The transaction can be canceled or voided only when it is in pending
status.
note
This endpoint is still work in progress for the PayPal Express Checkout gateway.
Parameters
Path parameters
Name | Required | Type | Description |
---|---|---|---|
transactionId | Required | string | The UUID of the pending transaction to be canceled or voided. |
orderId | Required | string | The UUID of the order. |
Headers
Name | Required | Type | Description |
---|---|---|---|
Authorization | Required | string | The Bearer token required to get access to the API. |
Body
Name | Required | Type | Description |
---|---|---|---|
reason | Optional | string | Specifies the reason for canceling the pending transaction. The reason may include duplicate , fraudulent , requested_by_customer , or abandoned . |
Request Examples
Curl
curl -X POST https://api.moltin.com/v2/orders/:orderId/transactions/:transaction_id/cancel \
-H "Authorization: Bearer XXXX"
'{
"data": {
"reason": "requested_by_customer",
"options": {}
}
}'
JavaScript SDK
const MoltinGateway = require('@moltin/sdk').gateway
const Moltin = MoltinGateway({
client_id: 'X',
client_secret: 'X'
})
const orderId = "25617d3e-14a6-434c-bfab-3fda87517aaf";
const transactionId = "af18b745-0ea6-41ba-8042-cb91178b21f7";
Moltin.Transactions.Cancel({
order: orderId
transaction: transactionId
},
{
reason: 'duplicate'
}).then(transaction => {
// Do something
})
Response Example
200 OK
{
"data": {
"id": "79416043-c162-46c1-b22b-fe995e5efd33",
"type": "transaction",
"reference": "pi_3LVi8mD3qYZtjAmX1fZxNdIl",
"gateway": "stripe_connect",
"amount": 10000,
"refunded_amount": 0,
"currency": "JPY",
"transaction_type": "authorize",
"status": "cancelled",
"relationships": {
"order": {
"data": {
"type": "order",
"id": "04cce9f1-6968-4a9b-b5b2-5b3ed12bd978"
}
}
},
"meta": {
"display_price": {
"amount": 10000,
"currency": "JPY",
"formatted": "10,000"
},
"display_refunded_amount": {
"total": {
"amount": 0,
"currency": "JPY",
"formatted": "0"
}
},
"timestamps": {
"created_at": "2022-08-11T20:38:04Z",
"updated_at": "2022-08-11T20:38:24Z"
}
},
"payment_intent": {
"amount": 100,
"amount_capturable": 0,
"amount_details": {
"tip": {}
},
"amount_received": 0,
"application": "ca_KH5gI4U1QcTNYo08rUpmVAGds0YBp0ZG",
"application_fee_amount": null,
"automatic_payment_methods": null,
"canceled_at": 1660250303,
"cancellation_reason": "requested_by_customer",
"capture_method": "manual",
"charges": {
"data": [],
"has_more": false,
"object": "list",
"total_count": 0,
"url": "/v1/charges?payment_intent=pi_3LVi8mD3qYZtjAmX1fZxNdIl"
},
"client_secret": "XXXXXXXXXXXXXX-XXXXXX-XXXXXXX",
"confirmation_method": "automatic",
"created": 1660250284,
"currency": "jpy",
"customer": null,
"description": null,
"id": "pi_3LVi8mD3qYZtjAmX1fZxNdIl",
"invoice": null,
"last_payment_error": null,
"livemode": false,
"metadata": {
"email": "andy@example.com",
"ip_address": "99.234.199.127",
"order_id": "04cce9f1-6968-4a9b-b5b2-5b3ed12bd978"
},
"next_action": null,
"object": "payment_intent",
"on_behalf_of": null,
"payment_method": "pm_1LVi8mD3qYZtjAmXbPD30B8z",
"payment_method_options": {
"card": {
"installments": null,
"mandate_options": null,
"network": null,
"request_three_d_secure": "automatic"
}
},
"payment_method_types": [
"card"
],
"processing": null,
"receipt_email": "john@example.com",
"review": null,
"setup_future_usage": null,
"shipping": null,
"source": null,
"statement_descriptor": null,
"statement_descriptor_suffix": null,
"status": "canceled",
"transfer_data": null,
"transfer_group": null
}
}
}