Correct Transaction Regularity

post

https://api-sandbox.thisisbud.com/corrections/v3/regularity

Correct, or remove, the regularity frequency of a transaction, and optionally all similar transactions.

A frequency value of "unknown" removes the regularity of a transaction, and optionally all similar transactions.

The correction is stored as a rule and re-applied on every re-enrichment, so it follows the transaction even if its grouping changes, and future transactions that match will inherit it.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Expected request structure for the regularity correction endpoint

transaction_id

string

required

The unique identifier for the transaction

frequency

string

enum

required

The frequency to assign. unknown marks the transaction (or group) as not regular.

Allowed:

include_similar

boolean

Defaults to false

Apply the correction to the whole group of transactions similar to the specified transaction, rather than just the transaction itself

Headers

X-Client-Id

string

required

The API Client Identifier (Service Application Identifier).

X-Customer-Id

uuid

required

A unique identifier for a Customer, as registered on Bud's platform.

X-Customer-Idempotent-Identifier

string

Use the internal client identifier, provided in the client_metadata object when creating the customer in Create Customer V3, in place of an X-Customer-Id header.

Responses

401

Unauthorised request

405

An unexpected HTTP method was used

5XX

An unexpected error occurred on the server side

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

201The request was successfully processed

400The request contains an invalid payload.