Skip to main content
POST
/
transactions
/
{transaction_id}
/
cancel
C#
using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

var res = await sdk.Transactions.CancelAsync(transactionId: "7099948d-7286-47e4-aad8-b68f7eb44591");

// handle response
package main

import(
	"context"
	"os"
	gr4vygo "github.com/gr4vy/gr4vy-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := gr4vy.New(
		gr4vy.WithID("example"),
		gr4vy.WithServer(gr4vy.ServerSandbox),
		gr4vy.WithSecuritySource(withToken),
		gr4vy.WithMerchantAccountID("default"),
	)

    res, err := s.Transactions.Cancel(ctx, "7099948d-7286-47e4-aad8-b68f7eb44591")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}
package hello.world;

import com.gr4vy.sdk.Gr4vy;
import com.gr4vy.sdk.models.errors.*;
import com.gr4vy.sdk.models.operations.CancelTransactionResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Gr4vy sdk = Gr4vy.builder()
                .id("example")
                .server(AvailableServers.SANDBOX)
                .merchantAccountId("default")
                .securitySource(new BearerSecuritySource.Builder(privateKey).build())
            .build();

        CancelTransactionResponse res = sdk.transactions().cancel()
                .transactionId("7099948d-7286-47e4-aad8-b68f7eb44591")
                .call();

        if (res.transactionCancel().isPresent()) {
            System.out.println(res.transactionCancel().get());
        }
    }
}
declare(strict_types=1);

require 'vendor/autoload.php';

use Gr4vy;

$sdk = Gr4vy\SDK::builder()
    ->setId('example')
    ->setServer('sandbox')
    ->setSecuritySource(Auth::withToken($privateKey))
    ->setMerchantAccountId('default')
    ->build();



$response = $sdk->transactions->cancel(
    transactionId: '7099948d-7286-47e4-aad8-b68f7eb44591'
);

if ($response->transactionCancel !== null) {
    // handle response
}
from gr4vy import Gr4vy
import os


with Gr4vy(
    id="example",
    server="sandbox",
    merchant_account_id="default",
    bearer_auth=auth.with_token(open("./private_key.pem").read())
) as g_client:

    res = g_client.transactions.cancel(transaction_id="7099948d-7286-47e4-aad8-b68f7eb44591")

    # Handle response
    print(res)
import { Gr4vy, withToken } from "@gr4vy/sdk";
import fs from "fs";

const gr4vy = new Gr4vy({
    id: "example",
    server: "sandbox",
    merchantAccountId: "default",
    bearerAuth: withToken({
      privateKey: fs.readFileSync("private_key.pem", "utf8"),
    }),
});

async function run() {
  const result = await gr4vy.transactions.cancel("7099948d-7286-47e4-aad8-b68f7eb44591");

  console.log(result);
}

