API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

Transaction

Version 2019-10

Transactions are created for every order that results in an exchange of money.

There are five types of transactions:

  • Authorization: An amount reserved against the cardholder's funding source. Money does not change hands until the authorization is captured.
  • Sale: An authorization and capture performed together in a single step.
  • Capture: A transfer of the money that was reserved during the authorization stage.
  • Void: A cancellation of a pending authorization or capture.
  • Refund: A partial or full return of captured funds to the cardholder. A refund can happen only after a capture is processed.

Refund transactions must be created by using the Refund resource.

Note

An order can have no more than 100 transactions associated with it.

What you can do with Transaction

The Shopify API lets you do the following with the Transaction resource. More detailed versions of these general actions may be available:

Transaction properties

amount 
"amount": "10.00"

The amount of money included in the transaction. If you don't provide a value for `amount`, then it defaults to the total cost of the order (even if a previous transaction has been made towards it).

authorization 
"authorization": "ch_1AtJu6CktlpKSclI4zjeQb2t"

The authorization code associated with the transaction.
created_at
read-only 
"created_at": "2012-03-13T16:09:54-04:00"

The date and time (ISO 8601 format) when the transaction was created.
currency 
"currency": "USD"

The three-letter code (ISO 4217 format) for the currency used for the payment.
device_id
read-only 
"device_id": 1

The ID for the device.
error_code
read-only 
"error_code": "invalid_cvc"

A standardized error code, independent of the payment provider. Valid values:

  • incorrect_number
  • invalid_number
  • invalid_expiry_date
  • invalid_cvc
  • expired_card
  • incorrect_cvc
  • incorrect_zip
  • incorrect_address
  • card_declined
  • processing_error
  • call_issuer
  • pick_up_card
gateway 
"gateway": "shopify_payments"

The name of the gateway the transaction was issued through. A list of gateways can be found on Shopify's payment gateways page.

id
read-only 
"id": 999225661

The ID for the transaction.
kind
required 
"kind": "capture"

The transaction's type. Valid values:

  • authorization: Money that the customer has agreed to pay. The authorization period can be between 7 and 30 days (depending on your payment service) while a store waits for a payment to be captured.
  • capture: A transfer of money that was reserved during the authorization of a shop.
  • sale: The authorization and capture of a payment performed in one single step.
  • void: The cancellation of a pending authorization or capture.
  • refund: The partial or full return of captured money to the customer.
location_id
read-only 
"id": 49202758

The ID of the physical location where the transaction was processed.
message
read-only 
"message": "Marked the Cash on Delivery (COD) payment as received"

A string generated by the payment provider with additional information about why the transaction succeeded or failed.

order_id 
"order_id": 450789469

The ID for the order that the transaction is associated with.
payment_details
read-only 
"payment_details": {
  "credit_card_bin": "123456",
  "avs_result_code": "Y",
  "cvv_result_code": "M",
  "credit_card_number": "•••• •••• •••• 4242",
  "credit_card_company": "Visa"
}

Information about the credit card used for this transaction. It has the following properties:

  • credit_card_bin: The issuer identification number (IIN), formerly known as bank identification number (BIN) of the customer's credit card. This is made up of the first few digits of the credit card number.
  • avs_result_code: The response code from the address verification system. The code is always a single letter. Refer to this chart for the codes and their definitions.
  • cvv_result_code: The response code from the credit card company indicating whether the customer entered the card security code, or card verification value, correctly. The code is a single letter or empty string; see this chart for the codes and their definitions.
  • credit_card_number: The customer's credit card number, with most of the leading digits redacted.
  • credit_card_company: The name of the company that issued the customer's credit card.
parent_id 
"parent_id": 584698724408

The ID of an associated transaction.

  • For capture transactions, the parent needs to be an authorization transaction.
  • For void transactions, the parent needs to be an authorization transaction.
  • For refund transactions, the parent needs to be a capture or sale transaction.
processed_at 
"processed_at": "2018-01-10T11:00:00-05:00"

The date and time (ISO 8601 format) when a transaction was processed. This value is the date that's used in the analytic reports. By default, it matches the created_at value. If you're importing transactions from an app or another platform, then you can set processed_at to a date and time in the past to match when the original transaction was processed.

receipt
read-only 
"receipt": {}

A transaction receipt attached to the transaction by the gateway. The value of this field depends on which gateway the shop is using.

source_name
read-only 
"source_name": "web"

The origin of the transaction. This is set by Shopify and can't be overridden. Example values: web, pos, iphone, and android.

status 
"status": "success"

The status of the transaction. Valid values: pending, failure, success, and error.
test 
"test": true

Whether the transaction is a test transaction.
user_id 
"user_id": 106045196

The ID for the user who was logged into the Shopify POS device when the order was processed, if applicable.
currency_exchange_adjustment 
"currency_exchange_adjustment": {
  "id": 1,
  "adjustment": "-0.01",
  "original_amount": "-53.62",
  "final_amount": "-53.63",
  "currency": "CAD"
}

An adjustment on the transaction showing the amount lost or gained due to fluctuations in the currency exchange rate. It has the following properties:

  • ID: The ID of the adjustment.
  • adjustment: The difference between the amounts on the associated transaction and the parent transaction.
  • original_amount: The amount of the parent transaction in the shop currency.
  • final_amount: The amount of the associated transaction in the shop currency.
  • currency: The shop currency.
Requires the header X-Shopify-Api-Features = include-currency-exchange-adjustments.

Endpoints

GET /admin/api/2019-10/orders/{order_id}/transactions.json

Retrieves a list of transactions.

Transactions attached to multi-currency orders are in the presentment currency by default. To retrieve transactions in the shop currency, include the URL parameter in_shop_currency=true.

since_id

Retrieve only transactions after the specified ID.
fields

Show only certain fields, specifed by a comma-separated list of fields names.
in_shop_currency

Show amounts in the shop currency.

(default: false)

Retrieve an order's transactions

GET /admin/api/2019-10/orders/450789469/transactions.json
View Response 
HTTP/1.1 200 OK
{
  "transactions": [
    {
      "id": 179259969,
      "order_id": 450789469,
      "kind": "refund",
      "gateway": "bogus",
      "status": "success",
      "message": null,
      "created_at": "2005-08-05T12:59:12-04:00",
      "test": false,
      "authorization": "authorization-key",
      "location_id": null,
      "user_id": null,
      "parent_id": 801038806,
      "processed_at": "2005-08-05T12:59:12-04:00",
      "device_id": null,
      "error_code": null,
      "source_name": "web",
      "receipt": {},
      "currency_exchange_adjustment": null,
      "amount": "209.00",
      "currency": "USD",
      "admin_graphql_api_id": "gid://shopify/OrderTransaction/179259969"
    },
    {
      "id": 389404469,
      "order_id": 450789469,
      "kind": "authorization",
      "gateway": "bogus",
      "status": "success",
      "message": null,
      "created_at": "2005-08-01T11:57:11-04:00",
      "test": false,
      "authorization": "authorization-key",
      "location_id": null,
      "user_id": null,
      "parent_id": null,
      "processed_at": "2005-08-01T11:57:11-04:00",
      "device_id": null,
      "error_code": null,
      "source_name": "web",
      "payment_details": {
        "credit_card_bin": null,
        "avs_result_code": null,
        "cvv_result_code": null,
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa",
        "credit_card_name": null,
        "credit_card_wallet": null,
        "credit_card_expiration_month": null,
        "credit_card_expiration_year": null
      },
      "receipt": {
        "testcase": true,
        "authorization": "123456"
      },
      "currency_exchange_adjustment": null,
      "amount": "598.94",
      "currency": "USD",
      "admin_graphql_api_id": "gid://shopify/OrderTransaction/389404469"
    },
    {
      "id": 801038806,
      "order_id": 450789469,
      "kind": "capture",
      "gateway": "bogus",
      "status": "success",
      "message": null,
      "created_at": "2005-08-05T10:22:51-04:00",
      "test": false,
      "authorization": "authorization-key",
      "location_id": null,
      "user_id": null,
      "parent_id": 389404469,
      "processed_at": "2005-08-05T10:22:51-04:00",
      "device_id": null,
      "error_code": null,
      "source_name": "web",
      "receipt": {},
      "currency_exchange_adjustment": null,
      "amount": "250.94",
      "currency": "USD",
      "admin_graphql_api_id": "gid://shopify/OrderTransaction/801038806"
    }
  ]
}

