Merchant

Create a new bank account

Creates a new bank account for the specified merchant. Supports both fiat and crypto accounts with appropriate validation.

post/api/v1/organizations/{organizationId}/merchants/{merchantId}/accounts

Request

Base URL: https://api-sandbox.koywe.com
URL: https://api-sandbox.koywe.com/api/v1/organizations/{organizationId}/merchants/{merchantId}/accounts
Auth: HTTP bearer

Path parameters

merchantIdstring required

Merchant ID

organizationIdstring required

Organization ID

Headers

x-mfa-tokenstring required

Request body

namestring required

entitystring

Bank entity code. Optional for AR, MX, PE, BO, BR, US (auto-deduced). Required for CL, CO.

kind'BANK' | 'CRYPTO' | 'CASH' | 'ACQUIRER' | 'ACQUIRER_VIRTUAL' required

isVirtualboolean

Whether this is a virtual account. Optional for all account types. Defaults to false if not provided.

addressstring required

Blockchain network. Required for crypto accounts (kind=CRYPTO).

type'SAVINGS' | 'CHECKING' | 'VIRTUAL'

Account type (SAVINGS, CHECKING, VIRTUAL). Optional for all account types. Defaults to VIRTUAL if not provided.

accountNumberstring required

routingNumberstring required

isDefaultboolean required

isTrackedboolean

Whether this account is tracked for balance monitoring. Optional for all account types. Defaults to false if not provided.

countrySymbol'AR' | 'CL' | 'BR' | 'CO' | 'MX' | 'PE' | 'US' | 'BO' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BQ' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CM' | 'CN' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW'

Country code. Required for fiat accounts (kind=BANK), optional/ignored for crypto accounts (kind=CRYPTO).

currencySymbol'ARS' | 'CLP' | 'COP' | 'MXN' | 'USD' | 'PEN' | 'BRL' | 'ETH' | 'USDC' | 'USDT' | 'SOL' | 'TRX' | 'BTC' | 'BOB' | 'MATIC' | 'GBP' | 'CHF' | 'GYD' | 'PYG' | 'SRD' | 'UYU' | 'VES' | 'BZD' | 'CRC' | 'GTQ' | 'HNL' | 'NIO' | 'PAB' | 'CUP' | 'DOP' | 'HTG' | 'EUR' | 'CNY' | 'HKD' | 'SGD' | 'PHP' | 'JPY' | 'CAD' | 'AUD' required

Example request

{
  "name": "Banking of the Corp",
  "entity": "CITIBANK_NA",
  "kind": "bank",
  "address": "0x123...",
  "network": "ETHEREUM",
  "type": "SAVINGS",
  "accountNumber": "012342134-123",
  "routingNumber": "123456789",
  "isDefault": true,
  "countrySymbol": "CL",
  "currencySymbol": "CLP"
}

Response

idstring required

namestring required

entitystring required

kind'BANK' | 'CRYPTO' | 'CASH' | 'ACQUIRER' | 'ACQUIRER_VIRTUAL' required

isVirtualboolean required

addressstring required

networkstring required

type'SAVINGS' | 'CHECKING' | 'VIRTUAL' required

accountNumberstring required

routingNumberstring required

countryIdstring required

countryCodestring

Two-letter ISO country code

currencyIdstring required

currencyCodestring required

Currency symbol

createdAtstring date-time required

updatedAtstring date-time required

isDefaultboolean required

isTrackedboolean required

merchantIdstring required

contactIdstring required

pendingApprovalIdstring

Present when account creation requires policy approval. The account is not yet created.

Example response

{
  "id": "acc_6ead3cb5-e87f-4756-8389-8ad2f56757d0",
  "name": "Banking of the Corp",
  "entity": "Citibank NA",
  "kind": "bank",
  "address": "0x123...",
  "network": "ethereum",
  "type": "SAVINGS",
  "accountNumber": "012342134123",
  "routingNumber": "123456789",
  "countryId": "ctry_c7168583-0eeb-49b8-8c9b-0bffcf954fef",
  "countryCode": "AR",
  "currencyId": "cur_8289dc19-e775-4c0c-a42a-e0da129e3b64",
  "currencyCode": "ARS",
  "createdAt": "2024-07-01T22:40:22.003Z",
  "updatedAt": "2024-07-01T22:40:22.003Z",
  "merchantId": "mrc_31352afb-ce3a-4b7f-963d-b2512c646400",
  "contactId": "con_31352afb-ce3a-4b7f-963d-b2512c646400",
  "pendingApprovalId": "ppa_31352afb-ce3a-4b7f-963d-b2512c646400"
}

Changes

No recorded changes to this operation across all 1 revision of this API.