Jump to Content

Home Guides API Reference Changelog Discussions

v1.0

API Reference

v1.0Home Guides API Reference Changelog Discussions

Beneficiaries

/{beneficiaryId}
- getget
- postpost
/{beneficiaryId}/supplier-rules
- Get Supplier rulesget
- Patch Supplier rulespatch
/raw
- getget
/matches/{resourceId}
- getget
- patchpatch
/
- getget
- postpost
/v0/bank-details
- getget
/v0/beneficiary-required-details
- getget
/v1/searchBeneficiaries
- Search recipientspost

Quotes

/
- postpost

Payments

/v2
- List paymentsget
- Create Paymentput
/v2/bulk
- Bulk Create Paymentspost
/v2/{paymentId}
/v2/{paymentId}/payment-confirmation
- Get payment confirmationget
/v2/searchPayments
- Search paymentspost
/v2/createPayment
- Create Paymentpost
/v2/reference/purpose-codes
- Get payment purpose codesget
/v2/reference/invalid-payment-dates
- Get invalid payment dates for currencyget
/v2/list-duplicate-payments
- List duplicate paymentspost
/v2/payment-counts-and-amounts
- Get payment status counts and amountspost

Payroll

/{payrollId}
/validate
- postpost
/
- getget
- postpost

Rates

/rate
- getget

Transactions

/v1
- List Transactionsget
/v1/{transactionId}
- Get Transactionget
/v2
- List Transactionsget
/v2/transactionsTimeseries
- Get transaction timeseriespost
/v2/searchRolledUpTransactions
- Search rolled up transactionspost

Budgets

/budgets
- Create Budgetpost
- List budgetsget
/budgets/{budgetId}
/budgets/{budgetId}/transactions
- Get budget transactionsget
/budgets/{budgetId}/users
- Get budget usersget
/budgets/users/{userId}
- Batch get budgetsget
/budgets/cards/{cardId}
- Batch get budgets under a card IDget
/budgets/counts
- List the status total amountsget
/budgets/usage
- Get the Usage of Budgetsget
/budgetApprovalPreview
- Preview a budget approvalpost

Webhooks

/v1/events/{resourceType}
- List Eventsget
/v1/subscriptions
- List Subscriptionsget
/v1/subscriptions/company
- List Subscriptionsget
/v1/subscriptions/{resourceType}
- Create Subscriptionput

Bills

/v2
- List billsget
- Create billpost
/v2/counts
- Get bill status countsget
/v2/export
- Export bills data to a filepost
/v2/searchBills
- Search billspost
/v2/export/attachments
- Export bills attachments to a zipped folderpost
/v2/bulk
/v2/{billId}
- Get billget
- Update billpatch
/v2/{billId}/link
- Link payment to billpost
/v2/{billId}/uploadAttachment
- Upload Attachmentpost
/v2/{billId}/attachments
- Upload Attachmentpost
- List Attachmentsget
/v2/{billId}/attachments/{attachmentId}
/v2/{billId}/attachments/{attachmentId}/run-ocr
- Run OCRpost
/v2/previewBillApproval
- Preview a bill approvalpost
/v2/previewBillPaymentApproval
- Preview a bill payment approvalpost
/v2/list-duplicate-bills
- List duplicate billspost
/v2/billsCountsAndAmounts
- Get bill status counts and amountspost

Wallets

/v1
- List Walletsget
- Create new walletpost
/v1/{walletId}
- Get specific walletget
/v1/transferFunds
- Transfer fund amounts between 2 accounts of the same currencypost

Rates

/
- Get rateget
/bulk
- getget
/v1
- List Currency ratesget

Users

/v1
- Create Userpost
- Get all the company usersget
/v1/{userId}
- Get userget
- Update userpatch
/v1/companies
- Get the attached companies for a userget
/v1/validateEmail
- Checks if the email address is valid for use with Paytronpost
/v1/changePassword
- Changes a user's passwordpost
/v1/factor
/v1/factor/activate
- Activate a factorpost
/v1/factor/enable
- Enable user for MFA factor soput
/v1/getAuthProvider
- Get auth providerpost

Companies

