Paybook
Paybook is a hub that connects people with their financial world! Through bank connectivity and innovative technology, Paybook's solutions foster productivity and fiscal clarity to improve the lives and operations of individuals and businesses around the globe.Integrate your software solutions with financial institutions, government agencies, and utility service providers for a steady flow of…
83 subscribers
32 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Paybook endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST |
cancelInvoice /cancelInvoice |
Cancel the invoice. |
| POST |
checkStructure /checkStructure |
Check for errors and warning in JSON structure or XML invoice. |
| POST |
createCredentials /createCredentials |
Creates credentials.Credentials are the third-party data that is needed in order to authenticate with a third-party site. Credentials are encrypted upon arrival and won’t be… |
| POST |
createTaxpayer /createTaxpayer |
Create a new taxpayer.With these endpoint you can add or edit taxpayers that will be able to emit invoices. |
| POST |
createUser /createUser |
Create a new user.Users are logical segmentations for end-users. It's a best practice to register users in order to have their information grouped and have control on both ends.… |
| POST |
deleteCredentials /deleteCredentials |
Delete credentials.Credentials are the third-party data that is needed in order to authenticate with a third-party site. Credentials are encrypted upon arrival and won’t be… |
| POST |
deleteSessionToken /deleteSessionToken |
Delete a session token.Sessions are access tokens for the final user in order to consume Sync endpoints. Sessions expire after 5 minutes of inactivity and should be used for… |
| POST |
deleteUser /deleteUser |
Deletes a user.Users are logical segmentations for end-users. It's a best practice to register users in order to have their information grouped and have control on both ends. It… |
| POST |
getAccountTypes /getAccountTypes |
Return account types.Catalogues are a collection of endpoints that are relevant to the data segmentation on some of the other endpoints. |
| POST |
getAccounts /getAccounts |
Returns accounts for a specific user.Accounts are repositories for end-user transactions which are often segmented by some distinction, such as account type and/or account… |
| POST |
getAllStampedInvoices /getAllStampedInvoices |
Get all the stamped invoices for the user. |
| POST |
getAttachment /getAttachment |
Returns the attachment.Attachments are files that have a relation to accounts or transactions. The type of attachment will vary in its availability from its source. |
| POST |
getAttachmentTypes /getAttachmentTypes |
Return attachment types.Catalogues are a collection of endpoints that are relevant to the data segmentation on some of the other endpoints. |
| POST |
getAttachments /getAttachments |
Returns attachments for specific user.Attachments are files that have a relation to accounts or transactions. The type of attachment will vary in its availability from its source. |
| POST |
getAttachmentsCount /getAttachmentsCount |
Returns the number of attachments given some search parameters.Attachments are files that have a relation to accounts or transactions. The type of attachment will vary in its… |
| POST |
getAvailableCities /getAvailableCities |
Return available cities.Catalogues are a collection of endpoints that are relevant to the data segmentation on some of the other endpoints. |
| POST |
getAvailableCountries /getAvailableCountries |
Return available countries.Catalogues are a collection of endpoints that are relevant to the data segmentation on some of the other endpoints. |
| POST |
getAvailableSiteOrganizations /getAvailableSiteOrganizations |
Return available site organizations.Catalogues are a collection of endpoints that are relevant to the data segmentation on some of the other endpoints. |
| POST |
getCredentials /getCredentials |
Returns register credentials.Credentials are the third-party data that is needed in order to authenticate with a third-party site. Credentials are encrypted upon arrival and… |
| POST |
getExtractedDataFromAttachment /getExtractedDataFromAttachment |
Returns the extracted data from attachment.Attachments are files that have a relation to accounts or transactions. The type of attachment will vary in its availability from its… |
| POST |
getProviders /getProviders |
In Sync you can use different providers to stamp the invoices. |
| POST |
getSessionToken /getSessionToken |
Create a session token.Sessions are access tokens for the final user in order to consume Sync endpoints. Sessions expire after 5 minutes of inactivity and should be used for… |
| POST |
getSitesGroupBySiteOrganizations /getSitesGroupBySiteOrganizations |
Return sites group by site organizations.Catalogues are a collection of endpoints that are relevant to the data segmentation on some of the other endpoints. |
| POST |
getTaxpayers /getTaxpayers |
Get the list of the registered taxpayers for the user.With these endpoint you can add or edit taxpayers that will be able to emit invoices. |
| POST |
getTransactions /getTransactions |
Returns transactions for specific user.Transactions are financial movements that are related to an account. They reflect an income or expense that the end-user has on a specific… |
| POST |
getTransactionsCount /getTransactionsCount |
Returns the number of transactions given some search parameters.Transactions are financial movements that are related to an account. They reflect an income or expense that the… |
| POST |
getUserByApiKey /getUserByApiKey |
Returns users for that token.Users are logical segmentations for end-users. It's a best practice to register users in order to have their information grouped and have control on… |
| POST |
stampNewInvoice /stampNewInvoice |
Stamp a new invoice, you can send the JSON structure. |
| POST |
updateCredentials /updateCredentials |
Updates credentials.Credentials are the third-party data that is needed in order to authenticate with a third-party site. Credentials are encrypted upon arrival and won’t be… |
| POST |
updateTaxpayer /updateTaxpayer |
Update the credentials of taxpayer.With these endpoint you can add or edit taxpayers that will be able to emit invoices. |
| POST |
updateUser /updateUser |
Update user.Users are logical segmentations for end-users. It's a best practice to register users in order to have their information grouped and have control on both ends. It is… |
| POST |
validateSessionToken /validateSessionToken |
Sessions are access tokens for the final user in order to consume Sync endpoints. Sessions expire after 5 minutes of inactivity and should be used for creating or updating… |
Paybook pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — | — |
