Kontoinhaberdaten abgleichen

GET 
/api/account/matching

Prüft, ob die angegebenen Daten des Kontoinhabers mit dem Profil des Volet.com-Kontos übereinstimmen.

Anfrage

Query-Parameter

firstName stringerforderlich
Vorname des Kontoinhabers.
Beispiel: John
lastName stringerforderlich
Nachname des Kontoinhabers.
Beispiel: Doe
email string
E-Mail-Adresse des Kontoinhabers.
Beispiel: [email protected]
walletId string
Wallet-ID des Kontoinhabers.
Beispiel: USD880390848110

Antworten

200

OK

application/json

Schema

Schema

emailstring
E-Mail.
Beispiel: [email protected]
firstNamestring
Vorname.
Beispiel: test-value
lastNamestring
Nachname.
Beispiel: test-value
walletIdstring
Wallet-ID.
Beispiel: W000000000001
firstNameMatchingPercentageint32
Übereinstimmung des Vornamens in Prozent.
Beispiel: 1
lastNameMatchingPercentageint32
Übereinstimmung des Nachnamens in Prozent.
Beispiel: 1
verifiedboolean
Verifiziert-Kennzeichen.
Beispiel: true

Beispiel

{
  "email": "[email protected]",
  "firstName": "test-value",
  "lastName": "test-value",
  "walletId": "W000000000001",
  "firstNameMatchingPercentage": 1,
  "lastNameMatchingPercentage": 1,
  "verified": true
}

400

Ungültige Anfrage. Die Anfrage ist fehlerhaft oder enthält ungültige Parameter.

application/json

Schema

Schema

statusstringerforderlich
Antwortstatus.
Mögliche Werte: [error]
Beispiel: error
data objecterforderlich
Daten der Fehlerantwort.
errors object[]erforderlich
Liste der für die Anfrage zurückgegebenen Fehler.
Array [
errorMessagestringerforderlich
Stabiler maschinenlesbarer Fehlercode.
Beispiel: disabled
errorTypestringerforderlich
Fehlerkategorie.
Beispiel: FORM
errorIdstringerforderlich
Kurze eindeutige Fehlerkennung für Support und Logs.
Beispiel: errTest1234
errorDescriptionstringerforderlich
Lesbare Fehlerbeschreibung.
Beispiel: REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API
errorFieldstringnullable
Feld der Anfrage, auf das sich der Fehler bezieht, falls vorhanden.
Beispiel: null
paramsobject[]erforderlich
Zusätzliche Fehlerparameter.
requestParamsobjecterforderlich
Für die Diagnose erfasste Anfrageparameter.
]

Beispiel

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "disabled",
        "errorType": "FORM",
        "errorId": "errTest1234",
        "errorDescription": "REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

401

Nicht autorisiert. Die Authentifizierungs-Header des Händlers fehlen oder sind ungültig.

application/json

Schema

Schema

statusstringerforderlich
Antwortstatus.
Mögliche Werte: [error]
Beispiel: error
data objecterforderlich
Daten der Fehlerantwort.
errors object[]erforderlich
Liste der für die Anfrage zurückgegebenen Fehler.
Array [
errorMessagestringerforderlich
Stabiler maschinenlesbarer Fehlercode.
Beispiel: userDoesNotExistException
errorTypestringerforderlich
Fehlerkategorie.
Beispiel: GENERAL
errorIdstringerforderlich
Kurze eindeutige Fehlerkennung für Support und Logs.
Beispiel: errTest1234
errorDescriptionstringerforderlich
Lesbare Fehlerbeschreibung.
Beispiel: NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]
errorFieldstringnullable
Feld der Anfrage, auf das sich der Fehler bezieht, falls vorhanden.
Beispiel: null
paramsobject[]erforderlich
Zusätzliche Fehlerparameter.
requestParamsobjecterforderlich
Für die Diagnose erfasste Anfrageparameter.
]

Beispiel

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "userDoesNotExistException",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

404

Nicht gefunden. Die angeforderte Ressource existiert nicht.

application/json

Schema

Schema

statusstringerforderlich
Antwortstatus.
Mögliche Werte: [error]
Beispiel: error
data objecterforderlich
Daten der Fehlerantwort.
errors object[]erforderlich
Liste der für die Anfrage zurückgegebenen Fehler.
Array [
errorMessagestringerforderlich
Stabiler maschinenlesbarer Fehlercode.
Beispiel: resourceNotFound
errorTypestringerforderlich
Fehlerkategorie.
Beispiel: GENERAL
errorIdstringerforderlich
Kurze eindeutige Fehlerkennung für Support und Logs.
Beispiel: errTest1234
errorDescriptionstringerforderlich
Lesbare Fehlerbeschreibung.
Beispiel: Resource not found
errorFieldstringnullable
Feld der Anfrage, auf das sich der Fehler bezieht, falls vorhanden.
Beispiel: null
paramsobject[]erforderlich
Zusätzliche Fehlerparameter.
requestParamsobjecterforderlich
Für die Diagnose erfasste Anfrageparameter.
]

Beispiel

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "resourceNotFound",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Resource not found",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

500

Interner Serverfehler. Unerwarteter Fehler, wenden Sie sich an den Support

application/json

Schema

Schema

statusstringerforderlich
Antwortstatus.
Mögliche Werte: [error]
Beispiel: error
data objecterforderlich
Daten der Fehlerantwort.
errors object[]erforderlich
Liste der für die Anfrage zurückgegebenen Fehler.
Array [
errorMessagestringerforderlich
Stabiler maschinenlesbarer Fehlercode.
Beispiel: internalServerError
errorTypestringerforderlich
Fehlerkategorie.
Beispiel: GENERAL
errorIdstringerforderlich
Kurze eindeutige Fehlerkennung für Support und Logs.
Beispiel: errTest1234
errorDescriptionstringerforderlich
Lesbare Fehlerbeschreibung.
Beispiel: Internal server error
errorFieldstringnullable
Feld der Anfrage, auf das sich der Fehler bezieht, falls vorhanden.
Beispiel: null
paramsobject[]erforderlich
Zusätzliche Fehlerparameter.
requestParamsobjecterforderlich
Für die Diagnose erfasste Anfrageparameter.
]

Beispiel

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "internalServerError",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Internal server error",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}