API - Version 1

Base URL:
  • Production Environment: https://zed-pay.com
  • Test Environment: https://test.zed-pay.com
Module:
+ Account
post
/api/v1/account/open Open a new account for a user.
Send token as "Authorization" in your request header.
post
/api/v1/account/change Change account status.
Send token as "Authorization" in your request header.
post
/api/v1/account/delete Delete an account.
Send token as "Authorization" in your request header.
get
/api/v1/account/list Get a list of accounts. All filters are optional.
Send token as "Authorization" in your request header.
post
/api/v1/account/rename Rename account.
Send token as "Authorization" in your request header.
post
/api/v1/account/deposit Add fund to account. Send receipt (file) parameter if deposit was made by an offline transfer. This method is only available for fiat wallets.
Send token as "Authorization" in your request header.
post
/api/v1/account/withdraw Withdraw from account balance. This method is only available for fiat wallets.
Send token as "Authorization" in your request header.
post
/api/v1/account/remit Request an offline withdrawal. This method is only available for fiat wallets. Start bank_name with "(Local Bank) " if it is a Local Bank transfer.
Send token as "Authorization" in your request header.
post
/api/v1/account/transfer Transer between accounts.
Send token as "Authorization" in your request header.
get
/api/v1/account/transactions Get a list of recent transactions of an account. account_id is mandatory.
Send token as "Authorization" in your request header.
post
/api/v1/account/confirm-transfer Confirm a pending transfer by admin.
Send token as "Authorization" in your request header.
post
/api/v1/account/reject-transfer Reject a pending transfer by admin.
Send token as "Authorization" in your request header.
get
/api/v1/account/find Get public info of accounts connected to an email address or user id.
Send token as "Authorization" in your request header.
post
/api/v1/account/update-bank-transfer-log Submit a new update for a withdrawal or deposit request.
Send token as "Authorization" in your request header.
get
/api/v1/account/list-crypto-transactions Get a list of recent transactions of a crypto wallet.
Send token as "Authorization" in your request header.
get
/api/v1/account/list-crypto-pending-transfers Get a list of pending transaction to be send to blockchain. id parameter is optional.
Send token as "Authorization" in your request header.
get
/api/v1/account/create-invoice Create a Proforma Invoice.
Send token as "Authorization" in your request header.
post
/api/v1/account/new-visa-card Request a new Visa Card,
Send token as "Authorization" in your request header.
post
/api/v1/account/new-virtual-card Request a new virtual card.
Send token as "Authorization" in your request header.
get
/api/v1/account/list-cards Get a list of virtual cards.
Send token as "Authorization" in your request header.
get
/api/v1/account/transaction-invoice Get a PDF version of a transaction.
Send token as "Authorization" in your request header.
get
/api/v1/account/get-swap-elements Get a list of eligible accounts for swap.
Send token as "Authorization" in your request header.
get
/api/v1/account/get-swap-pay Get a list of eligible accounts for swap.
Send token as "Authorization" in your request header.
get
/api/v1/account/get-swap-receive Get a list of eligible accounts to swap.
Send token as "Authorization" in your request header.
get
/api/v1/account/buy-crypto-elements Get a list of eligible accounts to buy crypto.
Send token as "Authorization" in your request header.
+ Address-List
post
/api/v1/address-list/add Add an address to address list.
Send token as "Authorization" in your request header.
post
/api/v1/address-list/delete Delete an address from address list.
Send token as "Authorization" in your request header.
get
/api/v1/address-list/get-address-list Get a list of customer's address list.
Send token as "Authorization" in your request header.
+ APCard
post
/api/v1/apcard/issue-virtual-card Issue a new virtual card.
Send token as "Authorization" in your request header.
post
/api/v1/apcard/load-virtual-card Add funds to virtual card by USDZ wallet.
Send token as "Authorization" in your request header.
post
/api/v1/apcard/unload-virtual-card Withdraw card balance.
Send token as "Authorization" in your request header.
get
/api/v1/apcard/get-types Get a list of available virtual cards.
Send token as "Authorization" in your request header.
get
/api/v1/apcard/list List cards of specific user.
Send token as "Authorization" in your request header.
get
/api/v1/apcard/get-balance Get updated balance of a virtual card
Send token as "Authorization" in your request header.
get
/api/v1/apcard/get-history Get Virtual Card Transactions
Send token as "Authorization" in your request header.
post
/api/v1/apcard/card-to-card Send money from a card to another.
Send token as "Authorization" in your request header.
get
/api/v1/apcard/get-cvv Get card's CVV2.
Send token as "Authorization" in your request header.
+ Blog
get
/api/v1/blog/list Get a list of recent blogs. Use id filter to get a single specific blog.
post
/api/v1/blog/add-blog Add a new blog.
Send token as "Authorization" in your request header.
post
/api/v1/blog/edit-blog Edit blog content.
Send token as "Authorization" in your request header.
post
/api/v1/blog/delete-blog Delete a blog.
Send token as "Authorization" in your request header.
+ Card
get
/api/v1/card/list-countries Get a list of allowed countries.
Send token as "Authorization" in your request header.
post
/api/v1/card/issue-virtual-card Issue a new virtual card.
Send token as "Authorization" in your request header.
post
/api/v1/card/load-virtual-card Add funds to virtual card by USDZ wallet.
Send token as "Authorization" in your request header.
post
/api/v1/card/unload-virtual-card Withdraw card balance.
Send token as "Authorization" in your request header.
get
/api/v1/card/get-balance Get updated balance of a card.
Send token as "Authorization" in your request header.
get
/api/v1/card/transactions Get card transaction list. month and year are optional and only apply on physical cards.
Send token as "Authorization" in your request header.
get
/api/v1/card/list List cards of specific user.
Send token as "Authorization" in your request header.
get
/api/v1/card/get-cvv Get card's CVV2.
Send token as "Authorization" in your request header.
post
/api/v1/card/new-holder Define a new card holder for bank.
Send token as "Authorization" in your request header.
post
/api/v1/card/submit-kyc Send holder's document to bank for verification.
Send token as "Authorization" in your request header.
post
/api/v1/card/activate Active an assigned physical card.
Send token as "Authorization" in your request header.
post
/api/v1/card/set-pin Set PIN code of a physical card.
Send token as "Authorization" in your request header.
get
/api/v1/card/get-pin Get PIN code of a physical card.
Send token as "Authorization" in your request header.
post
/api/v1/card/load-physical-card Add funds to physical card by USDZ wallet.
Send token as "Authorization" in your request header.
post
/api/v1/card/unload-physical-card Withdraw card balance.
Send token as "Authorization" in your request header.
get
/api/v1/card/features Get a list of card features.
Send token as "Authorization" in your request header.
post
/api/v1/card/card-to-card Send money from a card to another.
Send token as "Authorization" in your request header.
get
/api/v1/card/commissions Get a list of commissions on card actions.
Send token as "Authorization" in your request header.
+ Currency
post
/api/v1/currency/add Add a new currency
Send token as "Authorization" in your request header.
post
/api/v1/currency/edit Edit currency paramters.
Send token as "Authorization" in your request header.
post
/api/v1/currency/delete Delete a currency
Send token as "Authorization" in your request header.
get
/api/v1/currency/list Get a list of currencies.
get
/api/v1/currency/rates Get a list of Exchange Rates.
post
/api/v1/currency/convert Convert currency.
Send token as "Authorization" in your request header.
get
/api/v1/currency/list-to-open Get a list of currencies that a customer can open a wallet on.
Send token as "Authorization" in your request header.
+ Escrow3
post
/api/v1/escrow3/new Open a new escrow offer.
Send token as "Authorization" in your request header.
post
/api/v1/escrow3/edit Edit escrow parameters when its status is still pending.
Send token as "Authorization" in your request header.
post
/api/v1/escrow3/delete Delete pending escrow by user. Admin can delete escrows in any status.
Send token as "Authorization" in your request header.
post
/api/v1/escrow3/change Update new status of an escrow.
Send token as "Authorization" in your request header.
get
/api/v1/escrow3/list Get a list of recent transactions.
Send token as "Authorization" in your request header.
+ ESIM
get
/api/v1/esim/list-countries Get a list of available countries and packages to order a phone number.
Send token as "Authorization" in your request header.
post
/api/v1/esim/new-number Order a number from an allowed country list for a specific period of time.
Send token as "Authorization" in your request header.
get
/api/v1/esim/list-numbers Get a list of purchased number for a specific user. Filters are optional.
Send token as "Authorization" in your request header.
post
/api/v1/esim/assign-number Assign a phone number to the ESIM number.
Send token as "Authorization" in your request header.
post
/api/v1/esim/unassign-number Unassign client number from the ESIM number.
Send token as "Authorization" in your request header.
post
/api/v1/esim/send-code Send a verification to client's mobile number.
Send token as "Authorization" in your request header.
post
/api/v1/esim/verify-code Confirm client's mobile number by providing the verification code.
Send token as "Authorization" in your request header.
get
/api/v1/esim/get-sms Get a list of received SMS by a phone number.
Send token as "Authorization" in your request header.
post
/api/v1/esim/change-renew-status Change renew status on the expiry time.
Send token as "Authorization" in your request header.
post
/api/v1/esim/change-call-forwarding Forward incoming call to another number.
Send token as "Authorization" in your request header.
post
/api/v1/esim/top-up Recharge your phone number credit.
Send token as "Authorization" in your request header.
+ IBAN
post
/api/v1/iban/confirm-mobile Send OTP code to the client.
Send token as "Authorization" in your request header.
post
/api/v1/iban/apply Apply for a TR-IBAN.
Send token as "Authorization" in your request header.
get
/api/v1/iban/list Get a list of TR-IBAN wallets.
Send token as "Authorization" in your request header.
get
/api/v1/iban/get-agreement Show TR-IBAN Wallet agreement to the customer.
Send token as "Authorization" in your request header.
post
/api/v1/iban/deposit Deposit wallet by balance of TRY wallet.
Send token as "Authorization" in your request header.
post
/api/v1/iban/deposit-by-card Deposit wallet by a card.
Send token as "Authorization" in your request header.
post
/api/v1/iban/withdraw Send money to another account or bank.
Send token as "Authorization" in your request header.
post
/api/v1/iban/transfer Send money to a friend.
Send token as "Authorization" in your request header.
get
/api/v1/iban/get-static-data Get a list of KYC options.
Send token as "Authorization" in your request header.
post
/api/v1/iban/create-card Order a new card.
Send token as "Authorization" in your request header.
get
/api/v1/iban/get-cvv Get card CVV from the issuer.
Send token as "Authorization" in your request header.
post
/api/v1/iban/activate Activate physical card.
Send token as "Authorization" in your request header.
post
/api/v1/iban/set-pin Set a new card PIN.
Send token as "Authorization" in your request header.
post
/api/v1/iban/freeze Freeze your card.
Send token as "Authorization" in your request header.
post
/api/v1/iban/unfreeze Unfreeze your card.
Send token as "Authorization" in your request header.
get
/api/v1/iban/card-transaction Get a list of transaction.
Send token as "Authorization" in your request header.
+ Newsletter
post
/api/v1/newsletter/subscribe Subscribe in newsletter.
get
/api/v1/newsletter/list Get a list of email subscribers.
Send token as "Authorization" in your request header.
post
/api/v1/newsletter/delete Delete an email from newsletter list.
Send token as "Authorization" in your request header.
+ NFT
post
/api/v1/nft/register Create an NFT user. email, verification_code and password is not necessary when you are a customer and have a token.
post
/api/v1/nft/edit-user Edit NFT profile of a user. Trend and badge parameters are for Admin usage only, logo and banner are optional.
Send token as "Authorization" in your request header.
post
/api/v1/nft/delete-profile Delete NFT user profile.
Send token as "Authorization" in your request header.
get
/api/v1/nft/list-users Get a list of NFT users. Filter is optional.
Send token as "Authorization" in your request header.
post
/api/v1/nft/change-follow-status Follow or unfollow an NFT user.
Send token as "Authorization" in your request header.
post
/api/v1/nft/create-contract Create a new smart contract.
Send token as "Authorization" in your request header.
post
/api/v1/nft/change-contract-status Change status of an NFT contract. Admin usage only.
Send token as "Authorization" in your request header.
post
/api/v1/nft/delete-contract Delete an NFT smart contract.
Send token as "Authorization" in your request header.
get
/api/v1/nft/list-contracts Get a list of NFT contracts. Filter is optional.
Send token as "Authorization" in your request header.
post
/api/v1/nft/save-categories Set a list of NFT categories.
Send token as "Authorization" in your request header.
get
/api/v1/nft/list-categories Get a list of NFT categories to be registered with NFT Collections.
Send token as "Authorization" in your request header.
post
/api/v1/nft/create-collection Create a new collection.
Send token as "Authorization" in your request header.
post
/api/v1/nft/edit-collection Edit collection parameters.
Send token as "Authorization" in your request header.
post
/api/v1/nft/delete-collection Delete a collection.
Send token as "Authorization" in your request header.
get
/api/v1/nft/list-collections Get a list of NFT collections. Filters are optional.
Send token as "Authorization" in your request header.
post
/api/v1/nft/create Create a new NFT. new_contract_name and new_contract_symbol is mandatory if contract_id is 0.
Send token as "Authorization" in your request header.
post
/api/v1/nft/edit Edit NFT parameters.
Send token as "Authorization" in your request header.
post
/api/v1/nft/delete Delete an NFT.
Send token as "Authorization" in your request header.
get
/api/v1/nft/list Get a list of NFTs. Filters are optional.
Send token as "Authorization" in your request header.
post
/api/v1/nft/change-like-status Like or dislike an NFT.
Send token as "Authorization" in your request header.
post
/api/v1/nft/transfer Transfer an NFT to a new owner.
Send token as "Authorization" in your request header.
post
/api/v1/nft/quick-transfer Transfer NFT by default price.
Send token as "Authorization" in your request header.
post
/api/v1/nft/transfer-out Transfer NFT to another address.
Send token as "Authorization" in your request header.
get
/api/v1/nft/transfers Get a list of recent transfers.
Send token as "Authorization" in your request header.
post
/api/v1/nft/login Login with MetaMask or WalletConnect Address.
post
/api/v1/nft/save-plans Define NFT Plans for subscribers. Admin usage only
Send token as "Authorization" in your request header.
get
/api/v1/nft/get-plans Get a list of subscription plans.
Send token as "Authorization" in your request header.
post
/api/v1/nft/renew-plan Renew NFT subscription plan. id is the NFT User ID parameter.
Send token as "Authorization" in your request header.
post
/api/v1/nft/change-plan Subscribe to a new NFT plan. id is the NFT User ID parameter.
Send token as "Authorization" in your request header.
post
/api/v1/nft/bid Offer to buy an NFT in auction. This method can also be used to edit the offer.
Send token as "Authorization" in your request header.
post
/api/v1/nft/cancel-bid Cancel an active bid.
Send token as "Authorization" in your request header.
post
/api/v1/nft/update-contract-cost Update the cost of deploying Smart Contracts.
Send token as "Authorization" in your request header.
post
/api/v1/nft/get-contract-cost Get the cost of deploying Smart Contracts.
Send token as "Authorization" in your request header.
post
/api/v1/nft/review-bid Accept or reject bid offers.
Send token as "Authorization" in your request header.
post
/api/v1/nft/register-web3-transaction Register a client side transaction created by MetaMask or WalletConnect.
Send token as "Authorization" in your request header.
get
/api/v1/nft/financial-report Get NFT financial report for a specific period.
Send token as "Authorization" in your request header.
+ Payment
get
/api/v1/payment/transak-currencies Get a list of allowed currencies on Transak. customer_id is optional.
Send token as "Authorization" in your request header.
post
/api/v1/payment/get-payment-link Get URL of payment from a bank.
Send token as "Authorization" in your request header.
get
/api/v1/payment/list Get a list of payments. Filters are optional.
Send token as "Authorization" in your request header.
post
/api/v1/payment/deposit-crypto Deposit Crypto by Visa / Mastercard / Bank Cards
Send token as "Authorization" in your request header.
+ Static
post
/api/v1/static/upload-file Upload file(s) to server. You need to send your request body as form-data. (URLs are temporary)
Send token as "Authorization" in your request header.
get
/api/v1/static/list-labels Get a list of all static labels.
post
/api/v1/static/save-labels Save static lables list.
Send token as "Authorization" in your request header.
post
/api/v1/static/send-message Send a message to support.
get
/api/v1/static/faq Get a list of FAQs.
get
/api/v1/static/get-api-methods Get a list of API methods documentation.
get
/api/v1/static/list-countries Get a list of countries.
get
/api/v1/static/list-document-types Get a list of acceptable document types.
Send token as "Authorization" in your request header.
get
/api/v1/static/get-commissions Get a list of service commissions.
get
/api/v1/static/get-withdraw-types Get a list of available withdraw types.
Send token as "Authorization" in your request header.
get
/api/v1/static/get-escrow-types Get a list of allowed escrow types.
Send token as "Authorization" in your request header.
get
/api/v1/static/get-shipping-methods Get a list of available shipping methods.
Send token as "Authorization" in your request header.
get
/api/v1/static/swift-countries Get a list of swift countries.
Send token as "Authorization" in your request header.
get
/api/v1/static/search-banks Get a list of banks from a specific country.
Send token as "Authorization" in your request header.
get
/api/v1/static/get-stat-report Get website visits reports. Send days=0 to get today's report.
Send token as "Authorization" in your request header.
get
/api/v1/static/generate-qr-code Generate QR code from a string.
Send token as "Authorization" in your request header.
get
/api/v1/static/get-bank-accounts Get a list of Zed-Pay bank accounts.
Send token as "Authorization" in your request header.
get
/api/v1/static/static-form-fields Get field values of static forms.
Send token as "Authorization" in your request header.
get
/api/v1/static/about Get contact info of the company.
get
/api/v1/static/local-banks-summary Get a list of available countries and cities.
Send token as "Authorization" in your request header.
get
/api/v1/static/get-local-banks Get a list if local banks. Filter is optional.
Send token as "Authorization" in your request header.
get
/api/v1/static/get-transaction-by-hash Get blockchain transaction by hash.
Send token as "Authorization" in your request header.
+ Ticket
post
/api/v1/ticket/open Open a new ticket.
Send token as "Authorization" in your request header.
post
/api/v1/ticket/reply Add a new message to ticket.
Send token as "Authorization" in your request header.
post
/api/v1/ticket/change Change status or delete a ticket.
Send token as "Authorization" in your request header.
get
/api/v1/ticket/list Get a list of tickets.
Send token as "Authorization" in your request header.
get
/api/v1/ticket/list-departments Get a list of departments for Ticket support
Send token as "Authorization" in your request header.
+ Token
post
/api/v1/token/close-session Close a list of valid tokens.
Send token as "Authorization" in your request header.
get
/api/v1/token/active-sessions Get a list of active sessions (tokens). Filter is availble for Admin usage only.
Send token as "Authorization" in your request header.
+ User
get
/api/v1/user/recent-logins Get a list of recent logins. user_type is mandatory. user_id filter is optional and for Admin usage only.
Send token as "Authorization" in your request header.
post
/api/v1/user/register Register as a new user.
post
/api/v1/user/edit-profile Edit user profile. remark and status parameters are for admin usage only.
Send token as "Authorization" in your request header.
post
/api/v1/user/change-avatar Change user avatart.
Send token as "Authorization" in your request header.
post
/api/v1/user/login Login as user.
post
/api/v1/user/change-password Password change by user.
Send token as "Authorization" in your request header.
get
/api/v1/user/who-am-i Get current logged in user information.
Send token as "Authorization" in your request header.
post
/api/v1/user/reset-password Password reset by user.
post
/api/v1/user/reset-password-admin User password reset by an Admin.
Send token as "Authorization" in your request header.
post
/api/v1/user/delete Delete customer account.
Send token as "Authorization" in your request header.
get
/api/v1/user/list Get a list of users / return current loggedin user. Filter is optional and for admin usage only.
Send token as "Authorization" in your request header.
post
/api/v1/user/submit-documents Submit a list of ID documents to get verified.
Send token as "Authorization" in your request header.
post
/api/v1/user/review-documents Review user documents by Admin.
Send token as "Authorization" in your request header.
post
/api/v1/user/remove-documents Remove a pending document from the list.
Send token as "Authorization" in your request header.
post
/api/v1/user/request-reset-password Request password reset.
post
/api/v1/user/register-email Request a verification code on email.
post
/api/v1/user/confirm-new-email Confirm an email before registration.
post
/api/v1/user/verify-email Request a verification code on email. email is optional.
Send token as "Authorization" in your request header.
post
/api/v1/user/confirm-email Confirm email by received code.
Send token as "Authorization" in your request header.
get
/api/v1/user/get-authenticator-code Enable two-step verification with Google Authenticator.
Send token as "Authorization" in your request header.
post
/api/v1/user/verify-authenticator-code Confirm two-step verification setup.
Send token as "Authorization" in your request header.
post
/api/v1/user/disable-authenticator-code Disable two-step verification.
Send token as "Authorization" in your request header.
post
/api/v1/user/verify-mobile Request a verification code on mobile.
Send token as "Authorization" in your request header.
post
/api/v1/user/confirm-mobile Confirm mobile by received code.
Send token as "Authorization" in your request header.
post
/api/v1/user/set-notifications Set notification types for a user.
Send token as "Authorization" in your request header.
post
/api/v1/user/update-business-profile Update business info of an organization.
Send token as "Authorization" in your request header.
get
/api/v1/user/get-notifications Get a list of recent notifications.
Send token as "Authorization" in your request header.
post
/api/v1/user/change-notifications-status Change status of a list of notifications to Read or Deleted.
Send token as "Authorization" in your request header.
post
/api/v1/user/set-firebase-id Set Firebase ID to receive app notifications.
Send token as "Authorization" in your request header.
get
/api/v1/user/agent-info Get public information of an agent.