ADadfin
Biller

Retrieves a biller

Changed on

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

get/biller

Request

  • Base URL
    https://api.adfin.com/api
  • URL
    https://api.adfin.com/api/biller
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.staging.adfin.com/api/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: https://api.adfin.com/api/oauth2/token

Response

The biller details retrieved successfully

idstring required

The unique identifier of the biller.

namestring required

The legal registration name of the company.

statementNamestring required

The biller statement name shown on bank and credit card statements.

directDebitStatementNamestring

The biller statement name shown on Direct Debit bank statements.

aliasstring required

The short name of the biller.

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

countryCodestring required

The default country code of the biller.

timezonestring required

The default timezone of the biller.

websitestring

The website of the biller.

categoryCodestring

The merchant category code (MCC) representing the business type.

industryCodestring

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.

vatRegistrationNostring

The VAT registration number of the biller.

billingEmailstring

The email address for billing purposes.

emailDomainstring

The email domain of the biller.

status'PENDING' | 'RESTRICTED' | 'VERIFIED' | 'ACTIVE' | 'INACTIVE' | 'LAPSED' | 'BLACKLISTED' | 'CLOSED' required

The status of the biller.

channelBillerIdstring

The identifier of the biller associated with the payment provider.

creationTimestring date-time

The date and time when the biller was created.

type'STANDARD' | 'DEMO' | 'E2E' required

The type of the biller.

Example response

{
  "bankAccounts": [
    {
      "bankDetails": {
        "sortCode": "200000",
        "accountNo": "****9911"
      }
    }
  ]
}

Changes

  • c5c5c6f3995dRevision changes
    • breaking

      the ////// response's property type changed from no type to object for status

    • breaking

      the ////// response's property type changed from no type to object for status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      removed subschema #2 from the ////// response property allOf list for the response status

    • info

      removed subschema #2 from the ////// response property allOf list for the response status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

  • 2598fd269be5Revision changes
    • info

      added the optional property // to the response with the status