Skip to main content

Get Merchant Term Acceptance

GET 
/v1/users/merchant-onboarding/:id/terms

Retrieves all terms that a merchant must accept for credentialing. The returned term IDs will be used in the term acceptance endpoint.

Request​

Path Parameters

    id stringrequired

    Merchant onboarding 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​

Merchant terms retrieved successfully.

Schema
    terms object[]required

    List of merchant terms.

  • Array [
    • id stringrequired

    Term acceptance ID.

    term_id stringrequired

    Term ID.

    status stringrequired

    Possible values: [WAITING_SIGNER, SIGNED]

    Term acceptance status.

    active booleanrequired

    Whether the term is active.

    accepted_at date-time

    Date when the term was accepted.

  • ]
Loading...