> This is Payabli documentation. For a complete page index, fetch https://docs.payabli.com/llms.txt — append .md to any page URL for lightweight markdown. For section-level indexes, query parameters, and other AI-optimized access methods, see https://docs.payabli.com/ai-agents.md

# Get basic paypoint details by ID

GET https://api-sandbox.payabli.com/api/Paypoint/basicById/{IdPaypoint}

Retrieves the basic details for a paypoint by ID.

Reference: https://docs.payabli.com/developers/api-reference/paypoint/get-paypoint-details-by-id

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.
- `requestToken` header (required) — Long-lived API token sent in the `requestToken` header. See [API token authentication](/developers/api-tokens).

## Servers

- `https://api-sandbox.payabli.com/api` (Sandbox, default)
- `https://api.payabli.com/api` (Production)

## Request

### Path parameters

- `IdPaypoint` (string, required) — Paypoint ID. You can find this value by querying `/api/Query/paypoints/{orgId}`

## Response

### 200

Success

- `isSuccess` (boolean, required) — Boolean indicating whether the operation was successful. A `true` value indicates success. A `false` value indicates failure.
- `responseText` (string, required) — Response text for operation: 'Success' or 'Declined'.
- `pageIdentifier` (string, optional) — Auxiliary validation used internally by payment pages and components.
- `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
- `responseData` (object, optional)
  - `EntryComment` (string, optional)
  - `EntryLogo` (string, optional)
  - `EntryName` (string, optional)
  - `EntryPages` (list of object, optional)
    - `AdditionalData` (map from string to map from string to any, optional) — Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using [custom identifiers](/developers/developer-guides/entities-customers), pass those in this object. Max length for a value is 100 characters. Example usage: ```json { "additionalData": { "key1": "value1", "key2": "value2", "key3": "value3" } } ```
    - `Credentials` (list of object, optional) — Array of credential objects with active services for the page
      - `accountId` (string, optional) — The identifier for the payment connector, matching the `accountId` of the linked bank account.
      - `cfeeFix` (double, optional)
      - `cfeeFloat` (double, optional)
      - `cfeeMax` (double, optional)
      - `cfeeMin` (double, optional)
      - `maxticket` (double, optional)
      - `minticket` (double, optional)
      - `mode` (integer, optional) — The payment mode supported by this service. `0` for one-time payments, `1` for recurring payments, `2` for both.
      - `referenceId` (long, optional)
      - `service` (string, optional) — The payment service that this credential applies to. A paypoint can support multiple services, each represented by its own credential object in the array. Possible values are `card` (credit/debit card), `ach` (ACH bank transfer), `check` (paper check), `vcard` (virtual card), `cloud` (card-present), `cash`, `managed` (managed payment service), and `wallet`.
      - `greaterValueAllowed` (boolean, optional) — When `true`, the customer can pay an amount greater than the invoice or bill amount.
      - `absorbDifference` (boolean, optional) — Whether the paypoint absorbs the difference between the configured service fee and the actual fee charged to the customer.
      - `allowOverride` (boolean, optional) — Whether the configured service fee can be overridden at the transaction level.
    - `LastAccess` (datetime, optional) — Timestamp of last access to page structure
    - `PageContent` (object, optional) — Sections of page
      - `amount` (object, optional) — Amount section of payment page
        - `categories` (list of object, optional)
          - `description` (string, optional)
          - `label` (string, optional)
          - `name` (string, optional)
          - `optionalPay` (boolean, optional)
          - `order` (integer, optional) — Order of element or section in container.
          - `quantity` (integer, optional)
          - `showDescription` (boolean, optional)
          - `type` (string, optional)
          - `value` (string, optional)
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `order` (integer, optional) — Order of element or section in container.
      - `autopay` (object, optional) — Autopay section of payment page
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `finish` (object, optional) — Type of end date
          - `calendar` (boolean, optional) — Flag to enable the 'calendar' option.
          - `untilCancelled` (boolean, optional) — Flag to enable the 'untilCancelled' option.
        - `frequency` (object, optional) — accepted frequencies for autopay
          - `annually` (boolean, optional) — Enable or disable the annual frequency.
          - `every2Weeks` (boolean, optional) — Enable or disable the every-two-weeks frequency.
          - `every3Months` (boolean, optional) — Enable or disable the every-three-months frequency.
          - `every6Months` (boolean, optional) — Enable or disable the every-six-months frequency.
          - `monthly` (boolean, optional) — Enable or disable the monthly frequency.
          - `onetime` (boolean, optional) — Enable or disable the one-time frequency.
          - `weekly` (boolean, optional) — Enable or disable the weekly frequency.
        - `frequencySelected` (string, optional) — Value of pre-selected frequency
        - `header` (string, optional) — Header text for section
        - `order` (integer, optional) — Order of element or section in container.
        - `startDate` (string, optional) — Range of days enabled in calendar. Leave empty to enable all days.
      - `contactUs` (object, optional) — ContactUs section of payment page
        - `emailLabel` (string, optional) — Custom content for email
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `header` (string, optional) — Header text for section
        - `order` (integer, optional) — Order of element or section in container.
        - `paymentIcons` (boolean, optional) — Flag indicating if icons for accepted card brands will be shown
        - `phoneLabel` (string, optional) — Custom content for phone number
      - `entry` (string, optional) — Identifier of entry point owner of page
      - `invoices` (object, optional) — Invoices section of payment page
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `invoiceLink` (object, optional) — Link to invoice
          - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
          - `label` (string, optional) — Label to display for section or element
          - `order` (integer, optional) — Order of element or section in container.
        - `order` (integer, optional) — Order of element or section in container.
        - `viewInvoiceDetails` (object, optional) — Link to view invoice details
          - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
          - `label` (string, optional) — Label to display for section or element
          - `order` (integer, optional) — Order of element or section in container.
      - `logo` (object, optional) — Logo section of payment page
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `order` (integer, optional) — Order of element or section in container.
      - `messageBeforePaying` (object, optional) — Message section of payment page
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `label` (string, optional) — Label to display for section or element
        - `order` (integer, optional) — Order of element or section in container.
      - `name` (string, optional) — Descriptor of page
      - `notes` (object, optional) — Notes section of payment page
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `header` (string, optional) — Header text for section
        - `order` (integer, optional) — Order of element or section in container.
        - `placeholder` (string, optional) — Placeholder text for input field
        - `value` (string, optional) — Pre-populated value for input field
      - `page` (object, optional) — Page header section of payment page
        - `description` (string, optional) — Page description in header
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `header` (string, optional) — Page header
        - `order` (integer, optional) — Order of element or section in container.
      - `paymentButton` (object, optional) — Payment button section of payment page
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `label` (string, optional) — Label to display for section or element
        - `order` (integer, optional) — Order of element or section in container.
      - `paymentMethods` (object, optional) — Payment methods section of payment page
        - `allMethodsChecked` (boolean, optional) — Flag indicating if all allowed payment methods will be pre-selected.
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `header` (string, optional) — Header text for section
        - `methods` (object, optional)
          - `amex` (boolean, optional) — When `true`, American Express is accepted.
          - `applePay` (boolean, optional) — When `true`, Apple Pay is accepted.
          - `googlePay` (boolean, optional) — When `true`, Google Pay is accepted.
          - `discover` (boolean, optional) — When `true`, Discover is accepted.
          - `eCheck` (boolean, optional) — When `true`, ACH is accepted.
          - `mastercard` (boolean, optional) — When `true`, Mastercard is accepted.
          - `visa` (boolean, optional) — When `true`, Visa is accepted.
          - `diners` (boolean, optional) — When `true`, Diners Club is accepted.
          - `jcb` (boolean, optional) — When `true`, JCB is accepted.
          - `rdc` (boolean, optional) — When `true`, Remote Deposit Capture (RDC) is accepted.
        - `order` (integer, optional) — Order of element or section in container.
        - `paymentDescription` (string, optional) — Description text shown in the payment methods section.
        - `settings` (object, optional) — Settings for wallet payment methods.
          - `applePay` (object, optional)
            - `buttonStyle` (enum, optional, default: black) — The Apple Pay button style. See [Apple Pay Button Style](/developers/developer-guides/hosted-payment-page-apple-pay#param-applepay-button-style) for more information.
            - `buttonType` (enum, optional, default: pay) — The text on Apple Pay button. See [Apple Pay Button Type](/developers/developer-guides/hosted-payment-page-apple-pay#param-applepay-button-type) for more information.
            - `language` (enum, optional, default: en-US) — The Apple Pay button locale. See [Apple Pay Button Language](/developers/developer-guides/hosted-payment-page-apple-pay#param-applepay-language) for more information.
        - `showSaveMethod` (boolean, optional, default: true) — Controls whether the "Save payment details for future use" checkbox appears on the hosted payment page. Set to `false` to hide the checkbox. Defaults to `true`.
      - `payor` (object, optional) — Customer/Payor section of payment page
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `fields` (list of object, optional) — Array of Customer/Payor fields to show in section
          - `display` (boolean, optional) — Flag indicating if the input field will show in container
          - `fixed` (boolean, optional) — Flag indicating if the value in input field is read-only or not.
          - `identifier` (boolean, optional) — Flag indicating if the input field is a customer identifier
          - `label` (string, optional) — Label to display for field
          - `name` (string, optional) — Name of field to show. Should be one of the standard customer fields or a custom field name
          - `order` (integer, optional) — Order of element or section in container.
          - `required` (boolean, optional) — Flag indicating if the input field is required for validation
          - `validation` (string, optional) — Type of validation to apply to the input field Accepted values: - alpha for alphabetical - numbers for numeric - text for alphanumeric - email for masked email address input - phone for US phone numbers
          - `value` (string, optional) — Pre-populated value for field
          - `width` (integer, optional) — Numeric value indicating the size of input relative to the container. Accepted values: - 4 = 1/3 - 6 = 1/2 - 8 = 2/3 - 12 = 3/3
        - `header` (string, optional) — Custom header text for section
        - `order` (integer, optional) — Order of element or section in container.
      - `review` (object, optional) — Review section of payment page
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `header` (string, optional) — Header text for section
        - `order` (integer, optional) — Order of element or section in container.
      - `subdomain` (string, optional) — Unique identifier assigned to the page.
    - `pageIdentifier` (string, optional) — Auxiliary validation used internally by payment pages and components.
    - `PageSettings` (object, optional) — Settings of page
      - `color` (string, optional) — An HTML color code in format #RRGGBB
      - `customCssUrl` (string, optional) — Complete URL to a custom CSS file to be loaded with the page
      - `language` (string, optional) — Two-letter code following ISO 639-1
      - `pageLogo` (object, optional) — Object containing logo file to upload/ use in page
        - `fContent` (string, optional) — Content of file, Base64-encoded. Ignored if `furl` is specified. Max upload size is 30 MB.
        - `filename` (string, optional) — The name of the attached file.
        - `ftype` (enum, optional) — The MIME type of the file (if content is provided).
          - Allowed values: `pdf`, `doc`, `docx`, `jpg`, `jpeg`, `png`, `gif`, `txt`
        - `furl` (string, optional) — Optional URL provided to show or download the file remotely.
      - `paymentButton` (object, optional)
        - `label` (string, required) — Label for custom payment button
        - `size` (enum, optional) — Specify size of custom payment button
          - Allowed values: `sm`, `md`, `lg`
      - `redirectAfterApprove` (boolean, optional) — Flag indicating if the capability for redirection in the page will be activated
      - `redirectAfterApproveUrl` (string, optional) — Complete URL where the page will be redirected after completion
    - `published` (integer, optional) — Flag indicating if page is active to accept payments. `0` for false, `1` for true.
    - `ReceiptContent` (object, optional) — Sections of payment receipt
      - `amount` (object, optional) — Section amount of payment receipt
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `order` (integer, optional) — Order of element or section in container.
      - `contactUs` (object, optional) — Section contactUs of payment receipt
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `order` (integer, optional) — Order of element or section in container.
      - `details` (object, optional) — Section payment details of payment receipt
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `order` (integer, optional) — Order of element or section in container.
      - `logo` (object, optional) — Section logo of payment receipt
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `order` (integer, optional) — Order of element or section in container.
      - `messageBeforeButton` (object, optional) — Section message of payment receipt
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `label` (string, optional) — Label to display for section or element
        - `order` (integer, optional) — Order of element or section in container.
      - `page` (object, optional) — Section page of payment receipt
        - `description` (string, optional) — Page description in header
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `header` (string, optional) — Page header
        - `order` (integer, optional) — Order of element or section in container.
      - `paymentButton` (object, optional) — Section payment button of payment receipt
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `label` (string, optional) — Label to display for section or element
        - `order` (integer, optional) — Order of element or section in container.
      - `paymentInformation` (object, optional) — Section payment information of payment receipt
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `order` (integer, optional) — Order of element or section in container.
      - `settings` (object, optional) — The receipt's settings.
        - `enabled` (boolean, optional) — Toggles whether the section or element is enabled.
        - `fields` (list of object, optional) — Fields to display on the receipt.
          - `display` (boolean, optional) — When `true`, the field is displayed on the receipt.
          - `Fixed` (boolean, optional) — This field is unused.
          - `name` (string, optional) — The field's name.
        - `order` (integer, optional) — Order of element or section in container.
        - `sendAuto` (boolean, optional, default: true) — When `true`, Payabli automatically sends the receipt to the payor email address.
        - `sendManual` (boolean, optional, default: false) — When `true`, you must send the receipt to the payor manually using the [/MoneyIn/sendreceipt/\{transId}](/developers/api-reference/moneyin/send-receipt-for-transaction) endpoint.
    - `Subdomain` (string, optional) — Page identifier. Must be unique in platform.
    - `totalAmount` (double, optional) — Total amount to pay in this page
    - `validationCode` (string, optional) — Base64 encoded image of CAPTCHA associated to this page load
  - `EntrySubtitle` (string, optional)
  - `EntryTitle` (string, optional)
  - `IdEntry` (long, optional)
  - `Paypoint` (object, optional)
    - `Address1` (string, optional) — The address.
    - `Address2` (string, optional) — Additional line for the address.
    - `BankData` (list of object, optional) — Information about associated bank accounts.
      - `default` (boolean, optional)
      - `country` (string, optional)
      - `id` (integer, optional) — The Payabli-assigned internal identifier for the bank account.
      - `accountId` (string, optional) — An identifier for the bank account, used to specify which account handles payments when multiple accounts are configured. If not provided during creation or update, the system generates one in the format `acct-{first_digit}xxxxx{last_4_digits}` based on the account number. The mask always uses five `x` characters regardless of account number length. For example, account number `123456789` produces `acct-1xxxxx6789`. If a duplicate exists within the same service at the paypoint, a numeric suffix is appended, such as `acct-1xxxxx6789-2`. This value is also used as the identifier for the bank account's associated payment connector.
      - `nickname` (string, optional) — User-defined name for the bank account.
      - `bankName` (string, optional) — Name of bank for account.
      - `routingAccount` (string, optional) — Routing number of bank account.
      - `accountNumber` (string, optional) — Account number for bank account. This value is returned masked in responses.
      - `typeAccount` (enum, optional) — Type of bank account: Checking or Savings.
        - Allowed values: `Checking`, `Savings`
      - `bankAccountHolderName` (string, optional) — The accountholder's name.
      - `bankAccountHolderType` (enum, optional) — Describes whether the bank is a personal or business account.
        - Allowed values: `Personal`, `Business`
      - `bankAccountFunction` (integer, optional) — Indicates the function of the bank account: - `0` — Deposits - `1` — Withdrawals - `2` — Deposits & Withdrawals - `3` — Remittances - `4` — Remittances & Deposits - `5` — Remittances & Withdrawals - `6` — Remittances & Withdrawals & Deposits A paypoint is required to have a single deposit and withdrawal account. A paypoint can have as many remittance accounts as needed for pay outs (remittances).
      - `verified` (boolean, optional) — Bank account verification status. When `true`, the account has been verified to exist and be in good standing based on vendor checks or previous processing histories.
      - `status` (integer, optional) — Bank account status
      - `services` (list of string, optional) — Array of services associated with this bank account
    - `BoardingId` (long, optional) — The Payabli-assigned ID of the boarding application linked to this paypoint.
    - `City` (string, optional) — The city.
    - `Contacts` (list of object, optional) — List of contacts.
      - `contactEmail` (string, optional) — Contact email address.
      - `contactName` (string, optional) — Contact name.
      - `contactPhone` (string, optional) — Contact phone number.
      - `contactTitle` (string, optional) — Contact title.
      - `additionalData` (string, optional) — Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage: ```json { "additionalData": { "key1": "value1", "key2": "value2", "key3": "value3" } } ```
    - `Country` (string, optional) — The country in ISO-3166-1 alpha 2 format. See [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) for reference.
    - `Credentials` (list of object, optional)
      - `Service` (string, optional) — The payment service that this credential applies to. A paypoint can support multiple services, each represented by its own credential object in the array. Possible values are `card` (credit/debit card), `ach` (ACH bank transfer), `check` (paper check), `vcard` (virtual card), `cloud` (card-present), `cash`, `managed` (managed payment service), and `wallet`.
      - `Mode` (integer, optional) — The payment mode supported by this service. `0` for one-time payments, `1` for recurring payments, `2` for both.
      - `MinTicket` (double, optional) — Minimum ticket amount for transactions within the paypoint. Contact Payabli support to request a change to this value.
      - `MaxTicket` (double, optional) — Maximum ticket amount for transactions within the paypoint. Contact Payabli support to request a change to this value.
      - `CfeeFix` (double, optional)
      - `CfeeFloat` (double, optional)
      - `CfeeMin` (double, optional)
      - `CfeeMax` (double, optional)
      - `AccountId` (string, optional) — The identifier for the payment connector, matching the `accountId` of the linked bank account.
      - `ReferenceId` (long, optional)
      - `Currency` (list of string, optional) — The default currency for the paypoint, either `USD` or `CAD`.
      - `GreaterValueAllowed` (boolean, optional) — When `true`, the customer can pay an amount greater than the invoice or bill amount.
      - `AbsorbDifference` (boolean, optional) — Whether the paypoint absorbs the difference between the configured service fee and the actual fee charged to the customer.
      - `AllowOverride` (boolean, optional) — Whether the configured service fee can be overridden at the transaction level.
      - `acceptSameDayACH` (boolean, optional)
    - `DbaName` (string, optional) — The alternate or common name that this business is doing business under, usually referred to as a DBA name.
    - `externalPaypointID` (string, optional) — A custom identifier for the paypoint, if applicable.
    - `Fax` (string, optional) — Fax number
    - `IdPaypoint` (long, optional) — The paypoint's ID in Payabli.
    - `LegalName` (string, optional) — Business legal name.
    - `ParentOrg` (object, optional)
      - `idOrg` (long, optional) — Organization ID. Unique identifier assigned to an org by Payabli.
      - `orgAddress` (string, optional) — The organization's address.
      - `orgLogo` (object, optional) — Contains details about a file. Max upload size is 30 MB.
        - `fContent` (string, optional) — Content of file, Base64-encoded. Ignored if `furl` is specified. Max upload size is 30 MB.
        - `filename` (string, optional) — The name of the attached file.
        - `ftype` (enum, optional) — The MIME type of the file (if content is provided).
          - Allowed values: `pdf`, `doc`, `docx`, `jpg`, `jpeg`, `png`, `gif`, `txt`
        - `furl` (string, optional) — Optional URL provided to show or download the file remotely.
      - `orgName` (string, optional) — The name of the organization.
      - `orgStatus` (integer, optional) — The paypoint's status. Active - `1` Inactive - 0
      - `orgType` (integer, optional) — The organization type. Currently, this must be `0`.
    - `PaypointStatus` (integer, optional) — The paypoint's status. - `1` — Active - `0` — Inactive
    - `Phone` (string, optional) — Phone number.
    - `ServiceData` (object, optional) — Controls which services will be enabled for the merchant.
      - `ach` (object, optional) — Configuration for which ACH SEC codes the user is allowed to use.
        - `acceptCCD` (boolean, optional) — CCD is an ACH SEC Code that can be used in ACH transactions by the user that indicates the transaction is a Corporate Credit or Debit Entry.
        - `acceptPPD` (boolean, optional) — PPD is an ACH SEC Code that can be used in ACH transactions by the user that indicates the transaction is a Prearranged Payment and Deposit.
        - `acceptWeb` (boolean, optional) — Web is an ACH SEC Code that can be used in ACH transactions by the user that indicates the transaction is an Internet-Initiated/Mobile Entry.
      - `card` (object, optional)
        - `acceptAmex` (boolean, optional) — Determines whether American Express is accepted.
        - `acceptDiscover` (boolean, optional) — Determines whether Discover is accepted.
        - `acceptMastercard` (boolean, optional) — Determines whether Mastercard is accepted.
        - `acceptVisa` (boolean, optional) — Determines whether Visa is accepted.
      - `odp` (object, optional)
        - `allowAch` (boolean, optional) — Enables or disables ACH payout functionality
        - `allowChecks` (boolean, optional) — Enables or disables check printing payout functionality
        - `allowVCard` (boolean, optional) — Enables or disables vCard payout functionality
        - `processing_region` (enum, optional) — Region where payment processing occurs
          - Allowed values: `US`, `CA`
        - `processor` (string, optional) — Payment processor identifier
        - `issuerNetworkSettingsId` (string, optional) — Reference ID for the program enabled for ODP issuance
    - `State` (string, optional) — The state or province.
    - `Summary` (string, optional) — This business description is captured during boarding. It differs from `summary`, which reports counts of customers, transactions, and subscriptions attached to the paypoint.
    - `summary` (object, optional)
      - `amountSubs` (double, optional)
      - `amountTx` (double, optional)
      - `countSubs` (integer, optional)
      - `countTx` (integer, optional)
      - `customers` (integer, optional)
    - `TimeZone` (integer, optional) — Timezone, in UTC offset. For example, -5 is Eastern time.
    - `WebsiteAddress` (string, optional) — The business website address. Include only the domain and TLD, do not enter the protocol (`http`/`https`). For example: `www.example.com` is acceptable.
    - `Zip` (string, optional) — ZIP code for address.
    - `StatementEmail` (object, optional) — Configuration for billing statement email recipients and sender address. `null` if not configured.
      - `sender` (string, optional) — The email address from which statements are sent. Always uses a Payabli domain, for example `acme-partners@payabli.com`. If `null`, `noreply@payabli.com` is used.
      - `recipients` (list of string, optional) — List of email addresses that receive billing statements. These are merchant or partner contacts.

## Errors

### 400 Bad Request Error

Bad request / invalid data.

- `isSuccess` (boolean, required) — Always `false` for error responses.
- `responseText` (string, required) — Error text describing what went wrong.
- `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
- `responseData` (object, optional) — Object with detailed error context.
  - `explanation` (string, optional) — Human-readable explanation of what happened.
  - `todoAction` (string, optional) — Suggested resolution.

