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 instructed as soon as it is authorised
- `payerBankAccountId` string, uuid, nullable — The bank account to pay from. For backwards compatibility, this field is still supported. New integrations should use PaymentSourceType and PaymentSourceId instead. - `paymentSourceType` 'BankAccount' | 'Card' - `paymentSourceId` string, uuid, nullable — ID of the payment source. The type is derived automatically when PaymentSourceType is omitted. Required for Bank payment sources. Optional if PaymentSourceType is Card (for stored cards). - `payables` union[], required — Collection of individual payable items that form this pay run - union - PayableResourceRepresentationVersion4 - `$type` 'Payable' | 'FeePayable', required - `payableId` string, uuid - `fundingAmount` PayableFundingAmountResourceRepresentationVersion4 - `currencyCode` string, required —ISO 4217 alpha-3 Currency Code for the funding amount (i.e. GBP)
- `amountInMinorUnits` integer, required — Value of the funding amount e.g. in GBP, this would be pence. A money value of £12.75 would have an AmountInMinorUnits of 1275. - `isEstimated` boolean, required — Is this an estimated funding amount? - `reference` string — Customer reference for this payment - `isLowPriority` boolean — Sets the payment to be processed last in the batch - `failureInsights` union - FailureInsightsResolutionResourceRepresentationVersion4 - `$type` string, required - FailureInsightsSuggestionResourceRepresentationVersion4 - `$type` string, required - `reversedAmount` PayableReversedAmountResourceRepresentationVersion4 - `currencyCode` string —ISO 4217 alpha-3 Currency Code for this returned amount (i.e. GBP)
- `amountInMinorUnits` integer, required — Value of the return amount in the minor unit of the currency. For GBP this would be the amount in pence e.g. a money value of £12.75 would have an AmountInMinorUnits of 1275. - `status` 'Unknown' | 'Open' | 'UserInitiationInProgress' | 'AwaitingMultiAuth' | 'BankInitiating' | 'WaitingForCustomer' | 'TransfersInProgress' | 'Processing' | 'Cancelling' | 'Reversing' | 'Processed' | 'Cancelled' | 'Reversed' | 'Draft' — Mapping for https://crezco.readme.io/reference/statuses so we don't expose internal statuses - `paymentSourceType` 'BankAccount' | 'Card' - `paymentSourceId` string, uuid, nullable — ID of the payment source, if known - FeePayableResourceRepresentationVersion4 - `$type` 'Payable' | 'FeePayable', required - `payableId` string, uuid - `fundingAmount` PayableFundingAmountResourceRepresentationVersion4 - `currencyCode` string, required —ISO 4217 alpha-3 Currency Code for the funding amount (i.e. GBP)
- `amountInMinorUnits` integer, required — Value of the funding amount e.g. in GBP, this would be pence. A money value of £12.75 would have an AmountInMinorUnits of 1275. - `isEstimated` boolean, required — Is this an estimated funding amount? - `reference` string — Customer reference for this payment - `isLowPriority` boolean — Sets the payment to be processed last in the batch - `failureInsights` union - FailureInsightsResolutionResourceRepresentationVersion4 - `$type` string, required - FailureInsightsSuggestionResourceRepresentationVersion4 - `$type` string, required - `reversedAmount` PayableReversedAmountResourceRepresentationVersion4 - `currencyCode` string —ISO 4217 alpha-3 Currency Code for this returned amount (i.e. GBP)
- `amountInMinorUnits` integer, required — Value of the return amount in the minor unit of the currency. For GBP this would be the amount in pence e.g. a money value of £12.75 would have an AmountInMinorUnits of 1275. - `status` 'Unknown' | 'Open' | 'UserInitiationInProgress' | 'AwaitingMultiAuth' | 'BankInitiating' | 'WaitingForCustomer' | 'TransfersInProgress' | 'Processing' | 'Cancelling' | 'Reversing' | 'Processed' | 'Cancelled' | 'Reversed' | 'Draft' — Mapping for https://crezco.readme.io/reference/statuses so we don't expose internal statuses - `paymentSourceType` 'BankAccount' | 'Card' - `paymentSourceId` string, uuid, nullable — ID of the payment source, if known - `groups` PayableGroupResourceRepresentationVersion4[], nullable —Optional collection of payable groups within this pay run
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.
Attempts to group payments with different beneficiaries will cause pay run creation to fail.
- `groupId` string, uuid - `status` 'Unknown' | 'Open' | 'Processed' | 'UserInitiationInProgress' | 'Processing' | 'Cancelling' | 'Draft' — Mapping for https://crezco.readme.io/reference/statuses so we don't expose internal statuses - `partnerEntityId` string, required — Globally Unique Id of this payment group in the partner system - `partnerPayableIds` PayableIdentifiersResourceRepresentationVersion4[], required —Collection of Payables which should be grouped together
- `payableId` string, uuid — ID of this payable in the Crezco system - `partnerEntityId` string, required — Globally Unique Id of this payable in the partner system - `reference` string, required — Customer reference for this payment group - `batches` BatchResourceRepresentationVersion4[] — Collection of batches within this pay run - `batchId` string, uuid, required — ID of this batch in the Crezco system - `paymentOrder` integer, required — We maintain an explicit ordering of Batches within a pay run, to ensure we have consistent order during "sequential" payment. We don't anticipate needing to re-order existing batches, although it is possible that batches could be appended (i.e. if a batch gets cancelled and multiple replacements created) - `status` 'Unknown' | 'Open' | 'Processed' | 'UserInitiationInProgress' | 'Processing' | 'Cancelling' | 'Draft', required — Mapping for https://crezco.readme.io/reference/statuses so we don't expose internal statuses - `groups` GroupIdentifiersResourceRepresentationVersion4[], required — Collection of all payment groups within this pay run - `groupId` string, uuid, required — ID of this group in the Crezco system - `partnerEntityId` string, nullable, required — Globally Unique Id of this group in the partner system - `payables` PayableIdentifiersResourceRepresentationVersion4[], required — Collection of all payment groups within this pay run - `payableId` string, uuid — ID of this payable in the Crezco system - `partnerEntityId` string, required — Globally Unique Id of this payable in the partner system - `status` 'Unknown' | 'Open' | 'UserInitiationInProgress' | 'Processing' | 'Cancelling' | 'Processed' | 'Concluded' | 'Cancelled' | 'Draft' — Mapping for https://crezco.readme.io/reference/statuses so we don't expose internal statuses - `checkoutUri` string, uri - `metadata` PayRunMetadataResourceRepresentationVersion4[] — Partner-defined metadata for this pay run - `key` string, required - `value` string, required ## Other responses - `400` — Bad Request - `401` — You do not have access. Check your API key is correct. - `403` — You do not have access to this organisation. - `404` — Not Found - `406` — The version of the API that you requested is not available. Check your Crezco-Version header. If you omit this header you will use the latest version of the API. - `429` — You have made too many requests to the API in too short a period. Wait a while and try again. - `503` — Service Unavailable --- [API](https://skmtc.net/crezco/apis/payables-api.md) · [All operations](https://skmtc.net/crezco/apis/payables-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crezco/payables-api/revisions/4427e79fba09/schema)