ZINC API
HomeSign InSupport
HomeSign InSupport
  1. Home
  • API Reference
  • Authentication
    • Get Access token
      GET
  • Core Resources
    • Accounts
      • Create Account
      • Get Account
      • Update Account
      • Get Account Balance
      • Submit Account For Activation
      • Get Account Transactions
      • Get Account Supported Currencies
      • Get Account Beneficiaries
    • Beneficiary
      • Add Beneficiary
      • Get Beneficiaries
      • Delete Beneficiary
    • Currency Accounts
      • Create Currency Account
      • Get Currency Account Details
    • Payouts
      • Create Payout
      • Get Payouts For Account
    • Cards
      • Simulation
        • Simulate Card Transaction
      • Create Card
      • Get Card Details
      • Update Transaction Limits
      • Update Cards Status
      • Get Card Transactions
    • Conversions
      • Create Conversion
      • Get Quote
    • Services
      • Upload File
  1. Home

API Reference

Introduction#

Welcome to the Zinc Multicurrency Wallet API documentation.
Zinc APIs are designed to empower businesses and individuals to seamlessly manage and process global payments. With Zinc's suite of APIs, you can effortlessly integrate comprehensive financial services into your applications, providing a streamlined and efficient user experience. Whether you need to handle multiple currencies or facilitate cross-border transactions, Zinc offers the tools to make it simple and secure. Explore our documentation to discover how Zinc can enhance your financial operations and deliver exceptional value to your users.

Authentication#

end points

Get Access Token#

This endpoint generates an access token that allows you to access all other API endpoints. You will need to use unique client ID and API key to authenticate and access token will be generated on successful authentication.

Account#

end points

Create Account#

Creates a new account with the provided details that is linked to the multi-currency wallet.To append documents, please use the ‘file upload’ endpoint. You can append more information to the account after creation using the ‘update account’ endpoint. Once all the required information has been provided you can submit the account using the ‘Submit Account For Activation’ endpoint

Get Account#

Retrieves details of a specific account using its ID.

Get Account Balance#

Retrieves the balance details of a specific account. This involves balance details in all the supported currencies.

Get Account Beneficiaries#

Retrieve beneficiaries associated with a specific account. This endpoint lists all the beneficiaries linked to the account for the purpose of making payouts.

Get Account Transactions#

Retrieve transactions of a specific account. This endpoint lists all transactions associated with the account, including deposits, paypouts and conversions.

Get Supported Currencies#

Retrieve transactions of a specific account. This endpoint lists all transactions associated with the account, including deposits, paypouts and conversions.
curl --location 'https://api-sandbox.z.inc/api/v1/account/:id/transactions' \
--header 'x-api-version: 2024-07-28' \
--header 'Authorization: Bearer 3aae7b2a-de82-4b64-bce2-c63cbf4133cc'

Submit Account For Activation#

To complete registration of an account, all mandatory fields and documentation must be submitted. After account activation, if you update primary_contact.email using the ‘Update account’ endpoint, you need to submit the account in order for the changes to take effect (available for individual accounts only).
💡
This is only for demo account testing purpose

Update Account#

Updates the details of an existing account.You can update the information prior to submitting the account for activation. can still update primary_contact.email and then use the ‘Submit Account For Activation’ endpoint to make the update take effect.

Beneficiaries#

end points

Create Beneficiary#

Add a new beneficiary. This endpoint registers a new beneficiary with the necessary payment details, such as bank account information.

Get Beneficiary Details#

Retrieve details of a specific beneficiary. This endpoint provides information about a particular beneficiary linked to an account.

Delete Beneficiary#

Delete a specific beneficiary. This endpoint removes a beneficiary from the account, preventing any future payouts to this entity.

Currency Account#

end points

Create Currency Account#

Create a new currency account. This endpoint sets up a sub-account under the main account. The currency account gives you the ability to hold balances in different currencies supported by it.

Get Currency Account#

Retrieve the details of a specific currency account.

Payouts#

end points

Create Payout#

Create a new payout to a beneficiary. This endpoint initiates a transfer of funds from an account to a registered beneficiary.

Get Payouts For An Account#

Retrieve payouts associated with a specific account. This endpoint lists all payouts made from an account, including details of each transaction.

Cards#

end points

Create Card#

Create a new card for an account. This endpoint issues a new payment card linked to an account, specifying the initial limits and settings. You can specify different types of limits DAILY, MONTHLY, PER_TRANSACTION, and ALL_TIME.

Get Card Details#

Retrieve details of a specific card. This endpoint provides information about a particular card, including its status and limits.

Update Card Status#

Update the status of a specific card. A card's status can be changed to any of the following status: ACTIVE, INACTIVE, and CLOSED.
curl --location --request PUT 'https://api-sandbox.z.inc/api/v1/card/:card_id/status' \
--header 'account-id: acct_4eJ7cv5jNaeuOWF5QDZwhg' \
--header 'x-api-version: 2024-07-28' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 7caa75f8-e06d-41ab-9e61-110d0248c7be' \
--data '{
    "card_status": "ACTIVE"
}'

Get Card Transactions#

Retrieve transactions of a specific card. This endpoint lists all transactions made with a particular card along with the status of each transaction.
curl --location 'https://api-sandbox.z.inc/api/v1/card/:card_id/transactions' \
--header 'account-id: acct_4eJ7cv5jNaeuOWF5QDZwhg' \
--header 'x-api-version: 2024-07-28' \
--header 'Authorization: Bearer d4c3e2e1-70c1-4e88-852d-8d247881bf9d'

Update Transaction Limits#

Update transaction limits for a specific card. This endpoint allows adjusting the spending limits on a card, including daily, weekly, monthly, per-transaction, and all-time limits.

Simulate Card Transaction#

📌
This end point Only for demo account purpose to simulate card transaction

Conversions#

end points

Create Conversion#

Create a new currency conversion. This endpoint initiates the conversion of one currency to another within an account, specifying the amount and currencies involved.

Get Quote#

Retrieves a conversion quote based on specified parameters. This endpoint provides the exchange rate and fees for a proposed currency conversion.

Services#

end points

Upload File#

Upload a file for onboarding or other purposes. This endpoint handles the uploading of documents needed for account verification or other administrative processes. It generates a file_id that is required to be passed in the apis requiring document upload.
Modified at 2024-07-28 15:13:22
Next
Authentication