### Platform Recommendation Response Example (GET) Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/card-transaction.md Example JSON response for the card BIN consumption recommendation endpoint. It lists platforms like Shopee, Meituan, Facebook, and Agoda, along with their transaction success rates. ```json { "code": "000000", "message": "success", "data": [ { "successRate": 1, "platformLabel": "Shopee" }, { "successRate": 1, "platformLabel": "Meituan" }, { "successRate": 1, "platformLabel": "Facebook" }, { "successRate": 0.8, "platformLabel": "Agoda" } ] } ``` -------------------------------- ### Get Card Bin Information Response Example Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/common.md This example demonstrates a successful response when querying for card bin information. It includes details about the card's ID, BIN, type, currency, network, verification status, and purchase limits. ```json { "code": "000000", "message": "success", "data": { "list": [ { "id": "1926684703962181633", "bin": "559666", "type": 1, "currencies": [ "USD" ], "network": "Master", "verification": { "avs": true, "threeDs": false }, "purchaseLimit": { "day": "1000000", "single": "1000000", "lifetime": "1000000" }, "supportPhysicalCard": false }, { "id": "1926684703681163265", "bin": "559666", "type": 0, "currencies": [ "USD" ], "network": "Master", "verification": { "avs": true, "threeDs": false }, "purchaseLimit": { "day": "1000000", "single": "1000000", "lifetime": "1000000" }, "supportPhysicalCard": false } ], "total": 94 } } ``` -------------------------------- ### Get Trade Data Example (JSON) Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/blockchain-refund.md This example demonstrates the structure of a successful response when retrieving trade data. It includes details such as trade ID, account information, currency pairs, amounts, side, rate, fees, status, and timestamps. ```json { "code": "000000", "message": "success", "data": { "total": 1, "list": [ { "id": "85feff81-b150-4a21-be75-e88498e9d1a6", "accountId": "b27c8873-e400-47cd-adc1-035cfa0d5347", "symbol": "USDT-USD", "baseWalletId": "d7bca4df-5671-4250-a644-8811bb1c31fc", "baseCurrency": "USDT", "baseAmount": "99.5", "quoteCurrency": "USD", "quoteAmount": "100", "side": "BUY", "rate": "1", "fee": "0.5", "feeCurrency": "USD", "status": "COMPLETE", "referenceId": "143541d1-2753-4cfb-9e1e-2b57ddf5c27a", "createTime": "1752744004537", "completeTime": "1752744005500" } ] } } ``` -------------------------------- ### Get Budget Success Response Example Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/card-transaction.md This example shows a successful response when retrieving budget details. It includes the budget's ID, associated account ID, creation time, name, balance information, and status. ```json { "code": "000000", "message": "success", "data": { "id": "e9561c9f-a7f6-4356-b2fe-4a4984c33c01", "accountId": "c83929c5-4ff3-42d4-af6d-56043022ebad", "createTime": "1758005368531", "name": "test name11222322222333", "balance": { "id": "a95b3d17-c8a4-4036-9898-13123d47c79f", "available": "0.00000000", "currency": "USD" }, "status": "ACTIVE" } } ``` -------------------------------- ### Get Physical Card Resource Example (JSON) Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/card-transaction.md Demonstrates a successful response for retrieving physical card details. Includes account ID, card ID, shipping address, contact information, and card style. ```json { "code": "000000", "message": "success", "data": { "id": "ba0a5c6d-ee96-4c44-82f1-dc306d325d8e", "accountId": "ba0a5c6d-ee96-4c44-82f1-dc306d325d8e", "cardId": "ba0a5c6d-ee96-4c44-82f1-dc306d325d8e", "shippingAddress": { "addressLine1": "123 Main Street", "addressLine2": "Apt 4B", "city": "New York", "state": "NY", "country": "US", "postalCode": "10001" }, "phoneNumber": "13765987596", "email": "user1234@gmail.com", "phoneCountryCode": "86", "firstName": "John", "lastName": "Smith", "batchNumber": "ba0a5c6d-ee96-4c44-82f1-dc306d325d8e", "cardStyle": "Plastic" } } ``` -------------------------------- ### Get Quotation Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/quotations.md Retrieves a quotation including the transaction rate, associated fees, and relevant timestamps. Refer to the Integration Guide for setup instructions. ```APIDOC ## GET /quotation ### Description Retrieves a quotation including the transaction rate, associated fees, and relevant timestamps. ### Method GET ### Endpoint /quotation ### Parameters #### Query Parameters - **amount** (number) - Required - The amount for which to get a quotation. - **currency** (string) - Required - The currency of the amount (e.g., 'USD', 'EUR'). ### Request Example ``` GET /quotation?amount=100¤cy=USD ``` ### Response #### Success Response (200) - **rate** (number) - The transaction rate. - **fees** (object) - An object containing fee details. - **processing_fee** (number) - The processing fee amount. - **network_fee** (number) - The network fee amount. - **timestamp** (string) - The timestamp when the quotation was generated. #### Response Example ```json { "rate": 0.005, "fees": { "processing_fee": 0.10, "network_fee": 0.05 }, "timestamp": "2023-10-27T10:00:00Z" } ``` ``` -------------------------------- ### File Upload Request Example (cURL) Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/authentication-1.md This example demonstrates how to upload files using the Quickbit Pro API. It utilizes a POST request with `multipart/form-data` to send the account ID and the file(s) to be uploaded. The response includes file IDs, account IDs, and creation times for successful uploads. ```bash curl -X POST \ http://your-api-domain.com/open-api/v3/files/upload \ -H 'Content-Type: multipart/form-data' \ -F 'accountId=ba0a5c6d-ee96-4c44-82f1-dc306d325d8e' \ -F 'files=@/path/to/your/file.jpg' ``` -------------------------------- ### Get Shipping Information - Success Example Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/getshippinginfo.md This JSON example shows a successful response from the 'Get Shipping Information' API endpoint. It includes details such as the courier company, tracking number, tracking URL, and timestamp for a physical card shipment. ```json { "code": "000000", "message": "success", "data": { "expressCompany": "SF Express", "trackingNumber": "SF1234567890", "trackingUrl": "https://www.sf-express.com/track?num=SF1234567890", "time": "1546272000000" } } ``` -------------------------------- ### Acquiring Payment Create Resource Example JSON Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/Acquiring.md An example JSON object illustrating the structure of the Acquiring Payment Create Resource. This resource contains core order details, status, currency, timestamps, payment tokens, and guidance for subsequent actions like redirection to payment or 3DS verification. It also includes nested objects for merchant and ticket information. ```json { "tradeNo": "PAY2025081500001", "merchantTradeNo": "MCH2025081500001", "amount": 399.50, "currency": "USD", "orderStatus": "READY", "orderType": "PAYMENT", "createTime": "1750000000000", "completeTime": null, "chargeToken": "ch_tok_64b8e321a7c8231f9d0e", "actions": { "redirectToPay": "https://payment-gateway.interlace.money/pay/123456789", "redirectTo3DS": "https://payment-3ds.interlace.money/pay/123456789" }, "merchant": { "subMerchantId": "1000000123" }, "ticket": { "ticketNo": "TKT2025081500001", "expirationTime": "2025-08-20T23:59:59", "barcode": "69825417369245813267", "format": "" } } ``` -------------------------------- ### Create Card Request Example Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/budgets.md This example demonstrates a successful request to create a card, including account ID, user name, currency, and transaction limits. The response includes the newly created card's details. ```json { "code": "000000", "message": "success", "data": { "id": "d8eda079-6ba7-409e-99c8-ab5f83566fbd", "accountId": "78ad30f2-5794-47c7-b413-62cc599ab203", "userName": "John Doe", "currency": "USD", "bin": "411111", "status": "ACTIVE", "cardLastFour": "4567", "label": "Personal Visa", "balanceId": "0d13f168-339b-4b74-a412-07a6ababcd9c", "budgetId": "c0598084-16d9-4426-b98e-382166afb0eb", "cardholderId": "1963922322985988097", "createTime": "1710813276127", "referenceId": "78ad30f2-5794-47r6-b413-62gh699ab203", "billingAddress": { "addressLine1": "123 Main Street", "addressLine2": "Apt 4B", "city": "New York", "state": "NY", "country": "US", "postalCode": "10001" }, "transactionLimits": [ { "type": "LIFETIME", "value": "5000.00", "currency": "USD" } ] } } ``` -------------------------------- ### List Wallets Request Parameters Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/blockchain-transfer.md This example shows how to query for wallets using various parameters. You can filter wallets by their ID, account ID, nickname, currency, master status, or reference ID. A limit can also be specified to control the number of results. ```json { "id": "string", "accountId": "string (uuid)", "nickname": "string", "currency": "string", "master": "boolean", "referenceId": "string (uuid)", "limit": "integer (int64)" } ``` -------------------------------- ### Get Blockchain Refund Details - Example Response Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/sweeping.md This example shows a successful response when retrieving details for a specific blockchain refund. It includes transaction identifiers, account information, destination, amount, fees, status, and timestamps. ```json { "code": "000000", "message": "success", "data": { "id": "7-4e5c-867a-639bbb8551e6", "accountId": "b27c8873-e400-47cd-adc1-035cfa0d5347", "destination": { "type": "BLOCKCHAIN", "chain": "AVAX", "address": "0x89F9Cfaa0dA076351DdfC6E320bD8df8b538dB17" }, "amount": { "amount": "10", "currency": "USDC" }, "fees": [ { "amount": "3", "currency": "USDC", "type": "GAS" } ], "status": "PENDING", "transactionHash": "0x55c51cfaa709d49da074634e630904b2f8a140524acfebfe73d9c600f80a6a16", "referenceId": "96478432-d972-496c-a50c-71d32267dd39", "createTime": "1746688012463", "completeTime": "1746688752376" } } ``` -------------------------------- ### Create Wallet Request Example Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/blockchain-transfer.md This example demonstrates the JSON payload required to create a new wallet. It includes essential fields like account ID, reference ID, and a nickname for the wallet. The account ID and reference ID are UUIDs used for identification and tracking. ```json { "accountId": "b27c8873-e400-47cd-adc1-035cfa0d5347", "referenceId": "907d6edf-0033-4629-bcba-ee0363b5e737", "nickname": "Developer" } ``` -------------------------------- ### Bind Wallet Request Example Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/common.md This example shows a request payload for binding a wallet. It requires the account ID, balance ID, wallet currency, wallet ID, and wallet type. The `walletType` specifies the business type of the destination, with 0 for INFINITY_ACCOUNT, 1 for BUSINESS_ACCOUNT, and 2 for CRYPTO_CONNECT. ```json { "accountId": "c6c6e3c4-6114-4f73-ac39-a4ca3d67a525", "walletId": "c6c6e3c4-6114-4f73-ac39-a4ca3d67a525", "walletCurrency": "USD", "walletType": 1, "balanceId": "c6c6e3c4-6114-4f73-ac39-a4ca3d67a525" } ``` -------------------------------- ### Get Card Access Token (Example Request) Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/budgets.md This example illustrates how to request a one-time access token for a specific card. The token is used by the Interlace iframe to securely display sensitive card information. The token is valid for 5 minutes and is single-use. ```http GET /open-api/v3/cards/{id}/private-info/access-token?accountId={accountId} HTTP/1.1 Host: api.interlace.com Authorization: ApiKey YOUR_API_KEY ``` -------------------------------- ### GET /transactions Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/card-bin.md Retrieves a list of card transactions. You can filter transactions by start and end times, and control the number of results per page. ```APIDOC ## GET /transactions ### Description Retrieves a list of card transactions. Supports filtering by time range and pagination. ### Method GET ### Endpoint /transactions ### Parameters #### Query Parameters - **startTime** (string) - Optional - Transaction start time. Format: timestamp - **endTime** (string) - Optional - Transaction end time. Format: timestamp - **limit** (string) - Optional - Limits the number of items to be returned. Default: 10. Example: 10 - **page** (string) - Optional - The page to be returned, counting from 0 as the first page. Default: 1. Example: 1 ### Response #### Success Response (200) - **code** (string) - Return code - **message** (string) - Error message - **data** (object) - Returned data - **list** (array) - List of data items - **id** (string) - Transaction ID - **accountId** (string) - Associated account ID - **cardId** (string) - Associated card ID - **cardholderId** (string) - Cardholder ID - **cardTransactionId** (string) - Card transaction ID - **currency** (string) - Currency code - **amount** (string) - Transaction amount - **fee** (string) - Transaction fee. The fee is not included in the `amount`. - **feeDetails** (array) - Transaction fee details - **amount** (string) - Amount - **currency** (string) - Currency code - **feeType** (string) - Fee Type: 0:Platform Settlement Fee, 1:Apple Pay Fee, 2:ATM Withdrawal Fee, 3:Reversal Fee, 4:Refund Fee - **clientTransactionId** (string) - Client custom transaction ID - **relatedCardTransactionId** (string) - Related card transaction ID - **transactionDisplayId** (string) - Transaction display ID - **type** (integer) - Transaction type: Values: 0:Credit, 1:Consumption, 2:TransferIn, 3:TransferOut, 9:Fee_Consumption, 10:Declined_Fee, 14:Reversal - **status** (string) - Transaction status. Values: CLOSED, PENDING, FAIL - **merchantName** (string) - Merchant name - **mcc** (string) - Merchant category code (MCC) - **mccCategory** (string) - Industry category of MCC - **merchantCity** (string) - Merchant city - **merchantCountry** (string) - Merchant country - **merchantState** (string) - Merchant state/province - **merchantZipcode** (string) - Merchant postal code - **merchantMid** (string) - Merchant identification number (MID) - **transactionTime** (string) - Transaction time - **transactionCurrency** (string) - Original transaction currency - **transactionAmount** (string) - Original transaction amount - **createTime** (string) - Creation time - **completeTime** (string) - Complete time - **remark** (string) - Reason for transaction failure - **detail** (string) - Some merchant info - **businessCodeList** (array) - Business code identifiers - **direction** (integer) - Transaction direction: 1 - Credit (incoming funds), 2 - Debit (outgoing funds) - **total** (integer) - Total number of records #### Response Example ```json { "code": "0000", "message": "OK", "data": { "list": [ { "id": "txn_1234567890abcdef", "accountId": "acc_abcdef1234567890", "cardId": "card_abcdef1234567890", "cardholderId": "ch_abcdef1234567890", "cardTransactionId": "ctrxn_abcdef1234567890", "currency": "USD", "amount": "100.50", "fee": "1.25", "feeDetails": [ { "amount": "0.50", "currency": "USD", "feeType": "0" } ], "clientTransactionId": "client_ref_xyz789", "relatedCardTransactionId": null, "transactionDisplayId": "TXN-ABC-123", "type": 1, "status": "CLOSED", "merchantName": "Example Merchant", "mcc": "5411", "mccCategory": "Supermarkets and Grocery Stores", "merchantCity": "New York", "merchantCountry": "US", "merchantState": "NY", "merchantZipcode": "10001", "merchantMid": "123456789012345", "transactionTime": "2023-10-27T10:30:00Z", "transactionCurrency": "USD", "transactionAmount": "100.50", "createTime": "2023-10-27T10:30:05Z", "completeTime": "2023-10-27T10:30:10Z", "remark": null, "detail": "Some merchant details", "businessCodeList": [101, 102], "direction": 2 } ], "total": 50 } } ``` ``` -------------------------------- ### POST /quickbit-pro/interlacedocs Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/getatransactions.md Creates a new interlaced documentation project. This endpoint allows users to initiate a new project within the Quickbit Pro system. ```APIDOC ## POST /quickbit-pro/interlacedocs ### Description Creates a new interlaced documentation project. This endpoint allows users to initiate a new project within the Quickbit Pro system. ### Method POST ### Endpoint /quickbit-pro/interlacedocs ### Parameters #### Request Body - **name** (string) - Required - The name of the new project. - **description** (string) - Optional - A description for the new project. ### Request Example ```json { "name": "New Project", "description": "A project for new documentation." } ``` ### Response #### Success Response (201) - **id** (string) - The unique identifier for the newly created project. - **name** (string) - The name of the project. - **description** (string) - The description of the project. - **createTime** (string) - The timestamp when the project was created. #### Response Example ```json { "id": "proj_456", "name": "New Project", "description": "A project for new documentation.", "createTime": "1756109834371" } ``` #### Error Response (400) - **code** (string) - Error code. - **message** (string) - Error message. #### Response Example ```json { "code": "400001", "message": "Invalid parameter" } ``` ``` -------------------------------- ### Get Budget Transactions List - API Request Example Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/card.md This example demonstrates how to make an API request to retrieve a list of budget transactions. It includes common query parameters such as account ID, budget ID, and time ranges. The response structure is also outlined. ```openapi { "tags": [ "Budgets" ], "summary": "Get budget transactions list", "operationId": "getBudgetTransactionList", "parameters": [ { "name": "id", "in": "query", "description": "The UUID of the transaction.", "required": false, "schema": { "type": "string", "description": "The UUID of the transaction.", "format": "uuid" } }, { "name": "accountId", "in": "query", "description": "The UUID of the account.", "required": true, "schema": { "type": "string", "description": "The UUID of the account.", "format": "uuid" } }, { "name": "budgetId", "in": "query", "description": "The UUID of the budget.", "required": false, "schema": { "type": "string", "description": "The UUID of the budget.", "format": "uuid" } }, { "name": "clientTransactionId", "in": "query", "description": "User-provided custom transaction ID.", "required": false, "schema": { "type": "string", "description": "User-provided custom transaction ID." } }, { "name": "cardReferenceId", "in": "query", "description": "This value corresponds to the unique identifier you assigned when creating the card.", "required": false, "schema": { "type": "string", "description": "This value corresponds to the unique identifier you assigned when creating the card." } }, { "name": "startTime", "in": "query", "description": "Transaction start time.", "required": false, "schema": { "type": "string", "description": "Transaction start time.", "format": "timestamp" } }, { "name": "endTime", "in": "query", "description": "Transaction end time.", "required": false, "schema": { "type": "string", "description": "Transaction end time.", "format": "timestamp" } }, { "name": "limit", "in": "query", "description": "Limits the number of items to be returned.", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "string", "description": "Limits the number of items to be returned.", "format": "number", "example": 10, "default": "10" }, "example": 10 }, { "name": "page", "in": "query", "description": "The page to be returned, counting from 1 as the first page.", "required": false, "schema": { "minimum": 1, "type": "string", "description": "The page to be returned, counting from 1 as the first page.", "format": "number", "example": 1, "default": "1" } } ], "responses": { "200": { "description": "Returned data", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Transaction UUID", "format": "uuid" }, "accountId": { "type": "string", "description": "Account UUID", "format": "uuid" }, "budgetId": { "type": "string", "description": "Budget UUID", "format": "uuid" }, "amount": { "type": "string", "description": "Transaction amount" }, "fee": { "type": "string", "description": "Transaction fee" }, "feeDetails": { "type": "array", "description": "Fee details", "items": { "type": "object" } }, "clientTransactionId": { "type": "string", "description": "User-provided custom transaction ID." }, "transactionDisplayId": { "type": "string", "description": "Displayable transaction ID." }, "type": { "type": "string", "description": "Transaction type: 0:TransferIn, 1:TransferOut, 2:CreateCardFee, 3:Consumption, 4:Refund, 5:FeeCredit, 6:Fee_Consumption, 7:Declined_Fee, 8:Reversal" }, "direction": { "type": "integer", "description": "Transaction direction: 1 - Credit (incoming funds), 2 - Debit (outgoing funds)", "format": "int32" }, "businessCodeList": { "type": "array", "description": "Business code identifiers. The complete list of supported business codes and their meanings can be found in the [Business Code Reference](https://developer.interlace.money/docs/card-business-code-reference).", "items": { "type": "integer", "description": "Business code identifiers. The complete list of supported business codes and their meanings can be found in the [Business Code Reference](https://developer.interlace.money/docs/card-business-code-reference).", "format": "int32" } }, "status": { "type": "string", "description": "Transaction status" }, "createTime": { "type": "string", "description": "Transaction time timestamp.", "format": "timestamp" }, "merchantCategoryCode": { "type": "string", "description": "Merchant category code (MCC) ,exists in consumer transactions." }, "mccCategory": { "type": "string", "description": "Industry category of MCC,exists in consumer transactions." }, "merchantCity": { "type": "string", "description": "Merchant city,exists in consumer transactions." }, "merchantCountry": { "type": "string", "description": "Merchant country,exists in consumer transactions." }, "merchantState": { "type": "string", "description": "Merchant state/province,exists in consumer transactions." }, "merchantZipcode": { "type": "string", "description": "Merchant postal code,exists in consumer transactions." }, "merchantMid": { "type": "string", "description": "Merchant identification number (MID),exists in consumer transactions." }, "transactionCurrency": { "type": "string", "description": "Original transaction currency" }, "transactionAmount": { "type": "string", "description": "Original transaction amount" }, "detail": { "type": "string", "description": "Transaction detail" } }, "description": "Returned data", "x-readme-ref-name": "BudgetTransaction" } }, "description": "budgetTransaction resources", "x-readme-ref-name": "BudgetTransactionResponse" }, "example": { "code": "000000", "message": "success", "data": { "id": "6444e0fe-e1f6-4ce0-87b0-192c07dc2b66", "accountId": "27b770ec-37a5-44ce-9810-6d6a40ef69d9", "budgetId": "ceddf229-5091-4280-8722-b5b37a06eb00", "amount": "4", "fee": "0", "feeDetails": [], "clientTransactionId": "1213221321352000801111", "transactionDisplayId": "2508251617000087", "type": "0", "direction": 1, "businessCodeList": [ 1001 ], "status": "CLOSED", "createTime": "1756109834371" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code", "example": "400001" }, "message": { "type": "string", "description": "Error message", "example": "Invalid parameter" } }, "x-readme-ref-name": "ErrorResult" }, "example": { "code": "40001", "message": "Invalid parameter" } } } } ], "security": [ { "ApiKeyAuth": [] } ] } ``` -------------------------------- ### Create Payment Checkout Session with Pre-selected Method (JSON) Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/refunds.md This example shows how to create a checkout session with a pre-selected payment method, such as a specific crypto card. The `paymentMethodId` field takes precedence over `paymentMethod` if both are provided. This allows for a more streamlined customer experience. ```json { "merchantTradeNo": "ORDER20250814123457", "amount": "150.00", "currency": "USD", "country": "US", "paymentDetail": { "paymentMethodId": "100003", "integrationMode": "redirect" }, "returnUrls": { "successUrl": "https://merchant.com/success", "failUrl": "https://merchant.com/fail" } } ``` -------------------------------- ### Get Card Details (JSON Example) Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/budgets.md This example demonstrates a successful response for retrieving card details. It includes account information, card status, billing address, and transaction limits. Sensitive fields like the card number and CVV are encrypted using AES. ```json { "code": "000000", "message": "success", "data": { "id": "d8eda079-6ba7-409e-99c8-ab5f83566fbd", "accountId": "78ad30f2-5794-47c7-b413-62cc599ab203", "userName": "John Doe", "currency": "USD", "bin": "411111", "status": "ACTIVE", "cardLastFour": "4567", "label": "Personal Visa", "balanceId": "0d13f168-339b-4b74-a412-07a6ababcd9c", "budgetId": "c0598084-16d9-4426-b98e-382166afb0eb", "cardholderId": "1963922322985988097", "referenceId": "78ad30f2-5794-47r6-b413-62gh699ab203", "createTime": "1710813276127", "billingAddress": { "addressLine1": "123 Main Street", "addressLine2": "Apt 4B", "city": "New York", "state": "NY", "country": "US", "postalCode": "10001" }, "transactionLimits": [ { "type": "LIFETIME", "value": "5000.00", "currency": "USD" } ] } } ``` -------------------------------- ### Get Private Card Info (JSON Example) Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/budgets.md This example shows a successful response for retrieving private card details. It includes encrypted PAN, CVV, expiration year, and month, along with non-sensitive BIN and card last four digits. The encryption uses AES with a key derived from clientSecret. ```json { "code": "000000", "message": "success", "data": { "pan": "3d91e3efd3bb64d8a5ba465470f4dc1973c5e951bea20b01ff7d1c1f90f4e32b", "cvv": "1f58406cc7d858578fedf4a9a9ae18a9", "expYear": "19980571355d04c6aef36001c878f994", "expMonth": "18fe21de46aea89042fdf7b311ced454", "bin": "49387519", "cardLastFour": "4425" } } ``` -------------------------------- ### Example JSON for Acquiring Payment Query Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/Acquiring.md This JSON object represents a sample response for a payment order query in the acquiring business scenario. It includes details such as trade number, amount, currency, status, and associated merchant, card, customer, and billing information. ```json { "tradeNo": "PAY2025081500001", "merchantTradeNo": "MCH2025081500001", "amount": 399.50, "currency": "USD", "country": "US", "orderStatus": "PAID", "orderType": "PAYMENT", "createTime": "1750000000000", "completeTime":"1750000000000", "merchant": { "subMerchantId": "SUB_MERCH_001" }, "card": { "firstName": "John", "lastName": "Doe", "pan": "4111****1111" }, "customer": { "merchantCustomerId": "CUST_0001", "firstName": "John", "lastName": "Doe", "phoneNumber": "+1-123-456-7890", "email": "john.doe@example.com" }, "billAddress": { "addressLine1": "123 Main Street", "addressLine2": "Apt 4B", "city": "New York", "state": "NY", "country": "US", "postalCode": "10001" }, "paymentMethod": "CARD" } ``` -------------------------------- ### Get Task Progress - OpenAPI 3.0.1 Definition Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/gettaskprogressing.md Defines the GET endpoint for retrieving task progress. It requires 'accountId' and 'taskId' as query parameters and returns task status, completion counts, and potential failure reasons. The response structure is detailed with success and error examples. ```json { "openapi": "3.0.1", "info": { "title": "Core Resource", "description": "Interface Developer Document", "version": "v3" }, "externalDocs": { "description": "Interface Developer", "url": "https://developer.interlace.money/" }, "servers": [ { "url": "https://api-sandbox.interlace.money", "description": "Sandbox" } ], "paths": { "/open-api/v3/task": { "get": { "tags": [ "Common Interface" ], "summary": "Get task process", "description": "Retrieve the current progress of a task by its task ID.", "operationId": "getTaskProgressing", "parameters": [ { "name": "accountId", "in": "query", "description": "Account ID", "required": true, "schema": { "type": "string", "description": "Account ID", "example": "ca0a5c6d-ee96-4c44-82f1-dc306d325d8e" }, "example": "ca0a5c6d-ee96-4c44-82f1-dc306d325d8e" }, { "name": "taskId", "in": "query", "description": "Task ID", "required": true, "schema": { "type": "string", "description": "Task ID", "example": 1755501328659 }, "example": 1755501328659 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "data" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error code", "example": "400001" }, "message": { "type": "string", "description": "Error message", "example": "Invalid parameter" }, "data": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Task ID", "example": "1955903027719811074" }, "doneNum": { "type": "integer", "description": "Number of completed", "format": "int32", "example": 10 }, "failedNum": { "type": "integer", "description": "Number of failed", "format": "int32", "example": 10 }, "totalNum": { "type": "integer", "description": "Total number", "format": "int32", "example": 20 }, "status": { "type": "string", "description": "Task status\n DONE: Completed\nPROCESSING: In Progress\nFAILED: Failed", "example": "DONE" }, "failedReason": { "type": "string", "description": "Task failed reason", "example": "error" } }, "description": "data", "x-readme-ref-name": "OpenApiV3ProgressVO" } }, "x-readme-ref-name": "OpenApiV3ProgressDataVO" }, "example": { "code": "000000", "message": "success", "data": { "taskId": "1955903027719811074", "doneNum": 10, "failedNum": 10, "totalNum": 20, "status": "DONE", "failedReason": "error" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code", "example": "400001" }, "message": { "type": "string", "description": "Error message" } } } } } } } } } } } ``` -------------------------------- ### Get Budget Transaction Details - API Example Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/card.md This example shows the successful response for retrieving the details of a specific budget transaction. It provides comprehensive information about the transaction, including its ID, associated account and budget IDs, amount, fees, status, and timestamps. This endpoint is essential for examining individual transaction records. ```json { "code": "000000", "message": "success", "data": { "id": "e6bb0163-8cd5-4f90-aba5-197b19431734", "accountId": "c83929c5-4ff3-42d4-af6d-56043022ebad", "budgetId": "e9561c9f-a7f6-4356-b2fe-4a4984c33c01", "cardId": "", "amount": "1", "fee": "0", "feeDetails": [ { "amount": "", "currency": "", "feeType": "" } ], "clientTransactionId": "8877665544332211", "transactionDisplayId": "2509161723000095", "merchantName": "", "mcc": "", "mccCategory": "", "merchantCity": "", "merchantCountry": "", "merchantState": "", "merchantZipcode": "", "merchantMid": "", "transactionCurrency": "", "transactionAmount": "", "type": "1", "status": "CLOSED", "createTime": "1758014613210", "detail": "", "businessCodeList": [], "direction": 2 } } ``` -------------------------------- ### Create Prepaid Card Request Example Source: https://github.com/quickbit-pro/interlacedocs/blob/main/pages/common.md This example shows a request payload for creating a prepaid card. It includes essential details such as the account ID, BIN ID, card mode, cardholder ID, and a unique reference ID for tracking. ```json { "accountId": "a1b2c3d4-e5f6-7890-1234-567890abcdef", "binId": "some_bin_id", "cardMode": "VIRTUAL_CARD", "useType": "Online advertising", "label": "My Custom Card", "cardholderId": "some_cardholder_id", "physicalCardDesignId": "some_design_id", "referenceId": "unique_reference_12345" } ```