Attribute | Type | Description | Nullable |
|
| The ID of the API User | no |
|
| The username which created the API User | no |
|
| The apiKey of the API User | no |
|
| The secret of the API User | no |
Attribute | Type | Description | Nullable |
|
| The ID of Vendor | no |
|
| Vendor name. (Company's name) | no |
|
| Vendor email | no |
|
| Country code | no |
|
| Vendor's city | no |
|
| First name of Vendor (if individual vendor, not business) | yes |
|
| First name of Vendor (if individual vendor, not business) | yes |
|
| Vendor's street address | no |
|
| Vendor's phone | yes |
|
| The zip of the vendor | no |
|
| Vendor state | yes, if country is not |
|
| The company’s VAT number | yes, if |
|
| The company’s business ID number | yes, if |
|
| Array of Payout Info objects | no |
|
| ​Vendor Principal object | no |
|
| The email from which the receipts and invoices will be sent | no |
|
| ​Email Setup object | yes |
|
| Currency code (ISO 4217) for the default payout currency | no |
|
| If set to true, receipts will be sent automatically to the shoppers | yes |
|
| If set to true, invoices will be sent automatically to the shoppers | yes |
|
| The payout frequency of the vendor. Possible values are: | no |
|
| Logo used in invoices. | yes |
Attribute | Type | Description | Nullable |
|
| The ID of a Payout info | no |
|
| Bank ID number (ie. Routing number) | no |
|
| Name of vendor bank | no |
|
| Country code of vendor bank | no |
|
| City of vendor bank | yes |
|
| Street address of vendor bank | yes |
|
| Zip/Postal code of vendor bank | no |
|
| Vendor bank account number | no |
|
| Vendor International Bank Account Number | yes, if |
|
| Account type. Possible values: | no |
|
| Type of bank account. Possible values: | no |
|
| Name on bank account for vendor | no |
|
| Method of payout to vendor. Possible values: | no |
|
| Payout currency for vendor's bank account. | no |
|
| 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 | no |
|
| Vendor state | yes, if country is not |
|
| International identification bank code | yes |
Possible values for payoutType
:
Value | Full name |
| Australia Dollar |
| Canada Dollar |
| Switzerland Franc |
| Denmark Kroner |
| Euro |
| United Kingdom Pound |
| Hong Kong Dollar |
| Japan Yen |
| Norway Kroner |
| New Zealand Dollar |
| Sweden Kroner |
| US Dollar |
Attribute | Type | Description | Nullable |
|
| First name of vendor principal owner | no |
|
| Last name of vendor principal owner | no |
|
| Address of vendor principal owner | no |
|
| City of vendor principal owner | no |
|
| Country code of vendor principal owner | no |
|
| Zip of vendor principal owner | no |
|
| Date of Birth of vendor principal owner. Format: | no |
|
| 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 |
|
| Driver license number of vendor principal owner | yes, if vendor principal country is not |
|
| Passport number of vendor principal owner. | yes, if vendro principal country is |
|
| Email address of vendor principal owner | no |
Attribute | Type | Description | Nullable |
|
| The email subject that will be shown when sending receipt to shoppers. | yes |
|
| The body header text that will be shown on top of the receipt document when sending receipt to shoppers. | yes |
Attribute | Type | Description | Nullable |
|
| The email subject that will be shown when sending invoice to shoppers. | yes |
|
| The body header text that will be shown on top of the invoice document when sending invoice to shoppers. | yes |
Attribute | Type | Description | Nullable |
|
| The ID of the Shopper | no |
|
| The vendor's name for which the shopper is created. | no |
|
| Shopper's first name | no |
|
| Shopper's last name | no |
|
| Shopper email | no |
|
| Shopper wallet address | no |
|
| The number of malicious attemps for a shopper. It is incremented when a given signed transaction reverts. | no |
|
| Indicates whether the shopper will use LimePay internal encrypted wallets. | no |
Attribute | Type | Description | Nullable |
|
| The generated JSON Web Token for the generation of LimePay encrypted Wallet later on | no |
Attribute | Type | Description | Nullable |
|
| The id of the payment | no |
|
| The status of the Payment | no |
|
| The date time when the payment was created | no |
|
| Currency code (ISO 4217) of the amount to be charged | no |
|
| The shopperID of the shopper that will be charged | no |
|
| The vendorID of the vendor that will charge the payment | no |
|
| Array of Items objects that are being purchased | no |
|
| Object containing information about the funding of an shopper | no |
|
| Objects containing information about every transaction that should be executed | no |
|
| ​Payment Details object | no |
|
| The type of the payment. Possible values | no |
|
| The generated JSON Web Token for the payment | yes |
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 |
Attribute | Type | Description | Nullable |
|
| Description of the item that is being bought. This information is displayed in the invoice. | no |
|
| Fiat amount of the item excluding VAT amount. | no |
|
| Quantity of the items | no |
Attribute | Type | Description | Nullable |
|
| Tax rate for the payment. Depends on the country of the Vendor | yes |
|
| Tax amount of the payment. Calculated with taxRate and the baseAmount | yes |
|
| Payment amount without tax | no |
|
| Payment amount with tax (if any) | no |
|
| ​Card Holder object | no |
Attribute | Type | Description | Nullable |
|
|
| yes |
|
| Personal/Company name of the shopper | no |
|
| If the shopper is company | no |
|
| Shopper's country | no |
|
| Shopper's zip/postal code | no |
|
| Shopper's street address | no |
Attribute | Type | Description | Nullable |
|
| Amount of ethers that the shopper will be funded with | no |
|
| Amount of tokens that the shopper will be funded with. NOTEIf the payment is | no |
|
| 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 |
|
| The hash of the transaction. It will be set once the transaction is executed | yes |
|
| The status of the transaction. Possible values are: | no |
|
| Gas price used for funding the shopper. Used only for version 3 Escrow contracts | yes |
Attribute | Type | Description | Nullable |
|
| Address that the transaction will be sent to | no |
|
| Name of the smart contract function | no |
|
| Gas price of the transaction | no |
|
| Gas limit of the transactions | no |
|
| Signed transaction by the shoppers private key, that will be broadcasted | no |
|
| Status of the transaction. Possible values are: | no |
|
| The hash of the transaction. It will be set once the transaction is broadcasted | yes |
|
| Array of Function parameter objects. Each object contain information(type,value) of parameter that should be passed to a function | no |
Attribute | Type | Description | Nullable |
|
| Value that should be passed to the function | no |
|
| The solidity type of the value. For example: bool, bool[]..... | no |