Check balance | API Doc InstantTransfer.tech

You can use this CURL to create a Withdrawal order.

curl --request GET \
--url https://baseurl.com/api/v1/balance/merchant?currency=USD' \
--header 'Authorization: Bearer Your Token' \
--header 'accept: text/plain' \

The provided JSON object contains key financial metrics for a partner's account. Here's the translated version with explanations:

{
  "currency": "USD", // Currency of the balance, mandatory QUERY parameter in the request
  "merchantBalance": 1000.00, // Current balance of the merchant
  "merchantOverdraft": 1500.00, // Permissible overdraft amount
  "pipelineBalance": 500.00, // Current pipeline balance (Authorization points)
  "pipelineProcessingOrdersDeposit": 0.00, // Current amount of deposits in non-final statuses (Created, Processing)
  "pipelineProcessingOrdersWithdrawals": 100.00 // Current amount of withdrawals in non-final statuses (Created, Processing)
}

Explanation of Each Field:

currency: Specifies the currency of the balance, in this case, Dollar (USD). The dictionary of available currencies can be found here: https://apidoc.paystar.uk/currencys

merchantBalance: Indicates the current balance available to the partner, which is 1,000.00 USD.

merchantOverdraft: Denotes the permissible overdraft amount, allowing the partner to overdraw up to 1,500.00 USD.

pipelineBalance: Reflects the current balance within the pipeline, amounting to 500.00 USD.

pipelineProcessingOrdersDeposit: Represents the total amount of deposits that are in non-final statuses such as 'Created' or 'Processing'. Here, it is 0.00 USD, indicating no pending deposits.

pipelineProcessingOrdersWithdrawals: Shows the total amount of withdrawals that are in non-final statuses. The value is 100.00 USD, indicating withdrawals that have been initiated but not yet completed.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

application/json

Body

Example

{
    "currency": "USD",
    "merchantBalance": 1000,
    "merchantOverdraft": 1500,
    "pipelineBalance": 500,
    "pipelineProcessingOrdersDeposit": 0,
    "pipelineProcessingOrdersWithdrawals": 100
}

GET Merchant balance

Request

Request Code Samples

Responses