Get merchant by ID

1 import requests 2 3 url = "https://api.koywe.com/api/v1/organizations/org_abc123/merchants/mer_def456" 4 5 headers = {"Authorization": "Bearer <token>"} 6 7 response = requests.get(url, headers=headers) 8 9 print(response.json())

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": "id", 22 "name": "name", 23 "code": "code", 24 "countryId": "countryId" 25 }, 26 "countyId": "cnt_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 27 "County": { 28 "id": "id", 29 "name": "name", 30 "code": "code", 31 "stateId": "stateId" 32 }, 33 "Country": { 34 "id": "id", 35 "name": "name", 36 "fullName": "fullName", 37 "Currency": {}, 38 "twoLetterIso": { 39 "key": "value" 40 } 41 }, 42 "state": "California" 43 }, 44 "businessType": "Galactic Republic Trading", 45 "businessStructure": "Galactic Republic Trading", 46 "capabilities": { 47 "payments": true, 48 "collections": true 49 }, 50 "chargesEnabled": true, 51 "countryId": "ctry_84b8b218-2777-4e7f-863e-7d0601ac289f", 52 "createdAt": "2024-07-01T22:40:22Z", 53 "defaultCurrencyId": "cur_8289dc19-e775-4c0c-a42a-e0da129e3b64", 54 "kybComplete": true, 55 "disabled": true, 56 "disabledReason": "N/D", 57 "Country": { 58 "id": "id", 59 "name": "name", 60 "fullName": "fullName", 61 "Currency": {}, 62 "twoLetterIso": { 63 "key": "value" 64 } 65 }, 66 "branding": { 67 "icon": "https://example.com/icon.png", 68 "logo": "https://example.com/logo.png", 69 "primaryColor": "#FF0000", 70 "secondaryColor": "#00FF00" 71 } 72 }

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

createdAtdatetime

defaultCurrencyIdstring

kybCompleteboolean

disabledboolean

disabledReasonstring

Countryobject or null

brandingobject or null

Get merchant by ID

Path parameters

Headers

Response

Errors