Get merchant by ID

1 curl https://api.koywe.com/api/v1/organizations/org_abc123/merchants/mer_def456 \ 2 -H "Authorization: Bearer <token>"

1 { 2 "merchantId": "mrc_31fd8637-f889-43fa-8b31-50d9296abfdc", 3 "slug": "republic", 4 "profile": { 5 "name": "Galactic Republic Trading", 6 "description": "1234 Main St, Coruscant", 7 "address": "1234 Main St, Coruscant", 8 "email": "galactic.republic@row.com", 9 "phone": "1234567890", 10 "url": "https://galacticrepublic.com", 11 "supportEmail": "galacticrepublic", 12 "supportPhone": "1234567890", 13 "supportUrl": "https://galacticrepublic.com/support", 14 "taxIdType": "RUT", 15 "taxIdNumber": "123456789", 16 "addressLine2": "Suite 100", 17 "city": "Springfield", 18 "postalCode": "90210", 19 "stateId": "st_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 20 "State": { 21 "id": "string", 22 "name": "string", 23 "code": "string", 24 "countryId": "string" 25 }, 26 "countyId": "cnt_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 27 "County": { 28 "id": "string", 29 "name": "string", 30 "code": "string", 31 "stateId": "string" 32 }, 33 "Country": { 34 "id": "string", 35 "name": "string", 36 "fullName": "string", 37 "Currency": {}, 38 "twoLetterIso": {} 39 }, 40 "state": "California" 41 }, 42 "businessType": "Galactic Republic Trading", 43 "businessStructure": "Galactic Republic Trading", 44 "capabilities": { 45 "payments": true, 46 "collections": true 47 }, 48 "chargesEnabled": true, 49 "countryId": "ctry_84b8b218-2777-4e7f-863e-7d0601ac289f", 50 "createdAt": "2024-07-01T22:40:22.003Z", 51 "defaultCurrencyId": "cur_8289dc19-e775-4c0c-a42a-e0da129e3b64", 52 "kybComplete": true, 53 "disabled": true, 54 "disabledReason": "N/D", 55 "billing": { 56 "roundingType": "NET" 57 }, 58 "Country": { 59 "id": "string", 60 "name": "string", 61 "fullName": "string", 62 "Currency": {}, 63 "twoLetterIso": {} 64 }, 65 "branding": { 66 "icon": "https://example.com/icon.png", 67 "logo": "https://example.com/logo.png", 68 "primaryColor": "#FF0000", 69 "secondaryColor": "#00FF00" 70 } 71 }

Retrieve detailed information for a specific merchant within an organization. Requires ORGANIZATION_SETTINGS_VIEW_MERCHANT permission.

Path parameters

organizationIdstringRequired

Organization identifier

merchantIdstringRequired

Merchant identifier

Response

Merchant information retrieved successfully

merchantIdstring

slugstring

profileobject

businessTypestring

businessStructurestring

capabilitiesobject

chargesEnabledboolean

countryIdstring

createdAtstringformat: "date-time"

defaultCurrencyIdstring

kybCompleteboolean

disabledboolean

disabledReasonstring

billingobject

Billing configuration for the merchant

Countryobject or null

brandingobject or null

Get merchant by ID

Path parameters

Headers

Response

Errors