---
title: "Create a payment schedule"
method: POST
path: "/payment_schedules"
tags: ["PaymentSchedules"]
---

# Create a payment schedule

`POST /payment_schedules`

Create a payment schedule

## Request body

- PaymentSchedule — Payment schedule
  - `description` string, required — User provided description for the payment schedule
  - `id` string, uuid — Payment schedule ID
  - `metadata` object — User provided JSON format data
  - `next_payment_date` PaymentDate
    - `execution_date` string, date, required — Execution date for the next payment
    - `scheduled_date` string, date, required — Scheduled date for the next payment
  - `payment_instruction` union, required
    - AchInstruction
      - `request` OutgoingAchRequest, required — Send an ACH
        - `amount` integer, required — Amount to transfer in ISO 4217 minor currency units
        - `company_entry_description` string, nullable — Company Entry Description field in ACH batch header. Originator inserts this field's value to provide the Receiver with a description of the entry's purpose. NACHA Operating Rules dictate that Payroll or E-Commerce Purchase ACH transactions require setting this field to PAYROLL or PURCHASE respectively. Only ASCII-printable characters (0x20-0x7E) are accepted. Non-ASCII characters will be stripped; the request will be rejected if no ASCII characters remain.
        - `company_name` string — Overrides the 'Company Name' field in ACH batch header, which otherwise defaults to the configured partner name. The provided name will be prepended with the Bank's configured prefix and a *. It will then be truncated to 16 characters. Only ASCII-printable characters (0x20-0x7E) are accepted. Non-ASCII characters will be stripped; the request will be rejected if no ASCII characters remain.
        - `currency` string, required — ISO 4217 alphabetic currency code of the transfer amount
        - `customer_id` string, uuid, required — The customer's unique identifier
        - `dc_sign` 'credit' | 'debit', required — The type of transaction (debit or credit). A debit is a transfer in and a credit is a transfer out of the originating account
        - `effective_date` string, date, nullable — Effective date transaction proccesses (is_same_day needs to be false or not present at all)
        - `external_data` object, nullable — Additional transfer metadata structured as key-value pairs
        - `final_customer_id` string, uuid, nullable — ID of the international customer that receives the final remittance transfer (required for OFAC enabled payments)
        - `hold` AchRequestHoldData, nullable
          - `amount` integer, required
          - `duration` integer, required
        - `is_same_day` boolean, nullable — Send as same day ACH transaction (use only is_same_day without specific effective_date)
        - `memo` string, nullable — Memo for the payment
        - `originating_account_id` string, uuid, required — The unique identifier for an originating account
        - `receiving_account_id` string, uuid, required — The unique identifier for an receiving account
        - `reference_info` string, nullable — Will be sent to the ACH network and maps to Addenda record 05 - the recipient bank will receive this info. Only ASCII-printable characters (0x20-0x7E) are accepted. Non-ASCII characters will be stripped; the request will be rejected if no ASCII characters remain.
        - `risk` RiskData, nullable
          - `client_ip` string — Client IP
        - `sec_code` 'CCD' | 'PPD' | 'WEB' — Standard Entry Class Code: * WEB: Internet initiated / Mobile Entry (default if empty) * CCD: Corporate Credit or Debit * PPD: Pre-arranged Payment or Deposit (only deposits currently supported)
      - `type` 'ACH', required
    - InternalTransferInstruction
      - `request` InternalTransfer, required
        - `amount` integer, required — The amount (in cents) to transfer from originating account to receiving account.
        - `capture_mode` 'IMMEDIATE' | 'MANUAL' — Controls when the transfer will take effect. A value of `IMMEDIATE` (the default) means that the transfer will be completed immediately. A value of `MANUAL` means that the transaction will remain in a "pending" state until explicitly completed or cancelled (or the auth expires).
        - `currency` string, required — ISO 4217 alphabetic currency code of the transfer amount
        - `expires_at` string, date-time — When `capture_mode` is `MANUAL`, this field describes when the pending transaction should expire.
        - `final_customer_id` string, uuid — The customer id of the international customer that receives the final remittance transfer (required for remittance payments).
        - `memo` string — A short note to the recipient
        - `metadata` object — Arbitrary key-value metadata to associate with the transaction
        - `originating_account_alias` string — An alias representing a GL account to debit. This is alternative to specifying by account id
        - `originating_account_customer_id` string, uuid — The customer id of the owner of the originating account.
        - `originating_account_id` string, uuid — The UUID of the account being debited
        - `receiving_account_alias` string — An alias representing a GL account to credit. This is an alternative to specifying by account id
        - `receiving_account_customer_id` string, uuid — The customer id of the owner of the receiving account.
        - `receiving_account_id` string, uuid — The UUID of the account being credited
        - `reference_id` string — Network reference id
        - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
        - `type` 'ACCOUNT_BALANCE_ADJUSTMENT' | 'ACCOUNT_TO_ACCOUNT' | 'ACCOUNT_TO_ACCOUNT_SWEEP' | 'ACH_CREDIT_SWEEP' | 'ACH_DEBIT_SWEEP' | 'ACH_FLOAT_TRANSFER' | 'ACH_INCOMING_CREDIT_SWEEP' | 'ACH_INCOMING_DEBIT_SWEEP' | 'ACH_INCOMING_RETURN_CREDIT_SWEEP' | 'ACH_INCOMING_RETURN_DEBIT_SWEEP' | 'ACH_OUTGOING_CREDIT_SWEEP' | 'ACH_OUTGOING_DEBIT_SWEEP' | 'ACH_OUTGOING_RETURN_CREDIT_SWEEP' | 'ACH_OUTGOING_RETURN_DEBIT_SWEEP' | 'ACH_SWEEP' | 'ARBITRATION_FINAL_CREDIT' | 'ARBITRATION_FINAL_CREDIT_REVERSAL' | 'AUTO_PAYMENT' | 'AUTO_PAYMENT_REVERSAL' | 'BULK_DOMESTIC_WIRE_OUTGOING_SWEEP' | 'BULK_EFT_CA_OUTGOING_CREDIT_SWEEP' | 'BULK_EFT_CA_OUTGOING_DEBIT_SWEEP' | 'CARD_CHARGEBACK' | 'CARD_CHARGEBACK_CASE_WON_SWEEP' | 'CARD_CHARGEBACK_CASE_WON_SWEEP_REVERSAL' | 'CARD_CHARGEBACK_WRITEOFF' | 'CARD_CHARGEBACK_WRITEOFF_SWEEP' | 'CARD_CHARGEBACK_WRITEOFF_SWEEP_REVERSAL' | 'CARD_PROVISIONAL_CREDIT' | 'CARD_PROVISIONAL_CREDIT_REVERSAL' | 'CARD_PROVISIONAL_CREDIT_SWEEP' | 'CARD_PROVISIONAL_CREDIT_SWEEP_REVERSAL' | 'CASHBACK' | 'CASHBACK_SWEEP' | 'CASH_DEPOSIT_KIOSK' | 'CASH_DEPOSIT_KIOSK_REVERSAL' | 'CHARGEBACK_FINAL_CREDIT' | 'CHARGEBACK_FINAL_CREDIT_REVERSAL' | 'CHECK_DEPOSIT_KIOSK' | 'CHECK_DEPOSIT_KIOSK_GOV' | 'CHECK_DEPOSIT_KIOSK_GOV_REVERSAL' | 'CHECK_DEPOSIT_KIOSK_PAYROLL' | 'CHECK_DEPOSIT_KIOSK_PAYROLL_REVERSAL' | 'CHECK_DEPOSIT_KIOSK_REVERSAL' | 'CHECK_DEPOSIT_MOBILE' | 'CHECK_DEPOSIT_MOBILE_REVERSAL' | 'CREDIT_MEMO' | 'DOMESTIC_MONEY_TRANSFER_ATM_WITHDRAWAL' | 'DOMESTIC_MONEY_TRANSFER_ATM_WITHDRAWAL_REVERSAL' | 'DOMESTIC_MONEY_TRANSFER_BANK_DEPOSIT' | 'DOMESTIC_MONEY_TRANSFER_BANK_DEPOSIT_REVERSAL' | 'DOMESTIC_MONEY_TRANSFER_CASH_PICKUP' | 'DOMESTIC_MONEY_TRANSFER_CASH_PICKUP_REVERSAL' | 'DOMESTIC_MONEY_TRANSFER_HOME_DELIVERY' | 'DOMESTIC_MONEY_TRANSFER_HOME_DELIVERY_REVERSAL' | 'DOMESTIC_MONEY_TRANSFER_MOBILE_WALLET' | 'DOMESTIC_MONEY_TRANSFER_MOBILE_WALLET_REVERSAL' | 'DOMESTIC_WIRE_INCOMING_RETURN_SWEEP' | 'DOMESTIC_WIRE_INCOMING_SWEEP' | 'DOMESTIC_WIRE_OUTGOING_RETURN_SWEEP' | 'DOMESTIC_WIRE_OUTGOING_SWEEP' | 'EFT_CA_INCOMING_CREDIT_RETURN_SWEEP' | 'EFT_CA_INCOMING_CREDIT_SWEEP' | 'EFT_CA_INCOMING_DEBIT_RETURN_SWEEP' | 'EFT_CA_INCOMING_DEBIT_SWEEP' | 'EFT_CA_OUTGOING_CREDIT_RETURN_SWEEP' | 'EFT_CA_OUTGOING_CREDIT_SWEEP' | 'EFT_CA_OUTGOING_DEBIT_RETURN_SWEEP' | 'EFT_CA_OUTGOING_DEBIT_SWEEP' | 'ETRANSFER_SWEEP' | 'FEE' | 'FEE_REVERSAL' | 'FEE_SWEEP' | 'FORCE_PAYMENT' | 'GENERAL_FEE_SWEEP' | 'GENERAL_FEE_SWEEP_REVERSAL' | 'GENERAL_INTERNAL_TRANSFER_SWEEP' | 'GENERAL_INTERNAL_TRANSFER_SWEEP_REVERSAL' | 'GENERAL_REWARD_SWEEP' | 'GENERAL_REWARD_SWEEP_REVERSAL' | 'INCOMING_WIRE' | 'INCOMING_WIRE_SWEEP' | 'INTEREST_CHARGED_SWEEP' | 'INTEREST_CORRECTION' | 'INTEREST_PAYOUT' | 'INTEREST_PAYOUT_SWEEP' | 'INTERNATIONAL_WIRE_INCOMING_SWEEP' | 'INTERNATIONAL_WIRE_OUTGOING_RETURN_SWEEP' | 'INTERNATIONAL_WIRE_OUTGOING_SWEEP' | 'INVOICE' | 'IN_STORE_CASH_DEPOSIT_SWEEP' | 'IN_STORE_CASH_DEPOSIT_SWEEP_REVERSAL' | 'LOAN_DISBURSEMENT' | 'LOAN_FUNDING' | 'MANUAL_ADJUSTMENT' | 'MANUAL_ADJUSTMENT_REVERSAL' | 'MANUAL_ADJUSTMENT_SWEEP' | 'MANUAL_AFT_SWEEP' | 'MANUAL_CARD_SWEEP' | 'MANUAL_CASH_DEPOSIT_SWEEP' | 'MANUAL_CASH_ORDER_SWEEP' | 'MANUAL_CHECK_ISSUANCE' | 'MANUAL_CHECK_SWEEP' | 'MANUAL_OCT_SWEEP' | 'MANUAL_WIRE_SWEEP' | 'MARKETPLACE_BILL_PAY' | 'MARKETPLACE_BILL_PAY_REVERSAL' | 'MARKETPLACE_EVENT_TICKETS' | 'MARKETPLACE_EVENT_TICKETS_REVERSAL' | 'MARKETPLACE_GIFT_CARD' | 'MARKETPLACE_GIFT_CARD_REVERSAL' | 'MARKETPLACE_MOBILE_TOP_UP' | 'MARKETPLACE_MOBILE_TOP_UP_REVERSAL' | 'MASTERCARD_GROSS_SWEEP' | 'MASTERCARD_INTERCHANGE_SWEEP' | 'MASTERCARD_NET_SWEEP' | 'MISC_CREDIT' | 'MOBILE_DEPOSIT_RETURN_SWEEP' | 'MOBILE_DEPOSIT_SWEEP' | 'NEGATIVE_BALANCE_RESERVE' | 'NEGATIVE_BALANCE_WRITEOFF' | 'NETWORK_ADJUSTMENT_SWEEP' | 'NETWORK_CHARGEBACK_SWEEP' | 'ONE_TIME_PAYMENT' | 'ONE_TIME_PAYMENT_REVERSAL' | 'OUTGOING_INTERNATIONAL_REMITTANCE' | 'OUTGOING_INTERNATIONAL_REMITTANCE_REVERSAL' | 'OVERDUE_CARD_WRITEOFF' | 'PEER_TO_PEER' | 'PROMOTIONAL_CREDIT' | 'PROMOTIONAL_CREDIT_REVERSAL' | 'PROMOTIONAL_CREDIT_SWEEP' | 'PROVISIONAL_CREDIT' | 'PROVISIONAL_CREDIT_REVERSAL' | 'PULSE_GROSS_SWEEP' | 'PULSE_INTERCHANGE_SWEEP' | 'REVENUE_DISBURSEMENT' | 'SECURITY_ACCOUNT_PAYMENT' | 'SECURITY_OVERPAY_ADJUSTMENT' | 'SECURITY_OVERPAY_ADJUSTMENT_REVERSAL' | 'SIGN_UP_BONUS' | 'SUBSCRIPTION_FEE' | 'TRANSFER_FEE' | 'TRANSFER_FEE_REVERSAL' | 'VISA_GROSS_SWEEP' | 'VISA_INTERCHANGE_SWEEP' | 'VISA_NET_SWEEP' | 'WIRE_SETTLEMENT_CREDIT' | 'WIRE_SETTLEMENT_DEBIT' | 'WRITEOFF_FRAUD_FINAL_CREDIT' | 'WRITEOFF_FRAUD_FINAL_CREDIT_REVERSAL' | 'WRITEOFF_NON_FRAUD_FINAL_CREDIT' | 'WRITEOFF_NON_FRAUD_FINAL_CREDIT_REVERSAL', required — The desired transaction type to use for this transfer
      - `type` 'INTERNAL_TRANSFER', required
  - `schedule` ScheduleConfig, required — Payment schedule recurrence configuration
    - `count` integer — Number of times to recur. Exactly one of end_date or count must be provided
    - `end_date` string, date — End date of the schedule (exclusive). Exactly one of end_date or count must be provided
    - `execution_time` string — Local time of day (24-hour HH:MM:SS) in the bank's configured timezone at which the schedule executes. Defaults to 11:00:00 if omitted, and the resolved value (including the default) is returned on read. Cannot be modified after creation; cancel and recreate the schedule to change it. Note: event-triggered variable payment schedules (e.g. EOD) ignore this and execute at the start of the day.
    - `frequency` 'DAILY' | 'MONTHLY' | 'WEEKLY', required
    - `interval` integer, required — Interval between recurrences, e.g. interval = 2 with frequency = WEEKLY means every other week.
    - `start_date` string, date, required — Start date of the schedule (inclusive)
    - `start_search` 'BACKWARD' | 'FORWARD' — start_search determines the direction of the search for a start date that falls on a banking day. If 'BACKWARD' is selected, the search begins from the specified start date and checks each preceding day, up to a month. Conversely, if 'FORWARD' is selected, the search commences from the specified start date and checks each subsequent day, for up to a month.
  - `status` 'ACTIVE' | 'CANCELLED' | 'ERRORED' | 'EXPIRED' — Status of the payment schedule.
  - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