### 401 Unauthorized Error

Unauthorized request.

- `isSuccess` (boolean, required) — Always `false` for error responses.
- `responseText` (string, required) — Error text describing what went wrong.
- `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
- `responseData` (object, optional) — Object with detailed error context.
  - `explanation` (string, optional) — Human-readable explanation of what happened.
  - `todoAction` (string, optional) — Suggested resolution.

### 500 Internal Server Error

Internal server error.

- `isSuccess` (boolean, required) — Always `false` for error responses.
- `responseText` (string, required) — Error text describing what went wrong.
- `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
- `responseData` (object, optional) — Object with detailed error context.
  - `explanation` (string, optional) — Human-readable explanation of what happened.
  - `todoAction` (string, optional) — Suggested resolution.

### 503 Service Unavailable Error

Database connection error.

- `isSuccess` (boolean, required) — Always `false` for error responses.
- `responseText` (string, required) — Error text describing what went wrong.
- `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
- `responseData` (object, optional) — Object with detailed error context.
  - `explanation` (string, optional) — Human-readable explanation of what happened.
  - `todoAction` (string, optional) — Suggested resolution.

## Examples

**Response**

```json
{
  "isSuccess": true,
  "responseText": "Success",
  "responseCode": 1,
  "responseData": {
    "EntryName": "8cfec329267",
    "EntryPages": [
      {
        "AdditionalData": {
          "key1": {
            "key": "value"
          },
          "key2": {
            "key": "value"
          },
          "key3": {
            "key": "value"
          }
        }
      }
    ],
    "IdEntry": 11111,
    "Paypoint": {
      "Address1": "123 Ocean Drive",
      "Address2": "Suite 400",
      "BankData": [
        {
          "nickname": "Business Checking 1234",
          "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
          "bankAccountFunction": 0
        }
      ],
      "BoardingId": 340,
      "City": "Bristol",
      "Contacts": [
        {}
      ],
      "Country": "US",
      "Credentials": [
        {}
      ],
      "DbaName": "Sunshine Gutters",
      "externalPaypointID": "",
      "Fax": "5555555555",
      "IdPaypoint": 1000000,
      "LegalName": "Sunshine Services, LLC",
      "ParentOrg": {
        "orgName": "Pilgrim Planner",
        "orgStatus": 1,
        "orgType": 0
      },
      "PaypointStatus": 1,
      "Phone": "5555555555",
      "State": "GA",
      "Summary": "Residential and commercial gutter installation and repair.",
      "summary": {
        "amountSubs": 0,
        "amountTx": 0,
        "countSubs": 0,
        "countTx": 0,
        "customers": 1
      },
      "TimeZone": -5,
      "WebsiteAddress": "www.example.com",
      "Zip": "31113"
    }
  }
}
```

**SDK Code**

```typescript
import { PayabliClient } from "@payabli/sdk-node";

