Headers
Request body
country and currency are accepted in any case; the API returns them normalised in
uppercase.The country is a business choice, not a copy of yours. It determines the compliance
schedule of your vendor’s KYC file. A Congolese marketplace can connect a vendor from another
supported country.
Refused fields
Three fields are explicitly rejected with 422 (they are never silently ignored):
If you send several of them, they are all named in the same response: you do not have to
fix them one field at a time.
Example
Response
201
The vendor’s
environment is inherited from the key used: an sk_test_ can only produce
a test vendor. It is then impossible to target a live vendor with a test key: the response
is a 401.Replay
Reusing the sameIdempotency-Key returns the same 201 with the same id, within 24 h
(response cache) as well as beyond it (uniqueness in the database). You will never create two
vendors by accident.
A key that is already being processed returns 409 E_IDEMPOTENCY_CONFLICT: retry once the
first call has finished.
Errors
Model constraints
A vendor belongs to one marketplace, forever
A vendor belongs to one marketplace, forever
The control link is set here and it is immutable. There is no unlinking, and no transfer
to another marketplace.
A vendor cannot connect other vendors
A vendor cannot connect other vendors
Depth is limited to 1.
The currency must be your account's
The currency must be your account's
Multi-currency is not supported: an allocation or a split between two different currencies
is refused with
422 E_CURRENCY_MISMATCH.Next
Onboarding and verification
Send the vendor their verification link.