Status Page Contact sales

Developers Integration guides Embedded components SDKs & tools API reference

Using the API
- API overview
- API responses
API

Status Page Contact sales

API 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   "responseText": "Success",
3   "responseCode": 1,
4   "pageIdentifier": "null",
5   "isSuccess": true,
6   "responseData": " "
7 }

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

Path parameters

customerIdintegerRequired

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

Headers

requestTokenstringRequired

Response

Success

responseTextstring

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

responseCodeinteger or null

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

pageIdentifierstring or null

Auxiliary validation used internally by payment pages and components.

roomIdlong or null

Describes the room ID. Only in use on Boarding endpoints, returns 0 when not applicable.

isSuccessboolean or null

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

responseDatastring or integer or null

The response data.

Errors

Was this page helpful?

Import customers