async function main() {
    const client = new PayabliClient({
        clientId: "YOUR_CLIENT_ID",
        clientSecret: "YOUR_CLIENT_SECRET",
    });
    await client.paypoint.getBasicEntryById("198");
}
main();

```

```python
from payabli import payabli

client = payabli(
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)

client.paypoint.get_basic_entry_by_id(
    id_paypoint="198",
)

```

```java
package com.example.usage;

import io.github.payabli.api.PayabliApiClient;

public class Example {
    public static void main(String[] args) {
        PayabliApiClient client = PayabliApiClient.withCredentials("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET")
            .build()
        ;

        client.paypoint().getBasicEntryById("198");
    }
}
```

```ruby
require "payabli"

client = Payabli::Client.new(api_key: "YOUR_API_KEY_HERE")

client.paypoint.get_basic_entry_by_id(id_paypoint: "198")

```

```csharp
using PayabliApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new PayabliApiClient(
            clientId: "YOUR_CLIENT_ID",
            clientSecret: "YOUR_CLIENT_SECRET"
        );

        await client.Paypoint.GetBasicEntryByIdAsync(
            "198"
        );
    }

}

```

```go
package example

import (
    context "context"

    client "github.com/payabli/sdk-go/client"
    option "github.com/payabli/sdk-go/option"
)

func do() {
    client := client.NewClient(
        option.WithClientCredentials(
            "YOUR_CLIENT_ID",
            "YOUR_CLIENT_SECRET",
        ),
    )
    client.Paypoint.GetBasicEntryById(
        context.TODO(),
        "198",
    )
}

```

```php
<?php

namespace Example;

use Payabli\PayabliClient;

$client = new PayabliClient(
    clientId: 'YOUR_CLIENT_ID',
    clientSecret: 'YOUR_CLIENT_SECRET',
);
$client->paypoint->getBasicEntryById(
    '198',
);

```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Paypoint/basicById/198")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```