Get Pending Fund Account

This endpoint allows you to retrieve information about your VelaFi Pending Fund account, With this information, you can pre-load funds into the Pending Fund account in advance. Pre-funding your account enables faster transactions, as you won't need to wait for external transfers to be confirmed at the time of trading.

Endpoint Information

  • Request Header: X-BH-TOKEN: ******

  • Request Method: GET

  • Request Path: /v2/merchant/addfunds

  • Authorization Required: Yes

Query Parameters

  • merchantId: (int) The merchant ID.

  • paymentId: (int) The payment ID. Currently supported payment IDs are 58 (Automated SPEI - Arcus) and 63 (Automated Bank Transfer (Argentina)).

  • fiat: (string) Name of the fiat currency. Currently supported currencies are MXN and ARS.

Response Structure

The response will include the following fields:

{
    "code": 200,
    "msg": "SUCCESS",
    "data": {  
        "paymentMethodName": "Paypal",  // (string: name of the payment method)
        "fieldList": {                   // (object: list of fields related to the payment method)
            "fieldName1": ["value1", "value2"], // (string: array of values for fieldName1)
            "fieldName2": ["value1", "value2"]  // (string: array of values for fieldName2)
        }
    }
}

Example Responses

Example for Payment ID 58:

{
    "code": 200,
    "msg": "SUCCESS",
    "data": {  
        "fiat": "MXN",
        "paymentMethodName": "Automated SPEI - Arcus",
        "fieldList": {
             "CLABE number": "MACM000509IR9",
             "Account number/card": "706180304649761358",
             "Beneficiary Name": "Rrturo Tellez"
        }
    }
}

Example for Payment ID 63:

{
    "code": 200,
    "msg": "SUCCESS",
    "data": {  
        "fiat": "ARS",
        "paymentMethodName": "Automated Bank Transfer (Argentina)",
        "fieldList": {
             "CVU number": "0000775900000000000086",
             "CUIT": "20339698695"            
        }
    }
}

Example for Payment ID 68:

{
    "code": 200,
    "msg": "SUCCESS",
    "data": {   
        "fiat": "COP",
        "paymentMethodName": "PSE",       
        "fieldList": {
            "alias": "soc.ce",
            "paymentLink": "https://links.cobre.co/zAOCe"
        }
    }
}

Example for Payment ID 81/82/83/84:

{
    "code": 200,
    "msg": "SUCCESS",
    "data": {
        "fiat": "USD",
        "paymentMethodName": "ACH_push",
        "realName": "",
        "fieldList": {
            "Deposit Message": "BRGJT5PNSZX636P9EC2D",
            "Bank Account Number": "11223344556672",
            "Bank Routing Number": "123456790",
            "Bank Beneficiary Name": "Ventures Inc",
            "Bank Name": "Bank of Nowhere",
            "Bank Address": "1800 North Pole St., Orlando, FL 32803"
        }
    }
}

Example for Payment ID 85:

{
    "code": 200,
    "msg": "SUCCESS",
    "data": {
        "fiat": "EUR",
        "paymentMethodName": "SEPA",
        "realName": "",
        "fieldList": {
            "Deposit Message": "BRGJT5PNSZX636P9EC2D",
            "BIC/Swift Code": "123456790",
            "IBAN": "11223344556672",
            "Bank Beneficiary Name": "Ventures Inc",
            "Bank Name": "Bank of Nowhere",
            "Bank Address": "1800 North Pole St., Orlando, FL 32803"
        }
    }
}

Notes

  • The paymentMethodName field indicates the name of the payment method associated with the pending funds.

  • The fieldList object contains various fields relevant to the payment method, where each key is a field name and the value is an array of associated values.

Last updated