## Response `201`

Created payment schedule

- PaymentScheduleResponse — Payment schedule
  - `creation_time` string, date-time, required
  - `last_updated_time` string, date-time, required
  - `tenant` string, required — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
  - `description` string, required — User provided description for the payment schedule
  - `id` string, uuid — Payment schedule ID
  - `metadata` object — User provided JSON format data
  - `next_payment_date` PaymentDate
    - `execution_date` string, date, required — Execution date for the next payment
    - `scheduled_date` string, date, required — Scheduled date for the next payment
  - `payment_instruction` union, required
    - AchInstruction
      - `request` OutgoingAchRequest, required — Send an ACH
        - `amount` integer, required — Amount to transfer in ISO 4217 minor currency units
        - `company_entry_description` string, nullable — Company Entry Description field in ACH batch header. Originator inserts this field's value to provide the Receiver with a description of the entry's purpose. NACHA Operating Rules dictate that Payroll or E-Commerce Purchase ACH transactions require setting this field to PAYROLL or PURCHASE respectively. Only ASCII-printable characters (0x20-0x7E) are accepted. Non-ASCII characters will be stripped; the request will be rejected if no ASCII characters remain.
        - `company_name` string — Overrides the 'Company Name' field in ACH batch header, which otherwise defaults to the configured partner name. The provided name will be prepended with the Bank's configured prefix and a *. It will then be truncated to 16 characters. Only ASCII-printable characters (0x20-0x7E) are accepted. Non-ASCII characters will be stripped; the request will be rejected if no ASCII characters remain.
        - `currency` string, required — ISO 4217 alphabetic currency code of the transfer amount
        - `customer_id` string, uuid, required — The customer's unique identifier
        - `dc_sign` 'credit' | 'debit', required — The type of transaction (debit or credit). A debit is a transfer in and a credit is a transfer out of the originating account
        - `effective_date` string, date, nullable — Effective date transaction proccesses (is_same_day needs to be false or not present at all)
        - `external_data` object, nullable — Additional transfer metadata structured as key-value pairs
        - `final_customer_id` string, uuid, nullable — ID of the international customer that receives the final remittance transfer (required for OFAC enabled payments)
        - `hold` AchRequestHoldData, nullable
          - `amount` integer, required
          - `duration` integer, required
        - `is_same_day` boolean, nullable — Send as same day ACH transaction (use only is_same_day without specific effective_date)
        - `memo` string, nullable — Memo for the payment
        - `originating_account_id` string, uuid, required — The unique identifier for an originating account
        - `receiving_account_id` string, uuid, required — The unique identifier for an receiving account
        - `reference_info` string, nullable — Will be sent to the ACH network and maps to Addenda record 05 - the recipient bank will receive this info. Only ASCII-printable characters (0x20-0x7E) are accepted. Non-ASCII characters will be stripped; the request will be rejected if no ASCII characters remain.
        - `risk` RiskData, nullable
          - `client_ip` string — Client IP
        - `sec_code` 'CCD' | 'PPD' | 'WEB' — Standard Entry Class Code: * WEB: Internet initiated / Mobile Entry (default if empty) * CCD: Corporate Credit or Debit * PPD: Pre-arranged Payment or Deposit (only deposits currently supported)
      - `type` 'ACH', required
    - InternalTransferInstruction
      - `request` InternalTransfer, required
        - `amount` integer, required — The amount (in cents) to transfer from originating account to receiving account.
        - `capture_mode` 'IMMEDIATE' | 'MANUAL' — Controls when the transfer will take effect. A value of `IMMEDIATE` (the default) means that the transfer will be completed immediately. A value of `MANUAL` means that the transaction will remain in a "pending" state until explicitly completed or cancelled (or the auth expires).
        - `currency` string, required — ISO 4217 alphabetic currency code of the transfer amount
        - `expires_at` string, date-time — When `capture_mode` is `MANUAL`, this field describes when the pending transaction should expire.
        - `final_customer_id` string, uuid — The customer id of the international customer that receives the final remittance transfer (required for remittance payments).
        - `memo` string — A short note to the recipient
        - `metadata` object — Arbitrary key-value metadata to associate with the transaction
        - `originating_account_alias` string — An alias representing a GL account to debit. This is alternative to specifying by account id
        - `originating_account_customer_id` string, uuid — The customer id of the owner of the originating account.
        - `originating_account_id` string, uuid — The UUID of the account being debited
        - `receiving_account_alias` string — An alias representing a GL account to credit. This is an alternative to specifying by account id
        - `receiving_account_customer_id` string, uuid — The customer id of the owner of the receiving account.
        - `receiving_account_id` string, uuid — The UUID of the account being credited
        - `reference_id` string — Network reference id
        - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
        - `type` 'ACCOUNT_BALANCE_ADJUSTMENT' | 'ACCOUNT_TO_ACCOUNT' | 'ACCOUNT_TO_ACCOUNT_SWEEP' | 'ACH_CREDIT_SWEEP' | 'ACH_DEBIT_SWEEP' | 'ACH_FLOAT_TRANSFER' | 'ACH_INCOMING_CREDIT_SWEEP' | 'ACH_INCOMING_DEBIT_SWEEP' | 'ACH_INCOMING_RETURN_CREDIT_SWEEP' | 'ACH_INCOMING_RETURN_DEBIT_SWEEP' | 'ACH_OUTGOING_CREDIT_SWEEP' | 'ACH_OUTGOING_DEBIT_SWEEP' | 'ACH_OUTGOING_RETURN_CREDIT_SWEEP' | 'ACH_OUTGOING_RETURN_DEBIT_SWEEP' | 'ACH_SWEEP' | 'ARBITRATION_FINAL_CREDIT' | 'ARBITRATION_FINAL_CREDIT_REVERSAL' | 'AUTO_PAYMENT' | 'AUTO_PAYMENT_REVERSAL' | 'BULK_DOMESTIC_WIRE_OUTGOING_SWEEP' | 'BULK_EFT_CA_OUTGOING_CREDIT_SWEEP' | 'BULK_EFT_CA_OUTGOING_DEBIT_SWEEP' | 'CARD_CHARGEBACK' | 'CARD_CHARGEBACK_CASE_WON_SWEEP' | 'CARD_CHARGEBACK_CASE_WON_SWEEP_REVERSAL' | 'CARD_CHARGEBACK_WRITEOFF' | 'CARD_CHARGEBACK_WRITEOFF_SWEEP' | 'CARD_CHARGEBACK_WRITEOFF_SWEEP_REVERSAL' | 'CARD_PROVISIONAL_CREDIT' | 'CARD_PROVISIONAL_CREDIT_REVERSAL' | 'CARD_PROVISIONAL_CREDIT_SWEEP' | 'CARD_PROVISIONAL_CREDIT_SWEEP_REVERSAL' | 'CASHBACK' | 'CASHBACK_SWEEP' | 'CASH_DEPOSIT_KIOSK' | 'CASH_DEPOSIT_KIOSK_REVERSAL' | 'CHARGEBACK_FINAL_CREDIT' | 'CHARGEBACK_FINAL_CREDIT_REVERSAL' | 'CHECK_DEPOSIT_KIOSK' | 'CHECK_DEPOSIT_KIOSK_GOV' | 'CHECK_DEPOSIT_KIOSK_GOV_REVERSAL' | 'CHECK_DEPOSIT_KIOSK_PAYROLL' | 'CHECK_DEPOSIT_KIOSK_PAYROLL_REVERSAL' | 'CHECK_DEPOSIT_KIOSK_REVERSAL' | 'CHECK_DEPOSIT_MOBILE' | 'CHECK_DEPOSIT_MOBILE_REVERSAL' | 'CREDIT_MEMO' | 'DOMESTIC_MONEY_TRANSFER_ATM_WITHDRAWAL' | 'DOMESTIC_MONEY_TRANSFER_ATM_WITHDRAWAL_REVERSAL' | 'DOMESTIC_MONEY_TRANSFER_BANK_DEPOSIT' | 'DOMESTIC_MONEY_TRANSFER_BANK_DEPOSIT_REVERSAL' | 'DOMESTIC_MONEY_TRANSFER_CASH_PICKUP' | 'DOMESTIC_MONEY_TRANSFER_CASH_PICKUP_REVERSAL' | 'DOMESTIC_MONEY_TRANSFER_HOME_DELIVERY' | 'DOMESTIC_MONEY_TRANSFER_HOME_DELIVERY_REVERSAL' | 'DOMESTIC_MONEY_TRANSFER_MOBILE_WALLET' | 'DOMESTIC_MONEY_TRANSFER_MOBILE_WALLET_REVERSAL' | 'DOMESTIC_WIRE_INCOMING_RETURN_SWEEP' | 'DOMESTIC_WIRE_INCOMING_SWEEP' | 'DOMESTIC_WIRE_OUTGOING_RETURN_SWEEP' | 'DOMESTIC_WIRE_OUTGOING_SWEEP' | 'EFT_CA_INCOMING_CREDIT_RETURN_SWEEP' | 'EFT_CA_INCOMING_CREDIT_SWEEP' | 'EFT_CA_INCOMING_DEBIT_RETURN_SWEEP' | 'EFT_CA_INCOMING_DEBIT_SWEEP' | 'EFT_CA_OUTGOING_CREDIT_RETURN_SWEEP' | 'EFT_CA_OUTGOING_CREDIT_SWEEP' | 'EFT_CA_OUTGOING_DEBIT_RETURN_SWEEP' | 'EFT_CA_OUTGOING_DEBIT_SWEEP' | 'ETRANSFER_SWEEP' | 'FEE' | 'FEE_REVERSAL' | 'FEE_SWEEP' | 'FORCE_PAYMENT' | 'GENERAL_FEE_SWEEP' | 'GENERAL_FEE_SWEEP_REVERSAL' | 'GENERAL_INTERNAL_TRANSFER_SWEEP' | 'GENERAL_INTERNAL_TRANSFER_SWEEP_REVERSAL' | 'GENERAL_REWARD_SWEEP' | 'GENERAL_REWARD_SWEEP_REVERSAL' | 'INCOMING_WIRE' | 'INCOMING_WIRE_SWEEP' | 'INTEREST_CHARGED_SWEEP' | 'INTEREST_CORRECTION' | 'INTEREST_PAYOUT' | 'INTEREST_PAYOUT_SWEEP' | 'INTERNATIONAL_WIRE_INCOMING_SWEEP' | 'INTERNATIONAL_WIRE_OUTGOING_RETURN_SWEEP' | 'INTERNATIONAL_WIRE_OUTGOING_SWEEP' | 'INVOICE' | 'IN_STORE_CASH_DEPOSIT_SWEEP' | 'IN_STORE_CASH_DEPOSIT_SWEEP_REVERSAL' | 'LOAN_DISBURSEMENT' | 'LOAN_FUNDING' | 'MANUAL_ADJUSTMENT' | 'MANUAL_ADJUSTMENT_REVERSAL' | 'MANUAL_ADJUSTMENT_SWEEP' | 'MANUAL_AFT_SWEEP' | 'MANUAL_CARD_SWEEP' | 'MANUAL_CASH_DEPOSIT_SWEEP' | 'MANUAL_CASH_ORDER_SWEEP' | 'MANUAL_CHECK_ISSUANCE' | 'MANUAL_CHECK_SWEEP' | 'MANUAL_OCT_SWEEP' | 'MANUAL_WIRE_SWEEP' | 'MARKETPLACE_BILL_PAY' | 'MARKETPLACE_BILL_PAY_REVERSAL' | 'MARKETPLACE_EVENT_TICKETS' | 'MARKETPLACE_EVENT_TICKETS_REVERSAL' | 'MARKETPLACE_GIFT_CARD' | 'MARKETPLACE_GIFT_CARD_REVERSAL' | 'MARKETPLACE_MOBILE_TOP_UP' | 'MARKETPLACE_MOBILE_TOP_UP_REVERSAL' | 'MASTERCARD_GROSS_SWEEP' | 'MASTERCARD_INTERCHANGE_SWEEP' | 'MASTERCARD_NET_SWEEP' | 'MISC_CREDIT' | 'MOBILE_DEPOSIT_RETURN_SWEEP' | 'MOBILE_DEPOSIT_SWEEP' | 'NEGATIVE_BALANCE_RESERVE' | 'NEGATIVE_BALANCE_WRITEOFF' | 'NETWORK_ADJUSTMENT_SWEEP' | 'NETWORK_CHARGEBACK_SWEEP' | 'ONE_TIME_PAYMENT' | 'ONE_TIME_PAYMENT_REVERSAL' | 'OUTGOING_INTERNATIONAL_REMITTANCE' | 'OUTGOING_INTERNATIONAL_REMITTANCE_REVERSAL' | 'OVERDUE_CARD_WRITEOFF' | 'PEER_TO_PEER' | 'PROMOTIONAL_CREDIT' | 'PROMOTIONAL_CREDIT_REVERSAL' | 'PROMOTIONAL_CREDIT_SWEEP' | 'PROVISIONAL_CREDIT' | 'PROVISIONAL_CREDIT_REVERSAL' | 'PULSE_GROSS_SWEEP' | 'PULSE_INTERCHANGE_SWEEP' | 'REVENUE_DISBURSEMENT' | 'SECURITY_ACCOUNT_PAYMENT' | 'SECURITY_OVERPAY_ADJUSTMENT' | 'SECURITY_OVERPAY_ADJUSTMENT_REVERSAL' | 'SIGN_UP_BONUS' | 'SUBSCRIPTION_FEE' | 'TRANSFER_FEE' | 'TRANSFER_FEE_REVERSAL' | 'VISA_GROSS_SWEEP' | 'VISA_INTERCHANGE_SWEEP' | 'VISA_NET_SWEEP' | 'WIRE_SETTLEMENT_CREDIT' | 'WIRE_SETTLEMENT_DEBIT' | 'WRITEOFF_FRAUD_FINAL_CREDIT' | 'WRITEOFF_FRAUD_FINAL_CREDIT_REVERSAL' | 'WRITEOFF_NON_FRAUD_FINAL_CREDIT' | 'WRITEOFF_NON_FRAUD_FINAL_CREDIT_REVERSAL', required — The desired transaction type to use for this transfer
      - `type` 'INTERNAL_TRANSFER', required
  - `schedule` ScheduleConfig, required — Payment schedule recurrence configuration
    - `count` integer — Number of times to recur. Exactly one of end_date or count must be provided
    - `end_date` string, date — End date of the schedule (exclusive). Exactly one of end_date or count must be provided
    - `execution_time` string — Local time of day (24-hour HH:MM:SS) in the bank's configured timezone at which the schedule executes. Defaults to 11:00:00 if omitted, and the resolved value (including the default) is returned on read. Cannot be modified after creation; cancel and recreate the schedule to change it. Note: event-triggered variable payment schedules (e.g. EOD) ignore this and execute at the start of the day.
    - `frequency` 'DAILY' | 'MONTHLY' | 'WEEKLY', required
    - `interval` integer, required — Interval between recurrences, e.g. interval = 2 with frequency = WEEKLY means every other week.
    - `start_date` string, date, required — Start date of the schedule (inclusive)
    - `start_search` 'BACKWARD' | 'FORWARD' — start_search determines the direction of the search for a start date that falls on a banking day. If 'BACKWARD' is selected, the search begins from the specified start date and checks each preceding day, up to a month. Conversely, if 'FORWARD' is selected, the search commences from the specified start date and checks each subsequent day, for up to a month.
  - `status` 'ACTIVE' | 'CANCELLED' | 'ERRORED' | 'EXPIRED' — Status of the payment schedule.

## Other responses

- `400` — BadRequest
- `401` — Unauthorized
- `403` — Forbidden error
- `409` — Resource already exists error
- `500` — Internal server error

---

[API](https://skmtc.net/synctera/apis/synctera-api.md) · [All operations](https://skmtc.net/synctera/apis/synctera-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/synctera/synctera-api/versions/b0d812e6cdd0/schema)