Sign in

v1

latestOpenAPI 3.0.02026-07-262561105.1 KB
Transactions API

Update Transaction

Updates a transaction by specifying the values of the parameters passed. Any parameters that you don't provide won't change.

post/transactions/{transaction_id}

Path parameters

transaction_idstring required
Example:ABCD-1234

A unique ID representing the transaction’s loan or charge ID.

Request body

order_idstring

Identifies the order within the merchant's order management system that this transaction corresponds to. It is only returned in the response if included in the request.

reference_idstring nullable

An optional, unique identifier that may be associated with each transaction event and reconciled with the system of record used by the merchant.

shipping_carrierstring nullable

The shipping carrier used to ship the items.

shipping_confirmationstring nullable

The tracking number of the shipment.

Example request

{
  "order_id": "order_125",
  "reference_id": "202307011027",
  "shipping_carrier": "USPS",
  "shipping_confirmation": "C12345678901234",
  "shipping": {
    "address": {
      "street1": "123 Example Street",
      "street2": "Apt 123",
      "city": "Vancouver",
      "region1_code": "BC",
      "postal_code": "V7X 3S9",
      "country_code": "CA"
    },
    "email": "test@example.com",
    "phone_number": "1234567890"
  }
}

Response

HTTP 200 OK