Retrieve an order's transactions after a specified ID

GET /admin/api/2019-10/orders/450789469/transactions.json?since_id=801038806
View Response 
HTTP/1.1 200 OK
{
  "transactions": [
    {
      "id": 1072844665,
      "order_id": 450789469,
      "kind": "capture",
      "gateway": "bogus",
      "status": "success",
      "message": "Bogus Gateway: Forced success",
      "created_at": "2021-04-01T14:33:34-04:00",
      "test": true,
      "authorization": null,
      "location_id": null,
      "user_id": null,
      "parent_id": 389404469,
      "processed_at": "2021-04-01T14:33:34-04:00",
      "device_id": null,
      "error_code": null,
      "source_name": "755357713",
      "receipt": {},
      "currency_exchange_adjustment": null,
      "amount": "10.00",
      "currency": "USD",
      "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844665"
    }
  ]
}
GET /admin/api/2019-10/orders/{order_id}/transactions/count.json
Retrieves a count of an order's transactions.

Count an order's transactions

GET /admin/api/2019-10/orders/450789469/transactions/count.json
View Response 
HTTP/1.1 200 OK
{
  "count": 3
}
GET /admin/api/2019-10/orders/{order_id}/transactions/{transaction_id}.json

Retrieves a specific transaction.

Transactions attached to multi-currency orders are in the presentment currency by default. To retrieve transactions in the shop currency, include the URL parameter in_shop_currency=true.

fields

Show only certain fields, specified by a comma-separated list of field names.
in_shop_currency

Show amounts in the shop currency.

(default: false)

Retrieve a specific transaction for an order

GET /admin/api/2019-10/orders/450789469/transactions/389404469.json
View Response 
HTTP/1.1 200 OK
{
  "transaction": {
    "id": 389404469,
    "order_id": 450789469,
    "kind": "authorization",
    "gateway": "bogus",
    "status": "success",
    "message": null,
    "created_at": "2005-08-01T11:57:11-04:00",
    "test": false,
    "authorization": "authorization-key",
    "location_id": null,
    "user_id": null,
    "parent_id": null,
    "processed_at": "2005-08-01T11:57:11-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "web",
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "receipt": {
      "testcase": true,
      "authorization": "123456"
    },
    "currency_exchange_adjustment": null,
    "amount": "598.94",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/389404469"
  }
}
POST /admin/api/2019-10/orders/{order_id}/transactions.json

Creates a transaction for an order.

source

The origin of the transaction. Set to external to create a cash transaction for the associated order.

Capture a specified amount on an authorized order, and associate the capture with an authorization by including its ID

POST /admin/api/2019-10/orders/450789469/transactions.json
{
  "transaction": {
    "currency": "USD",
    "amount": "10.00",
    "kind": "capture",
    "parent_id": 389404469
  }
}
View Response 
HTTP/1.1 201 Created
{
  "transaction": {
    "id": 1072844666,
    "order_id": 450789469,
    "kind": "capture",
    "gateway": "bogus",
    "status": "success",
    "message": "Bogus Gateway: Forced success",
    "created_at": "2021-04-01T14:33:50-04:00",
    "test": true,
    "authorization": null,
    "location_id": null,
    "user_id": null,
    "parent_id": 389404469,
    "processed_at": "2021-04-01T14:33:50-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "755357713",
    "receipt": {},
    "currency_exchange_adjustment": null,
    "amount": "10.00",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844666"
  }
}

Void a transaction

POST /admin/api/2019-10/orders/450789469/transactions.json
{
  "transaction": {
    "currency": "USD",
    "amount": "10.00",
    "kind": "void",
    "parent_id": 389404469
  }
}
View Response 
HTTP/1.1 201 Created
{
  "transaction": {
    "id": 1072844667,
    "order_id": 450789469,
    "kind": "void",
    "gateway": "bogus",
    "status": "success",
    "message": "Bogus Gateway: Forced success",
    "created_at": "2021-04-01T14:33:56-04:00",
    "test": true,
    "authorization": null,
    "location_id": null,
    "user_id": null,
    "parent_id": 389404469,
    "processed_at": "2021-04-01T14:33:56-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "755357713",
    "receipt": {},
    "currency_exchange_adjustment": null,
    "amount": "0.00",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844667"
  }
}

Create a test transaction

POST /admin/api/2019-10/orders/450789469/transactions.json
{
  "transaction": {
    "currency": "USD",
    "amount": "10.00",
    "kind": "capture",
    "parent_id": 389404469,
    "test": true
  }
}
View Response 
HTTP/1.1 201 Created
{
  "transaction": {
    "id": 1072844668,
    "order_id": 450789469,
    "kind": "capture",
    "gateway": "bogus",
    "status": "success",
    "message": "Bogus Gateway: Forced success",
    "created_at": "2021-04-01T14:34:01-04:00",
    "test": true,
    "authorization": null,
    "location_id": null,
    "user_id": null,
    "parent_id": 389404469,
    "processed_at": "2021-04-01T14:34:01-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "755357713",
    "receipt": {},
    "currency_exchange_adjustment": null,
    "amount": "10.00",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844668"
  }
}

Capture the full amount for an authorized order, and associate the capture with an authorization by including its authorization code

POST /admin/api/2019-10/orders/450789469/transactions.json
{
  "transaction": {
    "kind": "capture",
    "authorization": "authorization-key"
  }
}
View Response 
HTTP/1.1 201 Created
{
  "transaction": {
    "id": 1072844669,
    "order_id": 450789469,
    "kind": "capture",
    "gateway": "bogus",
    "status": "success",
    "message": "Bogus Gateway: Forced success",
    "created_at": "2021-04-01T14:34:04-04:00",
    "test": true,
    "authorization": null,
    "location_id": null,
    "user_id": null,
    "parent_id": 389404469,
    "processed_at": "2021-04-01T14:34:04-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "755357713",
    "receipt": {},
    "currency_exchange_adjustment": null,
    "amount": "598.94",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844669"
  }
}
Version 2020-01

Transactions are created for every order that results in an exchange of money.

There are five types of transactions:

  • Authorization: An amount reserved against the cardholder's funding source. Money does not change hands until the authorization is captured.
  • Sale: An authorization and capture performed together in a single step.
  • Capture: A transfer of the money that was reserved during the authorization stage.
  • Void: A cancellation of a pending authorization or capture.
  • Refund: A partial or full return of captured funds to the cardholder. A refund can happen only after a capture is processed.

Refund transactions must be created by using the Refund resource.

Note

An order can have no more than 100 transactions associated with it.

What you can do with Transaction

The Shopify API lets you do the following with the Transaction resource. More detailed versions of these general actions may be available:

Transaction properties

amount 
"amount": "10.00"

The amount of money included in the transaction. If you don't provide a value for `amount`, then it defaults to the total cost of the order (even if a previous transaction has been made towards it).

authorization 
"authorization": "ch_1AtJu6CktlpKSclI4zjeQb2t"

The authorization code associated with the transaction.
created_at
read-only 
"created_at": "2012-03-13T16:09:54-04:00"

The date and time (ISO 8601 format) when the transaction was created.
currency 
"currency": "USD"

