# Retrieves a biller

Fetches the details of the authenticated user's associated biller. Returns a 404 if no biller is found.

Endpoint: GET /biller
Version: 1.0.0
Security: Biller Access Token (Staging), Biller Access Token (Production)

## Response 200 fields (application/json):

  - `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.

  - `alias` (string, required)
    The short name of the biller.

  - `registrationNo` (string, required)
    The registration number of the company.

  - `currencyCode` (string, required)
    The default currency of the biller.. 
Possible values (non-exclusive): 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

  - `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` (string, required)
    The legal entity type of the biller.. 
Possible values (non-exclusive): organization, soleProprietorship

  - `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` (array)
    The list of payment details associated with the biller.

  - `paymentDetails.bankName` (string)
    The name of the bank.

  - `paymentDetails.sortCode` (string)
    The sort code, without separators or whitespace.

  - `paymentDetails.accountNo` (string)
    The bank account number (without separators).

  - `paymentDetails.accountType` (string)
    The account type. For example: Main Account.

  - `bankAccounts` (array)
    The list of bank accounts associated with the biller.

  - `bankAccounts.id` (string, required)
    The unique identifier of the bank account.

  - `bankAccounts.billerId` (string, required)
    The unique identifier of the biller.

  - `bankAccounts.name` (string, required)
    The name of the bank account.

  - `bankAccounts.paymentDetails` (object)
    The payment details of the biller.

  - `bankAccounts.countryCode` (string, required)
    The default country code of the bank account.

  - `locations` (array)
    The registered business locations of the biller.

  - `locations.address` (object)
    The address of a biller location

  - `locations.address.id` (string)
    The internal id of the address.

  - `locations.address.city` (string)
    The name of the city.

  - `locations.address.postalCode` (string)
    The postal code.

  - `locations.address.country` (string)
    The name of the biller country.

  - `locations.address.addressLine1` (string)
    The name of the street, and the house or building number.

  - `locations.person` (object)
    The data defining a person.

  - `locations.person.id` (string)
    The internal id of the person.

  - `locations.person.firstName` (string)
    The first name of the person.

  - `locations.person.lastName` (string)
    The last name of the person.

  - `locations.person.email` (string)
    The email of the person.

  - `locations.person.phoneNo` (string)
    The phone number of the person.

  - `locations.person.isPrimaryContact` (boolean)
    True if this person is a primary contact.

  - `locations.person.isIncludedInCommunications` (boolean)
    True if this person is included in the customers communications.

  - `status` (string, required)
    The status of the biller. 
Possible values (non-exclusive): PENDING, VERIFIED, ACTIVE, INACTIVE, LAPSED, BLACKLISTED

  - `channelBillerId` (string)
    The identifier of the biller associated with the payment provider.

  - `paymentSettings` (object)
    Payment settings response details

  - `paymentSettings.status` (string, required)
    The current status of payment settings, indicating if the payments can be processed or not.. 
Possible values (non-exclusive): ACTIVE, INACTIVE

  - `paymentSettings.paymentMethods` (array, required)
    The list of payment methods

  - `paymentSettings.paymentMethods.paymentMethod` (string, required)
    Payment method types. 
Possible values (non-exclusive): BANK_PAYMENT, CARD, APPLE_PAY, GOOGLE_PAY, DIRECT_DEBIT, IMPORTED, MANUAL_BANK_TRANSFER, BANK_TRANSFER, AMEX

  - `paymentSettings.paymentMethods.enabled` (boolean, required)
    Indicates whether the payment method is enabled (true) or disabled (false).

  - `paymentSettings.paymentMethods.allowed` (boolean, required)
    Indicates whether receiving payments via provided payment method is allowed.

  - `paymentSettings.paymentMethods.status` (string, required)
    Statuses for payment method. 
Possible values (non-exclusive): ACTIVE, INACTIVE

  - `paymentSettings.paymentMethods.amountLimits` (array, required)
    The amount limits

  - `paymentSettings.paymentMethods.amountLimits.min` (string, required)
    The min amount limit

  - `paymentSettings.paymentMethods.amountLimits.max` (string, required)
    The max amount limit

  - `paymentSettings.entityId` (string, required)
    The internal id of the entity for whom this payment setting was created.

  - `paymentSettings.entityType` (string, required)
    Attribute that specifies the type of entity. 
Possible values (non-exclusive): BILLER, CUSTOMER, INVOICE, PAYMENT_REQUEST

  - `accountingSettings` (object)
    The accounting settings of the biller.

  - `accountingSettings.connectors` (array)
    The list of available accounting connectors

  - `accountingSettings.connectors.type` (string)
    The connector type. 
Possible values (non-exclusive): XERO, QUICKBOOKS, BRIDGE, STRIPE, PLATFORM

  - `accountingSettings.connectors.status` (string)
    The status of the accounting connector. 
Possible values (non-exclusive): CONNECTED, NOT_CONNECTED, PENDING

  - `accountingSettings.connectors.externalCode` (string)
    The unique public facing identifier of the organisation

  - `accountingSettings.connectors.collectionMethodSettings` (object)
    Settings used to determine how payments are collected (e.g. on demand or auto collect).

  - `accountingSettings.connectors.collectionMethodSettings.onDemand` (array)
    The list of settings that configure on demand payment collection.

  - `accountingSettings.connectors.collectionMethodSettings.onDemand.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.

  - `accountingSettings.connectors.collectionMethodSettings.onDemand.type` (string)
    The type of setting used to determine the collection method.. 
Possible values (non-exclusive): TERM, BRANDING_THEME

  - `accountingSettings.connectors.collectionMethodSettings.autoCollect` (array)
    The list of settings that configure auto collect payment collection.

  - `accountingSettings.connectors.actionHints` (object)
    User-facing prompts for follow-up actions

  - `accountingSettings.connectors.actionHints.reconnectRequired` (boolean)
    Whether the user must re-auth/reconnect the accounting connector.

  - `externalData` (array)
    References about this biller from external platforms Adfin integrates with, such as ID, etc.

  - `externalData.connectorType` (string, required)
    The biller connector type. 
Possible values (non-exclusive): XERO, QUICKBOOKS

  - `externalData.id` (string, required)
    The ID of the Biller in the external platform.

  - `externalData.code` (string)
    The code of the Biller in the external platform.


## Response 404 fields

## Response 500 fields