Paypoint
Get Paypoint Settings
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
- Organization
- Paypoint
- Customer
- User
- Vendor
- Notification
- Query
- Statistic
- Export
- Import
Object Models
- Object Model References
Get Paypoint Settings
Retrieves an paypoint’s basic settings like custom fields, identifiers, and invoicing settings.
GET
/
Paypoint
/
settings
/
{entry}
curl --request GET \
--url https://api-sandbox.payabli.com/api/Paypoint/settings/{entry} \
--header 'requestToken: <api-key>'
{
"general": [
{
"readOnly": true,
"key": "currency",
"value": "USD"
},
{
"readOnly": true,
"key": "disableAutoReceipt",
"value": "true"
},
{
"readOnly": false,
"key": "sendApprovedReceipt",
"value": "true"
},
{
"readOnly": false,
"key": "sendDeclinedReceipt",
"value": "true"
},
{
"readOnly": true,
"key": "",
"value": ""
}
],
"customFields": [
{
"readOnly": false,
"key": "customerID",
"value": ""
},
{
"readOnly": false,
"key": "test",
"value": ""
},
{
"readOnly": false,
"key": "newfield",
"value": ""
},
{
"readOnly": false,
"key": "testfield",
"value": ""
}
],
"identifiers": [],
"forInvoices": [
{
"readOnly": null,
"key": "brandColor",
"value": "#0594fad1"
},
{
"readOnly": null,
"key": "requiredInvoiceNumber",
"value": "true"
},
{
"readOnly": null,
"key": "invoicePrefix",
"value": "INV-"
},
{
"readOnly": null,
"key": "invoiceNumber",
"value": "1"
},
{
"readOnly": null,
"key": "dueDate",
"value": "NET30"
},
{
"readOnly": null,
"key": "dueDateCustom",
"value": "Invalid Date"
},
{
"readOnly": null,
"key": "memoNote",
"value": "Thank you for your business!"
},
{
"readOnly": null,
"key": "footerNote",
"value": "default footer testing"
},
{
"readOnly": null,
"key": "includePaymentLink",
"value": "true"
},
{
"readOnly": null,
"key": "paylinkHeader",
"value": "Gruzya Adventure Outfitters"
},
{
"readOnly": null,
"key": "paylinkDescription",
"value": "Pay Invoice"
},
{
"readOnly": null,
"key": "contactUsText",
"value": "Contact Us"
},
{
"readOnly": null,
"key": "contactUsEmail",
"value": "support@gruzyaadventureoutfitters.com"
},
{
"readOnly": null,
"key": "contactUsPhone",
"value": "5551234567"
},
{
"readOnly": null,
"key": "invoiceNumbering",
"value": "autoapply"
},
{
"readOnly": null,
"key": "paymentVisa",
"value": "true"
},
{
"readOnly": null,
"key": "paymentMastercard",
"value": "true"
},
{
"readOnly": null,
"key": "paymentDiscover",
"value": "true"
},
{
"readOnly": null,
"key": "paymentAmex",
"value": "true"
},
{
"readOnly": null,
"key": "paymentAch",
"value": "true"
},
{
"readOnly": null,
"key": "paymentApplePay",
"value": "false"
},
{
"readOnly": null,
"key": "paymentGooglePay",
"value": "false"
},
{
"readOnly": null,
"key": "requireInvoiceNumber",
"value": "false"
},
{
"readOnly": null,
"key": "autoCreateInvoice",
"value": "true"
},
{
"readOnly": null,
"key": "",
"value": ""
}
],
"forPayOuts": [
{
"readOnly": false,
"key": "autoCapture",
"value": "true"
},
{
"readOnly": false,
"key": "autoPay",
"value": "true"
},
{
"readOnly": false,
"key": "autoDownloadCheckImage",
"value": "false"
}
],
"forWallets": [
{
"readOnly": false,
"key": "isApplePayEnabled",
"value": "false"
}
]
}
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
The paypoint's entrypoint identifier. Learn more
Example:
"8cfec329267"
Response
200 - application/json
Success
Was this page helpful?
curl --request GET \
--url https://api-sandbox.payabli.com/api/Paypoint/settings/{entry} \
--header 'requestToken: <api-key>'
{
"general": [
{
"readOnly": true,
"key": "currency",
"value": "USD"
},
{
"readOnly": true,
"key": "disableAutoReceipt",
"value": "true"
},
{
"readOnly": false,
"key": "sendApprovedReceipt",
"value": "true"
},
{
"readOnly": false,
"key": "sendDeclinedReceipt",
"value": "true"
},
{
"readOnly": true,
"key": "",
"value": ""
}
],
"customFields": [
{
"readOnly": false,
"key": "customerID",
"value": ""
},
{
"readOnly": false,
"key": "test",
"value": ""
},
{
"readOnly": false,
"key": "newfield",
"value": ""
},
{
"readOnly": false,
"key": "testfield",
"value": ""
}
],
"identifiers": [],
"forInvoices": [
{
"readOnly": null,
"key": "brandColor",
"value": "#0594fad1"
},
{
"readOnly": null,
"key": "requiredInvoiceNumber",
"value": "true"
},
{
"readOnly": null,
"key": "invoicePrefix",
"value": "INV-"
},
{
"readOnly": null,
"key": "invoiceNumber",
"value": "1"
},
{
"readOnly": null,
"key": "dueDate",
"value": "NET30"
},
{
"readOnly": null,
"key": "dueDateCustom",
"value": "Invalid Date"
},
{
"readOnly": null,
"key": "memoNote",
"value": "Thank you for your business!"
},
{
"readOnly": null,
"key": "footerNote",
"value": "default footer testing"
},
{
"readOnly": null,
"key": "includePaymentLink",
"value": "true"
},
{
"readOnly": null,
"key": "paylinkHeader",
"value": "Gruzya Adventure Outfitters"
},
{
"readOnly": null,
"key": "paylinkDescription",
"value": "Pay Invoice"
},
{
"readOnly": null,
"key": "contactUsText",
"value": "Contact Us"
},
{
"readOnly": null,
"key": "contactUsEmail",
"value": "support@gruzyaadventureoutfitters.com"
},
{
"readOnly": null,
"key": "contactUsPhone",
"value": "5551234567"
},
{
"readOnly": null,
"key": "invoiceNumbering",
"value": "autoapply"
},
{
"readOnly": null,
"key": "paymentVisa",
"value": "true"
},
{
"readOnly": null,
"key": "paymentMastercard",
"value": "true"
},
{
"readOnly": null,
"key": "paymentDiscover",
"value": "true"
},
{
"readOnly": null,
"key": "paymentAmex",
"value": "true"
},
{
"readOnly": null,
"key": "paymentAch",
"value": "true"
},
{
"readOnly": null,
"key": "paymentApplePay",
"value": "false"
},
{
"readOnly": null,
"key": "paymentGooglePay",
"value": "false"
},
{
"readOnly": null,
"key": "requireInvoiceNumber",
"value": "false"
},
{
"readOnly": null,
"key": "autoCreateInvoice",
"value": "true"
},
{
"readOnly": null,
"key": "",
"value": ""
}
],
"forPayOuts": [
{
"readOnly": false,
"key": "autoCapture",
"value": "true"
},
{
"readOnly": false,
"key": "autoPay",
"value": "true"
},
{
"readOnly": false,
"key": "autoDownloadCheckImage",
"value": "false"
}
],
"forWallets": [
{
"readOnly": false,
"key": "isApplePayEnabled",
"value": "false"
}
]
}