Pay Run lifecycle changes
- Expect that newly-created Pay Runs and Payables begin with a status of Draft instead of Open
- Expect Pay Runs and Payables to move from status Draft to Open when Checkout is called on the Pay Run
- Continue to expect that Pay Runs and Payables in Open status can time out and become Cancelled after 10 minutes of no activity, but Draft Pay Runs and Payables cannot
Replace uses of FX Estimate endpoint (removed) with Create pay run
- Create pay run and Get pay run now return estimated currency conversion rates and fees, before the customer has confirmed a rate during the payment flow
- Speculative calls to Create pay run are accepted, such pay runs can be created and abandoned without consequence
Replace uses of Get Organisation By PartnerClientId (removed) with Get Organisation
Payable object changes
- FX Fees are now part of the Fees object in a Payable
- transferFee and exchangeFee have been replaced with providerFixedFee and providerVariableFee to describe the fees that are flat and proportional to Payable value respectively (see Get pay run and Collecting Fees for details)
- Payable amount is now recipientAmount for clarity
- Payable amountReturned is now reversedAmount to match the Reversed status it is relevant to
Connect and Checkout now return 200 OK with a { "url": "https://example.com" } response instead of a 302 Found response, to be consistent with Verification flow
Checkout is now a POST endpoint instead of a GET endpoint as it has the side effect of moving a Draft Pay Run to Open
Update webhook subscriptions
- Breaking change: Payable webhook payload is now the entire Payable object as described in Get pay run
- There are no other breaking changes in webhook data, but new additions such as FX estimates and Failure Insights will only appear in v2025-01-31
- Call Register webhook for each of the webhook events that you wish to subscribe to in the new version of the API
- Call Delete existing webhookfor each webhook for the old version to which you are still subscribed
Begin sending a Crezco-Version header with value of 2025-01-31 with all API calls