Funds

This endpoint allows you to retrieve the available funds of a customer across one or more countries. It can be used to quickly check the balance a customer holds in different regions, either filtered by specific countries or listing all countries where the customer has a presence.

Retrieve funds

Returns the available funds of a customer identified by customer_uuid in one or more countries. If the countries query parameter is not provided, the response will include all countries where the customer has available funds.

GET https://stage.api.payments.depay.us/v2/funds/customers?countries=AR,BR

Headers

Name
Type
Description

Authorization*

String

Bearer Token.

Query Parameters

Name
Type
Description

countries

String

Optional. Comma-separated list of country codes (e.g., AR, BR).

Response

Name
Type
Description

country

String

Country code where the customer has funds.

fund

Number

Amount of available funds in that country.

[
  {
    "country": "AR",
    "fund": 5000000.61
  },
  {
    "country": "BR",
    "fund": 1000000
  }
]

Last updated