Get Funding Details

The GET /funding_details method enables you to retrieve your account's funding information for the specified currency; for example, for BTC, it is your user Bitcoin address; for MXN, it is your CLABE, the bank's name, and the beneficiary's name; and for XRP, it is the address and the destination tag. This information is useful when making a deposit.

HTTP Request

GET https://api-stage.bitso.com/v3/funding_details

Header Parameters

You must specify the following authorization parameters in your request:

Parameter	Description	Required
`key`	See the section, Authentication	Yes
`signature`	See the section, Authentication	Yes
`nonce`	See the section, Authentication	Yes

Query Parameters

You can use the following query parameters in your request:

Parameter	Description	Required
`asset`	The digital asset in a network. In most cases, it is the same as the deposit's currency, for example, eth, matic, and usdt.	Yes. See callout below.
`currency`	The currency to deposit in the provided destination data, for example, btc, mxn, and usd.	Yes. See callout below.
`network`	The payment network where the deposit is processed.	No
`protocol`	A specific mechanism, protocol, or standard used in a network.	No

📘
Send one parameter or the other.
You must send either asset or currency in the query parameters. However, the endpoint does not throw an error if you send both.

JSON Response Payload

As explained in the introductory article, Retrieve Your Destination Address, the endpoint returns a JSON object designed for interacting with the Bitso application. It is out of the scope of this article to explain all the fields of this payload. Instead, this section presents several examples that enable you to understand how to look for the required information.

📘
The explanation omits the Bitso Transfer method.
The data for Bitso Transfer is also part of the payload, usually the very last object of the returned JSON object. You can identify it by the field "network": "bt". It also contains a details array. However, the array in the explanation below refers to the details array of networks other than Bitso Transfer.

The payload's details array includes several objects that house the funding destination information. Every object stores only one piece of information, so searching through several, for example, bank, beneficiary, and CLABE, might be necessary. In every object, the field label identifies the piece of information stored, for instance, beneficiary, and the field value, as the name says, the value of it. In some objects, the subtitle field provides valuable information such as to whom the data belongs, uniqueness of the value, fees, frequency of address changes, and similar.

When more than one payment network is available, a details array exists per network, so search accordingly. For example, BRL has two alternatives: Pix and TED, each with a details array. For some digital assets, such as XRP and XLM (Stellar 1), you need more than the destination address, so look for the destination tag as well.

The following response objects exemplify the JSON object returned to a request using currency as the search parameter:

curl "https://api-stage.bitso.com/v3/funding_details?currency={currency_ticker}"

{
    "success": true,
    "payload": [
        {
            "currency": "mxn",
            "asset": "mxn",
            "network": "spei",
            "protocol": "clabe",
            "integration": "praxis",
            "requires_manual_generation": false,
            "details": [
                {
                    "type": "STRING",
                    "identifier": "71096900000*******",
                    "reference": "",
                    "value": "NVIO",
                    "label": "Bank",
                    "subtitle": null,
                    "allow_copy": true
                },
                {
                    "type": "STRING",
                    "identifier": "71096900000*******",
                    "reference": "",
                    "value": "Darth Vader",
                    "label": "Beneficiary",
                    "subtitle": null,
                    "allow_copy": true
                },
                {
                    "type": "STRING",
                    "identifier": "71096900000*******",
                    "reference": "",
                    "value": "71096900000*******",
                    "label": "CLABE",
                    "subtitle": "Zero-fee deposit. This CLABE is unique to you.",
                    "allow_copy": true
                }
            ]
        },
        {
            "currency": "mxn",
            "asset": "mxn",
            "network": "bt",
            "protocol": "bt",
            "integration": "bt",
            "requires_manual_generation": false,
            "details": [
                {
                    "type": "QR_CODE",
                    "identifier": "ktkl",
                    "reference": "",
                    "value": "bitsotransfer:ktkl?b=Darth%20Vader&c=mxn",
                    "label": ""
                }
            ]
        }
    ]
}

{
    "success": true,
    "payload": [
        {
            "currency": "ars",
            "asset": "ars",
            "network": "coelsa",
            "requires_manual_generation": false,
            "protocol": "cvu",
            "details": [
                {
                    "identifier": "000048280000002*******",
                    "reference": "",
                    "value": "000048280000002*******",
                    "subtitle": "Zero-fee deposit.",
                    "label": "CVU",
                    "allowCopy": true,
                    "type": "STRING"
                },
                {
                    "identifier": "000048280000002*******",
                    "reference": "",
                    "value": "Obi-Wan Kenobi",
                    "label": "Beneficiary",
                    "allowCopy": true,
                    "type": "STRING"
                }
            ]
        },
        {
            "currency": "ars",
            "asset": "ars",
            "network": "bt",
            "requires_manual_generation": false,
            "protocol": "bt",
            "details": [
                {
                    "identifier": "ktkl",
                    "reference": "",
                    "value": "bitsotransfer:ktkl?b=Obi-Wan%20Kenobi&c=ars",
                    "label": "",
                    "type": "QR_CODE"
                }
            ]
        }
    ]
}

