Skip to main content
POST
Criar um link do portal do cliente
Gera o link do portal do cliente para um cliente e um checkout que ele pagou. Veja o que o cliente consegue fazer no portal em Referência.
Requer uma destas permissões: CHECKOUT:CREATE, SUBSCRIPTION:CREATE ou CUSTOMER:CREATE.
Exemplo:
Chamar de novo com o mesmo customerId e checkoutId devolve o mesmo link. Não precisa guardar a url.

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Body

application/json
customerId
string
required

ID do cliente que pagou o checkout

Example:

"cust_abc123xyz"

checkoutId
string
required

ID do checkout (avulso ou de assinatura)

Example:

"bill_abc123xyz"

Response

Link do portal criado (ou o existente).

data
object
error
string | null
Example:

null

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true