Skip to main content

Get 3DS authentication by ID

GET 
/v1/payin/three-ds/authentications/:id
Tag: api-payments-gateway-get-3ds-authentication-by-idDescription: Retrieve 3DS authentication details by its unique ID.

Request​

Path Parameters

    id stringrequired

    Three DS ID.

Header Parameters

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

    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

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses​

Transaction details retrieved successfully.

Schema
    id stringrequired

    Three DS Authentication ID.

    user_id stringrequired

    User ID of the merchant who performed the transaction.

    country stringrequired

    Country Of Transaction.

    payment_method stringrequired

    Possible values: [DEBIT_CARD, CREDIT_CARD]

    Payment Method.

    amount numberrequired

    Payment Value.

    currency_tag stringrequired

    Possible values: [BRL, USD]

    Payment Currency Tag.

    status stringrequired

    Possible values: [PENDING, WAITING_AUTHENTICATION, WAITING_CHALLENGE, ACCEPTED, REJECTED, FAILED, ERROR]

    Transaction Status.

    third_part_name stringrequired

    Third Part Full Name.

    third_part_email stringrequired

    Third Part Email Address.

    third_part_phone_number stringrequired

    Third Part Phone Number.

    third_part_address_city stringrequired

    Third Part Address City.

    third_part_address_country stringrequired

    Third Part Address Country.

    third_part_address_federative_unit stringrequired

    Third Part Address Federative Unit.

    third_part_address_number stringrequired

    Third Part Address Number.

    third_part_address_street stringrequired

    Third Part Address Street.

    third_part_address_zip_code stringrequired

    Third Part Address Zip Code.

    third_part_address_complement string

    Third Part Address Complement.

    third_part_address_neighborhood string

    Third Part Address Neighborhood.

    third_part_navigator_language stringrequired

    Browser language.

    third_part_navigator_java_enabled booleanrequired

    Java enabled status.

    third_part_navigator_color_depth numberrequired

    Color depth in bits.

    third_part_navigator_screen_height numberrequired

    Screen height in pixels.

    third_part_navigator_screen_width numberrequired

    Screen width in pixels.

    third_part_navigator_time_difference numberrequired

    Time difference in minutes.

    third_part_navigator_user_agent stringrequired

    User agent string.

    third_part_navigator_http_accept_content stringrequired

    HTTP Accept content.

    merchant_url stringrequired

    Merchant URL.

    merchant_challenge_window_size stringrequired

    Possible values: [SMALL, MEDIUM, LARGE, XLARGE, FULL_PAGE]

    Merchant Challenge Window Size.

    merchant_transaction_mode stringrequired

    Possible values: [ECOMMERCE, MOBILE, TABLET]

    Merchant Transaction Mode.

    device_channel stringrequired

    Possible values: [SDK, BROWSER]

    Device channel.

    challenge_data object
    access_token stringrequired

    Access Token to be used in the challenge step up URL.

    step_up_url stringrequired

    Step Up URL provided by the 3DS provider.

    authentication_id stringrequired

    Authentication ID for tracking the challenge session.

    iframe_dimension_width stringrequired

    Width of the iframe to be used for the challenge (e.g., "400px").

    iframe_dimension_height stringrequired

    Height of the iframe to be used for the challenge (e.g., "600px").

    created_at date-timerequired

    Transaction creation date

    updated_at date-timerequired

    Transaction last update date

Loading...