Changes to Create a sweep

Changed in 14 of the 51 revisions of this API.▲7●23○45

1. May 19, 2026v287544766dc8e○2
2. Jan 21, 2026v20d06f978a8b5○20
3. Nov 19, 2025v24cd18d5551af●1○1
4. Sep 9, 2025v2dd6159049c95▲6○3
5. Jul 29, 2025v29fede8325f6d●1○1
6. Mar 20, 2025v2e69e67d2e692●1○1
7. Nov 20, 2024v261259c9969a5○1
8. Nov 13, 2024v25c1b264dd7b8●1○1
9. Oct 10, 2024v280dfacd37eec●4○4
10. Jun 20, 2024v2f874764bcf8b●1○1
11. Apr 26, 2024v26f1fad79c6c0●1○5
12. Jan 16, 2024v224691235e721○1
13. Nov 14, 2023v212a0c6036e6b●10
14. Oct 19, 2023v278e297a2eb6f▲1●3○4

What changed

• May 19, 2026v287544766dc8e○2See the full diff
  • ○

    api tag Custom payout schedules (sweeps) added

    api-tag-added

  • ○

    api tag Balance accounts removed

    api-tag-removed

• Jan 21, 2026v20d06f978a8b5○20See the full diff
  • ○

    removed the enum value approvalExpired of the request read-only property reason

    request-read-only-property-enum-value-removed

  • ○

    removed the enum value balanceAccountTemporarilyBlockedByTransactionRule of the request read-only property reason

    request-read-only-property-enum-value-removed

  • ○

    removed the enum value declined of the request read-only property reason

    request-read-only-property-enum-value-removed

  • ○

    removed the enum value declinedByTransactionRule of the request read-only property reason

    request-read-only-property-enum-value-removed

  • ○

    removed the enum value pending of the request read-only property reason

    request-read-only-property-enum-value-removed

  • ○

    removed the enum value pendingApproval of the request read-only property reason

    request-read-only-property-enum-value-removed

  • ○

    removed the enum value pendingExecution of the request read-only property reason

    request-read-only-property-enum-value-removed

  • ○

    removed the enum value refusedByCustomer of the request read-only property reason

    request-read-only-property-enum-value-removed

  • ○

    removed the enum value scaFailed of the request read-only property reason

    request-read-only-property-enum-value-removed

  • ○

    removed the enum value schemeAdvice of the request read-only property reason

    request-read-only-property-enum-value-removed

  • ○

    removed the approvalExpired enum value from the reason response property for the response status 200

    response-property-enum-value-removed

  • ○

    removed the balanceAccountTemporarilyBlockedByTransactionRule enum value from the reason response property for the response status 200

    response-property-enum-value-removed

  • ○

    removed the declined enum value from the reason response property for the response status 200

    response-property-enum-value-removed

  • ○

    removed the declinedByTransactionRule enum value from the reason response property for the response status 200

    response-property-enum-value-removed

  • ○

    removed the pending enum value from the reason response property for the response status 200

    response-property-enum-value-removed

  • ○

    removed the pendingApproval enum value from the reason response property for the response status 200

    response-property-enum-value-removed

  • ○

    removed the pendingExecution enum value from the reason response property for the response status 200

    response-property-enum-value-removed

  • ○

    removed the refusedByCustomer enum value from the reason response property for the response status 200

    response-property-enum-value-removed

  • ○

    removed the scaFailed enum value from the reason response property for the response status 200

    response-property-enum-value-removed

  • ○

    removed the schemeAdvice enum value from the reason response property for the response status 200

    response-property-enum-value-removed

• Nov 19, 2025v24cd18d5551af●1○1See the full diff
  • ●

    added the new schemeAdvice enum value to the reason response property for the response status 200

    response-property-enum-value-added

  • ○

    added the new schemeAdvice enum value to the request property reason

    request-property-enum-value-added

• Sep 9, 2025v2dd6159049c95▲6○3See the full diff
  • ▲

    the sweepAmount/currency response property's maxLength was unset from 3 for the response status 200

    response-property-max-length-unset

  • ▲

    the targetAmount/currency response property's maxLength was unset from 3 for the response status 200

    response-property-max-length-unset

  • ▲

    the triggerAmount/currency response property's maxLength was unset from 3 for the response status 200

    response-property-max-length-unset

  • ▲

    the sweepAmount/currency response property's minLength was decreased from 3 to 0 for the response status 200

    response-property-min-length-decreased

  • ▲

    the targetAmount/currency response property's minLength was decreased from 3 to 0 for the response status 200

    response-property-min-length-decreased

  • ▲

    the triggerAmount/currency response property's minLength was decreased from 3 to 0 for the response status 200

    response-property-min-length-decreased

  • ○

    the sweepAmount/currency request property's minLength was decreased from 3 to 0

    request-property-min-length-decreased

  • ○

    the targetAmount/currency request property's minLength was decreased from 3 to 0

    request-property-min-length-decreased

  • ○

    the triggerAmount/currency request property's minLength was decreased from 3 to 0

    request-property-min-length-decreased

