GET
/
api
/
partner
/
v1
/
user-bank-info
/
on-ramp
/
{country}
/
{userId}
cURL
curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v1/user-bank-info/on-ramp/{country}/{userId} \
  --header 'partner-api-key: <partner-api-key>' \
  --header 'x-supported-country: <x-supported-country>'
{
  "status": "ok",
  "data": [
    {
      "id": "<string>",
      "userId": "<string>",
      "partnerId": "<string>",
      "bankName": "<string>",
      "accountNumber": "<string>",
      "accountType": "SAVINGS",
      "clabe": "<string>",
      "country": "MX",
      "rampType": "ON_RAMP",
      "documentNumber": "<string>",
      "documentType": "PASSPORT",
      "isVerified": true,
      "verificationStatus": "PENDING",
      "verifiedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

​
Headers

PartnerApiKey (string) - API key associated with the partner.
Partner API Key RequiredRequires partner-api-key for authentication to ensure only authorized partners can access this data.See 🔑 API Key Generation Guide for getting your API key

​
Params

  • Country (string): The user’s bank information country. The values can me
    • MX
    • DO
  • userId(string): The unique identifier of the user who owns this bank information.

​
Response

  • id (string): The unique identifier for this bank information record.
  • userId (string): The unique identifier of the user who owns this bank information.
  • partnerId (string): The unique identifier of the partner that owns this bank information.
  • bankName (string, optional): The name of the bank if it is not listed as a supported bank.
  • accountNumber (string): The account number associated with this bank account.
  • accountType (string): The type of the bank account.
  • clabe (string, optional): The CLABE number specific to Mexican banks. This can be null if not applicable.
  • country (string): The country where this bank account information is applicable.
  • rampType (string): The type of transaction associated with this bank information.
  • documentNumber (string): The user’s nationality identifier.
  • supportedBankId (string, optional): The identifier of the supported bank. This field is null if the bank is not listed as a supported bank.
  • createdAt (Date): The date and time when this bank information was created.
  • updatedAt (Date): The date and time when this bank information was last updated.

​
Example

JSON
{
  "id": "987e6543-e21b-12d3-b456-426614174999",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "partnerId": "partner_001",
  "bankName": "Bank of Example",
  "accountNumber": "1234567890",
  "accountType": "SAVINGS",
  "clabe": "123456789012345678",
  "country": "MX",
  "rampType": "ON_RAMP",
  "documentNumber": "ABCD123456XYZ",
  "createdAt": "2024-09-16T12:34:56Z",
  "updatedAt": "2024-09-17T08:22:30Z"
}

​
Use Cases

  • On-Ramp Transactions: Retrieve the user’s bank information for an on-ramp process

Headers

​
x-supported-country
string
required

Country code of the flow (MX or DO)

​
partner-api-key
string
required

Api key for the affiliated partner that is performing the request

Path Parameters

​
country
enum<string>
required

The country to be used as filter for getting the user bank info.

Available options:
MX,
DO,
US,
AT,
BE,
BG,
HR,
CY,
CZ,
DK,
EE,
FI,
FR,
DE,
GR,
HU,
IE,
IT,
LV,
LT,
LU,
MT,
NL,
PL,
PT,
RO,
SK,
SI,
ES,
SE,
IS,
LI,
NO,
CH,
GB,
MC,
SM,
AD,
VA
Example:

"DO"

​
userId
string
required

User identifier

Example:

"8374f327-38bd-4b0b-b8a7-2524599eb903"

Response

200 - application/json

Retrieves the bank info for the partner user to deposit in an on ramp.

​
status
string
Example:

"ok"

​
data
object[]