{
    "success": true,
    "payload": [
        {
            "currency": "brl",
            "asset": "brl",
            "network": "pix",
            "protocol": "pix",
            "integration": "btg",
            "requires_manual_generation": false,
            "details": [
                {
                    "type": "STRING",
                    "identifier": "",
                    "reference": "",
                    "value": "35.136.120/0001-03",
                    "label": "CNPJ",
                    "subtitle": "This key belongs to Bitso Brazil.",
                    "allow_copy": true
                }
            ]
        },
        {
            "currency": "brl",
            "asset": "brl",
            "network": "ted",
            "protocol": "ted",
            "integration": "btg",
            "requires_manual_generation": false,
            "details": [
                {
                    "type": "STRING",
                    "identifier": "",
                    "reference": "",
                    "value": "208 - Banco BTG Pactual",
                    "label": "Bank",
                    "subtitle": null,
                    "allow_copy": true
                },
                {
                    "type": "STRING",
                    "identifier": "",
                    "reference": "",
                    "value": "0030",
                    "label": "Agency",
                    "subtitle": "Zero-fee deposit.",
                    "allow_copy": true
                },
                {
                    "type": "STRING",
                    "identifier": "",
                    "reference": "",
                    "value": "288733-4",
                    "label": "Checking account",
                    "subtitle": null,
                    "allow_copy": true
                },
                {
                    "type": "STRING",
                    "identifier": "",
                    "reference": "",
                    "value": "NVIO BRASIL SERVICOS DE PAGAMENTOS LTDA.",
                    "label": "Beneficiary",
                    "subtitle": null,
                    "allow_copy": true
                },
                {
                    "type": "STRING",
                    "identifier": "",
                    "reference": "",
                    "value": "35.136.120/0001-03",
                    "label": "CNPJ",
                    "subtitle": null,
                    "allow_copy": true
                }
            ]
        },
        {
            "currency": "brl",
            "asset": "brl",
            "network": "bt",
            "protocol": "bt",
            "integration": "bt",
            "requires_manual_generation": false,
            "details": [
                {
                    "type": "QR_CODE",
                    "identifier": "ktkl",
                    "reference": "",
                    "value": "bitsotransfer:ktkl?b=Jar%20Jar%20Binks&c=brl",
                    "label": ""
                }
            ]
        }
    ]
}

{
    "success": true,
    "payload": [
        {
            "currency": "btc",
            "asset": "btc",
            "network": "btc",
            "protocol": "btc",
            "integration": "bitgo-v2",
            "requires_manual_generation": false,
            "details": [
                {
                    "type": "QR_CODE",
                    "identifier": "2Mx1ioyowuH35dB3QA7y3wKPr**********",
                    "reference": "",
                    "value": "bitcoin:2Mx1ioyowuH35dB3QA7y3wKPr**********",
                    "label": ""
                },
                {
                    "type": "STRING",
                    "identifier": "",
                    "reference": "",
                    "value": "Bitcoin",
                    "label": "Network",
                    "subtitle": null,
                    "allow_copy": false
                },
                {
                    "type": "STRING",
                    "identifier": "2Mx1ioyowuH35dB3QA7y3wKPr**********",
                    "reference": "",
                    "value": "2Mx1ioyowuH35dB3QA7y3wKPr**********",
                    "label": "Address",
                    "subtitle": "For privacy purposes, this address will change after every deposit.",
                    "allow_copy": true
                }
            ]
        },
        {
            "currency": "btc",
            "asset": "btc",
            "network": "bt",
            "protocol": "bt",
            "integration": "bt",
            "requires_manual_generation": false,
            "details": [
                {
                    "type": "QR_CODE",
                    "identifier": "ktkl",
                    "reference": "",
                    "value": "bitsotransfer:ktkl?b=Anakin%20Skywalker&c=btc",
                    "label": ""
                }
            ]
        }
    ]
}

{
    "success": true,
    "payload": [
        {
            "currency": "xrp",
            "asset": "xrp",
            "network": "rp",
            "protocol": "ripple",
            "integration": "rippled",
            "requires_manual_generation": false,
            "details": [
                {
                    "type": "QR_CODE",
                    "identifier": "rhYqLsBYcGe7wQpFjJ7kxgjM**********",
                    "reference": "226*****",
                    "value": "rhYqLsBYcGe7wQpFjJ7kxgjM**********",
                    "label": ""
                },
                {
                    "type": "STRING",
                    "identifier": "",
                    "reference": "",
                    "value": "Ripple",
                    "label": "Network",
                    "subtitle": null,
                    "allow_copy": false
                },
                {
                    "type": "STRING",
                    "identifier": "rhYqLsBYcGe7wQpFjJ7kxgjM**********",
                    "reference": "22650110",
                    "value": "rhYqLsBYcGe7wQpFjJ7kxgjM**********",
                    "label": "Address",
                    "subtitle": null,
                    "allow_copy": true
                },
                {
                    "type": "STRING",
                    "identifier": "rhYqLsBYcGe7wQpFjJ7kxgjM**********",
                    "reference": "",
                    "value": "22650110",
                    "label": "Destination tag",
                    "subtitle": "Include the destination tag, otherwise your funds will be lost.",
                    "allow_copy": true
                }
            ]
        },
        {
            "currency": "xrp",
            "asset": "xrp",
            "network": "bt",
            "protocol": "bt",
            "integration": "bt",
            "requires_manual_generation": false,
            "details": [
                {
                    "type": "QR_CODE",
                    "identifier": "ktkl",
                    "reference": "",
                    "value": "bitsotransfer:ktkl?b=Luke%20Skywalker&c=xrp",
                    "label": ""
                }
            ]
        }
    ]
}