The three-letter code (ISO 4217 format) for the currency used for the payment.
device_id
read-only 
"device_id": 1

The ID for the device.
error_code
read-only 
"error_code": "invalid_cvc"

A standardized error code, independent of the payment provider. Valid values:

  • incorrect_number
  • invalid_number
  • invalid_expiry_date
  • invalid_cvc
  • expired_card
  • incorrect_cvc
  • incorrect_zip
  • incorrect_address
  • card_declined
  • processing_error
  • call_issuer
  • pick_up_card
gateway 
"gateway": "shopify_payments"

The name of the gateway the transaction was issued through. A list of gateways can be found on Shopify's payment gateways page.

id
read-only 
"id": 999225661

The ID for the transaction.
kind
required 
"kind": "capture"

The transaction's type. Valid values:

  • authorization: Money that the customer has agreed to pay. The authorization period can be between 7 and 30 days (depending on your payment service) while a store waits for a payment to be captured.
  • capture: A transfer of money that was reserved during the authorization of a shop.
  • sale: The authorization and capture of a payment performed in one single step.
  • void: The cancellation of a pending authorization or capture.
  • refund: The partial or full return of captured money to the customer.
location_id
read-only 
"id": 49202758

The ID of the physical location where the transaction was processed.
message
read-only 
"message": "Marked the Cash on Delivery (COD) payment as received"

A string generated by the payment provider with additional information about why the transaction succeeded or failed.

order_id 
"order_id": 450789469

The ID for the order that the transaction is associated with.
payment_details
read-only 
"payment_details": {
  "credit_card_bin": "123456",
  "avs_result_code": "Y",
  "cvv_result_code": "M",
  "credit_card_number": "•••• •••• •••• 4242",
  "credit_card_company": "Visa"
}

Information about the credit card used for this transaction. It has the following properties:

  • credit_card_bin: The issuer identification number (IIN), formerly known as bank identification number (BIN) of the customer's credit card. This is made up of the first few digits of the credit card number.
  • avs_result_code: The response code from the address verification system. The code is always a single letter. Refer to this chart for the codes and their definitions.
  • cvv_result_code: The response code from the credit card company indicating whether the customer entered the card security code, or card verification value, correctly. The code is a single letter or empty string; see this chart for the codes and their definitions.
  • credit_card_number: The customer's credit card number, with most of the leading digits redacted.
  • credit_card_company: The name of the company that issued the customer's credit card.
parent_id 
"parent_id": 584698724408

The ID of an associated transaction.

  • For capture transactions, the parent needs to be an authorization transaction.
  • For void transactions, the parent needs to be an authorization transaction.
  • For refund transactions, the parent needs to be a capture or sale transaction.
processed_at 
"processed_at": "2018-01-10T11:00:00-05:00"

The date and time (ISO 8601 format) when a transaction was processed. This value is the date that's used in the analytic reports. By default, it matches the created_at value. If you're importing transactions from an app or another platform, then you can set processed_at to a date and time in the past to match when the original transaction was processed.

receipt
read-only 
"receipt": {}

A transaction receipt attached to the transaction by the gateway. The value of this field depends on which gateway the shop is using.

source_name
read-only 
"source_name": "web"

The origin of the transaction. This is set by Shopify and can't be overridden. Example values: web, pos, iphone, and android.

status 
"status": "success"

The status of the transaction. Valid values: pending, failure, success, and error.
test 
"test": true

Whether the transaction is a test transaction.
user_id 
"user_id": 106045196

The ID for the user who was logged into the Shopify POS device when the order was processed, if applicable.
currency_exchange_adjustment 
"currency_exchange_adjustment": {
  "id": 1,
  "adjustment": "-0.01",
  "original_amount": "-53.62",
  "final_amount": "-53.63",
  "currency": "CAD"
}

An adjustment on the transaction showing the amount lost or gained due to fluctuations in the currency exchange rate. It has the following properties:

  • ID: The ID of the adjustment.
  • adjustment: The difference between the amounts on the associated transaction and the parent transaction.
  • original_amount: The amount of the parent transaction in the shop currency.
  • final_amount: The amount of the associated transaction in the shop currency.
  • currency: The shop currency.
Requires the header X-Shopify-Api-Features = include-currency-exchange-adjustments.

Endpoints

GET /admin/api/2020-01/orders/{order_id}/transactions.json

Retrieves a list of transactions.

Transactions attached to multi-currency orders are in the presentment currency by default. To retrieve transactions in the shop currency, include the URL parameter in_shop_currency=true.

since_id

Retrieve only transactions after the specified ID.
fields

Show only certain fields, specifed by a comma-separated list of fields names.
in_shop_currency

Show amounts in the shop currency.

(default: false)

Retrieve an order's transactions

GET /admin/api/2020-01/orders/450789469/transactions.json
View Response 
HTTP/1.1 200 OK
{
  "transactions": [
    {
      "id": 179259969,
      "order_id": 450789469,
      "kind": "refund",
      "gateway": "bogus",
      "status": "success",
      "message": null,
      "created_at": "2005-08-05T12:59:12-04:00",
      "test": false,
      "authorization": "authorization-key",
      "location_id": null,
      "user_id": null,
      "parent_id": 801038806,
      "processed_at": "2005-08-05T12:59:12-04:00",
      "device_id": null,
      "error_code": null,
      "source_name": "web",
      "receipt": {},
      "currency_exchange_adjustment": null,
      "amount": "209.00",
      "currency": "USD",
      "admin_graphql_api_id": "gid://shopify/OrderTransaction/179259969"
    },
    {
      "id": 389404469,
      "order_id": 450789469,
      "kind": "authorization",
      "gateway": "bogus",
      "status": "success",
      "message": null,
      "created_at": "2005-08-01T11:57:11-04:00",
      "test": false,
      "authorization": "authorization-key",
      "location_id": null,
      "user_id": null,
      "parent_id": null,
      "processed_at": "2005-08-01T11:57:11-04:00",
      "device_id": null,
      "error_code": null,
      "source_name": "web",
      "payment_details": {
        "credit_card_bin": null,
        "avs_result_code": null,
        "cvv_result_code": null,
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa",
        "credit_card_name": null,
        "credit_card_wallet": null,
        "credit_card_expiration_month": null,
        "credit_card_expiration_year": null
      },
      "receipt": {
        "testcase": true,
        "authorization": "123456"
      },
      "currency_exchange_adjustment": null,
      "amount": "598.94",
      "currency": "USD",
      "admin_graphql_api_id": "gid://shopify/OrderTransaction/389404469"
    },
    {
      "id": 801038806,
      "order_id": 450789469,
      "kind": "capture",
      "gateway": "bogus",
      "status": "success",
      "message": null,
      "created_at": "2005-08-05T10:22:51-04:00",
      "test": false,
      "authorization": "authorization-key",
      "location_id": null,
      "user_id": null,
      "parent_id": 389404469,
      "processed_at": "2005-08-05T10:22:51-04:00",
      "device_id": null,
      "error_code": null,
      "source_name": "web",
      "receipt": {},
      "currency_exchange_adjustment": null,
      "amount": "250.94",
      "currency": "USD",
      "admin_graphql_api_id": "gid://shopify/OrderTransaction/801038806"
    }
  ]
}

Retrieve an order's transactions after a specified ID

GET /admin/api/2020-01/orders/450789469/transactions.json?since_id=801038806
View Response 
HTTP/1.1 200 OK
{
  "transactions": [
    {
      "id": 1072844665,
      "order_id": 450789469,
      "kind": "capture",
      "gateway": "bogus",
      "status": "success",
      "message": "Bogus Gateway: Forced success",
      "created_at": "2021-04-01T14:33:34-04:00",
      "test": true,
      "authorization": null,
      "location_id": null,
      "user_id": null,
      "parent_id": 389404469,
      "processed_at": "2021-04-01T14:33:34-04:00",
      "device_id": null,
      "error_code": null,
      "source_name": "755357713",
      "receipt": {},
      "currency_exchange_adjustment": null,
      "amount": "10.00",
      "currency": "USD",
      "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844665"
    }
  ]
}
GET /admin/api/2020-01/orders/{order_id}/transactions/count.json
Retrieves a count of an order's transactions.

