Model

API User
Attribute
Type
Description
Nullable
_id
string
The ID of the API User
no
userId
string
The username which created the API User
no
apiKey
string
The apiKey of the API User
no
secret
string
The secret of the API User
no
Vendor
Attribute
Type
Description
Nullable
_id
string
The ID of Vendor
no
name
string
Vendor name. (Company's name)
no
email
string
Vendor email
no
country
string
Country code
no
city
string
Vendor's city
no
firstName
string
First name of Vendor (if individual vendor, not business)
yes
lastName
string
First name of Vendor (if individual vendor, not business)
yes
address
string
Vendor's street address
no
phone
string
Vendor's phone
yes
zip
string
The zip of the vendor
no
state
string
Vendor state
yes, if country is not US or CA
vatId
string
The company’s VAT number
yes, if taxId is set
taxId
string
The company’s business ID number
yes, if vatId is set
payoutInfo
array
Array of Payout Info objects
no
vendorPrincipal
object
​Vendor Principal object
no
receiptEmail
string
The email from which the receipts and invoices will be sent
no
emailSetup
object
​Email Setup object
yes
defaultPayoutCurrency
string
Currency code (ISO 4217) for the default payout currency
no
autoReceipt
boolean
If set to true, receipts will be sent automatically to the shoppers
yes
autoInvoice
boolean
If set to true, invoices will be sent automatically to the shoppers
yes
frequency
string
The payout frequency of the vendor. Possible values are: DAILY, WEEKLY, SEMIMONTHLY and MONTHLY
no
rawLogo
string
Logo used in invoices.
yes
Payout Info
Attribute
Type
Description
Nullable
_id
string
The ID of a Payout info
no
bankId
string
Bank ID number (ie. Routing number)
no
bankName
string
Name of vendor bank
no
country
string
Country code of vendor bank
no
city
string
City of vendor bank
yes
address
string
Street address of vendor bank
yes
zip
string
Zip/Postal code of vendor bank
no
bankAccountId
string
Vendor bank account number
no
iban
string
Vendor International Bank Account Number
yes, if payoutTypeis CHAPS or SEPA
bankAccountType
string
Account type. Possible values: CHECKING, SAVINGS
no
bankAccountClass
string
Type of bank account. Possible values: PERSONAL, CORPORATE, INTERNATIONAL
no
nameOnAccount
string
Name on bank account for vendor
no
payoutType
string
Method of payout to vendor. Possible values: ACH (USD, CAD), CHAPS (GBP), SEPA (EUR), WIRE
no
baseCurrency
string
Payout currency for vendor's bank account.
no
minimalPayoutAmount
integer
Minimum amount for which a vendor may be paid out. If the vendor's account balance is below this amount, their balance will be carried forward to the next pay cycle. The currency for minimalPayoutAmount is the same as baseCurrency.
no
state
string
Vendor state
yes, if country is not US or CA
swiftBic
string
International identification bank code
yes
Possible values for payoutType:
Value
Full name
AUD
Australia Dollar
CAD
Canada Dollar
CHF
Switzerland Franc
DKK
Denmark Kroner
EUR
Euro
GBP
United Kingdom Pound
HKD
Hong Kong Dollar
JPY
Japan Yen
NOK
Norway Kroner
NZD
New Zealand Dollar
SEK
Sweden Kroner
USD
US Dollar
Vendor Principal
Attribute
Type
Description
Nullable
firstName
string
First name of vendor principal owner
no
lastName
string
Last name of vendor principal owner
no
address
string
Address of vendor principal owner
no
city
string
City of vendor principal owner
no
country
string
Country code of vendor principal owner
no
zip
string
Zip of vendor principal owner
no
dob
string
Date of Birth of vendor principal owner. Format: dd-mm-yyyy
no
personalIdentificationNumber
string
In the US, this value is the last four digits of the principal owner's Social Security Number. In countries outside of the US, this value is the full National Identification Number of the principal owner, or TaxID if the country doesn’t support a National Identification Number.
no
driverLicenseNumber
string
Driver license number of vendor principal owner
yes, if vendor principal country is not US
passportNumber
string
Passport number of vendor principal owner.
yes, if vendro principal country is US
email
string
Email address of vendor principal owner
no
Email setup
Attribute
Type
Description
Nullable
receipt
object
Object of type Receipt. Configuration of the receipt email.
no
invoice
object
Object of type Invoice. Configuration of the invoice email.
no
Receipt
Attribute
Type
Description
Nullable
subject
string
The email subject that will be shown when sending receipt to shoppers.
yes
bodyHeaderText
string
The body header text that will be shown on top of the receipt document when sending receipt to shoppers.
yes
Invoice
Attribute
Type
Description
Nullable
subject
string
The email subject that will be shown when sending invoice to shoppers.
yes
bodyHeaderText
string
The body header text that will be shown on top of the invoice document when sending invoice to shoppers.
yes
Shopper
Attribute
Type
Description
Nullable
_id
string
The ID of the Shopper
no
vendor
string
The vendor's name for which the shopper is created.
no
firstName
string
Shopper's first name
no
lastName
string
Shopper's last name
no
email
string
Shopper email
no
walletAddress
string
Shopper wallet address
no
maliciousAttempts
integer
The number of malicious attemps for a shopper. It is incremented when a given signed transaction reverts.
no
useLimePayWallet
boolean
Indicates whether the shopper will use LimePay internal encrypted wallets.
no
Wallet Token
Attribute
Type
Description
Nullable
walletToken
string
The generated JSON Web Token for the generation of LimePay encrypted Wallet later on
no
Payment
Attribute
Type
Description
Nullable
_id
string
The id of the payment
no
status
string
The status of the Payment
no
date
date
The date time when the payment was created
no
currency
string
Currency code (ISO 4217) of the amount to be charged
no
shopper
string
The shopperID of the shopper that will be charged
no
vendor
string
The vendorID of the vendor that will charge the payment
no
items
array
Array of Items objects that are being purchased
no
fundTxData
object
Object containing information about the funding of an shopper
no
genericTransactions
array
Objects containing information about every transaction that should be executed
no
paymentDetails
object
​Payment Details object
no
type
string
The type of the payment. Possible values FIAT_PAYMENT, RELAYED_PAYMENT
no
limeToken
string
The generated JSON Web Token for the payment
yes
Payment statuses
Attribute
Description
NEW
When a payment is created
PROCESSING
When a payment is sent for processing and all validation passes
SUCCESSFUL
When a payment is processed without errors
FAILED
When a payment is sent for processing but something went wrong
Item
Attribute
Type
Description
Nullable
description
string
Description of the item that is being bought. This information is displayed in the invoice.
no
lineAmount
decimal
Fiat amount of the item excluding VAT amount.
no
quantity
integer
Quantity of the items
no
Payment Details
Attribute
Type
Description
Nullable
taxRate
decimal
Tax rate for the payment. Depends on the country of the Vendor
yes
taxAmount
decimal
Tax amount of the payment. Calculated with taxRate and the baseAmount
yes
baseAmount
decimal
Payment amount without tax
no
totalAmount
decimal
Payment amount with tax (if any)
no
cardHolder
object
​Card Holder object
no
Card Holder
Attribute
Type
Description
Nullable
vatNumber
string
vatNumber of the shopper
yes
name
string
Personal/Company name of the shopper
no
isCompany
boolean
If the shopper is company
no
country
string
Shopper's country
no
zip
string
Shopper's zip/postal code
no
street
string
Shopper's street address
no
Fund Transaction data
Attribute
Type
Description
Nullable
weiAmount
string
Amount of ethers that the shopper will be funded with
no
tokenAmount
string
Amount of tokens that the shopper will be funded with. NOTEIf the payment is relayed, token amount should not be provided. If you execute GET request for a relayed payment, tokenAmount will be 0
no
authorizationSignature
string
Signature used to authorize the funding of the shopper. It is send to the Escrow contract on shopper funding along the other funding information
no
transactionHash
string
The hash of the transaction. It will be set once the transaction is executed
yes
status
string
The status of the transaction. Possible values are: PENDING, PROCESSING, SUCCESSFUL, FAILED
no
gasPrice
string
Gas price used for funding the shopper. Used only for version 3 Escrow contracts
yes
Generic transaction
Attribute
Type
Description
Nullable
to
string
Address that the transaction will be sent to
no
functionName
string
Name of the smart contract function
no
gasPrice
string
Gas price of the transaction
no
gasLimit
integer
Gas limit of the transactions
no
signedTransaction
string
Signed transaction by the shoppers private key, that will be broadcasted
no
status
string
Status of the transaction. Possible values are: PENDING, PROCESSING, SUCCESSFUL, FAILED
no
transactionHash
string
The hash of the transaction. It will be set once the transaction is broadcasted
yes
functionParams
array
Array of Function parameter objects. Each object contain information(type,value) of parameter that should be passed to a function
no
Function parameter
Attribute
Type
Description
Nullable
value
any
Value that should be passed to the function
no
type
string
The solidity type of the value. For example: bool, bool[].....
no

REST API - Previous

Payments

Next - REST API

Errors

Last updated yesterday

Attribute	Type	Description	Nullable
`_id`	`string`	The ID of Vendor	no
`name`	`string`	Vendor name. (Company's name)	no
`email`	`string`	Vendor email	no
`country`	`string`	Country code	no
`city`	`string`	Vendor's city	no
`firstName`	`string`	First name of Vendor (if individual vendor, not business)	yes
`lastName`	`string`	First name of Vendor (if individual vendor, not business)	yes
`address`	`string`	Vendor's street address	no
`phone`	`string`	Vendor's phone	yes
`zip`	`string`	The zip of the vendor	no
`state`	`string`	Vendor state	yes, if country is not `US` or `CA`
`vatId`	`string`	The company’s VAT number	yes, if `taxId` is set
`taxId`	`string`	The company’s business ID number	yes, if `vatId` is set
`payoutInfo`	`array`	Array of Payout Info objects	no
`vendorPrincipal`	`object`	Vendor Principal object	no
`receiptEmail`	`string`	The email from which the receipts and invoices will be sent	no
`emailSetup`	`object`	Email Setup object	yes
`defaultPayoutCurrency`	`string`	Currency code (ISO 4217) for the default payout currency	no
`autoReceipt`	`boolean`	If set to true, receipts will be sent automatically to the shoppers	yes
`autoInvoice`	`boolean`	If set to true, invoices will be sent automatically to the shoppers	yes
`frequency`	`string`	The payout frequency of the vendor. Possible values are: `DAILY`, `WEEKLY`, `SEMIMONTHLY` and `MONTHLY`	no
`rawLogo`	`string`	Logo used in invoices.	yes

Attribute	Type	Description	Nullable
`_id`	`string`	The ID of a Payout info	no
`bankId`	`string`	Bank ID number (ie. Routing number)	no
`bankName`	`string`	Name of vendor bank	no
`country`	`string`	Country code of vendor bank	no
`city`	`string`	City of vendor bank	yes
`address`	`string`	Street address of vendor bank	yes
`zip`	`string`	Zip/Postal code of vendor bank	no
`bankAccountId`	`string`	Vendor bank account number	no
`iban`	`string`	Vendor International Bank Account Number	yes, if `payoutType`is `CHAPS` or `SEPA`
`bankAccountType`	`string`	Account type. Possible values: `CHECKING`, `SAVINGS`	no
`bankAccountClass`	`string`	Type of bank account. Possible values: `PERSONAL`, `CORPORATE`, `INTERNATIONAL`	no
`nameOnAccount`	`string`	Name on bank account for vendor	no
`payoutType`	`string`	Method of payout to vendor. Possible values: `ACH` (USD, CAD), `CHAPS` (GBP), `SEPA` (EUR), `WIRE`	no
`baseCurrency`	`string`	Payout currency for vendor's bank account.	no
`minimalPayoutAmount`	`integer`	Minimum amount for which a vendor may be paid out. If the vendor's account balance is below this amount, their balance will be carried forward to the next pay cycle. The currency for `minimalPayoutAmount` is the same as `baseCurrency`.	no
`state`	`string`	Vendor state	yes, if country is not `US` or `CA`
`swiftBic`	`string`	International identification bank code	yes

Attribute	Type	Description	Nullable
`firstName`	`string`	First name of vendor principal owner	no
`lastName`	`string`	Last name of vendor principal owner	no
`address`	`string`	Address of vendor principal owner	no
`city`	`string`	City of vendor principal owner	no
`country`	`string`	Country code of vendor principal owner	no
`zip`	`string`	Zip of vendor principal owner	no
`dob`	`string`	Date of Birth of vendor principal owner. Format: `dd-mm-yyyy`	no
`personalIdentificationNumber`	`string`	In the US, this value is the last four digits of the principal owner's Social Security Number. In countries outside of the US, this value is the full National Identification Number of the principal owner, or TaxID if the country doesn’t support a National Identification Number.	no
`driverLicenseNumber`	`string`	Driver license number of vendor principal owner	yes, if vendor principal country is not `US`
`passportNumber`	`string`	Passport number of vendor principal owner.	yes, if vendro principal country is `US`
`email`	`string`	Email address of vendor principal owner	no

Value	Full name
`AUD`	Australia Dollar
`CAD`	Canada Dollar
`CHF`	Switzerland Franc
`DKK`	Denmark Kroner
`EUR`	Euro
`GBP`	United Kingdom Pound
`HKD`	Hong Kong Dollar
`JPY`	Japan Yen
`NOK`	Norway Kroner
`NZD`	New Zealand Dollar
`SEK`	Sweden Kroner
`USD`	US Dollar

Attribute	Description
NEW	When a payment is created
PROCESSING	When a payment is sent for processing and all validation passes
SUCCESSFUL	When a payment is processed without errors
FAILED	When a payment is sent for processing but something went wrong