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": "Enrichment has an incorrect location. Wrong postal code.",
  "incorrectLocation": true,
  "incorrectLocationDescription": "The location'\''s city is incorrect.",
  "incorrectCategory": false,
  "incorrectCategoryDescription": "The category returned is incorrect.",
  "incorrectChannel": false,
  "incorrectChannelDescription": "The spending channel should have been physical.",
  "incorrectCounterparty": false,
  "incorrectCounterpartyDescription": "The counterparty is incorrect."
}'
{
  "details": "Enrichment Successfully Reported."
}

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.

Examples:

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

incorrectLocation
boolean

Bool indicating if the enrichment has a wrong location.

Examples:

true

incorrectLocationDescription
string

Description of incorrect location details in enrichment.

Examples:

"The location's city is incorrect."

incorrectCategory
boolean

Bool indicating if the enrichment has a wrong Category.

Examples:

false

incorrectCategoryDescription
string

Description of incorrect category details in enrichment.

Examples:

"The category returned is incorrect."

incorrectChannel
boolean

Bool indicating if the enrichment has a wrong Channel.

Examples:

false

incorrectChannelDescription
string

Description of incorrect channel details in enrichment.

Examples:

"The spending channel should have been physical."

incorrectCounterparty
boolean

Bool indicating if the enrichment has a wrong Counterparty.

Examples:

false

incorrectCounterpartyDescription
string

Description of incorrect counterparty details in enrichment.

Examples:

"The counterparty is incorrect."

Response

Enrichment reported successfully

Response for reporting an enriched transaction.

details
string
Examples:

"Enrichment Successfully Reported."