Skip to main content

List Merchants

GET 
/v1/users/merchant-onboarding

Retrieve a list of merchant onboardings with optional filters.

Request​

Query Parameters

    page number

    Default value: 1

    Page number.

    size number

    Possible values: <= 100

    Default value: 20

    Page size. Max size is 100.

    sort string

    Possible values: [created_at]

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

    status string

    Possible values: [PENDING, WAITING_DOCUMENTS, APPROVED, DECLINED, FAILED]

    Merchant onboarding status.

    external_id string

    External merchant ID.

    user_id string

    User ID.

Header Parameters

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid string

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

Responses​

Merchants returned successfully.

Schema
    page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Page total.

    total numberrequired

    Total of elements.

    data object[]required

    Merchant onboardings data.

  • Array [
    • id stringrequired

    Merchant onboarding ID.

    status stringrequired

    Possible values: [PENDING, WAITING_DOCUMENTS, APPROVED, DECLINED, FAILED]

    Merchant onboarding status.

    external_id string

    External merchant ID.

    merchant_id string

    Merchant ID (MID) for synchronization with authorizers.

    trade_name stringrequired

    Trade name.

    timezone stringrequired

    Establishment timezone. Format: +0300, -0300 (without colon).

    opening_days stringrequired

    Opening days.

    opening_hour stringrequired

    Opening hour.

    closing_hour stringrequired

    Closing hour.

    has_tef booleanrequired

    Has TEF.

    has_pix booleanrequired

    Has PIX.

    has_top booleanrequired

    Has TOP.

    has_3ds booleanrequired

    Has 3DS.

    establishment_format stringrequired

    Possible values: [EI, MEI, EIRELI, LTDA, SS, SA, ME, EPP, EMPG, COOP, OTHER]

    Establishment format.

    revenue number

    Revenue.

    created_at date-timerequired

    Created at.

    updated_at date-timerequired

    Updated at.

  • ]
Loading...