API Guide
Log In
API Guide

Estimate pay run costs

post
https://api.partners.uat.crezco.com/organisations//pay-runs/estimate

Estimates costs for a pay run without creating it. Accepts minimal beneficiary details (country code only). Returns detailed fee breakdown, batch assignments, and routing information.

Path Params
uuid
required

The unique Crezco ID for an organisation

Body Params

Model for requesting a pay run estimate with minimal beneficiary details

string | null

Globally Unique Id of this estimate in the partner system

date | null

The date that this pay run is scheduled to be paid represented in ISO 8601 complete date delimited format (e.g. 2022-05-12 would be 12th May 2022)

If omitted, payment will be assumed to be immediate

uuid | null

The bank account to pay from. For backwards compatibility, this field is still supported. New integrations should use PaymentSourceType and PaymentSourceId instead.

string
enum
Allowed:
uuid | null

ID of the payment source. Optional for estimates — fee calculations do not depend on a specific bank account. Required for actual pay runs if PaymentSourceType is Bank. Optional if PaymentSourceType is Card (for stored cards).

payables
array of objects
required
length ≥ 1

Collection of individual payable items for estimation. For estimates, minimal beneficiary details are required (country code is sufficient).

payables*

Minimal payable details required for pay run estimation. Contains only the essential information needed to calculate fees and routing.

string

Globally Unique Id of this payment in the partner system

recipientAmount
object
required
beneficiary
object
required

Minimal beneficiary details required for pay run estimation. For estimates, only the country is required to calculate routing and fees. Currency is determined from the payable amount.

string
enum
fees
object
groups
array of objects | null

Optional collection of payable groups for estimation

Payables can be grouped by beneficiary. Grouped payables to the same beneficiary will, once paid, appear as a single line item on the payer's bank statements.

groups
metadata
array of objects

Partner-defined metadata for this estimate

metadata
Headers
string
Defaults to 2025-01-31

The requested API version

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

404

Not Found

Updated about 1 hour ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated about 1 hour ago