merchantRetrieve

GEThttps://api.twisto.pl/psp/v2/merchant/{merchantId}/

Get a merchant by its identifier

Security: Token Auth

Provide your auth token in the Authorization header when making requests to protected resources.
Example: Authorization: Token 123

Path Parameters

Param name	Type	Description	Required	Default values	Min/Max values
merchantId	`string`	Merchant identifier	true

Responses

Body

id: integer
required
Identifier
legal_name: string
required
Legal name

<= 100 characters
company_id: string or null
Legal identification of a company

<= 20 characters
Default:
vat_id: string or null
VAT identifier

<= 14 characters
Default:
street: string
required
Address' street

<= 100 characters
city: string
required
Address' city

<= 100 characters
zipcode: string
required
Address' ZIP code

<= 10 characters
contact_name: string or null
Contact name

<= 200 characters
Default:
contact_phone_number: string or null
Contact phone number

<= 20 characters
Default:
contact_email: string<email> or null
Contact e-mail

<= 254 characters
Default:
is_blocked: boolean
required
True if and only if merchant is currently blocked from performing new orders.
pl_krs: string or null
The National Court Register (KRS) number, PL only

Match pattern: ^\d{10}$
<= 10 characters
external_id: string or null
required
External ID provided by PSP

<= 255 characters

Response example

{
  "id": 61,
  "legal_name": "string",
  "company_id": "string",
  "vat_id": "string",
  "street": "string",
  "city": "string",
  "zipcode": "string",
  "contact_name": "string",
  "contact_phone_number": "string",
  "contact_email": "string",
  "is_blocked": true,
  "pl_krs": "string",
  "external_id": "string"
}