Enrichir un descripteur de transaction

Rend une identité de marchand pour un descripteur bancaire brut.

Au moins un identifiant est requis — un en-tête Idempotency-Key, un external_transaction_id, ou les deux. Sans aucun, la branche de déduplication est sautée entièrement et deux appels identiques produiraient deux événements facturés que plus rien ne distingue. L'API refuse plutôt que de laisser cela arriver.

Requête

application/jsonCreateRequest

Réponse

Réglé. Un 200 ne veut pas dire qu'un marchand a été trouvé — lisez enrichment.status. not_found est une réponse normale et complète.

application/jsonEnrichment

Erreurs possibles

Code
Statut	Code	Titre
`400`	`identifier_required`	Identifiant requis Un identifiant économique est requis pour résoudre cette transaction.
`400`	`invalid_idempotency_key`	Idempotency-Key invalide L'en-tête Idempotency-Key est absent ou mal formé.
`400`	`invalid_json`	Corps JSON invalide Le corps de la requête n'est pas un JSON valide.
`400`	`invalid_request`	Requête invalide La requête ne correspond pas à la forme documentée.
`400`	`unsupported_canonicalization`	Canonicalisation non prise en charge La version de canonicalisation demandée n'est pas prise en charge.
`401`	`invalid_api_key`	Identifiant d'API invalide L'identifiant d'API est absent, mal formé, révoqué ou inconnu.
`402`	`no_active_subscription`	Aucun abonnement actif Aucun abonnement actif ne couvre cette opération.
`402`	`sandbox_quota_exhausted`	Quota du Bac à sable épuisé L'organisation a consommé sa dotation de Bac à sable. Passez en Production pour continuer.
`403`	`account_inactive`	Compte inactif L'organisation ou l'espace de travail n'est pas actif.
`403`	`insufficient_scope`	Portée insuffisante L'identifiant d'API ne porte pas la portée qu'exige cette opération.
`403`	`production_not_enabled`	Accès Production non activé Cet identifiant d'API n'est pas autorisé à appeler l'environnement de production.
`409`	`idempotency_key_reuse`	Clé d'idempotence réutilisée Cette clé d'idempotence a déjà été utilisée avec une requête différente.
`409`	`input_mismatch`	Données d'entrée discordantes Les données d'entrée soumises ne correspondent pas à celles stockées pour cet identifiant.
`409`	`refresh_not_available`	Rafraîchissement indisponible Cet enrichissement ne peut pas être rafraîchi.
`409`	`transaction_id_conflict`	Conflit d'identifiant de transaction Cet identifiant de transaction a déjà été utilisé avec une requête différente.
`410`	`result_content_expired`	Contenu du résultat expiré Le contenu du résultat a été purgé et n'est plus disponible.
`413`	`request_entity_too_large`	Corps de requête trop volumineux Le corps de la requête dépasse la limite de taille documentée.
`415`	`unsupported_media_type`	Type de média non pris en charge Le corps de la requête doit être envoyé en application/json.
`429`	`rate_limited`	Débit dépassé Trop de requêtes. Reprenez après le délai indiqué par Retry-After.
`500`	`internal_error`	Erreur interne Une erreur inattendue s'est produite. Citez le request_id en contactant le support.
`503`	`busy`	Service occupé Le service est temporairement saturé. Reprenez après le délai indiqué par Retry-After.
`503`	`engine_error`	Erreur du moteur Le moteur d'enrichissement n'a pas pu produire de résultat. Cette tentative n'est pas facturable.
`503`	`pricing_not_activated`	Tarification non activée La facturation n'est pas encore activée pour cette opération. Reprenez plus tard.

Toutes les erreurs

POST/merchant/v1/enrichments

Serveurhttps://api.noryo.app

Bac à sable et Production partagent la surface de l'API ; l'identifiant d'API décide lequel des deux.

IDEMPOTENCY_KEY=$(uuidgen)
curl -sS -X POST 'https://api.noryo.app/merchant/v1/enrichments' \
  -H "Authorization: Bearer $NORYO_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "descriptor": "CB MCDONALDS PARIS 4519",
  "external_transaction_id": "tx_8f21c0"
}'

Shell

Authentification

En-tête: Authorization
Type: http
Schéma: bearer

Authorization: Bearer nry_mer_sbx_<key_id>.<secret>

Le préfixe porte l'environnement : nry_mer_sbx_ pour le Bac à sable, nry_mer_live_ pour la Production. Le secret est affiché une seule fois, à la création, et n'est jamais récupérable. Il n'existe pas d'opération de rotation : pour remplacer une clé, créez-en une nouvelle, déployez-la, puis révoquez l'ancienne.

Exemples de réponse

Structure du schéma

{
  "enrichment_id": "enr_7f3c1e20-…",
  "merchant": {
    "name": "McDonald's",
    "category": "alimentation.restaurant",
    "logo_url": "<string · uri>",
    "location": {
      "city": "PARIS",
      "postal_code": "75018"
    },
    "confidence": "<number · 0–1>"
  },
  "enrichment": {
    "status": "<string>",
    "reason": "<string>",
    "environment": "<string>",
    "source": "<string>",
    "customized": "<boolean>",
    "rules": [
      {
        "id": "<string · uuid>",
        "version": "<integer ≥ 1>"
      }
    ]
  },
  "usage": {
    "billable": "<boolean>",
    "units": "<integer>",
    "deduplicated": "<boolean>",
    "deduplicated_by": "<string>"
  }
}

JSON

Cette page vous a-t-elle aidé ?