Aller au contenu principal

Chargeback

Avant de commencer

Vos requêtes API sont authentifiées à l'aide d'un jeton d'accès. Toute requête qui n'inclut pas un jeton d'accès valide renverra une erreur. Pour en savoir plus, consultez Authentification.

URL de base
  • UAT : https://transactions.transactional.uat.unico.app/api/public/v1
  • Production : https://transactions.transactional.unico.app/api/public/v1

Demander une analyse de chargeback

POST /credit/transactions/{transaction_id}/chargeback — demande une analyse de chargeback pour une transaction spécifiée.

En-têtes
En-têteValeur
AuthorizationBearer {token} — un jeton d'accès valide.
Corps
{
"datetime": "2023-01-05T03:00:00.000Z",
"requestor": { "key": "cpf", "value": "USER_CPF" },
"name": "USER_NAME",
"reason": "REQUEST_REASON",
"observation": "GENERAL_OBSERVATIONS",
"documents": [
{ "label": "FILE_NAME", "data": "JVBERi0xLjQKMSAwI==" }
]
}
ChampTypeRequisDescription
datetimestringouiDate et heure de la demande de chargeback, au format ISO 8601.
requestorobjectouiInformations du demandeur.
requestor.keystringouiType de clé d'identification du demandeur (par exemple cpf).
requestor.valuestringouiValeur de la clé d'identification du demandeur.
namestringouiNom du demandeur.
reasonstringouiMotif de la demande de chargeback.
observationstringnonObservations générales sur la demande.
documentsarraynonDocuments liés au chargeback. Jusqu'à 3 éléments, chacun encodé en Base64 — PDF uniquement.
documents[].labelstringoui (par élément)Nom ou description du fichier.
documents[].datastringoui (par élément)Fichier PDF encodé en Base64.
200 OK
{
"id": "8263a268-5388-492a-bca2-28e1ff4a69f0"
}
ChampDescription
idID de chargeback généré.

Pour les réponses d'erreur, consultez Erreurs — Création de transaction.

Obtenir le statut de l'analyse de chargeback

GET /credit/transactions/{transaction_id}/chargeback/{chargeback_id} — vérifie le statut d'un chargeback spécifique.

En-têtes
En-têteValeur
AuthorizationBearer {token} — un jeton d'accès valide.
200 OK
{
"id": "8263a268-5388-492a-bca2-28e1ff4a69f0",
"status": "waiting"
}
ChampDescription
idID du chargeback.
statusStatut actuel du chargeback.

Consultez Énumérations — Résultat du chargeback pour tous les statuts possibles. Pour optimiser les performances, implémentez le Webhook plutôt que d'interroger ce point de terminaison en continu.