Skip to main content

Transfer fund​

This API to is used to Execute top-up transaction.

Request Body required
  • app_id int64 required

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

  • payment_id string required

    Payment code provided by Zalopay for Merchant disbursement execution.

  • partner_order_id string required

    Merchant transaction ID sent to Zalopay system for disbursement execution (TXID of the disbursement transaction). Merchant uses this value to query transaction status and perform reconciliation.

  • disbursement_type string required

    Disbursement type: WALLET or BANK.

  • receiver_info string required

    Encrypted beneficiary account details. Use RSA public key for encryption.

  • amount int64 required

    Transaction disbursement amount.

  • description string required

    Disbursement transaction description.

  • partner_embed_data string required

    Specific Merchant details for disbursement execution, formatted as a JSON string.
    - Default: "{}".
    - Use Merchant wallet: “{\“merchant_wallet_id\”:\ “35AA123456\”}". The value "35AA123456" is for example purposes only.

  • mc_reference_id string

    Merchant's custom information required for disbursement reconciliation based on the disbursement transaction ID (partner_order_id).
    Example: Disbursement transaction ID on the Merchant's system, User ID, etc.

  • extra_info string required

    Custom transaction data.
    If not applicable, set the value to "{}".

  • time int64 required

    Disbursement request timestamp in milliseconds (Unix timestamp). Current timestamp in milliseconds based on current time.

  • sig string

    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 + | + payment_id + | + partner_order_id + | + disbursement_type + | + receiver_info (after encrypt) + | + amount + | + description + | + partner_embed_data + | + extra_info + | time.

    Please refer to secure data transmission for detailed information.

Responses

OK

Schema
  • return_code integer

    Status code.
    Please refer to status code for detailed information.

  • return_message string

    Description status code.

  • sub_return_code integer

    Status code detail.
    Please refer to sub status code for detailed information.

  • sub_return_message string

    Description status code detail.

  • data object
  • order_id string

    Zalopay disbursement transaction ID.

  • disbursement_type string

    Disbursement type: WALLET or BANK

  • m_u_id string

    User's identity in Zalopay.
    Note: only respond when verify by disbursement_type = "WALLET".

  • phone string

    Masked user's phone number Example: masked_user_phone: "****6938".
    Note: only respond when transfer by disbursement_type = "WALLET".

  • bank_code string

    Beneficiary bank code.
    Note: only respond when transfer by disbursement_type = "BANK".

  • account_no string

    Beneficiary account number.
    Note: only respond when transfer by disbursement_type = "BANK" and using account.

  • account_holder_name string

    Beneficiary account holder name.
    Note: only respond when transfer by disbursement_type = "BANK" and using account.

  • card_no string

    Beneficiary card number.
    Note: only respond when transfer by disbursement_type = "BANK" and using card.

  • card_holder_name string

    Beneficiary card holder name.
    Note: only respond when transfer by disbursement_type = "BANK" and using card.

  • status integer

    Disbursement execution status.
    - 3 PROCESSING: The transaction is in progress. The merchant must retry calling the Query Transaction API (/v2/disbursement/query-txn) periodically until reaching a final state.

  • amount int64

    Transaction disbursement amount.

  • partner_fee int64

    Partner fee

  • zlp_fee int64

    Zalopay fee.

  • server_time int64

    The initiation time of the transfer processing.

Loading...