/v1
- Create a new companypost
/v1/{companyId}
- Get companyget
- Update companypatch
/v1/{companyId}/logo
- Update company logopatch
/v1/acceptMigrationTerms
- Update the acceptedMigrationTerms for a list of companiespost
/v0/documents
- Lists company's documentsget
- Upload a user's documentpost
/v1/documents/getDocumentUploadUrl
- Get document upload URL for companypost

Approvals

/approval-records/{type}/{id}
- Append approval to Paytron resourcepatch
/approval-records/{type}/{id}/preview
- Preview approval outcomepost

Conversions

/v2
- Create a new conversionpost
/v2/getCanUseFutureFixedConversions
- Check if the Company has access to fixed future conversionspost
/v2/{conversionId}/getCancellationCost
- Gets the cost of cancelling the conversion for the conversion IDpost
/v2/{conversionId}/cancel
- Cancels the conversion with the conversionIdpost
/v2/{conversionId}/changeConversionDate
- Change the date on a conversionpost
/v2/{conversionId}/getMoveConversionDateCost
- Get the cost of moving a conversion date for a conversionpost
/v1
- List conversionsget
- Create a new conversionpost
/v1/{conversionId}
- Get Conversionget
/v1/rate
- Get conversion rate for currency pair and datepost
/v1/quote
- Create a new conversion quotepost
/v1/quote/{conversionQuoteId}
- Get Conversion Quoteget
/v0/invalid-conversion-dates
- Get Invalid Conversion Datesget

External Transactions

/externalTransactions/v1
- List external transactionsget
- Create external transactionpost
/externalTransactions/v1/{id}

Accounting Sync Events

/syncEvents/v1/{paytronId}/events
- List sync eventsget
/syncEvents/v1/{paytronId}
- Get current sync statusget
/syncEvents/v1/{paytronId}/push
- Retry pushing a resource into the companies accounting systempost
/syncEvents/v1/{paytronId}/ingest
- Retry ingesting a resource from an accounting systempost

Notifications

/v1/{notificationId}
- Get notificationget

Powered by

Beneficiaries

/{beneficiaryId}
- getget
- postpost
/{beneficiaryId}/supplier-rules
- Get Supplier rulesget
- Patch Supplier rulespatch
/raw
- getget
/matches/{resourceId}
- getget
- patchpatch
/
- getget
- postpost
/v0/bank-details
- getget
/v0/beneficiary-required-details
- getget
/v1/searchBeneficiaries
- Search recipientspost

Quotes

/
- postpost

Payments

/v2
- List paymentsget
- Create Paymentput
/v2/bulk
- Bulk Create Paymentspost
/v2/{paymentId}
/v2/{paymentId}/payment-confirmation
- Get payment confirmationget
/v2/searchPayments
- Search paymentspost
/v2/createPayment
- Create Paymentpost
/v2/reference/purpose-codes
- Get payment purpose codesget
/v2/reference/invalid-payment-dates
- Get invalid payment dates for currencyget
/v2/list-duplicate-payments
- List duplicate paymentspost
/v2/payment-counts-and-amounts
- Get payment status counts and amountspost

Payroll

/{payrollId}
/validate
- postpost
/
- getget
- postpost

Rates

/rate
- getget

Transactions

/v1
- List Transactionsget
/v1/{transactionId}
- Get Transactionget
/v2
- List Transactionsget
/v2/transactionsTimeseries
- Get transaction timeseriespost
/v2/searchRolledUpTransactions
- Search rolled up transactionspost

Budgets

/budgets
- Create Budgetpost
- List budgetsget
/budgets/{budgetId}
/budgets/{budgetId}/transactions
- Get budget transactionsget
/budgets/{budgetId}/users
- Get budget usersget
/budgets/users/{userId}
- Batch get budgetsget
/budgets/cards/{cardId}
- Batch get budgets under a card IDget
/budgets/counts
- List the status total amountsget
/budgets/usage
- Get the Usage of Budgetsget
/budgetApprovalPreview
- Preview a budget approvalpost

Webhooks

