Get a terms link

POST/v1/tos_links

Key scope: write · Success: 201

The provider's hosted terms page for a customer you will verify by API. When the customer accepts, the page returns signed_agreement_id as a query parameter on redirectUri (or posts signedAgreementId to the parent window in an iframe). Send it as signedAgreementId with POST /v1/customers.

Headers

Idempotency-Key string: Optional. The same key and body run once; a replay answers with Idempotent-Replayed: true. Kept 24 hours.

Body

redirectUri https URL: Where the page sends the customer back, with signed_agreement_id.

Notes

In staging the provider's sandbox accepts any UUID as a signed agreement.

Errors

400 body_invalid
400 redirect_uri_invalid
413 payload_too_large
502 bridge_unavailable
401 api_key_required
401 api_key_invalid
401 api_key_wrong_mode
403 scope_missing
429 rate_limited

All codes: Errors.

Request

curl -X POST "https://wallet.simpleeasytransactions.com/v1/tos_links" \
  -H "Authorization: Bearer $SET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "redirectUri": "https://example.com/onboarding/terms-done" }'

Body

{ "redirectUri": "https://example.com/onboarding/terms-done" }

Response 201

{ "object": "tos_link", "url": "https://…", "returns": "signed_agreement_id, as a query parameter on redirectUri (or the signedAgreementId postMessage in an iframe). Send it as signedAgreementId with POST /v1/customers.", "sandbox": false }