Skip to main content
Get Real Time Account Transactions
curl --request GET \
  --url https://api.yapily.com/accounts/{accountId}/real-time/transactions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'consent: <consent>'
{
  "meta": {
    "tracingId": "488ce8243ee74a378be722ffffec8f7f",
    "count": 1
  },
  "data": [
    {
      "id": "49d6e5c6-0130-46e3-884b-1b185432d9e0",
      "date": "2021-05-06T17:44:34.589Z",
      "bookingDateTime": "2021-05-06T17:44:34.589Z",
      "valueDateTime": "2021-05-06T17:44:34.589Z",
      "status": "BOOKED",
      "transactionAmount": {
        "amount": -100.23,
        "currency": "GBP"
      },
      "reference": "0",
      "description": "Debit for Payment Id: sdp-1-57379a43-c4b8-49f5-bd7c-699189ee7a60",
      "transactionInformation": [
        "Debit for Payment Id: sdp-1-57379a43-c4b8-49f5-bd7c-699189ee7a60"
      ],
      "isoBankTransactionCode": {
        "domainCode": {
          "code": "PMNT",
          "name": "Payments"
        },
        "familyCode": {
          "code": "ICDT",
          "name": "Issued Credit Transfers"
        },
        "subFamilyCode": {
          "code": "DMCT",
          "name": "Domestic Credit Transfer"
        }
      },
      "proprietaryBankTransactionCode": {
        "code": "PMT",
        "issuer": "modelo-sandbox"
      },
      "balance": {
        "type": "CLOSING_AVAILABLE",
        "balanceAmount": {
          "amount": 426.53,
          "currency": "GBP"
        }
      }
    }
  ],
  "links": {
    "first": "https://api.yapily.com/accounts/700004000000000000000002/transactions?cursor=aaa",
    "prev": "https://api.yapily.com/accounts/700004000000000000000002/transactions?cursor=bbb",
    "self": "https://api.yapily.com/accounts/700004000000000000000002/transactions?cursor=ccc",
    "next": "https://api.yapily.com/accounts/700004000000000000000002/transactions?cursor=ddd",
    "last": "https://api.yapily.com/accounts/700004000000000000000002/transactions?cursor=zzz"
  }
}
Learn more: Cursor-based Pagination - This endpoint uses cursor pagination (beta)

Authorizations

Authorization
string
header
required

Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.

Headers

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

psu-id
string

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-id
string

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-address
string

Conditional. The IP address of the PSU.

See PSU identifiers to see if this header is required.

sub-application
string<uuid>

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

Path Parameters

accountId
string
required

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

Query Parameters

from
string

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

before
string

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

cursor
string

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

Response

Ok

meta
object
data
object[]
forwardedData
object[]
raw
object[]
deprecated