API Guide
Log In
API Guide

Checkout

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

Calling Checkout with a valid pay run ID will return a URL that the user should be redirected to in order to initiate the payment process for the given pay run.

When calling this endpoint you are expected to provide completeUrl and incompleteUrl query parameters which will be used to redirect the user back to your system following the checkout process depending on whether all batch processing is complete or not. Regardless of the URL used webhooks and/or status endpoints should always be used to obtain most accurate status information.

Path Params
uuid
required

The unique Crezco ID for an organisation

uuid
required

The unique pay run ID for the pay run

Query Params
string
required

The URL that we should redirect the user back to following the checkout process when all constituent batches have reached the processed state.

If not specified then this parameter must be specified on the supplied checkout URL itself.

string
required

The URL that we should redirect the user back to following the checkout process when not all of the constituent batches have reached the processed state.

If not specified then this parameter must be specified on the supplied checkout URL itself.

string

UserId of the user that intends to authorise the pay run batch(es)

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 7 months 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 7 months ago