General usage

BANK ACCOUNT TYPES:

  • CRYPTO currency: PLATFORM and REAP
  • FIAT currency: JDB

CARDS:

  • Only bank accounts of type REAP and JDB can have cards.

REQUIRED PARAMS for API:

  • x-apy-key: provided API key
  • x-ref-id: a unique identifier for the user

API Flow:

  1. Create a core user using x-apy-key and x-ref-id
    • A core user will be created.
    • A bank account of type PLATFORM with currency USDC (CRYPTO) will be created.
  2. Create a KYC for the user by filling in all required form fields and uploading 3 images
    • After creation, you can list KYCs and retrieve the ID
    • Use the "Change KYC status" endpoint to set the status to approved.
  3. Create a bank account of type REAP with currency USDC (CRYPTO).
  4. Create Cards using the endpoint "FIXED Create a new card request"
    • at productId use 9

MONEY TRANSFER

  1. Send money from external (e.g., MetaMask) to PLATFORM:
    1. Use the user’s PLATFORM bank account ID and call BankAccounts → Get deposit info to retrieve the wallet address.
    2. Transfer USDC (test/fake) to that wallet.
  2. Transfer money from PLATFORM to REAP
    1. Use the BankAccounts → Transfer endpoint to send funds from the PLATFORM to the REAP account.


BANK ACCOUNT

  • Use "Get bank account balance" to retrieve the available balance.