Payabli Paypoint API is one of 33 APIs that Payabli publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Paypoint. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
8 operations
across 7 paths,
and defines 106 schemas.
It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api-sandbox.payabli.com/api, https://api.payabli.com/api.
The identity and technical contract details declared by the specification.
Idpaypoint
integer
The paypoint's ID in Payabli.
ContactsField
array
List of contacts.
ContactElement
object
6 properties
AccountId
string
Custom identifier for payment connector.
MethodElementSettingsApplePayButtonStyle
string
The Apple Pay button style. See [Apple Pay Button Style](/developers/developer-guides/hosted-payment-page-apple-payparam-applepay-button-style) for more inform…
OdpSetupProcessingRegion
string
Region where payment processing occurs.
BankName
string
Name of bank for account.
MinTicket
number
Minimum ticket amount for transactions within the paypoint. Contact Payabli support to request a change to this value.
PayabliErrorBodyResponseData
object
Object with detailed error context.
2 properties
Enabled
boolean
Toggles whether the section or element is enabled.
FrequencyList
object
7 properties
Email
string
Email address.
CityNullable
string
The city.
PayabliCredentialsPascal
object
15 properties
Element
object
2 properties
NotificationRequest
object
2 properties
1 required
Entrypointfield
string
The entrypoint identifier.
PageIdentifier
string
Auxiliary validation used internally by payment pages and components.
OrgData
object
6 properties
AbsorbDifference
boolean
Whether the paypoint absorbs the difference between the configured service fee and the actual fee charged to the customer.
PayabliCredentials
object
13 properties
FileContent
object
Contains details about a file. Max upload size is 30 MB.
4 properties
HeaderElement
object
3 properties
Order
integer
Order of element or section in container.
ResponseText
string
Response text for operation: 'Success' or 'Declined'.
PayabliApiResponse00Responsedatanonobject
object
6 properties
1 required
BankAccountFunction
integer
Indicates the function of the bank account: - 0 — Deposits - 1 — Withdrawals - 2 — Deposits & Withdrawals - 3 — Remittances - 4 — Remittances & Deposits - 5 —…
PaypointSummary
object
5 properties
PayabliApiResponseGeneric2Part
object
Minimal response wrapper used by approval-style endpoints that don't carry the standard response envelope.
2 properties
1 required
Subdomain
string
Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.
OdpSetup
object
6 properties
PayabliErrorBody
object
Shape returned by every Payabli API error response. The responseData object carries human-readable error context.
4 properties
2 required
PageSetting
object
7 properties
NoteElement
object
5 properties
DisplayProperty
object
3 properties
MethodElementSettings
object
Settings for wallet payment methods.
1 property
BankAccountHolderType
string
Describes whether the bank is a personal or business account.
CountryNullable
string
The country in ISO-3166-1 alpha 2 format. See [ISO 3166-1](https://en.wikipedia.org/wiki/ISO3166-1) for reference.
AdditionalDataString
string
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"…
RoutingAccount
string
Routing number of bank account.
ButtonElementSize
string
Specify the size of the custom payment button.
Bank
object
Object that contains bank account details.
15 properties
IsSuccess
boolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
AllowOverride
boolean
Whether the configured service fee can be overridden at the transaction level.
Orgaddress
string
The organization's address.
InvoiceElement
object
4 properties
Dbaname
string
The alternate or common name that this business is doing business under, usually referred to as a DBA name.
SettingsQueryRecord
object
6 properties
AutoElement
object
7 properties
BankNickname
string
User-defined name for the bank account.
BoardingId
integer
The Payabli-assigned ID of the boarding application linked to this paypoint.
Website
string
The business website address. Include only the domain and TLD, do not enter the protocol (http/https). For example: www.example.com is acceptable.
CardSetup
object
4 properties
Paypointstatus
integer
The paypoint's status. - 1 — Active - 0 — Inactive
BankAccountHolderName
string
The accountholder's name.
MethodElementSettingsApplePayButtonType
string
The text on Apple Pay button. See [Apple Pay Button Type](/developers/developer-guides/hosted-payment-page-apple-payparam-applepay-button-type) for more inform…
PaypointData
object
23 properties
Orgname
string
The name of the organization.
Services
object
Controls which services will be enabled for the merchant.
3 properties
AdditionalData
object
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](…
GetBasicEntryResponse
object
5 properties
2 required
PageElement
object
4 properties
GreaterValueAllowed
boolean
When true, the customer can pay an amount greater than the invoice or bill amount.
PayCategory
object
9 properties
KeyValue
object
3 properties
FileContentFtype
string
The MIME type of the file (if content is provided).
MethodElementSettingsApplePayLanguage
string
The Apple Pay button locale. See [Apple Pay Button Language](/developers/developer-guides/hosted-payment-page-apple-payparam-applepay-language) for more inform…
PaypointMoveRequest
object
3 properties
2 required
MaxTicket
number
Maximum ticket amount for transactions within the paypoint. Contact Payabli support to request a change to this value.
Responsedatanonobject
The response data.
Timezone
integer
Timezone, in UTC offset. For example, -5 is Eastern time.
ExternalPaypointId
string
A custom identifier for the paypoint, if applicable.
GetBasicEntryByIdResponse
object
5 properties
2 required
PayabliPages
object
11 properties
MethodElement
object
8 properties
BankData
array
Information about associated bank accounts.
MethodsList
object
10 properties
Orgid
integer
Organization ID. Unique identifier assigned to an org by Payabli.
SettingElement
object
5 properties
Contacts
object
5 properties
ReceiptContent
object
Object containing receipt body configuration
9 properties
WebHeaderParameter
object
2 properties
2 required
PageContent
object
15 properties
StateNullable
string
The state or province.
PayorFields
object
10 properties
AddressNullable
string
The address.
ReadOnly
boolean
When true, the element is read-only.
PaypointEntryConfig
object
8 properties
PhoneNumber
string
Phone number.
PayorElement
object
4 properties
AmountElement
object
3 properties
Zip
string
ZIP code for address.
MigratePaypointResponse
object
3 properties
2 required
LabelElement
object
3 properties
TypeAccount
string
Type of bank account: Checking or Savings.
ButtonElement
object
2 properties
1 required
Orgtype
integer
The organization type. Currently, this must be 0.
Responsecode
integer
Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
StatementEmailConfig
object
Configuration for statement email recipients and the sender address.
2 properties
AccountNumber
string
Account number for bank account. This value is returned masked in responses.
Legalname
string
Business legal name.
Finishtype
object
2 properties
AddressAddtlNullable
string
Additional line for the address.
MethodElementSettingsApplePay
object
3 properties
GetEntryConfigResponse
object
5 properties
2 required
AchSetup
object
Configuration for which ACH SEC codes the user is allowed to use.
3 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Payabli publishes across the network.
