YAyapily
Financial Data

Get Account Periodic Payments

Returns the list of periodic payments (standing orders in the UK) for an account.

Feature: ACCOUNT_PERIODIC_PAYMENTS

get/accounts/{accountId}/periodic-payments

Request

  • Base URL
    https://api.yapily.com
  • Auth
    HTTP basic

Path parameters

accountIdstring required

Mandatory. The account Id of the user's bank account.

Query parameters

limitinteger

Optional. The maximum number of transaction records to be returned. Must be between 1 and 1000.

Headers

consentstring required

Mandatory. The consent-token containing the user's authorisation to make the request.

sub-applicationstring uuid

The sub-application ID to which event type is being subscribed to

Response

Ok

linksobject
tracingIdstring

Example response

{
  "data": [
    {
      "statusDetails": {
        "isoStatus": {
          "code": "ACCC",
          "name": "AcceptedCreditSettlementCompleted"
        }
      },
      "payer": {
        "name": "John Doe",
        "accountIdentifications": [
          {
            "type": "SORT_CODE",
            "identification": "401016"
          }
        ],
        "address": {
          "country": "GB"
        }
      },
      "payeeDetails": {
        "name": "Jane Doe",
        "accountIdentifications": [
          {
            "identification": "401016",
            "type": "SORT_CODE"
          },
          {
            "identification": "71518920",
            "type": "ACCOUNT_NUMBER"
          }
        ],
        "address": {
          "country": "GB"
        },
        "merchantId": "24589303",
        "merchantCategoryCode": "0742"
      },
      "amountDetails": {
        "amount": 10,
        "currency": "GBP"
      },
      "firstPaymentAmount": {
        "amount": 10,
        "currency": "GBP"
      },
      "nextPaymentAmount": {
        "amount": 10,
        "currency": "GBP"
      },
      "finalPaymentAmount": {
        "amount": 10,
        "currency": "GBP"
      },
      "previousPaymentAmount": {
        "amount": 10,
        "currency": "GBP"
      },
      "chargeDetails": [
        {
          "chargeAmount": {
            "amount": 10,
            "currency": "GBP"
          }
        }
      ],
      "refundAccount": {
        "accountIdentifications": [
          {
            "type": "SORT_CODE",
            "identification": "401016"
          }
        ]
      }
    }
  ],
  "paging": {
    "data": [
      {
        "statusDetails": {
          "isoStatus": {
            "code": "ACCC",
            "name": "AcceptedCreditSettlementCompleted"
          }
        },
        "payer": {
          "name": "John Doe",
          "accountIdentifications": [
            {
              "type": "SORT_CODE",
              "identification": "401016"
            }
          ],
          "address": {
            "country": "GB"
          }
        },
        "payeeDetails": {
          "name": "Jane Doe",
          "accountIdentifications": [
            {
              "identification": "401016",
              "type": "SORT_CODE"
            },
            {
              "identification": "71518920",
              "type": "ACCOUNT_NUMBER"
            }
          ],
          "address": {
            "country": "GB"
          },
          "merchantId": "24589303",
          "merchantCategoryCode": "0742"
        },
        "amountDetails": {
          "amount": 10,
          "currency": "GBP"
        },
        "firstPaymentAmount": {
          "amount": 10,
          "currency": "GBP"
        },
        "nextPaymentAmount": {
          "amount": 10,
          "currency": "GBP"
        },
        "finalPaymentAmount": {
          "amount": 10,
          "currency": "GBP"
        },
        "previousPaymentAmount": {
          "amount": 10,
          "currency": "GBP"
        },
        "chargeDetails": [
          {
            "chargeAmount": {
              "amount": 10,
              "currency": "GBP"
            }
          }
        ],
        "refundAccount": {
          "accountIdentifications": [
            {
              "type": "SORT_CODE",
              "identification": "401016"
            }
          ]
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.