# Cancel Order
Use this API to cancel the Payment against an order.
> 📘 Note:
>
> * You can use this API only when the `pre_auth` parameter is set to true and the payment is created against an order request.
## Environment
Use our UAT environment endpoint for testing and for integration utilize our production endpoint.
| Environment | Endpoints |
| :----------------------------- | :------------------------------------------------------------------- |
| User Acceptance Testing \[UAT] | `https://pluraluat.v2.pinepg.in/api/pay/v1/orders/{order_id}/cancel` |
| Production \[PROD] | `https://api.pluralpay.in/api/pay/v1/orders/{order_id}/cancel` |
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "order",
"version": "3.0"
},
"servers": [
{
"url": "https://pluraluat.v2.pinepg.in/api"
}
],
"components": {
"securitySchemes": {
"sec0": {
"type": "apiKey",
"name": "Authorization",
"in": "header",
"x-bearer-format": "bearer",
"x-default": ""
}
}
},
"security": [
{
"sec0": []
}
],
"paths": {
"/pay/v1/orders/{order_id}/cancel": {
"put": {
"summary": "Cancel Order",
"description": "Use this API to cancel the Payment against an order.",
"operationId": "orders-cancel",
"parameters": [
{
"name": "order_id",
"in": "path",
"description": "Unique identifier of the order in the Pine Labs Online database.
Example: `v1-5757575757-aa-hU1rUd`",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "Content-Type",
"in": "header",
"description": "The type of content included in the HTTP message body.
Possible value: `application/json`.",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "The HTTP header where you can include your secret token for authentication.
Example: `Bearer `
**Note**: Use the access token generated using our Generate Token API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Request-Timestamp",
"in": "header",
"description": "Use ISO 8601 UTC Timestamp, to create a timestamp when the generate token is requested.
Example: `2024-07-09T07:57:08.022Z`",
"schema": {
"type": "string"
}
},
{
"name": "Request-ID",
"in": "header",
"description": "Use a global unique identifier [GUID] for the request.- Minimum: 1 characters.
- Maximum: 50 characters
Example: `c17ce30f-f88e-4f81-ada1-c3b4909ed235`",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"data\":{\n \"order_id\":\"v1-5757575757-aa-hU1rUd\",\n \"merchant_order_reference\":\"2177120b-3be1-4330-a15f-53ce14d19841\",\n \"type\":\"CHARGE\",\n \"status\":\"CANCELLED\",\n \"merchant_id\":\"123456\",\n \"order_amount\":{\n \"value\":50000,\n \"currency\":\"INR\"\n },\n \"pre_auth\":true,\n \"allowed_payment_methods\":[\n \"CARD\",\n \"UPI\",\n \"NETBANKING\",\n \"POINTS\",\n \"WALLET\"\n ],\n \"notes\":\"order1\",\n \"callback_url\":\"https://sample-callback-url\",\n \"failure_callback_url\": \"https://sample-failure-callback-url\",\n \"purchase_details\":{\n \"customer\":{\n \"email_id\":\"kevin.bob@example.com\",\n \"first_name\":\"Kevin\",\n \"last_name\":\"Bob\",\n \"customer_id\":\"232323\",\n \"mobile_number\":\"9876543210\",\n\t\t\t\t\"country_code\": \"91\",\n \"billing_address\": {\n \t\"address1\": \"10 Downing Street Westminster London\",\n \t\"address2\": \"Oxford Street Westminster London\",\n \t\"address3\": \"Baker Street Westminster London\",\n \t\"pincode\": \"51524036\",\n \t\"city\": \"Westminster\",\n \t\"state\": \"Westminster\",\n \t\"country\": \"London\",\n\t\t\t\t\t\"full_name\": \"Kevin Bob\",\n\t\t\t\t\t\"adddress_type\": \"Home\",\n\t\t\t\t\t\"address_category\": \"billing\"\n \t},\n \t\"shipping_address\": {\n \t\"address1\": \"10 Downing Street Westminster London\",\n \t\"address2\": \"Oxford Street Westminster London\",\n \t\"address3\": \"Baker Street Westminster London\",\n \t\"pincode\": \"51524036\",\n \t\"city\": \"Westminster\",\n \t\"state\": \"Westminster\",\n \t\"country\": \"London\",\n\t\t\t\t\t\"full_name\": \"Kevin Bob\",\n\t\t\t\t\t\"adddress_type\": \"Home\",\n\t\t\t\t\t\"address_category\": \"shipping\"\n \t}\n },\n \"merchant_metadata\":{\n \"key1\":\"DD\",\n \"key2\":\"XOF\"\n }\n },\n \"payments\":[\n {\n \"id\":\"v1-2711071924-aa-VxIzq1-cc-Z\",\n \"status\":\"CANCELLED\",\n \"payment_amount\":{\n \"value\":1100,\n \"currency\":\"INR\"\n },\n \"payment_method\":\"CARD\",\n \"payment_option\":{\n \"card_data\":{\n \"card_type\":\"CREDIT\",\n \"network_name\":\"VISA\",\n \"issuer_name\":\"NONE\",\n \"card_category\":\"CONSUMER\",\n \"country_code\":\"IND\",\n \"token_txn_type\":\"ALT_TOKEN\",\n \"last4_digit\": \"1091\",\n \"save\": false,\n \"is_native_otp_eligible\": true\n }\n },\n \"acquirer_data\":{\n \"approval_code\":\"000000\",\n \"acquirer_reference\":\"202456644249243\",\n \"rrn\":\"420123000239\",\n \"is_aggregator\":true\n },\n \"created_at\":\"2024-09-05T06:29:27.721Z\",\n \"updated_at\":\"2024-09-05T06:30:40.640Z\"\n }\n ],\n \"created_at\":\"2024-07-19T11:27:55.664Z\",\n \"updated_at\":\"2024-07-19T11:28:52.487Z\"\n }\n}"
},
"Cancel Pending": {
"value": "{\n \"data\":{\n \"order_id\":\"v1-241010170109-aa-l63F0Y\",\n \"merchant_order_reference\":\"4e0631bb-1a1f-45e5-88f0-47219ffdc73a\",\n \"type\":\"CHARGE\",\n \"status\":\"CANCELLED\",\n \"merchant_id\":\"108272\",\n \"order_amount\":{\n \"value\":10000,\n \"currency\":\"INR\"\n },\n \"pre_auth\":true,\n \"allowed_payment_methods\":[\n \"CARD\",\n \"UPI\",\n \"NETBANKING\",\n \"POINTS\",\n \"WALLET\"\n ],\n \"notes\":\"order1\",\n \"callback_url\":\"https://sample-callback-url\",\n \"failure_callback_url\": \"https://sample-failure-callback-url\",\n \"purchase_details\":{\n \"customer\":{\n \"email_id\":\"joe.sam@gmail.com\",\n \"first_name\":\"joe\",\n \"last_name\":\"kumar\",\n \"customer_id\":\"192212\",\n \"mobile_number\":\"192192883\",\n\t\t\t\t\"country_code\": \"91\",\n \"billing_address\": {\n \t\"address1\": \"10 Downing Street Westminster London\",\n \t\"address2\": \"Oxford Street Westminster London\",\n \t\"address3\": \"Baker Street Westminster London\",\n \t\"pincode\": \"51524036\",\n \t\"city\": \"Westminster\",\n \t\"state\": \"Westminster\",\n \t\"country\": \"London\",\n\t\t\t\t\t\"full_name\": \"Kevin Bob\",\n\t\t\t\t\t\"adddress_type\": \"Home\",\n\t\t\t\t\t\"address_category\": \"billing\"\n \t},\n \t\"shipping_address\": {\n \t\"address1\": \"10 Downing Street Westminster London\",\n \t\"address2\": \"Oxford Street Westminster London\",\n \t\"address3\": \"Baker Street Westminster London\",\n \t\"pincode\": \"51524036\",\n \t\"city\": \"Westminster\",\n \t\"state\": \"Westminster\",\n \t\"country\": \"London\",\n\t\t\t\t\t\"full_name\": \"Kevin Bob\",\n\t\t\t\t\t\"adddress_type\": \"Home\",\n\t\t\t\t\t\"address_category\": \"shipping\"\n \t}\n },\n \"merchant_metadata\":{\n \"invoice_number\":\"HLS0001\"\n }\n },\n \"payments\":[\n {\n \"id\":\"v1-241010170109-aa-l63F0Y-cc-J\",\n \"status\":\"CANCELLED\",\n \"payment_amount\":{\n \"value\":10000,\n \"currency\":\"INR\"\n },\n \"payment_method\":\"CARD\",\n \"payment_option\":{\n \"card_data\":{\n \"card_type\":\"CREDIT\",\n \"network_name\":\"MASTERCARD\",\n \"issuer_name\":\"ICICI BANK LIMITED\",\n \"card_category\":\"\",\n \"country_code\":\"IND\",\n \"token_txn_type\":\"ALT_TOKEN\",\n \"last4_digit\": \"1091\",\n \"save\": false,\n \"is_native_otp_eligible\": true\n }\n },\n \"acquirer_data\":{\n \"approval_code\":\"831000\",\n \"acquirer_reference\":\"7285796824536663503954\",\n \"rrn\":\"428417534659\",\n \"is_aggregator\":true\n },\n \"created_at\":\"2024-10-10T17:01:09.141Z\",\n \"updated_at\":\"2024-10-10T17:03:22.332Z\"\n }\n ],\n \"created_at\":\"2024-10-10T17:01:09.063Z\",\n \"updated_at\":\"2024-10-10T17:03:22.334Z\",\n \"integration_mode\":\"SEAMLESS\"\n }\n}"
}
},
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"order_id": {
"type": "string",
"example": "v1-5757575757-aa-hU1rUd"
},
"merchant_order_reference": {
"type": "string",
"example": "2177120b-3be1-4330-a15f-53ce14d19841"
},
"type": {
"type": "string",
"example": "CHARGE"
},
"status": {
"type": "string",
"example": "CANCELLED"
},
"merchant_id": {
"type": "string",
"example": "123456"
},
"order_amount": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"example": 50000,
"default": 0
},
"currency": {
"type": "string",
"example": "INR"
}
}
},
"pre_auth": {
"type": "boolean",
"example": true,
"default": true
},
"allowed_payment_methods": {
"type": "array",
"items": {
"type": "string",
"example": "CARD"
}
},
"notes": {
"type": "string",
"example": "order1"
},
"callback_url": {
"type": "string",
"example": "https://sample-callback-url"
},
"failure_callback_url": {
"type": "string",
"example": "https://sample-failure-callback-url"
},
"purchase_details": {
"type": "object",
"properties": {
"customer": {
"type": "object",
"properties": {
"email_id": {
"type": "string",
"example": "kevin.bob@example.com"
},
"first_name": {
"type": "string",
"example": "Kevin"
},
"last_name": {
"type": "string",
"example": "Bob"
},
"customer_id": {
"type": "string",
"example": "232323"
},
"mobile_number": {
"type": "string",
"example": "9876543210"
},
"country_code": {
"type": "string",
"example": "91"
},
"billing_address": {
"type": "object",
"properties": {
"address1": {
"type": "string",
"example": "10 Downing Street Westminster London"
},
"address2": {
"type": "string",
"example": "Oxford Street Westminster London"
},
"address3": {
"type": "string",
"example": "Baker Street Westminster London"
},
"pincode": {
"type": "string",
"example": "51524036"
},
"city": {
"type": "string",
"example": "Westminster"
},
"state": {
"type": "string",
"example": "Westminster"
},
"country": {
"type": "string",
"example": "London"
},
"full_name": {
"type": "string",
"example": "Kevin Bob"
},
"adddress_type": {
"type": "string",
"example": "Home"
},
"address_category": {
"type": "string",
"example": "billing"
}
}
},
"shipping_address": {
"type": "object",
"properties": {
"address1": {
"type": "string",
"example": "10 Downing Street Westminster London"
},
"address2": {
"type": "string",
"example": "Oxford Street Westminster London"
},
"address3": {
"type": "string",
"example": "Baker Street Westminster London"
},
"pincode": {
"type": "string",
"example": "51524036"
},
"city": {
"type": "string",
"example": "Westminster"
},
"state": {
"type": "string",
"example": "Westminster"
},
"country": {
"type": "string",
"example": "London"
},
"full_name": {
"type": "string",
"example": "Kevin Bob"
},
"adddress_type": {
"type": "string",
"example": "Home"
},
"address_category": {
"type": "string",
"example": "shipping"
}
}
}
}
},
"merchant_metadata": {
"type": "object",
"properties": {
"key1": {
"type": "string",
"example": "DD"
},
"key2": {
"type": "string",
"example": "XOF"
}
}
}
}
},
"payments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "v1-2711071924-aa-VxIzq1-cc-Z"
},
"status": {
"type": "string",
"example": "CANCELLED"
},
"payment_amount": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"example": 1100,
"default": 0
},
"currency": {
"type": "string",
"example": "INR"
}
}
},
"payment_method": {
"type": "string",
"example": "CARD"
},
"payment_option": {
"type": "object",
"properties": {
"card_data": {
"type": "object",
"properties": {
"card_type": {
"type": "string",
"example": "CREDIT"
},
"network_name": {
"type": "string",
"example": "VISA"
},
"issuer_name": {
"type": "string",
"example": "NONE"
},
"card_category": {
"type": "string",
"example": "CONSUMER"
},
"country_code": {
"type": "string",
"example": "IND"
},
"token_txn_type": {
"type": "string",
"example": "ALT_TOKEN"
},
"last4_digit": {
"type": "string",
"example": "1091"
},
"save": {
"type": "boolean",
"example": false,
"default": true
},
"is_native_otp_eligible": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
},
"acquirer_data": {
"type": "object",
"properties": {
"approval_code": {
"type": "string",
"example": "000000"
},
"acquirer_reference": {
"type": "string",
"example": "202456644249243"
},
"rrn": {
"type": "string",
"example": "420123000239"
},
"is_aggregator": {
"type": "boolean",
"example": true,
"default": true
}
}
},
"created_at": {
"type": "string",
"example": "2024-09-05T06:29:27.721Z"
},
"updated_at": {
"type": "string",
"example": "2024-09-05T06:30:40.640Z"
}
}
}
},
"created_at": {
"type": "string",
"example": "2024-07-19T11:27:55.664Z"
},
"updated_at": {
"type": "string",
"example": "2024-07-19T11:28:52.487Z"
}
}
}
}
},
{
"title": "Cancel Pending",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"order_id": {
"type": "string",
"example": "v1-241010170109-aa-l63F0Y"
},
"merchant_order_reference": {
"type": "string",
"example": "4e0631bb-1a1f-45e5-88f0-47219ffdc73a"
},
"type": {
"type": "string",
"example": "CHARGE"
},
"status": {
"type": "string",
"example": "CANCELLED"
},
"merchant_id": {
"type": "string",
"example": "108272"
},
"order_amount": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"example": 10000,
"default": 0
},
"currency": {
"type": "string",
"example": "INR"
}
}
},
"pre_auth": {
"type": "boolean",
"example": true,
"default": true
},
"allowed_payment_methods": {
"type": "array",
"items": {
"type": "string",
"example": "CARD"
}
},
"notes": {
"type": "string",
"example": "order1"
},
"callback_url": {
"type": "string",
"example": "https://sample-callback-url"
},
"failure_callback_url": {
"type": "string",
"example": "https://sample-failure-callback-url"
},
"purchase_details": {
"type": "object",
"properties": {
"customer": {
"type": "object",
"properties": {
"email_id": {
"type": "string",
"example": "joe.sam@gmail.com"
},
"first_name": {
"type": "string",
"example": "joe"
},
"last_name": {
"type": "string",
"example": "kumar"
},
"customer_id": {
"type": "string",
"example": "192212"
},
"mobile_number": {
"type": "string",
"example": "192192883"
},
"country_code": {
"type": "string",
"example": "91"
},
"billing_address": {
"type": "object",
"properties": {
"address1": {
"type": "string",
"example": "10 Downing Street Westminster London"
},
"address2": {
"type": "string",
"example": "Oxford Street Westminster London"
},
"address3": {
"type": "string",
"example": "Baker Street Westminster London"
},
"pincode": {
"type": "string",
"example": "51524036"
},
"city": {
"type": "string",
"example": "Westminster"
},
"state": {
"type": "string",
"example": "Westminster"
},
"country": {
"type": "string",
"example": "London"
},
"full_name": {
"type": "string",
"example": "Kevin Bob"
},
"adddress_type": {
"type": "string",
"example": "Home"
},
"address_category": {
"type": "string",
"example": "billing"
}
}
},
"shipping_address": {
"type": "object",
"properties": {
"address1": {
"type": "string",
"example": "10 Downing Street Westminster London"
},
"address2": {
"type": "string",
"example": "Oxford Street Westminster London"
},
"address3": {
"type": "string",
"example": "Baker Street Westminster London"
},
"pincode": {
"type": "string",
"example": "51524036"
},
"city": {
"type": "string",
"example": "Westminster"
},
"state": {
"type": "string",
"example": "Westminster"
},
"country": {
"type": "string",
"example": "London"
},
"full_name": {
"type": "string",
"example": "Kevin Bob"
},
"adddress_type": {
"type": "string",
"example": "Home"
},
"address_category": {
"type": "string",
"example": "shipping"
}
}
}
}
},
"merchant_metadata": {
"type": "object",
"properties": {
"invoice_number": {
"type": "string",
"example": "HLS0001"
}
}
}
}
},
"payments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "v1-241010170109-aa-l63F0Y-cc-J"
},
"status": {
"type": "string",
"example": "CANCELLED"
},
"payment_amount": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"example": 10000,
"default": 0
},
"currency": {
"type": "string",
"example": "INR"
}
}
},
"payment_method": {
"type": "string",
"example": "CARD"
},
"payment_option": {
"type": "object",
"properties": {
"card_data": {
"type": "object",
"properties": {
"card_type": {
"type": "string",
"example": "CREDIT"
},
"network_name": {
"type": "string",
"example": "MASTERCARD"
},
"issuer_name": {
"type": "string",
"example": "ICICI BANK LIMITED"
},
"card_category": {
"type": "string",
"example": ""
},
"country_code": {
"type": "string",
"example": "IND"
},
"token_txn_type": {
"type": "string",
"example": "ALT_TOKEN"
},
"last4_digit": {
"type": "string",
"example": "1091"
},
"save": {
"type": "boolean",
"example": false,
"default": true
},
"is_native_otp_eligible": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
},
"acquirer_data": {
"type": "object",
"properties": {
"approval_code": {
"type": "string",
"example": "831000"
},
"acquirer_reference": {
"type": "string",
"example": "7285796824536663503954"
},
"rrn": {
"type": "string",
"example": "428417534659"
},
"is_aggregator": {
"type": "boolean",
"example": true,
"default": true
}
}
},
"created_at": {
"type": "string",
"example": "2024-10-10T17:01:09.141Z"
},
"updated_at": {
"type": "string",
"example": "2024-10-10T17:03:22.332Z"
}
}
}
},
"created_at": {
"type": "string",
"example": "2024-10-10T17:01:09.063Z"
},
"updated_at": {
"type": "string",
"example": "2024-10-10T17:03:22.334Z"
},
"integration_mode": {
"type": "string",
"example": "SEAMLESS"
}
}
}
}
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"code\":\"UNAUTHORIZED\",\n \"message\":\"Unauthorized\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "UNAUTHORIZED"
},
"message": {
"type": "string",
"example": "Unauthorized"
}
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"code\": \"ORDER_NOT_FOUND\",\n \"message\": \"Order not found\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "ORDER_NOT_FOUND"
},
"message": {
"type": "string",
"example": "Order not found"
}
}
}
}
}
},
"422": {
"description": "422",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"code\": \"OPERATION_NOT_ALLOWED\",\n \"message\": \"Void is not allowed\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "OPERATION_NOT_ALLOWED"
},
"message": {
"type": "string",
"example": "Void is not allowed"
}
}
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"Internal Server Error\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "INTERNAL_ERROR"
},
"message": {
"type": "string",
"example": "Internal Server Error"
}
}
}
}
}
}
},
"deprecated": false
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": true,
"proxy-enabled": true
},
"x-readme-fauxas": true
}
```