run();
curl --request POST \
  --url https://api.sandbox.{id}.gr4vy.app/transactions/{transaction_id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "code": "service_error",
  "raw_response_code": "E104",
  "raw_response_description": "Internal error",
  "transaction": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reconciliation_id": "<string>",
    "merchant_account_id": "<string>",
    "currency": "<string>",
    "amount": 123,
    "authorized_amount": 123,
    "captured_amount": 123,
    "refunded_amount": 123,
    "settled_amount": 123,
    "settled": true,
    "gift_card_redemptions": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "refunded_amount": 123,
        "gift_card": {
          "bin": "<string>",
          "sub_bin": "<string>",
          "last4": "<string>",
          "type": "gift-card",
          "id": "356d56e5-fe16-42ae-97ee-8d55d846ae2e"
        },
        "type": "gift-card-redemption",
        "gift_card_service_redemption_id": "xYqd43gySMtori",
        "error_code": "expired_card",
        "raw_error_code": "10001",
        "raw_error_message": "Card expired"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "disputed": true,
    "merchant_initiated": true,
    "is_subsequent_payment": true,
    "multi_tender": true,
    "account_funding_transaction": true,
    "type": "transaction",
    "settled_currency": "USD",
    "country": "US",
    "external_identifier": "transaction-12345",
    "payment_method": {
      "type": "payment-method",
      "approval_url": "https://gr4vy.app/redirect/12345",
      "country": "US",
      "currency": "USD",
      "details": {
        "bin": "<string>",
        "card_issuer_name": "<string>"
      },
      "expiration_date": "12/30",
      "fingerprint": "20eb353620155d2b5fc864cc46a73ea77cb92c725238650839da1813fa987a17",
      "label": "1234",
      "last_replaced_at": "2013-07-16T19:23:00.000+00:00",
      "mode": "card",
      "scheme": "visa",
      "id": "852b951c-d7ea-4c98-b09e-4a1c9e97c077",
      "approval_target": "any",
      "external_identifier": "card-12345",
      "payment_account_reference": "V0010014629724763377327521982"
    },
    "method": "card",
    "instrument_type": "pan",
    "error_code": "missing_redirect_url",
    "payment_service": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payment_service_definition_id": "<string>",
      "display_name": "<string>",
      "type": "payment-service"
    },
    "pending_review": false,
    "buyer": {
      "type": "buyer",
      "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
      "display_name": "John Doe",
      "external_identifier": "buyer-12345",
      "billing_details": {
        "first_name": "John",
        "last_name": "Doe",
        "email_address": "john@example.com",
        "phone_number": "+1234567890",
        "address": {
          "city": "San Jose",
          "country": "US",
          "postal_code": "94560",
          "state": "California",
          "state_code": "US-CA",
          "house_number_or_name": "10",
          "line1": "Stafford Appartments",
          "line2": "29th Street",
          "organization": "Gr4vy"
        },
        "tax_id": {
          "value": "<string>"
        }
      },
      "account_number": "<string>"
    },
    "raw_response_code": "E104",
    "raw_response_description": "Missing redirect URL",
    "shipping_details": {
      "first_name": "John",
      "last_name": "Doe",
      "email_address": "john@example.com",
      "phone_number": "+1234567890",
      "address": {
        "city": "San Jose",
        "country": "US",
        "postal_code": "94560",
        "state": "California",
        "state_code": "US-CA",
        "house_number_or_name": "10",
        "line1": "Stafford Appartments",
        "line2": "29th Street",
        "organization": "Gr4vy"
      },
      "id": "bf8c36ad-02d9-4904-b0f9-a230b149e341",
      "buyer_id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
      "type": "shipping-details"
    },
    "checkout_session_id": "4137b1cf-39ac-42a8-bad6-1c680d5dab6b",
    "gift_card_service": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "display_name": "<string>",
      "type": "gift-card-service"
    },
    "airline": {
      "booking_code": "X36Q9C",
      "is_cardholder_traveling": true,
      "issued_address": "123 Broadway, New York",
      "issued_at": "2013-07-16T19:23:00.000+00:00",
      "issuing_carrier_code": "649",
      "issuing_carrier_name": "Air Transat A.T. Inc",
      "issuing_iata_designator": "TS",
      "issuing_icao_code": "TSC",
      "legs": [
        {
          "arrival_airport": "LAX",
          "arrival_at": "2013-07-16T19:23:00.000+00:00",
          "arrival_city": "Los Angeles",
          "arrival_country": "US",
          "carrier_code": "649",
          "carrier_name": "Air Transat A.T. Inc",
          "iata_designator": "TS",
          "icao_code": "TSC",
          "coupon_number": "15885566",
          "departure_airport": "LHR",
          "departure_at": "2013-07-16T19:23:00.000+00:00",
          "departure_city": "London",
          "departure_country": "GB",
          "departure_tax_amount": 1200,
          "fare_amount": 129900,
          "fare_basis_code": "FY",
          "fee_amount": 1200,
          "flight_class": "E",
          "flight_number": "101",
          "route_type": "round_trip",
          "seat_class": "F",
          "stop_over": false,
          "tax_amount": 1200
        }
      ],
      "passenger_name_record": "JOHN L",
      "passengers": [
        {
          "age_group": "adult",
          "date_of_birth": "2013-07-16",
          "email_address": "john@example.com",
          "first_name": "John",
          "frequent_flyer_number": "15885566",
          "last_name": "Luhn",
          "passport_number": "11117700225",
          "phone_number": "+1234567890",
          "ticket_number": "BA1236699999",
          "title": "Mr.",
          "country_code": "US"
        }
      ],
      "reservation_system": "Amadeus",
      "restricted_ticket": false,
      "ticket_delivery_method": "electronic",
      "ticket_number": "123-1234-151555",
      "travel_agency_code": "12345",
      "travel_agency_invoice_number": "EG15555155",
      "travel_agency_name": "ACME Agency",
      "travel_agency_plan_name": "B733"
    },
    "auth_response_code": "00",
    "avs_response_code": "match",
    "cvv_response_code": "match",
    "anti_fraud_decision": "accept",
    "cart_items": [
      {
        "name": "<string>",
        "quantity": 123,
        "unit_amount": 49999999,
        "discount_amount": 0,
        "tax_amount": 0,
        "external_identifier": "goprohd",
        "sku": "GPHD1078",
        "upc": "012345678905",
        "product_url": "https://example.com/catalog/go-pro-hd",
        "image_url": "https://example.com/images/go-pro-hd.jpg",
        "categories": [
          "camera",
          "travel",
          "gear"
        ],
        "product_type": "physical",
        "seller_country": "US",
        "tax_exempt": false,
        "unit_of_measure": "feet",
        "commodity_code": "43211503",
        "description": "A brief description of an interesting item.",
        "duty_amount": 1299,
        "shipping_amount": 1299
      }
    ],
    "statement_descriptor": {
      "name": "ACME",
      "description": "ACME San Jose Electronics",
      "city": "San Jose",
      "country": "US",
      "phone_number": "+1234567890",
      "url": "www.example.com",
      "postal_code": "94560"
    },
    "scheme_transaction_id": "123456789012345",
    "transaction_link_id": "123456789012345",
    "three_d_secure": {
      "version": "2.2.0",
      "status": "complete",
      "method": "challenge",
      "response_data": {
        "cavv": "<string>",
        "eci": "<string>",
        "version": "<string>",
        "directory_response": "<string>",
        "authentication_response": "<string>",
        "cavv_algorithm": "<string>",
        "xid": "<string>",
        "scheme": "visa"
      },
      "error_data": {
        "code": "305",
        "description": "Invalid ThreeDSCompInd",
        "detail": "The threeDSCompInd must be 'Y' when successful",
        "component": "C"
      },
      "amount": 123
    },
    "payment_service_transaction_id": "tx-12345",
    "additional_identifiers": {},
    "metadata": {
      "cohort": "cohort-12345",
      "order": "order-12345"
    },
    "authorized_at": "2013-07-16T19:23:00.000+00:00",
    "captured_at": "2013-07-16T19:23:00.000+00:00",
    "voided_at": "2013-07-16T19:23:00.000+00:00",
    "canceled_at": "2013-07-16T19:23:00.000+00:00",
    "approval_expires_at": "2013-07-16T19:23:00.000+00:00",
    "buyer_approval_timedout_at": "2013-07-16T19:23:00.000+00:00",
    "recipient": {
      "first_name": "<string>",
      "last_name": "<string>",
      "address": {
        "city": "San Jose",
        "country": "US",
        "postal_code": "94560",
        "state": "California",
        "state_code": "US-CA",
        "house_number_or_name": "10",
        "line1": "Stafford Appartments",
        "line2": "29th Street",
        "organization": "Gr4vy"
      },
      "account_number": "act12345",
      "date_of_birth": "1995-12-23"
    },
    "merchant_advice_code": "02",
    "installment_count": 3,
    "session_token": "j3CZf9Eg6nUygMAVA6PXsVWGHiccj",
    "tax_amount": 1299,
    "merchant_tax_id": "<string>",
    "purchase_order_number": "<string>",
    "customer_reference_number": "<string>",
    "amount_includes_tax": false,
    "supplier_order_number": "<string>",
    "duty_amount": 1299,
    "shipping_amount": 1299,
    "iso_response_code": "0110"
  },
  "type": "transaction-cancel"
}
{
  "type": "error",
  "code": "bad_request",
  "status": 400,
  "message": "Generic error",
  "details": []
}
{
  "type": "error",
  "code": "unauthorized",
  "status": 401,
  "message": "No valid API authentication found",
  "details": []
}
{
  "type": "error",
  "code": "forbidden",
  "status": 403,
  "message": "Generic error",
  "details": []
}
{
  "type": "error",
  "code": "not_found",
  "status": 404,
  "message": "The resource could not be found",
  "details": []
}
{
  "type": "error",
  "code": "method_not_allowed",
  "status": 405,
  "message": "Method Not Allowed",
  "details": []
}
{
  "type": "error",
  "code": "duplicate_record",
  "status": 409,
  "message": "Generic error",
  "details": [],
  "resource_id": "cdc70639-cb9c-4222-a73f-b8ce39f7821b"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}
{
  "type": "error",
  "code": "too_early",
  "status": 425,
  "message": "Generic error",
  "details": []
}
{
  "type": "error",
  "code": "too_many_requests",
  "status": 429,
  "message": "Generic error",
  "details": []
}
{
  "type": "error",
  "code": "server_error",
  "status": 500,
  "message": "Request could not be processed",
  "details": []
}
{
  "type": "error",
  "code": "bad_gateway",
  "status": 502,
  "message": "Request could not be processed",
  "details": []
}
{
  "type": "error",
  "code": "gateway_timeout",
  "status": 504,
  "message": "Request could not be processed",
  "details": []
}
This endpoint requires the transactions.write scope.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-gr4vy-merchant-account-id
string

The ID of the merchant account to use for this request.

Example:

"default"

Path Parameters

​
transaction_id
string<uuid>
required

The ID of the transaction

Example:

"7099948d-7286-47e4-aad8-b68f7eb44591"

Response

Successful Response

​
status
enum<string>
required

The status of the cancel call.

Available options:
succeeded,
pending,
failed
Example:

"succeeded"

​
code
string | null
required

The standardized error code set by Gr4vy.

Example:

"service_error"

​
raw_response_code
string | null
required

This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services.

Example:

"E104"

​
raw_response_description
string | null
required

This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services.

Example:

"Internal error"

​
transaction
Transaction · object
required

The transaction associated to this cancel.

​
type
string
default:transaction-cancel

Always transaction-cancel.

Allowed value: "transaction-cancel"
Example:

"transaction-cancel"