API Basics
Pay In Endpoints
- MoneyIn
- Subscription
- TokenStorage
- Invoice
- LineItem
- PaymentLink
- PaymentMethodDomain
- HostedPaymentPages
- Cloud
- Wallet: Apple Pay
Pay Out Endpoints
- MoneyOut
- Bill
Pay Ops Endpoints
- Templates
- Boarding
- Chargebacks and ACH Returns
- Entities
- Notification
- Query
- Statistic
- Export
- Import
Object Models
- Object Model References
OCR a Base64-encoded String
Use Payabli’s optical character recognition (OCR) engine on a base64-encoded file. You can use the response data to create a new bill or invoice.
Learn how to use our OCR engine to scrape documents and create : Use the OCR Engine
Authorizations
Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.
Path Parameters
The type of object to create in Payabli. Accepted values are bill and invoice.
Body
Contains details about a file. See See fileObject Object Model for a complete reference.
Content of file, Base64-encoded. Ignored if furl is specified.
The name of the attached file.
The MIME type of the image file (if content is provided).
pdf, jpg, jpeg, png, gif Optional url provided to show or download the file remotely.
Response
Success
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
Auxiliary validation used internally by payment pages and components.
Code for the response. Learn more in API Response Codes.
Object containing the response data.
The raw data from the OCR operation.
Order of element or section in container.
x > 0Key-value pairs created from the document's OCR results.
Returned when resultType = bill
Returned when resultType = bill
Returned when resultType = bill
Returned when resultType = bill
Returned when resultType = bill
Item or product price per unit.
Item or product name. Max length of 250 characters.
250Quantity of item or product.
Array of tags classifying item or product.
Item or product commodity code. Max length of 250 characters.
250Item or product description. Max length of 250 characters.
250Internal class of item or product: value '0' is only for invoices , '1' for bills and, '2' common for both.
0, 1, 2 Item or product code. Max length of 250 characters.
250Tax amount applied to item or product.
Tax rate applied to item or product.
Total amount in item or product.
Unit of measurement. Max length of 100 characters.
100Returned when resultType = bill
Returned when resultType = bill
250Returned with all resultType values.
Additional Custom fields in format "key":"value".
Customer address
Additional customer address
Customer balance.
Customer city
Company name
Customer country in ISO-3166-1 alpha 2 format
See https://en.wikipedia.org/wiki/ISO_3166-1 for reference.
Timestamp of when record was created, in UTC.
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
250Customer password for customer portal
Customer Status. Possible values:
-99Deleted0Inactive1Active85Locked (typically due to multiple failed login attempts)
Customer username for customer portal
Customer email address
Customer first name
List of fields acting as customer identifiers, to be used instead of CustomerNumber.
Customer last name
Customer phone number
The shipping address.
250Additional line for shipping address.
100Shipping city.
250Shipping address country.
Shipping state or province.
Shipping ZIP code.
50Customer State
Timezone, in UTC offset. For example, -5 is Eastern time.
Customer zip code
Returned when resultType = bill
Returned when resultType = bill
Returned when resultType = bill
Returned when resultType = invoice.
Object describing the customer/payor. Required for POST requests. Which fields are required depends on the paypoint's custom identifier settings. See PayorData Object Model for a complete reference.
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using custom identifiers, pass those in this object. Example usage:
{
"additionalData": {
"CustomIdentifier": "value",
"key2": "value2",
"key3": "value3"
}
}
Customer's billing address.
250Additional line for Customer's billing address.
100Customer's billing city.
250Customer's billing country.
100Customer's email address.
250Customer's phone number.
50Customer's billing state. Must be 2-letter state code for address in US.
250Customer's billing ZIP code.
50Customer's company name.
250The Payabli-generated unique ID for the customer.
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
250Customer/Payor first name.
250List of fields acting as customer identifiers, to be used instead of CustomerNumber.
Customer/Payor last name.
250The shipping address.
250Additional line for shipping address.
100Shipping city.
250Shipping address country.
100Shipping state or province.
Shipping ZIP code.
50Object describing the invoice. Required for POST requests.
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:
{
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
Array of fileContent objects with attached documents. Max upload size is 30 MB.
Company name of the recipient of the invoice.
Discount applied to the invoice.
Duty amount.
First name of the recipient of the invoice.
Freight/shipping amount.
Frequency of scheduled invoice.
one-time, weekly, every2weeks, every6months, monthly, every3months, annually Invoice total amount.
Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.
Invoice due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.
Indicate the date to finish a scheduled invoice cycle (`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.
Invoice number. Identifies the invoice under a paypoint.
250Status for invoice.
The accepted status values are:
- 0 draft
- 1 active
- 2 partially paid
- 4 paid/complete
- 99 cancelled
0, 1, 2, 4, 99 Type of invoice. Only 0 for one-time invoices is currently supported.
Array of line items included in the invoice.
Last name of the recipient of the invoice.
Notes included in the invoice.
Payment terms for invoice. If no terms are defined, then reponse data for this field defaults to N30.
PIA, CIA, UR, NET10, NET20, NET30, NET45, NET60, NET90, EOM, MFI, 5MFI, 10MFI, 15MFI, 20MFI, 2/10NET30, UF, 10UF, 20UF, 25UF, 50UF Purchase order number.
The shipping address.
250Additional line for shipping address.
100Shipping city.
250Shipping address country.
Shipping recipient's contact email address.
Sender shipping ZIP code.
Recipient phone number.
Shipping state or province.
Shipping ZIP code.
50Commodity code.
Tax rate in percent applied to the invoice.
Custom terms and conditions included in the invoice.
Object with options for scheduled invoices.
Flag to indicate if the scheduled invoice would include a paymentlink
Flag to indicate if the scheduled invoice would include a PDF version of invoice
Returned when resultType = bill
Returned when resultType = bill
Returned when resultType = bill
Returned when resultType = bill
Returned when resultType = bill
Response text for operation: 'Success' or 'Declined'.
Was this page helpful?