Get Funding Sources

Retrieve the funding sources mapped to a user's wallet for a specific currency.

A funding source is an account or address that has been linked to a user's wallet. This endpoint allows you to retrieve the funding sources associated with a user and currency, so you can identify where the user's funds can be received.

For example, for an NGN wallet, the returned funding source may be a virtual account assigned to that user. For a supported crypto currency, the funding source may be a blockchain address associated with the wallet.

The currency parameter must always contain a supported LedgerBlock wallet currency.

Request

To retrieve the funding sources for a user, send a GET request with the user's user_ref and the required currency.

GET {{base_Url}}/api/v1/user/funding-sources?user_ref={USER_REF}&currency=NGN

Request Headers

Name	Type	Description
`Authorization`*	String	`Bearer ${api_key}` — your activated merchant API key.
`x-merchant-ref`*	String	Your unique merchant reference.

Query Parameters

Name	Type	Description
`user_ref`*	String	Unique reference identifying the user.
`currency`*	String	Supported wallet currency for which funding sources should be retrieved.

Sample header

curl --request GET \
  --url '{{base_Url}}/api/v1/user/funding-sources?user_ref={USER_REF}&currency=NGN' \
  --header 'Authorization: Bearer ${api_key}' \
  --header 'x-merchant-ref: ${merchant_ref}'

Response

`200 OK`

{
  "status": "success",
  "message": "Retrieved successfully",
  "data": [
    {
      "funding_source_id": "e5640a6d-e94e-495e-94e2-79ce79bed978",
      "account_number": "7536780916",
      "currency": "NGN"
    }
  ]
}

The exact fields returned in data depend on the type of funding source mapped to the user. Fiat funding sources may return account details, while crypto funding sources may return address and chain details.

Response Fields

Key	Type	Description
`status`	String	Indicates the result of the request.
`message`	String	Message describing the result of the request.
`data`	Array	List of funding sources mapped to the user for the requested currency.

Expected Funding Source Details

Depending on the funding source type, data may contain details such as:

Key	Type	Description
`funding_source_id`	String	Unique identifier of the mapped funding source.
`account_number`	String	Account number assigned to the user for a fiat funding source.
`currency`	String	Currency associated with the funding source.
`address`	String	Blockchain address for a crypto funding source.
`chain`	String	Blockchain or payment chain associated with the funding source.