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
  • Response Parameters

Was this helpful?

Export as PDF
  1. API Reference
  2. Purchase Transactions

Get Transactions

Returns all vendor's transactions

/v3/transactions

GET https://apis.sandbox.flexshopper.com/v3/transactions

Query Parameters

Name
Type
Description

leaseStatus

string

Filter by lease status (signed/pending)

page

string

Page number to retrieve. Max 1000

limit

string

Limit of transactions to retrieve, defaults to 20. Max 1000,

fromDate

string

Start date to retrieve

toDate

string

End date to retrieve

Headers

Name
Type
Description

Authorization

string

Authorization token

{
  "data": {
    "transactions": [
      {
        "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": { 
              ordered: 1, 
              shipped: 1 
            }
          }
        ]
      }
    ],
    {
      "meta": {
      "count": 1,
      "totalPages": 1,
      "page": 1,
      "limit": 20
    }
  }
}

Response Parameters

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all transactions created.

Key

Type

Description

transactions

Array

The list transactions.

transactions.id

Number

Transaction id

transactions.createAt

Date

Transaction creation date

transactions.shippingCost

Number

Total Shipping Cost

transactions.items

Array

The list items.

transactions.items.quantity

Number

Item quantity.

transactions.items.quantityByStatus

Object

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

transactions.items.cost

Number

Item cost

transactions.items.description

String

Item description

transactions.items.brand

String

Item's brand

meta

Object

Result metadata

meta.count

Number

Amount of transactions

meta.totalPages

Number

Total number of pages

meta.page

Number

Current page

meta.limit

Number

Page size

PreviousPurchase TransactionsNextGet Transaction By ID

Last updated 4 years ago

Was this helpful?