FlexShopper API
3.0-preview
FlexShopper API
3.0-preview
  • Integration Guides
    • Medusa
    • Payment Plugin
  • Customer
    • Verify User Exists
    • Deeply Verify User Exists
    • Create User
    • Get Users
    • Get User
    • Create Authorization Token
    • Add Payment Method
      • Get LoanPaymentPro Child Key
      • Get Clover PKMS Key
  • Decision
    • Apply for Spending Limit
  • Lease
    • Create Lease
    • Get Transactions
    • Get Lease By ID
    • Get Transaction By ID
    • Sign Lease
    • Finalize Lease
    • Cancel Items
    • Return Items
    • Confirm Shipment
    • Confirm Receipt
Powered by GitBook
On this page
  • Request
  • Headers
  • Response
  • Samples
  • Schema

Was this helpful?

Export as PDF
  1. Customer

Get User

Retrieve details for the currently logged user.

GET /v3/users/me

Returns user's details

Request

Headers

Name
Type
Description

customer-token

string

Customer's authentication token

Authorization

string

Authorization token

Response

Samples

{
  "data": {
    "userId": "1234-asdf-4321-fdsa",
    "firstName": "John",
    "lastName": "Doe",
    "createdAt": "2018-03-19T15:51:27.080Z",
    "transactions": [
      {
        "id": "asdf-1234-fdsa-4321",
        "createdAt": "2018-12-21"
      }
    ],
    "decision": {
      "approved": true,
      "status": "approved",
      "spendingLimit": 1300,
      "availableBalance": 1200,
      "availableWeeklySpending": 120,
      "createdAt": "2018-03-19T15:51:27.080Z"
    },
    "verificationStatus": "succeeded"
  }
}

Schema

A successful request returns the HTTP 200 OK status code and a JSON response body that shows user details.

Key
Type
Description

userId

Number

Transaction id

firstName

String

User's first name

lastName

String

Users's last name

createdAt

Date

Users creation date

decision

Number

Total Shipping Cost

decision.approved

Boolean

Determines if the customer was approved or not [TO BE DEPRECATED]

decision.status

String

Determines the Application status. The possible values are: approved, denied, pending error

decision.spendingLimit

Number

The spending limit approved

decision.availableBalance

Number

Available balance to spend

decision.availableWeeklySpending

String

The available amount to spend in a weekly basis

decision.createdAt

String

Decision's creation date

verificationStatus

String

Verification status the possible status are: pending, failed, succeeded

transactions

Array

List of transactions for current user

transactions.id

String

Transaction's Id

transactions.createdAt

Date

Transaction's creation date

PreviousGet UsersNextCreate Authorization Token

Last updated 9 days ago

Was this helpful?