/api/partner/v1/user-bank-info

Headers

PartnerApiKey (string) - API key associated with the partner.

🚧

Partner API Key Required

Requires partner-api-key for authentication to ensure only authorized partners can access this data.

See 🔑 API Key Generation Guide for getting your API key

Input Body

All fields are required unless they're explicitly marked as optional

• userId (string): The unique identifier of the user who owns this bank information.
• bankName (string, optional): The name of the bank where this account is held. This field is required if supportedBankId is not provided.
• supportedBankId (string, optional): The identifier for the bank where this account is held.
• accountNumber (string): The account number associated with this bank account.
• accountType (string): The type of the bank account.
  • Possible values:
    • CHECKING
    • SAVINGS
• clabe (string, optional): The account identifier specific to bank accounts in Mexico.
• country (string): The country where this bank account information is applicable.
  • Possible values:
    • MX
    • DO
• documentNumber (string, optional): The nationality identifier for the user. If not provided, the document number from the user's KYC information will be used.

Example

{
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "bankName": "Bank of Example",
  "supportedBankId": "bank_abc123",
  "accountNumber": "1234567890",
  "accountType": "CHECKING",
  "clabe": "123456789012345678",
  "country": "MX",
  "documentNumber": "ABCD123456XYZ"
}

Response

This is the response body returned after creating or retrieving a user's bank information. All fields are required unless explicitly marked as optional. Below are the details of each field included in the 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, optional): 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 (enum: SupportedBankAccountType): The type of the bank account.

clabe (string, optional): The CLABE number specific to Mexican banks.

country (string): The country where this bank account information is applicable.

• Possible values:
  • CHECKING
  • SAVINGS

rampType (string): The type of transaction that this bank information is associated with.

• Possible values:
  • ON_RAMP
  • OFF_RAMP

documentNumber (string): The user's nationality identifier.

supportedBankId (string | null): 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

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

Use cases

Register account for off ramp transfers

A partner wants to register a new bank account details to transfer fiat currency to the user.

Update bank information about the user

A partner who wants to update old information about the user's bank account