FlexShopper API
3.0-legacy
FlexShopper API
3.0-legacy
  • Getting Started
  • Our Platforms
    • FlexPay Payment Platform
    • FlexShopper Backend API
  • API Reference
    • Get Started
      • API Requests
      • API Responses
      • Error Codes
    • User Management
      • Create User
      • Get Users
      • Get User
      • Verify User Exists
      • Deeply Verify User Exists
      • Get LoanPaymentPro Child Key
      • Add Payment Method
    • Customer Authentication
      • Request Passcode
      • Login Customer
    • Customer Application
      • Initiate Application
      • Get Verification Questions
      • Verify Answers
      • Validate Routing Number
    • Lease Management
      • Create Lease
      • Get Lease By ID
      • Sign Lease
      • Checkout
    • Purchase Transactions
      • Get Transactions
      • Get Transaction By ID
      • Cancel Items
      • Return Items
      • Confirm Shipment
      • Confirm Receipt
    • Products
      • Get Products
    • Settings
  • Change Log
Powered by GitBook
On this page
  • /v3/transactions/{transactionId}
  • Response Parameters

Was this helpful?

Export as PDF
  1. API Reference
  2. Purchase Transactions

Get Transaction By ID

Find the transaction by the given Id

/v3/transactions/{transactionId}

GET https://apis.sandbox.flexshopper.com/v3/transactions/{transactionId}

Path Parameters

Name
Type
Description

transactionId

string

Transaction Id

Headers

Name
Type
Description

Authorization

string

Authorization token

{
  "data": {
    "id": "eyJhbGcfasdvczOiJIUzI1NiIsInR5cCI6IkpXVC...",
    "shippingCost": 1.23,
    "createdAt": "2018-03-19T15:51:27.080Z",
    "lease": {
      "id": "eyJhbGcfasdvczOiJIUzI1NiIsInR5cCI6IkpXVC...",
      "status": "signed"
    },
    "items": [
      {
        "description": "iPad Mini",
        "sku": "abc123",
        "brand": "Apple",
        "cost": 100.23,
        "quantity": 1
        "quantityByStatus": {
          ordered: 1, 
          shipped: 1
        }
      }
    ]
  }
}
{
  "error": {
    "statusCode": 404,
    "code": "TransactionNotFound",
    "message": "The transaction with the provided id was not found",
    "data": {}
  }
}

Response Parameters

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the transaction info

Key

Type

Description

id

String

Transaction id

createAt

String

Transaction creation date

shippingCost

Number

Total Shipping Cost

lease.id

String

Lease Id

lease.status

String

The current lease status, values allowed: signed, pending

items

Array

The list items.

items.quantity

Number

Item quantity.

items.quantityByStatus

Object

Quantity of items grouped by status. Ex { signed: 1 }

items.cost

Number

Item cost with any discounts already applied.

items.description

String

Item description

items.brand

String

Item's brand

items.sku

String

Item unique identifier

PreviousGet TransactionsNextCancel Items

Last updated 6 years ago

Was this helpful?