Saltar para o conteúdo principal
POST
curl

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.

Corpo

application/json
amount_in_dollars
number
obrigatório

Montante a cobrar, em USD. Deve ser entre 50 e 20 000. O saldo recebe o mesmo montante, sem desconto nem bónus. O imposto é adicionado automaticamente no processo de pagamento com base na morada de faturação do cliente.

Intervalo necessário: 50 <= x <= 20000
success_url
string<uri>

URL para onde o checkout alojado redireciona o cliente após um pagamento bem-sucedido. Atualmente o valor predefinido é https://console.didit.me. Indique explicitamente um URL funcional; o anfitrião predefinido não está disponível. Anexe o marcador de posição literal {CHECKOUT_SESSION_ID} se pretender que o checkout alojado substitua o ID da sessão.

cancel_url
string<uri>

URL para onde o checkout alojado redireciona o cliente quando este cancela ou fecha a janela do Checkout. Atualmente o valor predefinido é https://console.didit.me. Indique explicitamente um URL funcional; o anfitrião predefinido não está disponível.

Resposta

Sessão de checkout alojada criada. Redirecione o utilizador para checkout_session_url para concluir o pagamento.

checkout_session_id
string
obrigatório

Identificador da sessão de checkout alojada (ex.: cs_test_a1B2c3...). Útil para reconciliação do lado do servidor.

checkout_session_url
string<uri>
obrigatório

URL de página de pagamento alojada de utilização única. Redirecione o cliente para esta página para concluir o pagamento.

Última modificação em 7 de novembro de 2026