Skip to navigation

Partner Balance

View as Markdown

Use this endpoint to check your current available balance with NoLimit Payments.

Call it with your x-api-key header. No body or query parameters are needed.

  • balance - [string] your available balance in CAD, always with 2 decimals and no thousands separator (e.g. "15230.75").

  • name - [string] your partner account name.

The balance is what is available for withdrawals and refunds. Funds held in your rolling reserve are not included. Deposits are added to the balance once they are completed and settled. Withdrawals and refunds, including their fees, are taken from the balance when they are created.

Possible errors:

  • 401 - the API key is invalid.

  • 409 - the x-api-key header is missing.

  • 500 - the balance could not be retrieved. Please retry later.

Headers

x-api-keystringOptional

Response

OK
dataobjectOptional
successintegerOptional

Errors

401
Unauthorized Error
409
Conflict Error