Wallet and Transaction API Calls
Detailed API call reference for wallet management and transaction processing
Wallet and Transaction API Calls
This document provides detailed information about all API calls used in wallet management and transaction processing. Each API call includes the endpoint, method, request parameters, and response format.
Get Customer Wallets
Retrieves all wallets associated with a customer.
Endpoint: /api/v2/wallet/customer-wallets
Microservice: walletMicroService
Method: POST
Headers:
Request Body:
Response:
Status Codes:
200 OK
: Wallets retrieved successfully401 Unauthorized
: Invalid or expired token404 Not Found
: No wallets found for customer
Get Transaction History
Retrieves transaction history for a customer.
Endpoint: /api/v2/wallet/transaction-history
Microservice: walletMicroService
Method: POST
Headers:
Request Body:
Response:
Status Codes:
200 OK
: Transaction history retrieved successfully400 Bad Request
: Invalid request parameters401 Unauthorized
: Invalid or expired token
Process Transaction Fee
Calculates fees for a transaction.
Endpoint: /api/v2/wallet/process-fee
Microservice: customerMicroService
Method: POST
Headers:
Request Body:
Response:
Status Codes:
200 OK
: Fee calculated successfully400 Bad Request
: Invalid request parameters401 Unauthorized
: Invalid or expired token
Process Transaction Limit
Validates that a transaction does not exceed applicable limits.
Endpoint: /api/v2/wallet/process-limit
Microservice: customerMicroService
Method: POST
Headers:
Request Body:
Response:
Status Codes:
200 OK
: Limit check passed400 Bad Request
: Invalid request parameters401 Unauthorized
: Invalid or expired token403 Forbidden
: Transaction exceeds limits
Send 2FA Verification Code
Sends a verification code for transaction authorization.
Endpoint: /api/v2/auth/2fa/send-code
Microservice: bffMs
Method: POST
Headers:
Request Body:
Response:
Status Codes:
200 OK
: Verification code sent successfully400 Bad Request
: Invalid phone number401 Unauthorized
: Invalid or expired token429 Too Many Requests
: Too many verification attempts
Verify 2FA Code
Verifies the 2FA code for transaction authorization.
Endpoint: /api/v2/auth/2fa/verify-code
Microservice: bffMs
Method: POST
Headers:
Request Body:
Response:
Status Codes:
200 OK
: Verification successful400 Bad Request
: Invalid verification code401 Unauthorized
: Invalid or expired token410 Gone
: Verification code expired429 Too Many Requests
: Too many verification attempts
Send Funds (Create Order)
Creates a transaction order.
Endpoint: /api/v2/wallet/send-fund
Microservice: bffMs
Method: POST
Headers:
Request Body:
Response:
Status Codes:
201 Created
: Order created successfully400 Bad Request
: Invalid request parameters401 Unauthorized
: Invalid or expired token403 Forbidden
: Insufficient funds or limits exceeded422 Unprocessable Entity
: Invalid beneficiary information
Get Order Details
Retrieves details of a specific order.
Endpoint: /api/v2/wallet/order-detail
Microservice: walletMicroService
Method: POST
Headers:
Request Body:
Response:
Status Codes:
200 OK
: Order details retrieved successfully401 Unauthorized
: Invalid or expired token404 Not Found
: Order not found
Internal API Calls
These are the internal API calls used by the system during wallet and transaction processing:
walletV2.getCustomerWallets
Microservice: walletMicroService
Description: Retrieves all wallets associated with a customer.
Request Parameters:
customerId
: Customer ID
Response:
- List of wallets with their details (ID, address, type, currency, balance, status)
walletV2.getOverAllTransactionHistoryByCustomer
Microservice: walletMicroService
Description: Retrieves transaction history for a customer.
Request Parameters:
consumerId
: Customer IDpageNumber
: Page number for paginationpageSize
: Number of records per pagesearchKey
: Optional search termfromDate
: Start date for filteringtoDate
: End date for filteringtransactionType
: Type of transactions to retrieve
Response:
- List of transactions with their details
- Total count of transactions
walletV2.getAssetTransactions
Microservice: walletMicroService
Description: Retrieves transactions for a specific asset.
Request Parameters:
customerId
: Customer IDassetId
: Asset IDpageNumber
: Page number for paginationpageSize
: Number of records per page
Response:
- List of transactions for the specified asset
- Total count of transactions
walletRule.processFee
Microservice: customerMicroService
Description: Calculates fees for a transaction.
Request Parameters:
customerId
: Customer IDtransactionType
: Type of transactionamount
: Transaction amountcurrency
: Transaction currencysourceWalletId
: Source wallet IDdestinationType
: Type of destination
Response:
- Fee amount and details
- Total amount including fees
walletRule.processLimit
Microservice: customerMicroService
Description: Checks if a transaction exceeds any limits.
Request Parameters:
customerId
: Customer IDtransactionType
: Type of transactionamount
: Transaction amountcurrency
: Transaction currencysourceWalletId
: Source wallet ID
Response:
- Limit check result
- Daily and monthly limits and usage
bff.resendCode
Microservice: bffMs
Description: Sends a verification code for transaction authorization.
Request Parameters:
customerId
: Customer IDphoneNumber
: Phone number to send code to
Response:
- Status of the code sending operation
- Expiration time of the code
bff.verifySmsCode
Microservice: bffMs
Description: Verifies the SMS code for transaction authorization.
Request Parameters:
customerId
: Customer IDverificationCode
: Code to verify
Response:
- Verification status
- Status message
bff.sendFund
Microservice: bffMs
Description: Creates a transaction order.
Request Parameters:
sourceWalletAddress
: Source wallet addressdestinationWalletAddress
: Destination wallet address (optional)amount
: Transaction amountcurrency
: Transaction currencybeneficiaryIban
: Beneficiary IBAN (for SEPA transfers)beneficiaryName
: Beneficiary namebeneficiaryBankName
: Beneficiary bank namebeneficiaryCountry
: Beneficiary country
Response:
- Order ID and transaction ID
- Status and estimated completion time
walletV2.getOrderDetail
Microservice: walletMicroService
Description: Retrieves details of a specific order.
Request Parameters:
orderId
: Order IDwalletAddress
: Wallet address
Response:
- Detailed order information including status, amounts, source and destination details