• Jul 29, 2025v29fede8325f6d●1○1See the full diff
  • ●

    added the new approvalExpired enum value to the reason response property for the response status 200

    response-property-enum-value-added

  • ○

    added the new approvalExpired enum value to the request property reason

    request-property-enum-value-added

• Mar 20, 2025v2e69e67d2e692●1○1See the full diff
  • ●

    added the new pending enum value to the reason response property for the response status 200

    response-property-enum-value-added

  • ○

    added the new pending enum value to the request property reason

    request-property-enum-value-added

• Nov 20, 2024v261259c9969a5○1See the full diff
  • ○

    added the optional property reasonDetail to the response with the 200 status

    response-optional-property-added

• Nov 13, 2024v25c1b264dd7b8●1○1See the full diff
  • ●

    added the new refusedByCustomer enum value to the reason response property for the response status 200

    response-property-enum-value-added

  • ○

    added the new refusedByCustomer enum value to the request property reason

    request-property-enum-value-added

• Oct 10, 2024v280dfacd37eec●4○4See the full diff
  • ●

    added the new accountHierarchyNotActive enum value to the reason response property for the response status 200

    response-property-enum-value-added

  • ●

    added the new directDebitNotSupported enum value to the reason response property for the response status 200

    response-property-enum-value-added

  • ●

    added the new pendingExecution enum value to the reason response property for the response status 200

    response-property-enum-value-added

  • ●

    added the new transferInstrumentDoesNotExist enum value to the reason response property for the response status 200

    response-property-enum-value-added

  • ○

    added the new accountHierarchyNotActive enum value to the request property reason

    request-property-enum-value-added

  • ○

    added the new directDebitNotSupported enum value to the request property reason

    request-property-enum-value-added

  • ○

    added the new pendingExecution enum value to the request property reason

    request-property-enum-value-added

  • ○

    added the new transferInstrumentDoesNotExist enum value to the request property reason

    request-property-enum-value-added

• Jun 20, 2024v2f874764bcf8b●1○1See the full diff
  • ●

    added the new declined enum value to the reason response property for the response status 200

    response-property-enum-value-added

  • ○

    added the new declined enum value to the request property reason

    request-property-enum-value-added

• Apr 26, 2024v26f1fad79c6c0●1○5See the full diff
  • ●

    added the new pendingApproval enum value to the reason response property for the response status 200

    response-property-enum-value-added

  • ○

    added the new optional request property reference

    new-optional-request-property

  • ○

    added the new optional request property referenceForBeneficiary

    new-optional-request-property

  • ○

    added the new pendingApproval enum value to the request property reason

    request-property-enum-value-added

  • ○

    added the optional property reference to the response with the 200 status

    response-optional-property-added

  • ○

    added the optional property referenceForBeneficiary to the response with the 200 status

    response-optional-property-added

• Jan 16, 2024v224691235e721○1See the full diff
  • ○

    the endpoint scheme security clientKey was added to the API

    api-security-added

  This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

• Nov 14, 2023v212a0c6036e6b●10See the full diff
  • ●

    removed the optional property response/paths from the response with the 400 status

    response-optional-property-removed

  • ●

    removed the optional property response/paths from the response with the 401 status

    response-optional-property-removed

  • ●

    removed the optional property response/paths from the response with the 403 status

    response-optional-property-removed

  • ●

    removed the optional property response/paths from the response with the 422 status

    response-optional-property-removed

  • ●

    removed the optional property response/paths from the response with the 500 status

    response-optional-property-removed

  • ●

    removed the optional property response/rootPath from the response with the 400 status

    response-optional-property-removed

  • ●

    removed the optional property response/rootPath from the response with the 401 status

    response-optional-property-removed

  • ●

    removed the optional property response/rootPath from the response with the 403 status

    response-optional-property-removed

  • ●

    removed the optional property response/rootPath from the response with the 422 status

    response-optional-property-removed

  • ●

    removed the optional property response/rootPath from the response with the 500 status

    response-optional-property-removed

  This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

• Oct 19, 2023v278e297a2eb6f▲1●3○4See the full diff
  • ▲

    removed the enum value directDebit of the request property priorities/items

    request-property-enum-value-removed

  • ●

    added the new balanceAccountTemporarilyBlockedByTransactionRule enum value to the reason response property for the response status 200

    response-property-enum-value-added

  • ●

    added the new declinedByTransactionRule enum value to the reason response property for the response status 200

    response-property-enum-value-added

  • ●

    added the new scaFailed enum value to the reason response property for the response status 200

    response-property-enum-value-added

  • ○

    added the new balanceAccountTemporarilyBlockedByTransactionRule enum value to the request property reason

    request-property-enum-value-added

  • ○

    added the new declinedByTransactionRule enum value to the request property reason

    request-property-enum-value-added

  • ○

    added the new scaFailed enum value to the request property reason

    request-property-enum-value-added

  • ○

    removed the directDebit enum value from the priorities/items response property for the response status 200

    response-property-enum-value-removed