--- title: "Get payer by its ID or external ID" method: GET path: "/v3/payers" tags: ["Payers"] --- # Get payer by its ID or external ID `GET /v3/payers` ## Request - Base URL: `https://api.sandbox.payall.com` - URL: `https://api.sandbox.payall.com/v3/payers` - Auth: OAuth 2 - Client credentials - Token URL: `/v2/oauth/token` This endpoint allows to retrieve payer by its ID or external ID. Either `id` or `external_id` must be provided. If both are provided then they both must match the same payer. ## Query parameters - `id` string, uuid: ID of the payer to get. - `external_id` string: External ID of the payer to get. ## Response `200` OK - union - PersonPayer: Abstract class. Use it's implementations instead. - `id` string, uuid - `accounts` AccountDetails[] - `id` string, uuid: Account id - `owner_id` string, uuid: Owner id - `owner_name` string: For individuals First name + Last name and for businesses Business Entity Title - `created` string, date-time: Account creation date - `number` string: Account reference - `name` string: Account name - `currency` string: Account currency - `balance` Amount - `currency` string, iso-4217, required - `value` integer, required: Amounts are always in the smallest currency unit. Example: 1000.23 EUR is represented as 100023 euro cents. - `type` 'Business' | 'Person', required - `external_id` string: ID from external system. - `first_name` string, required - `middle_name` string - `last_name` string, required - `phone_number` string - `registration_address` Address - `city` string - `street` string - `country` string - `postal_code` string - `unit_number` string - `building_name` string - `state_province` string - `building_number` string - `nationality` string - `government_id` string: Deprecated. Use `identity_document` instead. When `identity_document` is omitted, this value is used as the identity document number. - `identity_document` IdentityDocument - `type` string - `type_version_number` string - `country_issuing` string - `number` string - `national_id_number` string - `national_id_number_type` string - `series` string - `issue_date` string, date: Issue date of the identity document, in `YYYY-MM-DD` format. When provided, it must not be in the future — an issue date later than today is rejected when creating or updating a payer or recipient (see error codes PUB4221 for payers and PUB4222 for recipients). - `place_of_issue` string - `authority_of_issue` string - `expiry_date` string, date: Expiry date of the identity document, in `YYYY-MM-DD` format. When provided, it must not be in the past — an expired document is rejected when creating or updating a payer or recipient (see error codes PUB4219 for payers and PUB4220 for recipients). - `driver_license_number` string - `driver_license_serial_number` string - `driver_license_version_number` string - `date_of_birth` string, date - `source_of_income` string - `email` string - `place_of_birth` string - `occupation` 'general_worker' | 'businessman' | 'others' | 'professional' | 'tourist' | 'security_guard' | 'supervisor' | 'house_maid' | 'domestic_helper' | 'house_wife' - `relationship_with_beneficiary` string - `employer_name` string - `employer_country` string, iso-3166-alpha-2: Country of registration. 3166-1 alpha-2 value. Hint: It is `GB`, not `UK`. - `employer_industry` string - BusinessPayer: Abstract class. Use it's implementations instead. - `id` string, uuid - `accounts` AccountDetails[] - `id` string, uuid: Account id - `owner_id` string, uuid: Owner id - `owner_name` string: For individuals First name + Last name and for businesses Business Entity Title - `created` string, date-time: Account creation date - `number` string: Account reference - `name` string: Account name - `currency` string: Account currency - `balance` Amount - `currency` string, iso-4217, required - `value` integer, required: Amounts are always in the smallest currency unit. Example: 1000.23 EUR is represented as 100023 euro cents. - `type` 'Business' | 'Person', required - `external_id` string: ID from external system. - `legal_name` string, required - `trade_name` string - `country` string, iso-3166-alpha-2: Country of registration. 3166-1 alpha-2 value. Hint: It is `GB`, not `UK`. - `registration_number` string - `registration_date` string, date - `email` string: Business email - `phone_number` string: Business phone number - `registration_address` Address - `city` string - `street` string - `country` string - `postal_code` string - `unit_number` string - `building_name` string - `state_province` string - `building_number` string - `owners` BusinessOwner[] - `first_name` string, required - `middle_name` string - `last_name` string, required - `date_of_birth` string, date: Date of birth in ISO 8601 format (YYYY-MM-DD) - `job_title` string: Job title of the person at the related business. - `ownership` number: Represents a share percentage of the related business owned by this person. - `authorized_persons` AuthorizedPerson[] - `first_name` string, required - `middle_name` string - `last_name` string, required - `job_title` string: Job title of the person at the related business. - `email` string, email - `phone_number` string: E.164 phone number format - `organization_legal_structure` 'limited_liability_company' | 'limited_liability_partnership' | 'limited_partnership' | 'private_corporation' | 'public_corporation' | 'non_profit_corporation' | 'government_entity' | 'corporation' | 'partnership' | 'sole_proprietorship' | 'non_incorporated_entity': Specifies the legal structure of the organisation. A value outside this list is rejected. ## Other responses - `404`: Not found - payer could not be found --- [API](https://skmtc.dev/payall/apis/payall-m2m-authentication-api.md) - [All operations](https://skmtc.dev/payall/apis/payall-m2m-authentication-api/llms.txt) - [OpenAPI document](https://skmtc.dev/payall/apis/payall-m2m-authentication-api/revisions/5f561eccd6ce?raw)