Record consent (consumer)

Records the user's acceptance of the Payment Account terms.

Re-posting replaces the previous consent record wholesale — send the complete set of fields each time, not a delta. Recording "accepted": false withdraws consent and returns the user to the previous (pre-Payment-Account) behavior for subsequent transactions.

ip defaults to the source IP of this API request. When calling from your backend — the normal integration pattern — pass the end user's IP explicitly, otherwise your server's IP is recorded on the consent record.

dateAccepted defaults to the server time of the call.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

The user recording consent.

boolean
required

true records acceptance of the Payment Account terms; false withdraws it. Must be a JSON boolean — the string "true" is rejected with a validation error.

string
length between 1 and 50

The version of the terms document you displayed to the user.

uri

Where the displayed terms document is hosted.

date-time

ISO 8601 timestamp of the acceptance. Defaults to the server time of the call.

string

The end user's IP address (IPv4 or IPv6). Defaults to the source IP of this API request — pass this explicitly when calling from your backend, otherwise your server's IP is recorded.

Responses

401

Missing or invalid api-key or HMAC signature.

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