Merchant

Get bank accounts by merchant

Retrieves all bank accounts associated with a specific merchant, with optional filtering by currency symbol.

get/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

Query parameters

currencystring

Filter bank accounts by currency symbol (e.g. USD, ARS, CLP)

Response

Get bankAccounts by Merchant

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.