Terms Of Service

Generate a short-lived terms of service token for the authenticated merchant. Pass this token to the update endpoint once the user has accepted the terms.

Create terms of service token

Generate a short-lived terms of service token for the authenticated merchant. Pass this token to the update endpoint once the user has accepted the terms.

Parameters

No parameters.

Returns

Token created successfully

POST/v1/terms_of_service
curl --request POST \
  --url https://api.framepayments.com/v1/terms_of_service \
  --header 'Authorization: Bearer API_KEY'
RESPONSE
{
  "token": "tos_sandbox_7QDdsp7Y1ZeZXJUHPUQZDCZc"
}

Accept terms of service

Record acceptance of the terms of service using a token obtained from the create endpoint.

Body parameters
tokenstringrequired

Terms of service token from the create endpoint

Returns

Terms of service accepted

PATCH/v1/terms_of_service
curl --request PATCH \
  --url https://api.framepayments.com/v1/terms_of_service \
  --header 'Authorization: Bearer API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "token": null
}'
RESPONSE
{
  "token": "tos_sandbox_RpuxijnsG7tx1qgSASJf72CB"
}