/v1/events/{resourceType}
- List Eventsget
/v1/subscriptions
- List Subscriptionsget
/v1/subscriptions/company
- List Subscriptionsget
/v1/subscriptions/{resourceType}
- Create Subscriptionput

Bills

/v2
- List billsget
- Create billpost
/v2/counts
- Get bill status countsget
/v2/export
- Export bills data to a filepost
/v2/searchBills
- Search billspost
/v2/export/attachments
- Export bills attachments to a zipped folderpost
/v2/bulk
/v2/{billId}
- Get billget
- Update billpatch
/v2/{billId}/link
- Link payment to billpost
/v2/{billId}/uploadAttachment
- Upload Attachmentpost
/v2/{billId}/attachments
- Upload Attachmentpost
- List Attachmentsget
/v2/{billId}/attachments/{attachmentId}
/v2/{billId}/attachments/{attachmentId}/run-ocr
- Run OCRpost
/v2/previewBillApproval
- Preview a bill approvalpost
/v2/previewBillPaymentApproval
- Preview a bill payment approvalpost
/v2/list-duplicate-bills
- List duplicate billspost
/v2/billsCountsAndAmounts
- Get bill status counts and amountspost

Wallets

/v1
- List Walletsget
- Create new walletpost
/v1/{walletId}
- Get specific walletget
/v1/transferFunds
- Transfer fund amounts between 2 accounts of the same currencypost

Rates

/
- Get rateget
/bulk
- getget
/v1
- List Currency ratesget

Users

/v1
- Create Userpost
- Get all the company usersget
/v1/{userId}
- Get userget
- Update userpatch
/v1/companies
- Get the attached companies for a userget
/v1/validateEmail
- Checks if the email address is valid for use with Paytronpost
/v1/changePassword
- Changes a user's passwordpost
/v1/factor
/v1/factor/activate
- Activate a factorpost
/v1/factor/enable
- Enable user for MFA factor soput
/v1/getAuthProvider
- Get auth providerpost

Companies

/v1
- Create a new companypost
/v1/{companyId}
- Get companyget
- Update companypatch
/v1/{companyId}/logo
- Update company logopatch
/v1/acceptMigrationTerms
- Update the acceptedMigrationTerms for a list of companiespost
/v0/documents
- Lists company's documentsget
- Upload a user's documentpost
/v1/documents/getDocumentUploadUrl
- Get document upload URL for companypost

Approvals

/approval-records/{type}/{id}
- Append approval to Paytron resourcepatch
/approval-records/{type}/{id}/preview
- Preview approval outcomepost

Conversions

/v2
- Create a new conversionpost
/v2/getCanUseFutureFixedConversions
- Check if the Company has access to fixed future conversionspost
/v2/{conversionId}/getCancellationCost
- Gets the cost of cancelling the conversion for the conversion IDpost
/v2/{conversionId}/cancel
- Cancels the conversion with the conversionIdpost
/v2/{conversionId}/changeConversionDate
- Change the date on a conversionpost
/v2/{conversionId}/getMoveConversionDateCost
- Get the cost of moving a conversion date for a conversionpost
/v1
- List conversionsget
- Create a new conversionpost
/v1/{conversionId}
- Get Conversionget
/v1/rate
- Get conversion rate for currency pair and datepost
/v1/quote
- Create a new conversion quotepost
/v1/quote/{conversionQuoteId}
- Get Conversion Quoteget
/v0/invalid-conversion-dates
- Get Invalid Conversion Datesget

External Transactions

/externalTransactions/v1
- List external transactionsget
- Create external transactionpost
/externalTransactions/v1/{id}

Accounting Sync Events

/syncEvents/v1/{paytronId}/events
- List sync eventsget
/syncEvents/v1/{paytronId}
- Get current sync statusget
/syncEvents/v1/{paytronId}/push
- Retry pushing a resource into the companies accounting systempost
/syncEvents/v1/{paytronId}/ingest
- Retry ingesting a resource from an accounting systempost

Notifications

/v1/{notificationId}
- Get notificationget

Powered by

Search recipients

post https://beneficiaries.api.paytron.com/v1/searchBeneficiaries

Run multi-term search requests on recipients

Language

URL

Click Try It! to start a request and see the response here!