Skip to main content
POST
/
transactions
/
report
Report a card enrichment as incorrect
curl --request POST \
  --url https://east.sandbox.spade.com/transactions/report \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "enrichmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorDescription": "<string>",
  "incorrectLocation": true,
  "incorrectLocationDescription": "<string>",
  "incorrectCategory": true,
  "incorrectCategoryDescription": "<string>",
  "incorrectChannel": true,
  "incorrectChannelDescription": "<string>",
  "incorrectCounterparty": true,
  "incorrectCounterpartyDescription": "<string>"
}
'
{
  "details": "<string>"
}

Authorizations

​
X-Api-Key
string
header
required

Body

application/json

Schema for reporting an enriched transaction.

​
enrichmentId
string<uuid>
required

Enrichment id represented as a string UUID.

​
errorDescription
string
required

Description of incorrect details in enrichment.

Maximum string length: 1024
Example:

"Enrichment has an incorrect location. Wrong postal code."

​
incorrectLocation
boolean

Bool indicating if the enrichment has a wrong location.

Example:

true

​
incorrectLocationDescription
string

Description of incorrect location details in enrichment.

Maximum string length: 1024
Example:

"The location's city is incorrect."

​
incorrectCategory
boolean

Bool indicating if the enrichment has a wrong Category.

Example:

false

​
incorrectCategoryDescription
string

Description of incorrect category details in enrichment.

Maximum string length: 1024
Example:

"The category returned is incorrect."

​
incorrectChannel
boolean

Bool indicating if the enrichment has a wrong Channel.

Example:

false

​
incorrectChannelDescription
string

Description of incorrect channel details in enrichment.

Maximum string length: 1024
Example:

"The spending channel should have been physical."

​
incorrectCounterparty
boolean

Bool indicating if the enrichment has a wrong Counterparty.

Example:

false

​
incorrectCounterpartyDescription
string

Description of incorrect counterparty details in enrichment.

Maximum string length: 1024
Example:

"The counterparty is incorrect."

Callbacks

POST
https://example.com/your/callback/endpointCorrectedEnrichment

Body

application/json
​
transactionInfo
object
​
enrichmentId
string<uuid>

Our ID representing the enrichment, not to be confused with your provided transactionId.

​
counterparty
object[]

An array of counterparties matched to the transaction, ordered by descending match score.

​
mobileAppInfo
object

The mobile app information for the transaction. This object is only non-null if the transaction was matched to a mobile app.

This is a premium Spade field available depending on your product package.

​
customAttributes
object

A dictionary containing the custom attributes that were included in the enrichment request (if any).

Example:
{
  "custom_attribute_1": "value_1",
  "custom_attribute_2": "value_2"
}
​
actions
object[] | null

An array of triggered actions, or null if no triggers matched. This field is only present if your integration has the actions feature enabled.

When a transaction matches one or more registered triggers, this array contains the action details including your custom action data. Multiple matches are possible when triggers are registered at different scopes (account, program, user, card).

Example:
[
  {
    "id": "trigger-12345",
    "type": "merchant_trigger",
    "action": { "type": "REWARD", "rewardPercent": 5 },
    "scope": "account",
    "source": "counterparty"
  }
]

Response

Your server returns this code if it accepts the callback

Response

Enrichment reported successfully

Response for reporting an enriched transaction.

​
details
string
Example:

"Enrichment Successfully Reported."