Chargeback
Bevor Sie beginnen
Ihre API-Anfragen werden mit einem Zugriffstoken authentifiziert. Jede Anfrage, die kein gültiges Zugriffstoken enthält, gibt einen Fehler zurück. Erfahren Sie mehr unter Authentifizierung.
Basis-URL
- UAT:
https://transactions.transactional.uat.unico.app/api/public/v1 - Produktion:
https://transactions.transactional.unico.app/api/public/v1
Chargeback-Prüfung beantragen
POST /credit/transactions/{transaction_id}/chargeback — beantragt eine Chargeback-Prüfung für eine angegebene Transaktion.
Header
| Header | Wert |
|---|---|
Authorization | Bearer {token} — ein gültiges Zugriffstoken. |
Body
{
"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==" }
]
}
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
datetime | string | ja | Datum und Uhrzeit der Chargeback-Anfrage, ISO-8601-Format. |
requestor | object | ja | Informationen zum Antragsteller. |
requestor.key | string | ja | Typ des Identifikationsschlüssels für den Antragsteller (z. B. cpf). |
requestor.value | string | ja | Wert des Identifikationsschlüssels für den Antragsteller. |
name | string | ja | Name des Antragstellers. |
reason | string | ja | Grund für die Chargeback-Anfrage. |
observation | string | nein | Allgemeine Anmerkungen zur Anfrage. |
documents | array | nein | Dokumente im Zusammenhang mit dem Chargeback. Bis zu 3 Elemente, jeweils Base64-kodiert — nur PDF. |
documents[].label | string | ja (pro Element) | Dateiname oder Beschreibung. |
documents[].data | string | ja (pro Element) | Base64-kodierte PDF-Datei. |
200 OK
{
"id": "8263a268-5388-492a-bca2-28e1ff4a69f0"
}
| Feld | Beschreibung |
|---|---|
id | Generierte Chargeback-ID. |
Fehlerantworten finden Sie unter Fehler — Transaktionserstellung.
Status der Chargeback-Prüfung abrufen
GET /credit/transactions/{transaction_id}/chargeback/{chargeback_id} — prüft den Status eines bestimmten Chargebacks.
Header
| Header | Wert |
|---|---|
Authorization | Bearer {token} — ein gültiges Zugriffstoken. |
200 OK
{
"id": "8263a268-5388-492a-bca2-28e1ff4a69f0",
"status": "waiting"
}
| Feld | Beschreibung |
|---|---|
id | Chargeback-ID. |
status | Aktueller Status des Chargebacks. |
Alle möglichen Status finden Sie unter Aufzählungen — Chargeback-Ergebnis. Um die Leistung zu optimieren, implementieren Sie den Webhook, anstatt diesen Endpunkt abzufragen.