Pular para o conteúdo principal
Create TOS Link
curl --request POST \
  --url https://api.spherepay.co/v2/customer/{id}/tos-link \
  --header 'Authorization: Bearer <token>'
{
  "link": "https://spherepay.co/tos?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjdXN0b21lcl9lMDE2MzNjNWY1OTY0MThiOGU5ZTQzNDEyMzQ2OTk0YyIsImFwcGxpY2F0aW9uSWQiOiJhcHBsaWNhdGlvbl84NWM5ZmE2ZTFjMjk0YzJmOTA2NDcwNWFlYTE3Y2ZkMyIsImN1c3RvbWVyVHlwZSI6ImluZGl2aWR1YWwiLCJtc2FTdGF0dXMiOiJpbmNvbXBsZXRlIiwibXNhUmVxdWlyZWQiOmZhbHNlLCJpYXQiOjE3NjQwMzQwMDUsImV4cCI6MTc2NjQ1MzIwNX0.6z3976YqDxDr5LkMJxoZhw526cu1PGE3nFZtAE8vIfY",
  "expiresAt": "2026-03-09T20:46:31.305Z"
}
Gere um link hospedado de aceite dos Termos de Serviço para um cliente. Este endpoint é necessário apenas no modelo de onboarding Sphere-Managed — no modelo Platform-Managed, o aceite dos Termos de Serviço é tratado pela sua própria plataforma antes que o cliente seja passado ao SpherePay. Redirecione o cliente para o link retornado para que ele possa revisar e aceitar os Termos de Serviço do SpherePay. O link expira no momento indicado por expiresAt.
O aceite dos Termos de Serviço é uma etapa obrigatória no fluxo KYC gerenciado pelo Sphere. O cliente não pode ser aprovado para transferências até que tenha aceitado os Termos de Serviço. Se você estiver usando o modelo Platform-Managed, ignore este endpoint.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

id
string
obrigatório

Customer ID

Exemplo:

"customer_f31121c389624d3697cbf3ea8830b7a4"

Resposta

Terms of Service link URL

Exemplo:

"https://spherepay.co/tos?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjdXN0b21lcl9lMDE2MzNjNWY1OTY0MThiOGU5ZTQzNDEyMzQ2OTk0YyIsImFwcGxpY2F0aW9uSWQiOiJhcHBsaWNhdGlvbl84NWM5ZmE2ZTFjMjk0YzJmOTA2NDcwNWFlYTE3Y2ZkMyIsImN1c3RvbWVyVHlwZSI6ImluZGl2aWR1YWwiLCJtc2FTdGF0dXMiOiJpbmNvbXBsZXRlIiwibXNhUmVxdWlyZWQiOmZhbHNlLCJpYXQiOjE3NjQwMzQwMDUsImV4cCI6MTc2NjQ1MzIwNX0.6z3976YqDxDr5LkMJxoZhw526cu1PGE3nFZtAE8vIfY"

expiresAt
string
obrigatório

ISO 8601 formatted date and time of the TOS link expiration

Exemplo:

"2026-03-09T20:46:31.305Z"

Última modificação em 18 de junho de 2026