Count an order's transactions

GET /admin/api/2020-01/orders/450789469/transactions/count.json
View Response 
HTTP/1.1 200 OK
{
  "count": 3
}
GET /admin/api/2020-01/orders/{order_id}/transactions/{transaction_id}.json

Retrieves a specific transaction.

Transactions attached to multi-currency orders are in the presentment currency by default. To retrieve transactions in the shop currency, include the URL parameter in_shop_currency=true.

fields

Show only certain fields, specified by a comma-separated list of field names.
in_shop_currency

Show amounts in the shop currency.

(default: false)

Retrieve a specific transaction for an order

GET /admin/api/2020-01/orders/450789469/transactions/389404469.json
View Response 
HTTP/1.1 200 OK
{
  "transaction": {
    "id": 389404469,
    "order_id": 450789469,
    "kind": "authorization",
    "gateway": "bogus",
    "status": "success",
    "message": null,
    "created_at": "2005-08-01T11:57:11-04:00",
    "test": false,
    "authorization": "authorization-key",
    "location_id": null,
    "user_id": null,
    "parent_id": null,
    "processed_at": "2005-08-01T11:57:11-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "web",
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "receipt": {
      "testcase": true,
      "authorization": "123456"
    },
    "currency_exchange_adjustment": null,
    "amount": "598.94",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/389404469"
  }
}
POST /admin/api/2020-01/orders/{order_id}/transactions.json

Creates a transaction for an order.

source

The origin of the transaction. Set to external to create a cash transaction for the associated order.

Capture a specified amount on an authorized order, and associate the capture with an authorization by including its ID

POST /admin/api/2020-01/orders/450789469/transactions.json
{
  "transaction": {
    "currency": "USD",
    "amount": "10.00",
    "kind": "capture",
    "parent_id": 389404469
  }
}
View Response 
HTTP/1.1 201 Created
{
  "transaction": {
    "id": 1072844666,
    "order_id": 450789469,
    "kind": "capture",
    "gateway": "bogus",
    "status": "success",
    "message": "Bogus Gateway: Forced success",
    "created_at": "2021-04-01T14:33:50-04:00",
    "test": true,
    "authorization": null,
    "location_id": null,
    "user_id": null,
    "parent_id": 389404469,
    "processed_at": "2021-04-01T14:33:50-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "755357713",
    "receipt": {},
    "currency_exchange_adjustment": null,
    "amount": "10.00",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844666"
  }
}

Void a transaction

POST /admin/api/2020-01/orders/450789469/transactions.json
{
  "transaction": {
    "currency": "USD",
    "amount": "10.00",
    "kind": "void",
    "parent_id": 389404469
  }
}
View Response 
HTTP/1.1 201 Created
{
  "transaction": {
    "id": 1072844667,
    "order_id": 450789469,
    "kind": "void",
    "gateway": "bogus",
    "status": "success",
    "message": "Bogus Gateway: Forced success",
    "created_at": "2021-04-01T14:33:56-04:00",
    "test": true,
    "authorization": null,
    "location_id": null,
    "user_id": null,
    "parent_id": 389404469,
    "processed_at": "2021-04-01T14:33:56-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "755357713",
    "receipt": {},
    "currency_exchange_adjustment": null,
    "amount": "0.00",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844667"
  }
}

Create a test transaction

POST /admin/api/2020-01/orders/450789469/transactions.json
{
  "transaction": {
    "currency": "USD",
    "amount": "10.00",
    "kind": "capture",
    "parent_id": 389404469,
    "test": true
  }
}
View Response 
HTTP/1.1 201 Created
{
  "transaction": {
    "id": 1072844668,
    "order_id": 450789469,
    "kind": "capture",
    "gateway": "bogus",
    "status": "success",
    "message": "Bogus Gateway: Forced success",
    "created_at": "2021-04-01T14:34:01-04:00",
    "test": true,
    "authorization": null,
    "location_id": null,
    "user_id": null,
    "parent_id": 389404469,
    "processed_at": "2021-04-01T14:34:01-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "755357713",
    "receipt": {},
    "currency_exchange_adjustment": null,
    "amount": "10.00",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844668"
  }
}

Capture the full amount for an authorized order, and associate the capture with an authorization by including its authorization code

POST /admin/api/2020-01/orders/450789469/transactions.json
{
  "transaction": {
    "kind": "capture",
    "authorization": "authorization-key"
  }
}
View Response 
HTTP/1.1 201 Created
{
  "transaction": {
    "id": 1072844669,
    "order_id": 450789469,
    "kind": "capture",
    "gateway": "bogus",
    "status": "success",
    "message": "Bogus Gateway: Forced success",
    "created_at": "2021-04-01T14:34:04-04:00",
    "test": true,
    "authorization": null,
    "location_id": null,
    "user_id": null,
    "parent_id": 389404469,
    "processed_at": "2021-04-01T14:34:04-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "755357713",
    "receipt": {},
    "currency_exchange_adjustment": null,
    "amount": "598.94",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844669"
  }
}
Version 2020-04

Transactions are created for every order that results in an exchange of money.

There are five types of transactions:

  • Authorization: An amount reserved against the cardholder's funding source. Money does not change hands until the authorization is captured.
  • Sale: An authorization and capture performed together in a single step.
  • Capture: A transfer of the money that was reserved during the authorization stage.
  • Void: A cancellation of a pending authorization or capture.
  • Refund: A partial or full return of captured funds to the cardholder. A refund can happen only after a capture is processed.

Refund transactions must be created by using the Refund resource.

Note

An order can have no more than 100 transactions associated with it.

What you can do with Transaction

The Shopify API lets you do the following with the Transaction resource. More detailed versions of these general actions may be available:

Transaction properties

amount 
"amount": "10.00"

The amount of money included in the transaction. If you don't provide a value for `amount`, then it defaults to the total cost of the order (even if a previous transaction has been made towards it).

authorization 
"authorization": "ch_1AtJu6CktlpKSclI4zjeQb2t"

The authorization code associated with the transaction.
created_at
read-only 
"created_at": "2012-03-13T16:09:54-04:00"

The date and time (ISO 8601 format) when the transaction was created.
currency 
"currency": "USD"

The three-letter code (ISO 4217 format) for the currency used for the payment.
device_id
read-only 
"device_id": 1

The ID for the device.
error_code
read-only 
"error_code": "invalid_cvc"

A standardized error code, independent of the payment provider. Valid values:

  • incorrect_number
  • invalid_number
  • invalid_expiry_date
  • invalid_cvc
  • expired_card
  • incorrect_cvc
  • incorrect_zip
  • incorrect_address
  • card_declined
  • processing_error
  • call_issuer
  • pick_up_card
gateway 
"gateway": "shopify_payments"

The name of the gateway the transaction was issued through. A list of gateways can be found on Shopify's payment gateways page.

id
read-only 
"id": 999225661

The ID for the transaction.
kind
required 
"kind": "capture"

The transaction's type. Valid values:

  • authorization: Money that the customer has agreed to pay. The authorization period can be between 7 and 30 days (depending on your payment service) while a store waits for a payment to be captured.
  • capture: A transfer of money that was reserved during the authorization of a shop.
  • sale: The authorization and capture of a payment performed in one single step.
  • void: The cancellation of a pending authorization or capture.
  • refund: The partial or full return of captured money to the customer.
location_id
read-only 
"id": 49202758

