200Successful Response
Schema: SuccessEnvelope_MerchantProfileResponse_
successbooleanmessagestringcodestringdataMerchantProfileResponse
/api/v1/credit/merchant-profileName the merchant as on POST /credit/bank-feeds (program_id and external_merchant_id, or credit_line_id); DayZero uses its business, creating it the first time, and gives your token read access to it. Records the merchant's start date (business_started_on), legal form, NAICS code, MCC, industry, country and currency. Fields left out keep what an earlier call set. months_in_business reads the declared start date first (evidence.basis: declared); without one it infers the age from the first Shopify order or bank transaction (basis: inferred). The currency becomes the business's while its books are empty.
Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.
Schema: MerchantProfileRequest
program_idstringYour program the merchant is applying under. Required without credit_line_id; with it, must be the line's program if sent.
external_merchant_idstringYour id for the merchant, as on POST /credit/bank-feeds and POST /credit/lines. Required without credit_line_id.
credit_line_idstringThe merchant's open line, when there is one.
merchant_legal_namestringNames the merchant's DayZero business when this call creates it. Ignored when the business exists.
merchant_business_idstringThe merchant's existing DayZero business, when your token can reach it. Leave it out and DayZero uses the business the merchant was linked to before, or creates one.
business_started_onstring · dateWhen the business started trading (its founding date). months_in_business reads it before any date it can infer from the data (basis: declared). Not in the future.
legal_entity_typestringThe merchant's legal form.
naics_codestringNAICS industry code, 2 to 6 digits.
mccstringThe merchant's own card-acceptance MCC, 4 digits.
industrystringFree-text industry, e.g. apparel or restaurant.
countrystringISO 3166-1 alpha-2 country the merchant trades from.
currencystringISO 4217 currency the merchant's books are kept in. Applied to the merchant's business while it holds no journal entries; after that it is recorded and currency_applied is false.
Schema: SuccessEnvelope_MerchantProfileResponse_
successbooleanmessagestringcodestringdataMerchantProfileResponseSchema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.