Create Customer Consent to Receive SMS Messages for Payment Links

Creates a record of customer consent to receive SMS messages for Payment Links for a given phone number.

Body Params

Request to record SMS user consent for a phone number.

string
required

Phone number (will be normalized to E.164 format).

string
enum
required

The medium through which consent was obtained.

Allowed:
string
required
length ≤ 5000

The exact language used to obtain consent (max 5000 characters).

string

Name of the person providing consent.

string

Email of the person providing consent.

string

IP address of the person providing consent.

string

The GovHub site at which the customer will pay.

Responses
204

The SMS consent was successfully recorded.

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json