YAyapily
Financial Data

Get Real Time Account Transactions

Used to get the account transactions for an account in real time with cursor pagination

Feature: ACCOUNT_TRANSACTIONS

get/accounts/{accountId}/real-time/transactions

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

fromstring

Optional. Returned transactions will be on or after this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ).

beforestring

Optional. Returned transactions will be on or before this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ).

cursorstring

Optional. The cursor token supplied by a previous call. The cursor represents a location in the data set.

Headers

consentstring required

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

psu-idstring

Conditional. Represents the user's login ID for the Institution to a personal account.

See PSU identifiers to see if this header is required.

psu-corporate-idstring

Conditional. Represents the user's login ID for the Institution to a business account.

See PSU identifiers to see if this header is required.

psu-ip-addressstring

Conditional. The IP address of the PSU.

See PSU identifiers to see if this header is required.

sub-applicationstring uuid

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

Response

Ok

tracingIdstring

Example response

{
  "data": [
    {
      "transactionAmount": {
        "amount": 10,
        "currency": "GBP"
      },
      "grossAmount": {
        "amount": 10,
        "currency": "GBP"
      },
      "chargeDetails": {
        "chargeAmount": {
          "amount": 10,
          "currency": "GBP"
        }
      },
      "balance": {
        "balanceAmount": {
          "amount": 10,
          "currency": "GBP"
        }
      },
      "payeeDetails": {
        "name": "Jane Doe",
        "accountIdentifications": [
          {
            "identification": "401016",
            "type": "SORT_CODE"
          },
          {
            "identification": "71518920",
            "type": "ACCOUNT_NUMBER"
          }
        ],
        "address": {
          "country": "GB"
        },
        "merchantId": "24589303",
        "merchantCategoryCode": "0742"
      },
      "payerDetails": {
        "name": "John Doe",
        "accountIdentifications": [
          {
            "type": "SORT_CODE",
            "identification": "401016"
          }
        ],
        "address": {
          "country": "GB"
        }
      }
    }
  ]
}

Changes

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