Skip to main content
Transactions and Enrichment
curl --request POST \
  --url https://api.yapily.com/accounts/{accountId}/transactions/categorisation \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'consent: <consent>' \
  --data '
{
  "countryCode": "GB",
  "categorisationType": "consumer",
  "from": "2019-08-24T14:15:22Z",
  "before": "2019-08-24T14:15:22Z"
}
'
{
  "meta": {
    "tracingId": "string"
  },
  "data": {
    "categorisationId": "ed8ea63f-7a1e-05d4-3633-a8a9175b50da"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.yapily.com/llms.txt

Use this file to discover all available pages before exploring further.

Learn more: Transaction Categorisation

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

​
consent
string
required

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

Unique identifier for account

Body

application/json
​
countryCode
string
required

Mandatory. Two-letter country code in ISO 3166-1 alpha-2 format (e.g. GB)

​
categorisationType
string
required

Mandatory. Allowed values are consumer and business.

​
from
string<date-time>

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

​
before
string<date-time>

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

Response

Created

​
meta
object
​
data
object