The ID of the physical location where the transaction was processed.
message
read-only 
"message": "Marked the Cash on Delivery (COD) payment as received"

A string generated by the payment provider with additional information about why the transaction succeeded or failed.

order_id 
"order_id": 450789469

The ID for the order that the transaction is associated with.
payment_details
read-only 
"payment_details": {
  "credit_card_bin": "123456",
  "avs_result_code": "Y",
  "cvv_result_code": "M",
  "credit_card_number": "•••• •••• •••• 4242",
  "credit_card_company": "Visa"
}

Information about the credit card used for this transaction. It has the following properties:

  • credit_card_bin: The issuer identification number (IIN), formerly known as bank identification number (BIN) of the customer's credit card. This is made up of the first few digits of the credit card number.
  • avs_result_code: The response code from the address verification system. The code is always a single letter. Refer to this chart for the codes and their definitions.
  • cvv_result_code: The response code from the credit card company indicating whether the customer entered the card security code, or card verification value, correctly. The code is a single letter or empty string; see this chart for the codes and their definitions.
  • credit_card_number: The customer's credit card number, with most of the leading digits redacted.
  • credit_card_company: The name of the company that issued the customer's credit card.
parent_id 
"parent_id": 584698724408

The ID of an associated transaction.

  • For capture transactions, the parent needs to be an authorization transaction.
  • For void transactions, the parent needs to be an authorization transaction.
  • For refund transactions, the parent needs to be a capture or sale transaction.
processed_at 
"processed_at": "2018-01-10T11:00:00-05:00"

The date and time (ISO 8601 format) when a transaction was processed. This value is the date that's used in the analytic reports. By default, it matches the created_at value. If you're importing transactions from an app or another platform, then you can set processed_at to a date and time in the past to match when the original transaction was processed.

receipt
read-only 
"receipt": {}

A transaction receipt attached to the transaction by the gateway. The value of this field depends on which gateway the shop is using.

source_name
read-only 
"source_name": "web"

The origin of the transaction. This is set by Shopify and can't be overridden. Example values: web, pos, iphone, and android.

status 
"status": "success"

The status of the transaction. Valid values: pending, failure, success, and error.
test 
"test": true

Whether the transaction is a test transaction.
user_id 
"user_id": 106045196

The ID for the user who was logged into the Shopify POS device when the order was processed, if applicable.
currency_exchange_adjustment 
"currency_exchange_adjustment": {
  "id": 1,
  "adjustment": "-0.01",
  "original_amount": "-53.62",
  "final_amount": "-53.63",
  "currency": "CAD"
}

An adjustment on the transaction showing the amount lost or gained due to fluctuations in the currency exchange rate. It has the following properties:

  • ID: The ID of the adjustment.
  • adjustment: The difference between the amounts on the associated transaction and the parent transaction.
  • original_amount: The amount of the parent transaction in the shop currency.
  • final_amount: The amount of the associated transaction in the shop currency.
  • currency: The shop currency.
Requires the header X-Shopify-Api-Features = include-currency-exchange-adjustments.

Endpoints

GET /admin/api/2020-04/orders/{order_id}/transactions.json

Retrieves a list of transactions.

Transactions attached to multi-currency orders are in the presentment currency by default. To retrieve transactions in the shop currency, include the URL parameter in_shop_currency=true.

since_id

Retrieve only transactions after the specified ID.
fields

Show only certain fields, specifed by a comma-separated list of fields names.
in_shop_currency

Show amounts in the shop currency.

(default: false)

Retrieve an order's transactions

GET /admin/api/2020-04/orders/450789469/transactions.json
View Response 
HTTP/1.1 200 OK
{
  "transactions": [
    {
      "id": 179259969,
      "order_id": 450789469,
      "kind": "refund",
      "gateway": "bogus",
      "status": "success",
      "message": null,
      "created_at": "2005-08-05T12:59:12-04:00",
      "test": false,
      "authorization": "authorization-key",
      "location_id": null,
      "user_id": null,
      "parent_id": 801038806,
      "processed_at": "2005-08-05T12:59:12-04:00",
      "device_id": null,
      "error_code": null,
      "source_name": "web",
      "receipt": {},
      "currency_exchange_adjustment": null,
      "amount": "209.00",
      "currency": "USD",
      "admin_graphql_api_id": "gid://shopify/OrderTransaction/179259969"
    },
    {
      "id": 389404469,
      "order_id": 450789469,
      "kind": "authorization",
      "gateway": "bogus",
      "status": "success",
      "message": null,
      "created_at": "2005-08-01T11:57:11-04:00",
      "test": false,
      "authorization": "authorization-key",
      "location_id": null,
      "user_id": null,
      "parent_id": null,
      "processed_at": "2005-08-01T11:57:11-04:00",
      "device_id": null,
      "error_code": null,
      "source_name": "web",
      "payment_details": {
        "credit_card_bin": null,
        "avs_result_code": null,
        "cvv_result_code": null,
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa",
        "credit_card_name": null,
        "credit_card_wallet": null,
        "credit_card_expiration_month": null,
        "credit_card_expiration_year": null
      },
      "receipt": {
        "testcase": true,
        "authorization": "123456"
      },
      "currency_exchange_adjustment": null,
      "amount": "598.94",
      "currency": "USD",
      "admin_graphql_api_id": "gid://shopify/OrderTransaction/389404469"
    },
    {
      "id": 801038806,
      "order_id": 450789469,
      "kind": "capture",
      "gateway": "bogus",
      "status": "success",
      "message": null,
      "created_at": "2005-08-05T10:22:51-04:00",
      "test": false,
      "authorization": "authorization-key",
      "location_id": null,
      "user_id": null,
      "parent_id": 389404469,
      "processed_at": "2005-08-05T10:22:51-04:00",
      "device_id": null,
      "error_code": null,
      "source_name": "web",
      "receipt": {},
      "currency_exchange_adjustment": null,
      "amount": "250.94",
      "currency": "USD",
      "admin_graphql_api_id": "gid://shopify/OrderTransaction/801038806"
    }
  ]
}

Retrieve an order's transactions after a specified ID

GET /admin/api/2020-04/orders/450789469/transactions.json?since_id=801038806
View Response 
HTTP/1.1 200 OK
{
  "transactions": [
    {
      "id": 1072844665,
      "order_id": 450789469,
      "kind": "capture",
      "gateway": "bogus",
      "status": "success",
      "message": "Bogus Gateway: Forced success",
      "created_at": "2021-04-01T14:33:34-04:00",
      "test": true,
      "authorization": null,
      "location_id": null,
      "user_id": null,
      "parent_id": 389404469,
      "processed_at": "2021-04-01T14:33:34-04:00",
      "device_id": null,
      "error_code": null,
      "source_name": "755357713",
      "receipt": {},
      "currency_exchange_adjustment": null,
      "amount": "10.00",
      "currency": "USD",
      "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844665"
    }
  ]
}
GET /admin/api/2020-04/orders/{order_id}/transactions/count.json
Retrieves a count of an order's transactions.

Count an order's transactions

GET /admin/api/2020-04/orders/450789469/transactions/count.json
View Response 
HTTP/1.1 200 OK
{
  "count": 3
}
GET /admin/api/2020-04/orders/{order_id}/transactions/{transaction_id}.json

Retrieves a specific transaction.

Transactions attached to multi-currency orders are in the presentment currency by default. To retrieve transactions in the shop currency, include the URL parameter in_shop_currency=true.

fields

Show only certain fields, specified by a comma-separated list of field names.
in_shop_currency

Show amounts in the shop currency.

(default: false)

Retrieve a specific transaction for an order

