List Merchants

GET 
/v1/merchants

List all merchants

Responses

200

Successful response

application/json

Schema

Schema

merchants

object[]

Array [

id uuid

Merchant ID. Used only with Platform API.

entity_id uuid

Entity ID (Merchant Account). This ID is used with all other APIs.

type MerchantTypes (string)

Possible values: [freelancer, establishment, company, foreign_company, government, charity]

Merchant type determine the goverment category for the onboarded merchant and also affects the required KYC documents.

status string

Possible values: [pending, missing_docs, under_review, semi_active, active, hold, rejected, disabled]

Merchant current status.

The status missing_docs indicates that there are required changes that must be done for the merchant which can be found in reasons. After fixing the issues, the merchant must be submitted again for review.

name string

Merchant name

website uri

email email

created_at date-time

updated_at date-time

]

meta

object

current_page integer

next_page integer

prev_page integer

total_pages integer

total_count integer

Example (from schema)

{
  "merchants": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "freelancer",
      "status": "pending",
      "name": "Chocolate Factory",
      "website": "https://example.com",
      "email": "[email protected]",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "next_page": null,
    "prev_page": null,
    "total_pages": 1,
    "total_count": 1
  }
}

401

Invalid authorization credentials

application/json

Schema

Schema

type string

Possible values: [authentication_error]

message string

Possible values: [Invalid authorization credentials]

errors object

Example (from schema)

{
  "type": "authentication_error",
  "message": "Invalid authorization credentials",
  "errors": null
}

403

Invalid authorization credentials

application/json

Schema

Schema

type string

Possible values: [api_error]

message string

Possible values: [User not authorized]

errors object

Example (from schema)

{
  "type": "api_error",
  "message": "User not authorized",
  "errors": null
}

404

One of the record referenced in the request was not found

application/json

Schema

Schema

type string

Possible values: [record_not_found]

message string
errors object

Example (from schema)

{
  "type": "record_not_found",
  "message": "The <object type> record you were looking for was not found.",
  "errors": null
}

Loading...