L’API Obtenir l’état et les métadonnées de la transaction récupère l’état de la transaction et les métadonnées d’une transaction en fonction de son ID (uuid : transaction_id).
Si vous souhaitez obtenir l’ID de vérification d’une transaction terminée, vous devez utiliser le paramètre withVerifications . L’ID de vérification est requis pour la récupération des images de vérification d’une transaction. Pour plus d’informations, reportez-vous à la Retrieve verification images.
Syntaxe
GET /api/transaction/uuid: transaction_id(?withVerifications=true/false optional)
Exemples
Exemples de demandes
GET /api/transaction/dcaad720-d1e9-47ba-a76b-a6370ef0373b HTTP/1.1
Host: onespan.com
Accept: application/json, text/javascript
Exemple de demande incluant le paramètre withVerifications
GET /api/transaction/dcaad720-d1e9-47ba-a76b-a6370ef0373b?withVerifications=true HTTP/1.1
Host: onespan.com
Exemples de réponses
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
{
"id":"dcaad720-d1e9-47ba-a76b-a6370ef0373b",
"status":"new",
"created":"2017-04-23T18:25:43.511Z",
"tenant_id":"5e52d7b8-8b18-41a4-9187-d4ce75af681",
"workflow_id":"80b601c9-f102-4761-9eaa-90ba8fcb58b6",
"urlSetKey":"default",
"brand_id":"a089f718-f12d-4b13-b82e-e1d8b324337d",
language":"english",
"tokens": [...],
"users": [...],
"documents": [...],
"events": [...]
}
Exemple de réponse lors de l’utilisation du paramètre withVerifications
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
{
"id":"dcaad720-d1e9-47ba-a76b-a6370ef0373b",
"status":"new",
"created":"2017-04-23T18:25:43.511Z",
"tenant_id":"5e52d7b8-8b18-41a4-9187-d4ce75af681",
"workflow_id":"80b601c9-f102-4761-9eaa-90ba8fcb58b6",
"urlSetKey":"default",
"brand_id":"a089f718-f12d-4b13-b82e-e1d8b324337d",
language":"english",
"tokens": [...],
"verifications": [...],
"users": [...],
"documents": [...],
"events": [...]
}
En-têtes
Les en-têtes suivants sont inclus dans la demande et la réponse :
En-têtes de requête
Accepter : le type de contenu de la réponse dépend de l’en-tête Accepter .
Autorisation : jeton OAuth/JWT à authentifier.
En-têtes de réponse
Type de contenu : application/json
Codes d’état
Code d’état | Nom | Description |
---|---|---|
200 | D’ACCORD | Aucune erreur. |
400 | Mauvaise demande | Les données de transaction ne sont pas valides. |
401 | Non autorisée | Jeton non valide. |
403 | Interdit | Le jeton n’accorde pas de droits de création de transaction. |
500 | Erreur de serveur interne | Erreur de serveur ou d’application. |