Create a new periodic spayment schedule.

Endpoint Parameters

• Request parameters

  Name	Type	Origin	Description
  AccountKey	AccountKey	Body	The account identifier in key format from which to transfer money.
  Amount	Number	Body	The amount to be withdrawn.
  BeneficiaryInstructionId	String	Body	Id of the beneficiary instruction to be used for the withdrawal
  Currency	CurrencyCode	Body	The currency of amount.
  EndByDate	String	Body	Determines when the recurring payments would be stopped, when left blank, the recurring payment would be marked never ending.
  MessageToBeneficiary	String	Body	For MT103 type messages this is a free text field information to one of the parties involved in the transaction in a structured format.
  RecurrenceType	PeriodicScheduleTypes	Body	Specifies the frequency of recurring payment.
  StartDate	String	Body	Specifies when the actual payment should be started. It also detemines which day would be used for different frequencies i.e. Daily, Weekly etc.

• Response Parameters

  View Response Codes

  HTTP Code	Description
  200	OK	OK
  201	Created	Created
  400	Bad Request	Error Code Description CashAccessDenied One or more of the provided parameters are invalid.
  401	Unauthorized	Indicates that the request was rejected because the 'Authorization' header was missing in the request or contained an invalid security token.
  404	Not Found	Error Code Description TrialClientNotSupported Trial clients are not supported
  429	Too Many Requests	The request was rejected due to rate limit being exceeded.
  503	Service Unavailable	Service Unavailable.

  Close

  There are no response parameters

• Request Example

  Request URL

  POST /atr/v1/cashmanagement/periodicpayment

  Request Body

  {
    "AccountKey": "dIm75edbgnW6aBK3CIc-sw==",
    "Amount": 10,
    "BeneficiaryInstructionId": "stringValue",
    "Currency": "GBP",
    "EndByDate": "2024-09-18T07:34:43.767416Z",
    "MessageToBeneficiary": "stringValue",
    "RecurrenceType": "Daily",
    "StartDate": "2026-07-16T07:35:51.198812Z"
  }