HIhifi
External Account

Create an external account

Changed on

Create a new external bank account for offramp transfers. External accounts represent beneficiary bank accounts where funds can be sent.

The account will be validated and registered with the appropriate payment provider based on the specified rail and destination country/currency.

post/v2/users/{userId}/external-accounts

Request

  • Base URL
    https://production.hifibridge.com
  • URL
    https://production.hifibridge.com/v2/users/{userId}/external-accounts
  • Auth
    HTTP bearer

Path parameters

userIdstring required

ID of the user

Request body

OR
OR
OR
OR
OR

Example request

{
  "requestId": "550e8400-e29b-41d4-a716-446655440000",
  "direction": "payout",
  "country": "USA",
  "currency": "USD",
  "rail": "ach",
  "accountHolder": {
    "type": "individual",
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+14155551234",
    "address": {
      "addressLine1": "123 Main Street",
      "addressLine2": "Suite 100",
      "city": "New York",
      "stateProvinceRegion": "NY",
      "postalCode": "10001",
      "country": "USA"
    }
  },
  "accountDetails": {
    "accountNumber": "123456789",
    "routingNumber": "021000021",
    "accountType": "checking",
    "bankName": "Chase Bank"
  }
}

Response

External account created successfully

statusstring
messagestring
idstring uuid

Example response

{
  "status": "ACTIVE",
  "message": "Account created successfully",
  "id": "583eb259-e78b-4f0c-a4b5-a8957876fa6f"
}

Changes