GET /admin/api/2020-04/orders/450789469/transactions/389404469.json
View Response 
HTTP/1.1 200 OK
{
  "transaction": {
    "id": 389404469,
    "order_id": 450789469,
    "kind": "authorization",
    "gateway": "bogus",
    "status": "success",
    "message": null,
    "created_at": "2005-08-01T11:57:11-04:00",
    "test": false,
    "authorization": "authorization-key",
    "location_id": null,
    "user_id": null,
    "parent_id": null,
    "processed_at": "2005-08-01T11:57:11-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "web",
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "receipt": {
      "testcase": true,
      "authorization": "123456"
    },
    "currency_exchange_adjustment": null,
    "amount": "598.94",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/389404469"
  }
}
POST /admin/api/2020-04/orders/{order_id}/transactions.json

Creates a transaction for an order.

source

The origin of the transaction. Set to external to create a cash transaction for the associated order.

Capture a specified amount on an authorized order, and associate the capture with an authorization by including its ID

POST /admin/api/2020-04/orders/450789469/transactions.json
{
  "transaction": {
    "currency": "USD",
    "amount": "10.00",
    "kind": "capture",
    "parent_id": 389404469
  }
}
View Response 
HTTP/1.1 201 Created
{
  "transaction": {
    "id": 1072844666,
    "order_id": 450789469,
    "kind": "capture",
    "gateway": "bogus",
    "status": "success",
    "message": "Bogus Gateway: Forced success",
    "created_at": "2021-04-01T14:33:50-04:00",
    "test": true,
    "authorization": null,
    "location_id": null,
    "user_id": null,
    "parent_id": 389404469,
    "processed_at": "2021-04-01T14:33:50-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "755357713",
    "receipt": {},
    "currency_exchange_adjustment": null,
    "amount": "10.00",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844666"
  }
}

Void a transaction

POST /admin/api/2020-04/orders/450789469/transactions.json
{
  "transaction": {
    "currency": "USD",
    "amount": "10.00",
    "kind": "void",
    "parent_id": 389404469
  }
}
View Response 
HTTP/1.1 201 Created
{
  "transaction": {
    "id": 1072844667,
    "order_id": 450789469,
    "kind": "void",
    "gateway": "bogus",
    "status": "success",
    "message": "Bogus Gateway: Forced success",
    "created_at": "2021-04-01T14:33:56-04:00",
    "test": true,
    "authorization": null,
    "location_id": null,
    "user_id": null,
    "parent_id": 389404469,
    "processed_at": "2021-04-01T14:33:56-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "755357713",
    "receipt": {},
    "currency_exchange_adjustment": null,
    "amount": "0.00",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844667"
  }
}

Create a test transaction

POST /admin/api/2020-04/orders/450789469/transactions.json
{
  "transaction": {
    "currency": "USD",
    "amount": "10.00",
    "kind": "capture",
    "parent_id": 389404469,
    "test": true
  }
}
View Response 
HTTP/1.1 201 Created
{
  "transaction": {
    "id": 1072844668,
    "order_id": 450789469,
    "kind": "capture",
    "gateway": "bogus",
    "status": "success",
    "message": "Bogus Gateway: Forced success",
    "created_at": "2021-04-01T14:34:01-04:00",
    "test": true,
    "authorization": null,
    "location_id": null,
    "user_id": null,
    "parent_id": 389404469,
    "processed_at": "2021-04-01T14:34:01-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "755357713",
    "receipt": {},
    "currency_exchange_adjustment": null,
    "amount": "10.00",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844668"
  }
}

Capture the full amount for an authorized order, and associate the capture with an authorization by including its authorization code

POST /admin/api/2020-04/orders/450789469/transactions.json
{
  "transaction": {
    "kind": "capture",
    "authorization": "authorization-key"
  }
}
View Response 
HTTP/1.1 201 Created
{
  "transaction": {
    "id": 1072844669,
    "order_id": 450789469,
    "kind": "capture",
    "gateway": "bogus",
    "status": "success",
    "message": "Bogus Gateway: Forced success",
    "created_at": "2021-04-01T14:34:04-04:00",
    "test": true,
    "authorization": null,
    "location_id": null,
    "user_id": null,
    "parent_id": 389404469,
    "processed_at": "2021-04-01T14:34:04-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "755357713",
    "receipt": {},
    "currency_exchange_adjustment": null,
    "amount": "598.94",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844669"
  }
}
Version 2020-07

Transactions are created for every order that results in an exchange of money.

There are five types of transactions:

  • Authorization: An amount reserved against the cardholder's funding source. Money does not change hands until the authorization is captured.
  • Sale: An authorization and capture performed together in a single step.
  • Capture: A transfer of the money that was reserved during the authorization stage.
  • Void: A cancellation of a pending authorization or capture.
  • Refund: A partial or full return of captured funds to the cardholder. A refund can happen only after a capture is processed.

Refund transactions must be created by using the Refund resource.

Note

An order can have no more than 100 transactions associated with it.

What you can do with Transaction

The Shopify API lets you do the following with the Transaction resource. More detailed versions of these general actions may be available:

Transaction properties

amount 
"amount": "10.00"

The amount of money included in the transaction. If you don't provide a value for `amount`, then it defaults to the total cost of the order (even if a previous transaction has been made towards it).

authorization 
"authorization": "ch_1AtJu6CktlpKSclI4zjeQb2t"

The authorization code associated with the transaction.
created_at
read-only 
"created_at": "2012-03-13T16:09:54-04:00"

The date and time (ISO 8601 format) when the transaction was created.
currency 
"currency": "USD"

The three-letter code (ISO 4217 format) for the currency used for the payment.
device_id
read-only 
"device_id": 1

The ID for the device.
error_code
read-only 
"error_code": "invalid_cvc"

A standardized error code, independent of the payment provider. Valid values:

  • incorrect_number
  • invalid_number
  • invalid_expiry_date
  • invalid_cvc
  • expired_card
  • incorrect_cvc
  • incorrect_zip
  • incorrect_address
  • card_declined
  • processing_error
  • call_issuer
  • pick_up_card
gateway 
"gateway": "shopify_payments"

The name of the gateway the transaction was issued through. A list of gateways can be found on Shopify's payment gateways page.

id
read-only 
"id": 999225661

The ID for the transaction.
kind
required 
"kind": "capture"

The transaction's type. Valid values:

  • authorization: Money that the customer has agreed to pay. The authorization period can be between 7 and 30 days (depending on your payment service) while a store waits for a payment to be captured.
  • capture: A transfer of money that was reserved during the authorization of a shop.
  • sale: The authorization and capture of a payment performed in one single step.
  • void: The cancellation of a pending authorization or capture.
  • refund: The partial or full return of captured money to the customer.
location_id
read-only 
"id": 49202758

The ID of the physical location where the transaction was processed.
message
read-only 
"message": "Marked the Cash on Delivery (COD) payment as received"

A string generated by the payment provider with additional information about why the transaction succeeded or failed.

order_id 
"order_id": 450789469

The ID for the order that the transaction is associated with.
payment_details
read-only 
"payment_details": {
  "credit_card_bin": "123456",
  "avs_result_code": "Y",
  "cvv_result_code": "M",
  "credit_card_number": "•••• •••• •••• 4242",
  "credit_card_company": "Visa"
}

Information about the credit card used for this transaction. It has the following properties:

  • credit_card_bin: The issuer identification number (IIN), formerly known as bank identification number (BIN) of the customer's credit card. This is made up of the first few digits of the credit card number.
  • avs_result_code: The response code from the address verification system. The code is always a single letter. Refer to this chart for the codes and their definitions.
  • cvv_result_code: The response code from the credit card company indicating whether the customer entered the card security code, or card verification value, correctly. The code is a single letter or empty string; see this chart for the codes and their definitions.
  • credit_card_number: The customer's credit card number, with most of the leading digits redacted.
  • credit_card_company: The name of the company that issued the customer's credit card.
parent_id 
"parent_id": 584698724408

