Skip to main content
Enrichment
curl --request POST \
  --url https://api.yapily.com/transactions/categorisation \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "countryCode": "GB",
  "categorisationType": "consumer",
  "transactions": [
    {
      "id": "06edf952-8d94-44ae-8d4e-a065b7e47300",
      "date": "2025-03-01T14:15:16Z",
      "amount": {
        "value": -9900,
        "currency": "GBP"
      },
      "description": "Shopping",
      "countryCode": "GB"
    },
    {
      "id": "6a241cae-7c43-4058-bdbd-ff9d64e6c9df",
      "date": "2025-04-02T07:59:59Z",
      "amount": {
        "value": 1000,
        "currency": "USD"
      },
      "description": "Refund",
      "countryCode": "GB"
    }
  ]
}
'
{
  "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.

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

sub-application
string<uuid>

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

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.

transactions
object[]
required

Response

Created

meta
object
data
object