Response scheme

The Partner API uses the same format to describe all errors:

  • Authentication errors
  • Validation errors
  • Other errors

Authentication error

Example of a request that failed because of an authentication error:

{ "errors": ["Invalid JWT"] }

Validation error

Example of the error returned when onboarding a merchant with an invalid legal entity type for the selected country:

{
  "errors": [
    ">company>legalEntityType invalid option AktiengesellschaftAG) for selected cocRegisteredCountryCode option DE, possible options are: Aktiengesellschaft(AG); Eingetragene Genossenschaft(eG); Eingetragener Verein(e.V.); Europäische Wirtschaftliche Interessensvereinigung(EWIV); Gemeinnützige Gesellschaft mit beschränkter Haftung(gGmbH); Gesellschaft bürgerlichen Rechts(GbR); Gesellschaft mit beschränkter Haftung(GmbH); Kommanditgesellschaft auf Aktien(KGaA); Kommanditgesellschaft(KG); Nicht eingetragener Verein; Offene Handelsgesellschaft(OHG); Partnerschaftsgesellschaft(PartGG); Stiftung des privaten Rechts; Versicherungsverein auf Gegenseitigkeit; Einzelfirma; Unternehmergesellschaft mit beschränkter Haftung (UG); Other."
  ]
}

Did this page help you?