API Basics
Pay In Endpoints
- MoneyIn
- Subscription
- TokenStorage
- Invoice
- LineItem
- PaymentLink
- PaymentMethodDomain
- HostedPaymentPages
- Cloud
- Wallet: Apple Pay
Pay Out Endpoints
- MoneyOut
- Bill
Pay Ops Endpoints
- Templates
- Boarding
- Chargebacks and ACH Returns
- Entities
- Notification
- Query
- Statistic
- Export
- Import
Object Models
- Object Model References
Add Payment Method Domain
Add a payment method domain to an organization or paypoint.
curl --request POST \
--url https://api-sandbox.payabli.com/api/PaymentMethodDomain \
--header 'Content-Type: application/json' \
--header 'requestToken: <api-key>' \
--data '{
"entityId": 109,
"entityType": "paypoint",
"domainName": "subdomain.domain.com",
"applePay": {
"isEnabled": true
}
}'{
"responseText": "<string>",
"responseData": {
"entityId": 109,
"entityType": "paypoint",
"domainName": "subdomain.domain.com",
"applePay": {
"isEnabled": true,
"data": {
"errorMessage": "null",
"metadata": {
"isFileAvailable": true,
"isFileContentValid": true,
"statusCode": 123,
"redirectUrl": "<string>",
"redirectDomainName": "<string>"
}
}
},
"ownerEntityId": 109,
"ownerEntityType": "organization",
"cascades": [
{
"jobId": "445865",
"jobStatus": "completed",
"jobErrorMessage": "<string>",
"createdAt": "2022-07-01 15:00:01",
"updatedAt": "2022-07-01 15:00:01"
}
],
"createdAt": "2022-07-01 15:00:01",
"updatedAt": "2022-07-01 15:00:01",
"id": "pmd_12AB"
},
"pageidentifier": "<string>",
"isSuccess": true
}Authorizations
Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.
Body
The entity's ID in Payabli.
109
The entity type. Available values:
- paypoint
- organization
- psp (payment service provider).
"paypoint"
The domain. For example: subdomain.domain.com or domain.com
"subdomain.domain.com"
Response
Response for the add payment method domain operation.
Data related to the payment method domain.
The entity's ID in Payabli.
109
The entity type. Available values:
- paypoint
- organization
- psp (payment service provider).
"paypoint"
The domain. For example: subdomain.domain.com or domain.com
"subdomain.domain.com"
Details about the status of the Apple Pay service.
When true, Apple Pay is enabled.
true
Details about the Apple Pay service status.
Any error message related to Apple Pay's activation status.
null
This metadata appears only when the domain verification check fails. It gives more information about why the check failed.
When true, indicates whether the domain verification file is available at the expected path. When false, Payabli was unable to find the file at the expected path. If the file is missing, make sure it's hosted at the correct path: /.well-known/apple-developer-merchantid-domain-association
Indicates whether the domain verification file content is valid. If the file is invalid, try downloading it and hosting it again.
The status code return by the domain verification URL.
If the domain verification URL is redirected, this is the URL it's redirected to. For example, www.partner.com could redirect to www.partners-new-home-page.com. In this case, you should add www.partners-new-home-page.com as a domain instead of www.partner.com.
The domain name if the domain verification URL returns a redirect.
The domain's owning entity's ID in Payabli. This value might be different than the entityId, depending on whether the domain is cascaded and whether it's inherited.`
109
The domain's owner's entity type. Available values:
- paypoint
- organization
- psp (payment service provider).
"organization"
Data about the domain's cascade status.
Details about the cascade process.
The cascade process ID.
"445865"
The cascade process status. Available valudes:
- in_progress
- completed
- failed
"completed"
Error message for a failed cascade process.
Timestamp of when record was created, in UTC.
"2022-07-01 15:00:01"
Timestamp of when record was last updated, in UTC.
"2022-07-01 15:00:01"
Timestamp of when record was created, in UTC.
"2022-07-01 15:00:01"
Timestamp of when record was last updated, in UTC.
"2022-07-01 15:00:01"
The payment method domain's ID in Payabli.
"pmd_12AB"
Was this page helpful?
curl --request POST \
--url https://api-sandbox.payabli.com/api/PaymentMethodDomain \
--header 'Content-Type: application/json' \
--header 'requestToken: <api-key>' \
--data '{
"entityId": 109,
"entityType": "paypoint",
"domainName": "subdomain.domain.com",
"applePay": {
"isEnabled": true
}
}'{
"responseText": "<string>",
"responseData": {
"entityId": 109,
"entityType": "paypoint",
"domainName": "subdomain.domain.com",
"applePay": {
"isEnabled": true,
"data": {
"errorMessage": "null",
"metadata": {
"isFileAvailable": true,
"isFileContentValid": true,
"statusCode": 123,
"redirectUrl": "<string>",
"redirectDomainName": "<string>"
}
}
},
"ownerEntityId": 109,
"ownerEntityType": "organization",
"cascades": [
{
"jobId": "445865",
"jobStatus": "completed",
"jobErrorMessage": "<string>",
"createdAt": "2022-07-01 15:00:01",
"updatedAt": "2022-07-01 15:00:01"
}
],
"createdAt": "2022-07-01 15:00:01",
"updatedAt": "2022-07-01 15:00:01",
"id": "pmd_12AB"
},
"pageidentifier": "<string>",
"isSuccess": true
}