Schedule payment (deprecated)

Enables users to schedule a payment for a specified future date (schedule_datetime). For more information, see Schedule payment overview.

The payload for this request is similar to that of the Post a payment endpoint with the exception of the (schedule_datetime) property.

For more information about payments operations, see Corporate Banking Launch Reference.

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 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 field, which contains the following fields:
  • credit_external_account_id: Included in the metadata field when it's provided in the credit leg.
  • debit_external_account_id: Included in the metadata field when it's provided in the debit leg.
  • earmark_id: Included in the metadata field when it's provided in the debit leg.

This endpoint generates the following events:

• Authorization created
• Account balance changed
• Transaction created
• Current scheduled payment status displayed

See Data and reporting for more information about events and setting up event notifications.