# Get payment page

GET https://api-sandbox.payabli.com/api/Paypoint/{entry}/{subdomain}

Gets the details for single payment page for a paypoint. 

Reference: https://docs.payabli.com/developers/api-reference/hostedpaymentpages/get-payment-page-details

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Get payment page details
  version: endpoint_paypoint.getPage
paths:
  /Paypoint/{entry}/{subdomain}:
    get:
      operationId: get-page
      summary: Get payment page details
      description: 'Gets the details for single payment page for a paypoint. '
      tags:
        - - subpackage_paypoint
      parameters:
        - name: entry
          in: path
          description: >-
            The paypoint's entrypoint identifier. [Learn
            more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
        - name: subdomain
          in: path
          description: >-
            Payment page identifier. The subdomain value is the last portion of
            the payment page URL. For example,
            in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`,
            the subdomain is `pay-your-fees-1`.
          required: true
          schema:
            type: string
        - name: requestToken
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_:PayabliPages'
        '400':
          description: Bad request/ invalid data
          content: {}
        '401':
          description: Unauthorized request.
          content: {}
        '500':
          description: Internal API Error
          content: {}
        '503':
          description: Database connection error
          content: {}
components:
  schemas:
    type_:AdditionalData:
      type: object
      additionalProperties:
        type: object
        additionalProperties:
          description: Any type
    type_:PayabliCredentials:
      type: object
      properties:
        accountId:
          type: string
        cfeeFix:
          type: number
          format: double
        cfeeFloat:
          type: number
          format: double
        cfeeMax:
          type: number
          format: double
        cfeeMin:
          type: number
          format: double
        maxticket:
          type: number
          format: double
        minticket:
          type: number
          format: double
        mode:
          type: integer
        referenceId:
          type: integer
          format: int64
        service:
          type: string
    type_:Order:
      type: integer
    type_:PayCategory:
      type: object
      properties:
        description:
          type: string
        label:
          type: string
        name:
          type: string
        optionalPay:
          type: boolean
        order:
          $ref: '#/components/schemas/type_:Order'
        quantity:
          type: integer
        showDescription:
          type: boolean
        type:
          type: string
        value:
          type: string
    type_:Enabled:
      type: boolean
    type_:AmountElement:
      type: object
      properties:
        categories:
          type: array
          items:
            $ref: '#/components/schemas/type_:PayCategory'
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        order:
          $ref: '#/components/schemas/type_:Order'
    type_:Finishtype:
      type: object
      properties:
        calendar:
          type: boolean
          description: Flag to enable 'calendar' option
        untilCancelled:
          type: boolean
          description: Flag to enable 'untilCancelled' option
    type_:FrequencyList:
      type: object
      properties:
        annually:
          type: boolean
          description: Enable or disable frequency
        every2Weeks:
          type: boolean
          description: Enable or disable frequency
        every3Months:
          type: boolean
          description: Enable or disable frequency
        every6Months:
          type: boolean
          description: Enable or disable frequency
        monthly:
          type: boolean
          description: Enable or disable frequency
        onetime:
          type: boolean
          description: Enable or disable frequency
        weekly:
          type: boolean
          description: Enable or disable frequency
    type_:AutoElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        finish:
          $ref: '#/components/schemas/type_:Finishtype'
          description: Type of end date
        frequency:
          $ref: '#/components/schemas/type_:FrequencyList'
          description: accepted frequencies for autopay
        frequencySelected:
          type: string
          description: Value of pre-selected frequency
        header:
          type: string
          description: Header text for section
        order:
          $ref: '#/components/schemas/type_:Order'
        startDate:
          type: string
          description: Range of days enabled in calendar. Leave empty to enable all days.
    type_:ContactElement:
      type: object
      properties:
        emailLabel:
          type: string
          description: Custom content for email
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        header:
          type: string
          description: Header text for section
        order:
          $ref: '#/components/schemas/type_:Order'
        paymentIcons:
          type: boolean
          description: Flag indicating if icons for accepted card brands will be shown
        phoneLabel:
          type: string
          description: Custom content for phone number
    type_:LabelElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        label:
          type: string
          description: Label to display for section or element
        order:
          $ref: '#/components/schemas/type_:Order'
    type_:InvoiceElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        invoiceLink:
          $ref: '#/components/schemas/type_:LabelElement'
          description: Link to invoice
        order:
          $ref: '#/components/schemas/type_:Order'
        viewInvoiceDetails:
          $ref: '#/components/schemas/type_:LabelElement'
          description: Link to view invoice details
    type_:Element:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        order:
          $ref: '#/components/schemas/type_:Order'
    type_:NoteElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        header:
          type: string
          description: Header text for section
        order:
          $ref: '#/components/schemas/type_:Order'
        placeholder:
          type: string
          description: Placeholder text for input field
        value:
          type: string
          description: Pre-populated value for input field
    type_:PageElement:
      type: object
      properties:
        description:
          type: string
          description: Page description in header
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        header:
          type: string
          description: Page header
        order:
          $ref: '#/components/schemas/type_:Order'
    type_:MethodsList:
      type: object
      properties:
        amex:
          type: boolean
          description: When `true`, American Express is accepted.
        applePay:
          type: boolean
          description: When `true`, Apple Pay is accepted.
        googlePay:
          type: boolean
          description: When `true`, Google Pay is accepted.
        discover:
          type: boolean
          description: When `true`, Discover is accepted.
        eCheck:
          type: boolean
          description: When `true`, ACH is accepted.
        mastercard:
          type: boolean
          description: When `true`, Mastercard is accepted.
        visa:
          type: boolean
          description: When `true`, Visa is accepted.
    type_:MethodElementSettingsApplePayButtonStyle:
      type: string
      enum:
        - value: black
        - value: white-outline
        - value: white
      default: black
    type_:MethodElementSettingsApplePayButtonType:
      type: string
      enum:
        - value: plain
        - value: buy
        - value: donate
        - value: check-out
        - value: book
        - value: continue
        - value: top-up
        - value: order
        - value: rent
        - value: support
        - value: contribute
        - value: tip
        - value: pay
      default: pay
    type_:MethodElementSettingsApplePayLanguage:
      type: string
      enum:
        - value: en-US
        - value: ar-AB
        - value: ca-ES
        - value: zh-CN
        - value: zh-HK
        - value: zh-TW
        - value: hr-HR
        - value: cs-CZ
        - value: da-DK
        - value: de-DE
        - value: nl-NL
        - value: en-AU
        - value: en-GB
        - value: fi-FI
        - value: fr-CA
        - value: fr-FR
        - value: el-GR
        - value: he-IL
        - value: hi-IN
        - value: hu-HU
        - value: id-ID
        - value: it-IT
        - value: ja-JP
        - value: ko-KR
        - value: ms-MY
        - value: nb-NO
        - value: pl-PL
        - value: pt-BR
        - value: pt-PT
        - value: ro-RO
        - value: ru-RU
        - value: sk-SK
        - value: es-MX
        - value: es-ES
        - value: sv-SE
        - value: th-TH
        - value: tr-TR
        - value: uk-UA
        - value: vi-VN
      default: en-US
    type_:MethodElementSettingsApplePay:
      type: object
      properties:
        buttonStyle:
          $ref: '#/components/schemas/type_:MethodElementSettingsApplePayButtonStyle'
          description: >-
            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:
          $ref: '#/components/schemas/type_:MethodElementSettingsApplePayButtonType'
          description: >-
            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:
          $ref: '#/components/schemas/type_:MethodElementSettingsApplePayLanguage'
          description: >-
            The Apple Pay button locale. See [Apple Pay Button
            Language](/developers/developer-guides/hosted-payment-page-apple-pay#param-applepay-language)
            for more information.
    type_:MethodElementSettings:
      type: object
      properties:
        applePay:
          $ref: '#/components/schemas/type_:MethodElementSettingsApplePay'
    type_:MethodElement:
      type: object
      properties:
        allMethodsChecked:
          type: boolean
          description: Flag indicating if all allowed payment methods will be pre-selected.
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        header:
          type: string
          description: Header text for section
        methods:
          $ref: '#/components/schemas/type_:MethodsList'
        order:
          $ref: '#/components/schemas/type_:Order'
        settings:
          $ref: '#/components/schemas/type_:MethodElementSettings'
          description: Settings for wallet payment methods.
    type_:PayorFields:
      type: object
      properties:
        display:
          type: boolean
          description: Flag indicating if the input field will show in container
        fixed:
          type: boolean
          description: Flag indicating if the value in input field is read-only or not.
        identifier:
          type: boolean
          description: Flag indicating if the input field is a customer identifier
        label:
          type: string
          description: Label to display for field
        name:
          type: string
          description: >-
            Name of field to show. Should be one of the standard customer fields
            or a custom field name
        order:
          $ref: '#/components/schemas/type_:Order'
        required:
          type: boolean
          description: Flag indicating if the input field is required for validation
        validation:
          type: string
          description: |-
            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:
          type: string
          description: Pre-populated value for field
        width:
          type: integer
          description: >-
            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
    type_:PayorElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        fields:
          type: array
          items:
            $ref: '#/components/schemas/type_:PayorFields'
          description: Array of Customer/Payor fields to show in section
        header:
          type: string
          description: Custom header text for section
        order:
          $ref: '#/components/schemas/type_:Order'
    type_:HeaderElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        header:
          type: string
          description: Header text for section
        order:
          $ref: '#/components/schemas/type_:Order'
    type_:Subdomain:
      type: string
    type_:PageContent:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/type_:AmountElement'
          description: Amount section of payment page
        autopay:
          $ref: '#/components/schemas/type_:AutoElement'
          description: Autopay section of payment page
        contactUs:
          $ref: '#/components/schemas/type_:ContactElement'
          description: ContactUs section of payment page
        entry:
          type: string
          description: Identifier of entry point owner of page
        invoices:
          $ref: '#/components/schemas/type_:InvoiceElement'
          description: Invoices section of payment page
        logo:
          $ref: '#/components/schemas/type_:Element'
          description: Logo section of payment page
        messageBeforePaying:
          $ref: '#/components/schemas/type_:LabelElement'
          description: Message section of payment page
        name:
          type: string
          description: Descriptor of page
        notes:
          $ref: '#/components/schemas/type_:NoteElement'
          description: Notes section of payment page
        page:
          $ref: '#/components/schemas/type_:PageElement'
          description: Page header section of payment page
        paymentButton:
          $ref: '#/components/schemas/type_:LabelElement'
          description: Payment button section of payment page
        paymentMethods:
          $ref: '#/components/schemas/type_:MethodElement'
          description: Payment methods section of payment page
        payor:
          $ref: '#/components/schemas/type_:PayorElement'
          description: Customer/Payor section of payment page
        review:
          $ref: '#/components/schemas/type_:HeaderElement'
          description: Review section of payment page
        subdomain:
          $ref: '#/components/schemas/type_:Subdomain'
          description: Unique identifier assigned to the page.
    type_:PageIdentifier:
      type: string
    type_:FileContentFtype:
      type: string
      enum:
        - value: pdf
        - value: doc
        - value: docx
        - value: jpg
        - value: jpeg
        - value: png
        - value: gif
        - value: txt
    type_:FileContent:
      type: object
      properties:
        fContent:
          type: string
          description: >-
            Content of file, Base64-encoded. Ignored if furl is specified. Max
            upload size is 30 MB.
        filename:
          type: string
          description: The name of the attached file.
        ftype:
          $ref: '#/components/schemas/type_:FileContentFtype'
          description: The MIME type of the file (if content is provided)
        furl:
          type: string
          description: Optional URL provided to show or download the file remotely
    type_:ButtonElementSize:
      type: string
      enum:
        - value: sm
        - value: md
        - value: lg
    type_:ButtonElement:
      type: object
      properties:
        label:
          type: string
          description: Label for custom payment button
        size:
          $ref: '#/components/schemas/type_:ButtonElementSize'
          description: Specify size of custom payment button
      required:
        - label
    type_:PageSetting:
      type: object
      properties:
        color:
          type: string
          description: 'An HTML color code in format #RRGGBB'
        customCssUrl:
          type: string
          description: Complete URL to a custom CSS file to be loaded with the page
        language:
          type: string
          description: Two-letter code following ISO 639-1
        pageLogo:
          $ref: '#/components/schemas/type_:FileContent'
          description: Object containing logo file to upload/ use in page
        paymentButton:
          $ref: '#/components/schemas/type_:ButtonElement'
        redirectAfterApprove:
          type: boolean
          description: >-
            Flag indicating if the capability for redirection in the page will
            be activated
        redirectAfterApproveUrl:
          type: string
          description: Complete URL where the page will be redirected after completion
    type_:DisplayProperty:
      type: object
      properties:
        display:
          type: boolean
          description: When `true`, the field is displayed on the receipt.
        Fixed:
          type: boolean
          description: This field is unused.
        name:
          type: string
          description: The field's name.
    type_:SettingElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        fields:
          type: array
          items:
            $ref: '#/components/schemas/type_:DisplayProperty'
          description: Fields to display on the reciept.
        order:
          $ref: '#/components/schemas/type_:Order'
        sendAuto:
          type: boolean
          default: true
          description: >-
            When `true`, Payabli automatically sends the receipt to the payor
            email address.
        sendManual:
          type: boolean
          default: false
          description: >-
            When `true`, you must send the reciept to the payor manually using
            the
            [/MoneyIn/sendreceipt/\{transId\}](/developers/api-reference/moneyin/send-receipt-for-transaction)
            endpoint.
    type_:ReceiptContent:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/type_:Element'
          description: Section amount of payment receipt
        contactUs:
          $ref: '#/components/schemas/type_:Element'
          description: Section contactUs of payment receipt
        details:
          $ref: '#/components/schemas/type_:Element'
          description: Section payment details of payment receipt
        logo:
          $ref: '#/components/schemas/type_:Element'
          description: Section logo of payment receipt
        messageBeforeButton:
          $ref: '#/components/schemas/type_:LabelElement'
          description: Section message of payment receipt
        page:
          $ref: '#/components/schemas/type_:PageElement'
          description: Section page of payment receipt
        paymentButton:
          $ref: '#/components/schemas/type_:LabelElement'
          description: Section payment button of payment receipt
        paymentInformation:
          $ref: '#/components/schemas/type_:Element'
          description: Section payment information of payment receipt
        settings:
          $ref: '#/components/schemas/type_:SettingElement'
          description: The receipt's settings.
    type_:PayabliPages:
      type: object
      properties:
        AdditionalData:
          $ref: '#/components/schemas/type_:AdditionalData'
        credentials:
          type: array
          items:
            $ref: '#/components/schemas/type_:PayabliCredentials'
          description: Array of credential objects with active services for the page
        lastAccess:
          type: string
          format: date-time
          description: Timestamp of last access to page structure
        pageContent:
          $ref: '#/components/schemas/type_:PageContent'
          description: Sections of page
        pageIdentifier:
          $ref: '#/components/schemas/type_:PageIdentifier'
        pageSettings:
          $ref: '#/components/schemas/type_:PageSetting'
          description: Settings of page
        published:
          type: integer
          description: >-
            Flag indicating if page is active to accept payments. `0` for false,
            `1` for true.
        receiptContent:
          $ref: '#/components/schemas/type_:ReceiptContent'
          description: Sections of payment receipt
        subdomain:
          $ref: '#/components/schemas/type_:Subdomain'
          description: Page identifier. Must be unique in platform.
        totalAmount:
          type: number
          format: double
          description: Total amount to pay in this page
        validationCode:
          type: string
          description: Base64 encoded image of CAPTCHA associated to this page load

```

## SDK Code Examples

```python
from payabli import payabli

client = payabli(
    api_key="YOUR_API_KEY",
)
client.paypoint.get_page(
    entry="8cfec329267",
    subdomain="pay-your-fees-1",
)

```

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

const client = new PayabliClient({ apiKey: "YOUR_API_KEY" });
await client.paypoint.getPage("8cfec329267", "pay-your-fees-1");

```

```go
import (
	context "context"
	option "github.com/payabli/sdk-go/option"
	sdkgoclient "github.com/payabli/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.Paypoint.GetPage(
	context.TODO(),
	"8cfec329267",
	"pay-your-fees-1",
)

```

```csharp
using PayabliApi;

var client = new PayabliApiClient("API_KEY");
await client.Paypoint.GetPageAsync("8cfec329267", "pay-your-fees-1");

```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/Paypoint/8cfec329267/pay-your-fees-1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["requestToken"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/Paypoint/8cfec329267/pay-your-fees-1")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/Paypoint/8cfec329267/pay-your-fees-1', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```swift
import Foundation

let headers = ["requestToken": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Paypoint/8cfec329267/pay-your-fees-1")! 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()
```