Initialize seller boarding process

POST 
/v3/boarding/merchants/sellers/init

Initialize seller boarding process

Request

Header Parameters

Api-Key stringrequired

Unique key used to authenticate API requests.

Signature stringrequired

The Signature header is used to ensure the request’s body integrity and to confirm that its content has not changed.

Accept stringrequired

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand. Can be set to */*.

Content-Type stringrequired

The Content-Type entity header is used to indicate the media type of the resource.

application/json

Body

required

Request body for init process

nip stringrequired

Polish tax identification number

Possible values: >= 10 characters and <= 10 characters

notificationUrl string

The URL that the status notification will be sent to

Possible values: <= 1000 characters

Responses

201

Created

application/json

Schema

Schema

sellerId stringrequired

Possible values: >= 15 characters and <= 15 characters, Value must match regular expression ^([a-zA-Z0-9]{3}(-[a-zA-Z0-9]{3}){3})$

sellerApplicationUrl stringrequired

Address to redirect the seller

status stringrequired

Possible values: [NEW]

Example (from schema)

{
  "sellerId": "MB3-42Y-HRI-K9G",
  "sellerApplicationUrl": "https://melements.pl/...",
  "status": "NEW"
}

400

Bad request

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

errorType stringrequired

Error type

Possible values: [CONFLICT, FORBIDDEN, NOT_FOUND, RATE_LIMIT_REACHED, SYSTEM_TEMPORARILY_UNAVAILABLE, UNAUTHORIZED, VALIDATION_ERROR, VERIFICATION_FAILED, PAYMENT_METHOD_NOT_AVAILABLE, PAYMENT_AMOUNT_TOO_SMALL, PAYMENT_AMOUNT_TOO_LARGE, IDEMPOTENCY_KEY_MISSING, SIGNATURE_MISSING]

message string

Error description

]

Example (from schema)

{
  "statusCode": 0,
  "errors": [
    {
      "errorType": "CONFLICT",
      "message": "string"
    }
  ]
}

Example

{
  "statusCode": 400,
  "errors": [
    {
      "errorType": "VALIDATION_ERROR",
      "message": "Missing field XXX"
    },
    {
      "errorType": "VALIDATION_ERROR",
      "message": "Invalid format of field YYY"
    }
  ]
}

401

Unauthorized, invalid or missing credentials

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

oneOf

UnauthorizedErrorDetails

Error details

errorType stringrequired

Error type

Possible values: [UNAUTHORIZED]

message string

Error description

]

Example (from schema)

{
  "statusCode": 0,
  "errors": [
    {}
  ]
}

Example

{
  "statusCode": 401,
  "errors": [
    {
      "errorType": "UNAUTHORIZED",
      "message": "Unauthorized, invalid or missing credentials"
    }
  ]
}

409

Conflict

application/json

Schema

Schema

errorType stringrequired

Error type

Possible values: [CONFLICT, FORBIDDEN, NOT_FOUND, RATE_LIMIT_REACHED, SYSTEM_TEMPORARILY_UNAVAILABLE, UNAUTHORIZED, VALIDATION_ERROR, VERIFICATION_FAILED, PAYMENT_METHOD_NOT_AVAILABLE, PAYMENT_AMOUNT_TOO_SMALL, PAYMENT_AMOUNT_TOO_LARGE, IDEMPOTENCY_KEY_MISSING, SIGNATURE_MISSING]

message string

Error description

Example (from schema)

{
  "errorType": "CONFLICT",
  "message": "string"
}

Example

{
  "statusCode": 409,
  "errors": [
    {
      "errorType": "CONFLICT",
      "message": "Seller application with given nip is currently processed"
    }
  ]
}

500

Internal server error

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

errorType stringrequired

Error type

Possible values: [INTERNAL_SERVER_ERROR]

message string

Error description

]

Example (from schema)

{
  "statusCode": 0,
  "errors": [
    {
      "errorType": "INTERNAL_SERVER_ERROR",
      "message": "string"
    }
  ]
}

Example

{
  "statusCode": 500,
  "errors": [
    {
      "errorType": "INTERNAL_SERVER_ERROR",
      "message": "Internal server error"
    }
  ]
}

Loading...