The ID of an associated transaction.

  • For capture transactions, the parent needs to be an authorization transaction.
  • For void transactions, the parent needs to be an authorization transaction.
  • For refund transactions, the parent needs to be a capture or sale transaction.
processed_at 
"processed_at": "2018-01-10T11:00:00-05:00"

The date and time (ISO 8601 format) when a transaction was processed. This value is the date that's used in the analytic reports. By default, it matches the created_at value. If you're importing transactions from an app or another platform, then you can set processed_at to a date and time in the past to match when the original transaction was processed.

receipt
read-only 
"receipt": {}

A transaction receipt attached to the transaction by the gateway. The value of this field depends on which gateway the shop is using.

source_name
read-only 
"source_name": "web"

The origin of the transaction. This is set by Shopify and can't be overridden. Example values: web, pos, iphone, and android.

status 
"status": "success"

The status of the transaction. Valid values: pending, failure, success, and error.
test 
"test": true

Whether the transaction is a test transaction.
user_id 
"user_id": 106045196

The ID for the user who was logged into the Shopify POS device when the order was processed, if applicable.
currency_exchange_adjustment 
"currency_exchange_adjustment": {
  "id": 1,
  "adjustment": "-0.01",
  "original_amount": "-53.62",
  "final_amount": "-53.63",
  "currency": "CAD"
}

An adjustment on the transaction showing the amount lost or gained due to fluctuations in the currency exchange rate. It has the following properties:

  • ID: The ID of the adjustment.
  • adjustment: The difference between the amounts on the associated transaction and the parent transaction.
  • original_amount: The amount of the parent transaction in the shop currency.
  • final_amount: The amount of the associated transaction in the shop currency.
  • currency: The shop currency.
Requires the header X-Shopify-Api-Features = include-currency-exchange-adjustments.

Endpoints

GET /admin/api/2020-07/orders/{order_id}/transactions.json

Retrieves a list of transactions.

Transactions attached to multi-currency orders are in the presentment currency by default. To retrieve transactions in the shop currency, include the URL parameter in_shop_currency=true.

since_id

Retrieve only transactions after the specified ID.
fields

Show only certain fields, specifed by a comma-separated list of fields names.
in_shop_currency

Show amounts in the shop currency.

(default: false)

Retrieve an order's transactions

GET /admin/api/2020-07/orders/450789469/transactions.json
View Response 
HTTP/1.1 200 OK
{
  "transactions": [
    {
      "id": 179259969,
      "order_id": 450789469,
      "kind": "refund",
      "gateway": "bogus",
      "status": "success",
      "message": null,
      "created_at": "2005-08-05T12:59:12-04:00",
      "test": false,
      "authorization": "authorization-key",
      "location_id": null,
      "user_id": null,
      "parent_id": 801038806,
      "processed_at": "2005-08-05T12:59:12-04:00",
      "device_id": null,
      "error_code": null,
      "source_name": "web",
      "receipt": {},
      "currency_exchange_adjustment": null,
      "amount": "209.00",
      "currency": "USD",
      "admin_graphql_api_id": "gid://shopify/OrderTransaction/179259969"
    },
    {
      "id": 389404469,
      "order_id": 450789469,
      "kind": "authorization",
      "gateway": "bogus",
      "status": "success",
      "message": null,
      "created_at": "2005-08-01T11:57:11-04:00",
      "test": false,
      "authorization": "authorization-key",
      "location_id": null,
      "user_id": null,
      "parent_id": null,
      "processed_at": "2005-08-01T11:57:11-04:00",
      "device_id": null,
      "error_code": null,
      "source_name": "web",
      "payment_details": {
        "credit_card_bin": null,
        "avs_result_code": null,
        "cvv_result_code": null,
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa",
        "credit_card_name": null,
        "credit_card_wallet": null,
        "credit_card_expiration_month": null,
        "credit_card_expiration_year": null
      },
      "receipt": {
        "testcase": true,
        "authorization": "123456"
      },
      "currency_exchange_adjustment": null,
      "amount": "598.94",
      "currency": "USD",
      "admin_graphql_api_id": "gid://shopify/OrderTransaction/389404469"
    },
    {
      "id": 801038806,
      "order_id": 450789469,
      "kind": "capture",
      "gateway": "bogus",
      "status": "success",
      "message": null,
      "created_at": "2005-08-05T10:22:51-04:00",
      "test": false,
      "authorization": "authorization-key",
      "location_id": null,
      "user_id": null,
      "parent_id": 389404469,
      "processed_at": "2005-08-05T10:22:51-04:00",
      "device_id": null,
      "error_code": null,
      "source_name": "web",
      "receipt": {},
      "currency_exchange_adjustment": null,
      "amount": "250.94",
      "currency": "USD",
      "admin_graphql_api_id": "gid://shopify/OrderTransaction/801038806"
    }
  ]
}

Retrieve an order's transactions after a specified ID

GET /admin/api/2020-07/orders/450789469/transactions.json?since_id=801038806
View Response 
HTTP/1.1 200 OK
{
  "transactions": [
    {
      "id": 1072844665,
      "order_id": 450789469,
      "kind": "capture",
      "gateway": "bogus",
      "status": "success",
      "message": "Bogus Gateway: Forced success",
      "created_at": "2021-04-01T14:33:34-04:00",
      "test": true,
      "authorization": null,
      "location_id": null,
      "user_id": null,
      "parent_id": 389404469,
      "processed_at": "2021-04-01T14:33:34-04:00",
      "device_id": null,
      "error_code": null,
      "source_name": "755357713",
      "receipt": {},
      "currency_exchange_adjustment": null,
      "amount": "10.00",
      "currency": "USD",
      "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844665"
    }
  ]
}
GET /admin/api/2020-07/orders/{order_id}/transactions/count.json
Retrieves a count of an order's transactions.

Count an order's transactions

GET /admin/api/2020-07/orders/450789469/transactions/count.json
View Response 
HTTP/1.1 200 OK
{
  "count": 3
}
GET /admin/api/2020-07/orders/{order_id}/transactions/{transaction_id}.json

Retrieves a specific transaction.

Transactions attached to multi-currency orders are in the presentment currency by default. To retrieve transactions in the shop currency, include the URL parameter in_shop_currency=true.

fields

Show only certain fields, specified by a comma-separated list of field names.
in_shop_currency

Show amounts in the shop currency.

(default: false)

Retrieve a specific transaction for an order

GET /admin/api/2020-07/orders/450789469/transactions/389404469.json
View Response 
HTTP/1.1 200 OK
{
  "transaction": {
    "id": 389404469,
    "order_id": 450789469,
    "kind": "authorization",
    "gateway": "bogus",
    "status": "success",
    "message": null,
    "created_at": "2005-08-01T11:57:11-04:00",
    "test": false,
    "authorization": "authorization-key",
    "location_id": null,
    "user_id": null,
    "parent_id": null,
    "processed_at": "2005-08-01T11:57:11-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "web",
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "receipt": {
      "testcase": true,
      "authorization": "123456"
    },
    "currency_exchange_adjustment": null,
    "amount": "598.94",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/389404469"
  }
}
POST /admin/api/2020-07/orders/{order_id}/transactions.json

Creates a transaction for an order.

source

The origin of the transaction. Set to external to create a cash transaction for the associated order.

Capture a specified amount on an authorized order, and associate the capture with an authorization by including its ID

POST /admin/api/2020-07/orders/450789469/transactions.json
{
  "transaction": {
    "currency": "USD",
    "amount": "10.00",
    "kind": "capture",
    "parent_id": 389404469
  }
}
View Response 
HTTP/1.1 201 Created
{
  "transaction": {
    "id": 1072844666,
    "order_id": 450789469,
    "kind": "capture",
    "gateway": "bogus",
    "status": "success",
    "message": "Bogus Gateway: Forced success",
    "created_at": "2021-04-01T14:33:50-04:00",
    "test": true,
    "authorization": null,
    "location_id": null,
    "user_id": null,
    "parent_id": 389404469,
    "processed_at": "2021-04-01T14:33:50-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "755357713",
    "receipt": {},
    "currency_exchange_adjustment": null,
    "amount": "10.00",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844666"
  }
}

