PayWidePayWide
  • Introduction
  • General
    • PayWide Website
    • Authentication
    • Supported Network
  • Merchant API
    • Top-up
    • Top-up with Wallet
    • Card
    • API Model

API Model

Card Product

NameTypeRequiredDescription
idStringvProduct ID
nameStringvProduct name
noteArrayCard Notes
featureArrayIntroduction to card features
scenarioArrayUsage Scenarios
defaultBooleantrue. There will only be one default product. If no product is specified when creating a new card, the default product will be used.

Supported Currency

NameTypeRequiredDescription
chainNameStringvThe type of crypto network
currencyStringvCryotpcurrency symbol
contractAddressStringvPlease make sure to use the correct contract address to transfer tokens

Top-up Address

NameTypeRequiredDescription
createdAtStringvCreation timestamp
addressStringvAddress of the crypto currency
currencyStringvSupported currency

Card

NameTypeRequiredDescription
idStringvCard ID, which can be used to obtain card details
createdAtStringvCreation timestamp
numberStringvCard number (showing only the first and last 4 digits)
balanceUpperStringvCard maximum balance limit
productIdStringProduct ID

Topup

NameTypeRequiredDescription
idStringvTopup ID
createdAtStringvCreation timestamp
amountStringvTransaction amount in base unit
currencyStringvTop-up currency
addressStringPayee address. If using wallet top-up, there will be no address or hash information.
hashStringOn-chain transaction hash
cardIdstringThe card associated with the request
productIdStringThe product associated with the request

Wallet History

NameTypeRequiredDescription
idStringvHistory ID
atStringvHistory timestamp
amountStringvTransaction amount
currencyStringvusd
descriptionStringvDescription text

Authorized Transaction

NameTypeRequiredDescription
idStringvTransaction ID
atStringvTransaction timestamp
typeStringvFour transaction types:

Authorization Transaction is authorized
Success Transaction completed
Failure Transaction failed
Reversal Transaction reversed
original{}vcurrency:String original currency
amount:String original amount
settlement{}vcurrency:String authorized currency
amount:String authorized amount
descriptionStringvTransaction description

Settled Transaction

NameTypeRequiredDescription
idStringvTransaction ID
atStringvTransaction timestamp
amountStringvSettled amount
currencyStringvSettled currency
descriptionStringTransaction description
Prev
Card