GET Merchant balance | API PayStar.uk

INFO

Current method is used to get the balance, which returns both the overall merchant balance and the balance of the specific endpoint (authorization key) used for the request.
Please note that many limits and restrictions are tied specifically to the endpoint balance. If you have multiple authorization keys, we recommend checking the balance for each key individually.

You can use this CURL to get maerchnt balance

curl --request GET \
--url https://api.PayStar.uk/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
  "merchantBalance": 10000.00, // Current balance of the merchant
  "merchantOverdraft": 1000.00, // Permissible overdraft amount
  "pipelineBalance": 5000.00, // Current pipeline balance 
  "pipelineProcessingOrdersDeposit": 0.00, // Current amount of deposits in non-final statuses (Created, Processing)
  "pipelineProcessingOrdersWithdrawals": 4000.00 // Current amount of withdrawals in non-final statuses (Created, Processing)
  "pipelineAvailableBalance": 1000.0 // Available for usw pipeline balance 
}

Explanation of Each Field:

Currency: Specifies the currency of the balance, in this case, Dollar (USD).

MerchantBalance: Indicates the current balance available to the partner, which is 10,000.00 USD.

MerchantOverdraft: Denotes the permissible overdraft amount, allowing the partner to overdraw up to 1,000.00 USD.

PipelineBalance: Reflects the current balance within the pipeline, amounting to 5,000.00 USD.

pipelineAvailableBalance: Reflects the current balance within the pipeline, amounting to 1,000.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 payouts that are in non-final statuses. The value is 4,000.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

currency

string

required

merchantBalance

number

required

merchantOverdraft

number

required

pipelineAvailableBalance"

number

required

pipelineProcessingOrdersDeposit

number

required

pipelineProcessingOrdersWithdrawals

number

required

Example

{
    "currency": "RUB",
    "merchantBalance": 10000,
    "merchantOverdraft": 1000,
    "pipelineBalance": 5000,
    "pipelineAvailableBalance": 1000,
    "pipelineProcessingOrdersDeposit": 0,
    "pipelineProcessingOrdersWithdrawals": 4000
}

Balance H2H

Request

Request samples

Responses