Skip to main content
POST
/
v1
/
transactions
/
{id}
/
cancel
Cancel a transaction
curl --request POST \
  --url https://api.yorlet.com/v1/transactions/{id}/cancel \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "created": 123,
  "object": "transaction",
  "adaptive_pricing": {
    "localized_prices": [
      {
        "amount": 123,
        "currency": "<string>",
        "presentment_exchange_rate": {
          "currency": "<string>",
          "exchange_rate": 123
        }
      }
    ]
  },
  "amount": 123,
  "application": "<string>",
  "balance_transaction": "<string>",
  "client_secret": "<string>",
  "confirmed_at": 123,
  "cross_border": {
    "amount": 123,
    "enabled": true
  },
  "currency": "<string>",
  "customer": "<string>",
  "description": "<string>",
  "dispute": "<string>",
  "invoice": "<string>",
  "last_payment_error": {
    "code": "<string>",
    "failed_at": 123,
    "message": "<string>"
  },
  "next_action": {
    "type": "redirect_to_url",
    "redirect_to_url": {
      "url": "<string>"
    }
  },
  "paid_at": 123,
  "payment_method": "<string>",
  "payment_method_types": [
    "<string>"
  ],
  "payment_session": "<string>",
  "presentment_details": {
    "amount": 123,
    "currency": "<string>"
  },
  "processing": {
    "type": "bacs_debit"
  },
  "receipt_url": "<string>",
  "reporting_type": "<string>",
  "transfer_group": "<string>",
  "account": "<string>",
  "deleted": false,
  "amount_refunded": 0,
  "disputed": false,
  "metadata": {},
  "refunded": false
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Path Parameters

​
id
string
required

The id identifier.

Response

200 - application/json

Returns a transaction object if successful.

​
id
string
required

Unique identifier for the object.

​
created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

​
object
enum<string>
required
Available options:
transaction
​
adaptive_pricing
object
required
​
amount
number
required
​
application
string | null
required
​
balance_transaction
required
​
capture_method
enum<string> | null
required
Available options:
automatic,
manual,
null
​
client_secret
string | null
required
​
confirmed_at
number | null
required
​
cross_border
object
required
​
currency
string
required
​
customer
required
​
description
string | null
required
​
dispute
required
​
invoice
required
​
last_payment_error
object
required
​
next_action
object
required
​
paid_at
number | null
required
​
payment_method
required
​
payment_method_types
string[]
required
​
payment_session
required
​
presentment_details
object
required
​
processing
object
required
​
receipt_url
string | null
required
​
reporting_type
string
required
​
status
enum<string>
required
Available options:
requires_payment_method,
requires_confirmation,
requires_action,
processing,
canceled,
succeeded
​
transfer_group
string | null
required
​
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

​
deleted
boolean
default:false

Only returned if the object has been deleted.

​
amount_refunded
number
default:0
​
disputed
boolean
default:false
​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

​
refunded
boolean
default:false