0xCard Documentation
    0xCard Documentation
    • Overview 📃
    • Updates log ⚙️
    • Client API 🖥
      • Users 👤
        • Create
        • Get
      • Cards 💳
        • Layouts List
        • New
        • Details
        • Top Up
        • List
        • Transactions
        • Statement
        • Block
        • Freeze
        • Unfreeze
    • Merchant API (CLOSED)
    • Webhook 📥
      • Overview
      • Descriptions & Typing
      • Demo 📝
        • Brief description
        • Payment
        • Verification Code
        • Change Card Status
        • Recharge Card
        • Card Block
    • Components 🗂

    Overview 📃

    Introduction#

    Welcome to API document for developers.
    This document provides insight into the use of relevant API endpoints such as account management, user registration, card issuance and recharge, etc.

    Encrypted Verification of API#

    Get an API Key#

    Before signing any request, you must get the API keys from sales. You will be given 2 values: the Secret key and the Merchant uuid.

    Initiate a Request#

    All REST requests must use POST method, include the following headers, and the request body is valid JSON.
    Each generated request body must be encrypted using a special AES128 (Advanced Encryption Standard) encryption algorithm with CBC (Cipher Block Chaining) type. The generated hash must also be provided.

    Encryption#

    Let's look at an example of accessing the user creation endpoint.

    The sequence of forming a correct request to the API (+ Python example):#

    1.
    Form a dictionary of the data you want to pass in the body of the request.
    2.
    Form the initialization vector (iv).
    3.
    Based on the generated iv, secret_key and the dictionary translated into String, generate an encrypted string.
    4.
    Based on the generated encrypted_data, merchant_uuid and the timestamp just received, generate a validation hash.
    5.
    Bring the received data to the form of a complete request body consisting of encrypted_data, hash, iv, timestamp, merchant_uuid.
    6.
    Send the generated request to endpoint and receive a response in standard json format.
    Modified at 2024-08-01 12:56:01
    Next
    Updates log ⚙️
    Built with