Get transaction details - Streamlined

GET

/

transactions

/

{id}

Get transaction details

curl --request GET \
  --url https://api.staging.streamlinedpayments.com/api/v1/transactions/{id} \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>'

const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.staging.streamlinedpayments.com/api/v1/transactions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/transactions/{id}"

headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/transactions/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "USD",
  "amount": 123,
  "fee": 123,
  "payment_source": "<string>",
  "memo": "<string>",
  "payout_date": "2023-12-25",
  "net_amount": 123,
  "self_recorded": true,
  "display_type": "<string>",
  "txn_files": [
    {
      "id": 123,
      "filename": "<string>",
      "thumbnail_url": "<string>",
      "url": "<string>"
    }
  ],
  "invoice": {
    "invoice_token": "<string>",
    "amount": 123,
    "currency": "USD",
    "due_date": "2023-12-25"
  },
  "recipient": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_name": "<string>",
    "display_name": "<string>"
  }
}

Authorizations

X-App-Id

string

header

required

App ID for authentication

X-Api-Key

string

header

required

API Key for authentication

Path Parameters

id

string<uuid>

required

The UUID of the transaction to retrieve

Response

Successful operation

Returned by GET /transactions/:id. Note: this endpoint returns the transaction object directly, not wrapped in a transaction key. This differs from /orders, /invoices, /customers etc, which wrap their resource. Kept this way for v1 backwards compatibility.

uuid

string<uuid>

created_at

string<date-time>

currency

enum<string>

ISO currency code. Most resources support these. Products are limited to USD, CAD, EUR, GBP, AUD.

Available options:

USD,

CAD,

GBP,

EUR,

AUD,

JPY,

INR

amount

integer

fee

integer

payment_source

string

memo

string | null

payout_date

string<date> | null

Null if the transaction has not been paid out yet.

net_amount

integer

self_recorded

boolean

display_type

string

txn_files

object[]

Show child attributes

invoice

object | null

Null if this transaction is not linked to an invoice (e.g. an unallocated payment).

Show child attributes

recipient

object

Show child attributes

⌘I

Get transaction details

curl --request GET \
  --url https://api.staging.streamlinedpayments.com/api/v1/transactions/{id} \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>'

const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.staging.streamlinedpayments.com/api/v1/transactions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/transactions/{id}"

headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/transactions/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "USD",
  "amount": 123,
  "fee": 123,
  "payment_source": "<string>",
  "memo": "<string>",
  "payout_date": "2023-12-25",
  "net_amount": 123,
  "self_recorded": true,
  "display_type": "<string>",
  "txn_files": [
    {
      "id": 123,
      "filename": "<string>",
      "thumbnail_url": "<string>",
      "url": "<string>"
    }
  ],
  "invoice": {
    "invoice_token": "<string>",
    "amount": 123,
    "currency": "USD",
    "due_date": "2023-12-25"
  },
  "recipient": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_name": "<string>",
    "display_name": "<string>"
  }
}