Schedule payment (deprecated)

Allows users to schedule payments to be made on a specified future date (schedule_datetime). For more information, see the Schedule payment overview guide.

The payload for this request is similar to that of the payments endpoint, with the exception of the (schedule_datetime) property. See Post a payment guide for more details.

See the Data and reporting guide for more information on events and setting up event notifications.

For more information on payments operations, see the Corporate Banking Launch Reference guide.

NOTE:

  • This endpoint requires an account-specific access token; only this account can debit its balance to create the scheduled payment. Getting an account token requires you to call the Get OpenID access token endpoint with an external account ID. Tokens can expire quickly, which can result in an Unauthorized message.
  • The metadata field is updated with the inclusion of the corporate_metadata that contains the following fields:
    • credit_external_account_id: Included in the metadata field when it's informed in the credit leg.
    • debit_external_account_id: Included in the metadata field when it's informed in the debit leg.
    • earmark_id: Included in the metadata field when it's informed in the debit leg.

This endpoint generates the following events:

Language
Authorization
Bearer
JWT
Click Try It! to start a request and see the response here!