Status Page Contact sales

Home Platform Overview API Reference Integration Guides UI Guides Changelog

Home Platform Overview API Reference Integration Guides UI Guides Changelog

Using the API
API reference

API reference Pay In endpoints Customer

Send opt-in

POST

/Customer/:customerId/consent

POST

/api/Customer/:customerId/consent

1 curl -X POST https://api-sandbox.payabli.com/api/Customer/998/consent \
2      -H "requestToken: <apiKey>"

1 {
2   "isSuccess": true,
3   "pageIdentifier": "null",
4   "responseCode": 1,
5   "responseData": " ",
6   "responseText": "Success"
7 }

Sends the consent opt-in email to the customer email address in the customer record.

Authentication

requestTokenstring

API Key authentication via header

Path Parameters

customerIdintegerRequired

Payabli-generated customer ID. Maps to “Customer ID” column in PartnerHub.

Response

Success

isSuccessboolean or null

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

pageIdentifierstring or null

Auxiliary validation used internally by payment pages and components.

responseCodeinteger or null

Code for the response. Learn more in API Response Codes.

responseDatastring or integer or null

The response data.

responseTextstring or null

Response text for operation: ‘Success’ or ‘Declined’.

Errors

Was this page helpful?

Import customers

Status Page Contact sales