Cards API
  1. Top Up
Cards API
  • Introduction
  • API Usage Instructions
  • Platform URL's
  • API Specification
  • Authentication
  • Steps to Generate a Secure Signature
  • Callback Parameters and Template
  • Merchant
    • Information
      GET
    • Program Details
      GET
  • Cards
    • KYC Requirements
    • Apply Card
      • Apply
      • Binding
    • Information
      • CardDetails
      • PinDetails
      • CardBalance
      • Single Card Transactions
      • All Cards Transactions
      • Countries
      • Towns
    • Top Up
      • Estimate Card TopUp Fee
        POST
      • TopUp
        POST
      • TopUp Status
        GET
    • Actions
      • Freeze
      • UnFreeze
      • Cancellation
      • SetPin
  • Webhooks
    • Callback notification
    • Kycstatus result callback notification
    • Createcard result callback notification
    • Recharge callback notification
    • Operation callback notification
    • Consume result callback notification
    • Fee callback notification
    • Refund callback notification
    • Bank card 3DS verification
  1. Top Up

Estimate Card TopUp Fee

POST
EstimateCardTopUpFee
CardsService
This API calculates the estimated top-up fee for a card, based on the amount to be topped up, the fee amount, the expected receive amount, and the applicable exchange rates (for currency and coin). It helps to provide an estimate of how much a user will need to pay and receive based on these factors.

Request

Header Params
Content-Type
string 
optional
Default:
application/json
Authorization
string 
optional
Default:
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body Params application/json
cardId
string 
required
amount
string 
required
Example
{
  "cardId": "19d1f3e2-2ecf-45d3-a796-4f5a2d557f5d",
  "amount": "100.00"
}

Responses

🟢200OK
text/plain
Success
Body
cardId
string  | null 
optional
amount
string  | null 
optional
fee
number <double> | null 
optional
receiveAmount
number <double> | null 
optional
currencyExchangeRate
number <double> | null 
optional
coinExchangeRate
number <double> | null 
optional
Example
{
    "cardId": "d54f5e69-107d-49d2-bafe-7f837eb85da8",
    "amount": "100.00",
    "fee": "10.00",
    "receiveAmount": "90.00",
    "currencyExchangeRate": "1.00",
    "coinExchangeRate": "1.00"
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
🔴501501
Modified at 2025-02-18 13:21:14
Previous
Towns
Next
TopUp
Built with