Sign in

v1

latestOpenAPI 3.1.02026-07-227350156.5 KB
Feedback and Reporting

Report a card enrichment as incorrect

Endpoint to report a card enrichment as incorrect. An enrichmentId and an errorDescription are required fields to report an enrichment. Optional request fields such as incorrectLocation, incorrectLocationDescription, incorrectCategory, incorrectCategoryDescription, incorrectChannel, incorrectChannelDescription, incorrectCounterparty, and incorrectCounterpartyDescription, can be set to indicate what needs to be addressed in the enrichment. Once a report has been addressed, you will receive a corrected enrichment via a callback url you set with Spade. See the callback section to learn more on how we send back a corrected enrichment.

post/transactions/report

Request body

enrichmentIdstring uuid required

Enrichment id represented as a string UUID.

errorDescriptionstring required

Description of incorrect details in enrichment.

incorrectLocationboolean

Bool indicating if the enrichment has a wrong location.

incorrectLocationDescriptionstring

Description of incorrect location details in enrichment.

incorrectCategoryboolean

Bool indicating if the enrichment has a wrong Category.

incorrectCategoryDescriptionstring

Description of incorrect category details in enrichment.

incorrectChannelboolean

Bool indicating if the enrichment has a wrong Channel.

incorrectChannelDescriptionstring

Description of incorrect channel details in enrichment.

incorrectCounterpartyboolean

Bool indicating if the enrichment has a wrong Counterparty.

incorrectCounterpartyDescriptionstring

Description of incorrect counterparty details in enrichment.

Example request

{
  "errorDescription": "Enrichment has an incorrect location. Wrong postal code.",
  "incorrectLocation": true,
  "incorrectLocationDescription": "The location's city is incorrect.",
  "incorrectCategoryDescription": "The category returned is incorrect.",
  "incorrectChannelDescription": "The spending channel should have been physical.",
  "incorrectCounterpartyDescription": "The counterparty is incorrect."
}

Response

Enrichment reported successfully

detailsstring

Example response

{
  "details": "Enrichment Successfully Reported."
}