Difference between revisions of "XcelData:Terms"

From XcelData Wiki
Jump to: navigation, search
Line 4: Line 4:
 
'''''integer or decimal:''' 0-200''
 
'''''integer or decimal:''' 0-200''
  
Adjusts the buy amount by '''n''' percent.
+
Adjusts the buy amount by ''n'' percent.
  
 
==adj-loan==
 
==adj-loan==
 
'''''integer or decimal:''' 0-200''
 
'''''integer or decimal:''' 0-200''
  
Adjusts the buy amount by '''n''' percent.
+
Adjusts the loan amount by ''n'' percent.
  
 
==adj-sell==
 
==adj-sell==
 
'''''integer or decimal:''' 0-200''
 
'''''integer or decimal:''' 0-200''
  
Adjusts the buy amount by '''n''' percent.
+
Adjusts the sell amount by ''n'' percent.
  
 
== api-key ==
 
== api-key ==

Revision as of 19:08, 26 April 2018

Terms commonly used in the API

adj-buy

integer or decimal: 0-200

Adjusts the buy amount by n percent.

adj-loan

integer or decimal: 0-200

Adjusts the loan amount by n percent.

adj-sell

integer or decimal: 0-200

Adjusts the sell amount by n percent.

api-key

uuid: 00000000-0000-0000-0000-000000000000

A valid API key. Store API keys can be obtained from app.xceldata.com/customers

drivers-lic

string: a valid drivers lic

A valid drivers license that uniquely identifies the customer.

service-name

enum: superpawn or xpawn

Currently used to specify the type of license check to preform.

transaction-id

string: a unique transaction id

A transaction id that uniquely identifies the customer's transaction.

output-format

enum: json or xml

Specifies XML or JSON output.

unit-type

enum: dwt or gr

Specifies Pennyweight or Grams (what will be shown to tellers)