--- title: "Retrieves a biller" method: GET path: "/biller" tags: ["Biller"] --- # Retrieves a biller `GET /biller` Fetches the details of the authenticated user's associated biller. Returns a 404 if no biller is found. ## Response `200` The biller details retrieved successfully - BillerResponse - `id` string, required — The unique identifier of the biller. - `name` string, required — The legal registration name of the company. - `statementName` string, required — The biller statement name shown on bank and credit card statements. - `directDebitStatementName` string — The biller statement name shown on Direct Debit bank statements. - `alias` string, required — The short name of the biller. - `registrationNo` string, required — The registration number of the company. - `currencyCode` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SPL' | 'SRD' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWD', required — The default currency of the biller. - `countryCode` string, required — The default country code of the biller. - `timezone` string, required — The default timezone of the biller. - `website` string — The website of the biller. - `categoryCode` string — The merchant category code (MCC) representing the business type. - `industryCode` string — The industry code that represents the industry of the biller. - `legalEntityType` 'organization' | 'soleProprietorship', required — The legal entity type of the biller. - `businessType` 'PRIVATE_COMPANY' | 'PUBLIC_COMPANY' | 'OTHER_COMPANY' | 'INCORPORATED_PARTNERSHIP' | 'UNINCORPORATED_PARTNERSHIP' | 'INDIVIDUAL' | 'NON_PROFIT' — The business type of the biller. - `vatRegistrationNo` string — The VAT registration number of the biller. - `billingEmail` string — The email address for billing purposes. - `emailDomain` string — The email domain of the biller. - `paymentDetails` PaymentDetails[] — The list of payment details associated with the biller. - `bankName` string — The name of the bank. - `sortCode` string — The sort code, without separators or whitespace. - `accountNo` string — The bank account number (without separators). - `accountType` string — The account type. For example: Main Account. - `bankAccounts` BankAccountResponse[] — The list of bank accounts associated with the biller. - `id` string — The unique identifier of the bank account. Absent when the response carries the payment details of the biller rather than a stored bank account. - `billerId` string, required — The unique identifier of the biller. - `name` string, required — The name of the bank account. - `paymentDetails` PaymentDetails — The payment details of the biller. - `bankName` string — The name of the bank. - `sortCode` string — The sort code, without separators or whitespace. - `accountNo` string — The bank account number (without separators). - `accountType` string — The account type. For example: Main Account. - `currencyCode` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SPL' | 'SRD' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWD', required — The currency of the bank account. - `countryCode` string, required — The default country code of the bank account. - `locations` Location[] — The registered business locations of the biller. - `address` Address — The address of a biller location - `id` string — The internal id of the address. - `city` string — The name of the city. - `postalCode` string — The postal code. - `country` string — The name of the biller country. - `addressLine1` string — The name of the street, and the house or building number. - `person` Person — The data defining a person. - `id` string — The internal id of the person. - `firstName` string — The first name of the person. - `lastName` string — The last name of the person. - `email` string — The email of the person. - `phoneNo` string — The phone number of the person. - `isPrimaryContact` boolean — True if this person is a primary contact. - `isIncludedInCommunications` boolean — True if this person is included in the customers communications. - `validForEmailCommunication` boolean - `validForPhoneCommunication` boolean - `status` 'PENDING' | 'RESTRICTED' | 'VERIFIED' | 'ACTIVE' | 'INACTIVE' | 'LAPSED' | 'BLACKLISTED' | 'CLOSED', required — The status of the biller. - `channelBillerId` string — The identifier of the biller associated with the payment provider. - `paymentSettings` PaymentSettingsResponse — Payment settings response details - `status` 'ACTIVE' | 'INACTIVE', required — The current status of payment settings, indicating if the payments can be processed or not. - `paymentMethods` PaymentMethodResponse[], required — The list of payment methods - `paymentMethod` 'BANK_PAYMENT' | 'CARD' | 'APPLE_PAY' | 'GOOGLE_PAY' | 'DIRECT_DEBIT' | 'IMPORTED' | 'MANUAL_BANK_TRANSFER' | 'BANK_TRANSFER' | 'AMEX', required — The method used for making the payment - `enabled` boolean, required — Indicates whether the payment method is enabled (true) or disabled (false). - `allowed` boolean, required — Indicates whether receiving payments via provided payment method is allowed. - `status` 'ACTIVE' | 'INACTIVE', required — The current payment method status - `amountLimits` AmountLimitResponse[], required — The amount limits - `min` string, required — The min amount limit - `max` string, required — The max amount limit - `currencyCode` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SPL' | 'SRD' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWD' — The currency in which the amount limit is applied - `paymentServiceProvider` string — The payment service provider handling this payment method - `entityId` string, required — The internal id of the entity for whom this payment setting was created. - `entityType` 'BILLER' | 'CUSTOMER' | 'INVOICE' | 'PAYMENT_REQUEST', required — Attribute that specifies the type of entity - `accountingSettings` AccountingSettingsResponse - `connectors` AccountingConnectorResponse[] — The list of available accounting connectors - `type` 'XERO' | 'QUICKBOOKS' | 'PLATFORM' — The accounting connector type - `status` 'CONNECTED' | 'NOT_CONNECTED' | 'PENDING' — The status of the accounting connector - `externalCode` string — The unique public facing identifier of the organisation - `collectionMethodSettings` CollectionMethodSettings — Settings used to determine how payments are collected (e.g. on demand or auto collect). - `onDemand` CollectionMethodSetting[] — The list of settings that configure on demand payment collection. - `externalId` string — The unique identifier of the collection method setting, such as a QuickBooks invoice term or a Xero branding theme ID. This value is used to match against the corresponding configuration in the external accounting platform. - `type` 'TERM' | 'BRANDING_THEME' — The type of the setting, indicating its source or format. - `autoCollect` CollectionMethodSetting[] — The list of settings that configure auto collect payment collection. - `externalId` string — The unique identifier of the collection method setting, such as a QuickBooks invoice term or a Xero branding theme ID. This value is used to match against the corresponding configuration in the external accounting platform. - `type` 'TERM' | 'BRANDING_THEME' — The type of the setting, indicating its source or format. - `actionHints` ActionHints - `reconnectRequired` boolean — Whether the user must re-auth/reconnect the accounting connector. - `disconnectionWarningRequired` boolean — Whether a disconnection warning banner should be displayed to the user. - `creationTime` string, date-time — The date and time when the biller was created. - `externalData` BillerExternalData[] — References about this biller from external platforms Adfin integrates with, such as ID, etc. - `connectorType` 'XERO' | 'QUICKBOOKS', required — The name of the platform for which this data is stored for. - `id` string, required — The ID of the Biller in the external platform. - `code` string — The code of the Biller in the external platform. - `type` 'STANDARD' | 'DEMO' | 'E2E', required — The type of the biller. ## Other responses - `404` — The biller is not found - `500` — Something went wrong processing your request --- [API](https://skmtc.dev/adfin/apis/adfin-api.md) · [All operations](https://skmtc.dev/adfin/apis/adfin-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/adfin/adfin-api/revisions/53d29f0850e0/schema)