Fetches all the Scheduled Periodic Payments

Endpoint Parameters

• Request parameters

  Name	Type	Origin	Description
  ClientKey	ClientKey	Query-String	Client Id
  SkipToken	String	Query-String	Id token of entity to start taking elements from.
  Top	Integer	Query-String	Number of elements to retrieve.

• Response Parameters

  View Response Codes

  Name	Type	Description
  __count	Number	The total count of items in the feed.
  __next	String	The link for the next page of items in the feed.
  Data	PeriodicPaymentWithdrawal []	The collection of entities for this feed.
  MaxRows	Number	The maximum number of rows that can be returned (if applicable).

  HTTP Code	Description
  200	OK	OK
  400	Bad Request	Error Code Description InvalidRequest Default error code returned when it cannot be determined which part of the request is malformed.
  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 TransactionNotFound
  429	Too Many Requests	The request was rejected due to rate limit being exceeded.
  503	Service Unavailable	Service Unavailable.

  Close

• Request Example

  Request URL

  GET /atr/v1/cashmanagement/periodicpayment?ClientKey=zpSlGZ4F0cPIx59wR3HP1g==&SkipToken=stringValue&Top=99

• Response Example

  Response body

  {
    "Data": [
      {
        "AccountCurrency": "stringValue",
        "AccountId": "stringValue",
        "AccountKey": "dIm75edbgnW6aBK3CIc-sw==",
        "Amount": 10,
        "AmountInAccountCurrency": 10,
        "ClientId": 99,
        "ClientKey": "zpSlGZ4F0cPIx59wR3HP1g==",
        "ClientName": "stringValue",
        "CreatedDate": "2025-05-11T14:43:21.945555Z",
        "Currency": "stringValue",
        "EndByDate": "2027-03-23T00:48:28.308684Z",
        "ExternalAccountId": "stringValue",
        "Frequency": "Weekly",
        "FxRate": 10,
        "MessageToBeneficiary": "stringValue",
        "NextPaymentDate": "2024-04-05T22:24:01.657558Z",
        "PeriodicPaymentId": 99,
        "StartDate": "2026-04-23T08:26:14.11709Z"
      }
    ],
    "MaxRows": 99
  }