Skip to main content

This API to is used to get list bank deeplinks.

Request Body required
  • app_id string required

    This is a Zalopay-provided identifier specific to the merchant's service or application, established during the integration agreement for payment methods.

  • bank_codes string required

    List bank codes Merchant want to get deep link, separated by "," and should not have any space between.
    Example: BIDV,VTB.

  • os_type string required

    The OS mobile device type. Value: ios or android.

  • order_token string required

    The "order_token" value in Create Order API response. This param helps identify the order to fill payment information in the deeplink.
    Note: Zalopay strongly recommends that merchants provide this parameter when calling the API. Zalopay will automatically fill in the order’s data for supported bank's deeplinks.

  • mac string required

    Authentication information: mac = HMAC(hmac_algorihtm, mac key, hmacinput), see as below:
    - hmac_algorihtm: is a security method registered by Merchant with Zalopay, the default is HmacSHA256.
    - mac key: provided by Zalopay at registration.
    - hmac_input = app_id + | + bank_codes + | + os_type + | + order_token.

    Please refer to secure data transmission for detailed information.

Responses

OK

Schema
  • return_code integer

    Status code.
    Please refer to status code for possible values.

  • return_message string

    Description of status code.

  • sub_return_code integer

    Staus code detail.
    Please refer to sub status code for possible values

  • sub_return_message string

    Description of status code detail.

  • data object

    Data of banks deeplink.

  • bank_code string

    Bank identification code of Zalopay system.

  • short_name string

    Bank short name.

  • full_name string

    Bank full name.

  • logo_url string

    Bank logo url

  • is_auto_fill boolean

    - true : support auto fill.
    - false : not support auto fill.

  • deep_link string

    Bank deeplink information.
    - is_auto_fill = true : This deep link support autofill order information, allowing the user to process the payment without entering any details.
    - is_auto_fill = false : This deep link will only support the user to init bank app. User need to fill in the transfer information manually.
    Note: When the merchant provides the order_token parameter in the request, Zalopay will respond with a deep link containing the filled order information for supported banks. If the order_token is not provided, the deep_link field will be returned to the merchant but will not autofill the order information. This is intended to display the list of banks before creating the order.

Loading...