Void a transaction

POST /admin/api/2020-07/orders/450789469/transactions.json
{
  "transaction": {
    "currency": "USD",
    "amount": "10.00",
    "kind": "void",
    "parent_id": 389404469
  }
}
View Response 
HTTP/1.1 201 Created
{
  "transaction": {
    "id": 1072844667,
    "order_id": 450789469,
    "kind": "void",
    "gateway": "bogus",
    "status": "success",
    "message": "Bogus Gateway: Forced success",
    "created_at": "2021-04-01T14:33:56-04:00",
    "test": true,
    "authorization": null,
    "location_id": null,
    "user_id": null,
    "parent_id": 389404469,
    "processed_at": "2021-04-01T14:33:56-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "755357713",
    "receipt": {},
    "currency_exchange_adjustment": null,
    "amount": "0.00",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844667"
  }
}

Create a test transaction

POST /admin/api/2020-07/orders/450789469/transactions.json
{
  "transaction": {
    "currency": "USD",
    "amount": "10.00",
    "kind": "capture",
    "parent_id": 389404469,
    "test": true
  }
}
View Response 
HTTP/1.1 201 Created
{
  "transaction": {
    "id": 1072844668,
    "order_id": 450789469,
    "kind": "capture",
    "gateway": "bogus",
    "status": "success",
    "message": "Bogus Gateway: Forced success",
    "created_at": "2021-04-01T14:34:01-04:00",
    "test": true,
    "authorization": null,
    "location_id": null,
    "user_id": null,
    "parent_id": 389404469,
    "processed_at": "2021-04-01T14:34:01-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "755357713",
    "receipt": {},
    "currency_exchange_adjustment": null,
    "amount": "10.00",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844668"
  }
}

Capture the full amount for an authorized order, and associate the capture with an authorization by including its authorization code

POST /admin/api/2020-07/orders/450789469/transactions.json
{
  "transaction": {
    "kind": "capture",
    "authorization": "authorization-key"
  }
}
View Response 
HTTP/1.1 201 Created
{
  "transaction": {
    "id": 1072844669,
    "order_id": 450789469,
    "kind": "capture",
    "gateway": "bogus",
    "status": "success",
    "message": "Bogus Gateway: Forced success",
    "created_at": "2021-04-01T14:34:04-04:00",
    "test": true,
    "authorization": null,
    "location_id": null,
    "user_id": null,
    "parent_id": 389404469,
    "processed_at": "2021-04-01T14:34:04-04:00",
    "device_id": null,
    "error_code": null,
    "source_name": "755357713",
    "receipt": {},
    "currency_exchange_adjustment": null,
    "amount": "598.94",
    "currency": "USD",
    "admin_graphql_api_id": "gid://shopify/OrderTransaction/1072844669"
  }
}
Version 2020-10

Transactions are created for every order that results in an exchange of money.

There are five types of transactions:

  • Authorization: An amount reserved against the cardholder's funding source. Money does not change hands until the authorization is captured.
  • Sale: An authorization and capture performed together in a single step.
  • Capture: A transfer of the money that was reserved during the authorization stage.
  • Void: A cancellation of a pending authorization or capture.
  • Refund: A partial or full return of captured funds to the cardholder. A refund can happen only after a capture is processed.

Refund transactions must be created by using the Refund resource.

Note

An order can have no more than 100 transactions associated with it.

What you can do with Transaction

The Shopify API lets you do the following with the Transaction resource. More detailed versions of these general actions may be available:

Transaction properties

amount 
"amount": "10.00"

The amount of money included in the transaction. If you don't provide a value for `amount`, then it defaults to the total cost of the order (even if a previous transaction has been made towards it).

authorization 
"authorization": "ch_1AtJu6CktlpKSclI4zjeQb2t"

The authorization code associated with the transaction.
created_at
read-only 
"created_at": "2012-03-13T16:09:54-04:00"

The date and time (ISO 8601 format) when the transaction was created.
currency 
"currency": "USD"

The three-letter code (ISO 4217 format) for the currency used for the payment.
device_id
read-only 
"device_id": 1

The ID for the device.
error_code
read-only 
"error_code": "invalid_cvc"

A standardized error code, independent of the payment provider. Valid values:

  • incorrect_number
  • invalid_number
  • invalid_expiry_date
  • invalid_cvc
  • expired_card
  • incorrect_cvc
  • incorrect_zip
  • incorrect_address
  • card_declined
  • processing_error
  • call_issuer
  • pick_up_card
gateway 
"gateway": "shopify_payments"

The name of the gateway the transaction was issued through. A list of gateways can be found on Shopify's payment gateways page.

id
read-only 
"id": 999225661

The ID for the transaction.
kind
required 
"kind": "capture"

The transaction's type. Valid values:

  • authorization: Money that the customer has agreed to pay. The authorization period can be between 7 and 30 days (depending on your payment service) while a store waits for a payment to be captured.
  • capture: A transfer of money that was reserved during the authorization of a shop.
  • sale: The authorization and capture of a payment performed in one single step.
  • void: The cancellation of a pending authorization or capture.
  • refund: The partial or full return of captured money to the customer.
location_id
read-only 
"id": 49202758

The ID of the physical location where the transaction was processed.
message
read-only 
"message": "Marked the Cash on Delivery (COD) payment as received"

A string generated by the payment provider with additional information about why the transaction succeeded or failed.

order_id 
"order_id": 450789469

The ID for the order that the transaction is associated with.
payment_details
read-only 
"payment_details": {
  "credit_card_bin": "123456",
  "avs_result_code": "Y",
  "cvv_result_code": "M",
  "credit_card_number": "•••• •••• •••• 4242",
  "credit_card_company": "Visa"
}

Information about the credit card used for this transaction. It has the following properties:

  • credit_card_bin: The issuer identification number (IIN), formerly known as bank identification number (BIN) of the customer's credit card. This is made up of the first few digits of the credit card number.
  • avs_result_code: The response code from the address verification system. The code is always a single letter. Refer to this chart for the codes and their definitions.
  • cvv_result_code: The response code from the credit card company indicating whether the customer entered the card security code, or card verification value, correctly. The code is a single letter or empty string; see this chart for the codes and their definitions.
  • credit_card_number: The customer's credit card number, with most of the leading digits redacted.
  • credit_card_company: The name of the company that issued the customer's credit card.
parent_id 
"parent_id": 584698724408

The ID of an associated transaction.

  • For capture transactions, the parent needs to be an authorization transaction.
  • For void transactions, the parent needs to be an authorization transaction.
  • For refund transactions, the parent needs to be a capture or sale transaction.
processed_at 
"processed_at": "2018-01-10T11:00:00-05:00"

The date and time (ISO 8601 format) when a transaction was processed. This value is the date that's used in the analytic reports. By default, it matches the created_at value. If you're importing transactions from an app or another platform, then you can set processed_at to a date and time in the past to match when the original transaction was processed.

receipt
read-only 
"receipt": {}

A transaction receipt attached to the transaction by the gateway. The value of this field depends on which gateway the shop is using.

source_name
read-only 
"source_name": "web"

The origin of the transaction. This is set by Shopify and can't be overridden. Example values: web, pos, iphone, and android.

status 
"status": "success"

The status of the transaction. Valid values: pending, failure, success, and error.
test 
"test": true

Whether the transaction is a test transaction.
user_id 
"user_id": 106045196

The ID for the user who was logged into the Shopify POS device when the order was processed, if applicable.