Pular para o conteúdo principal
POST
Criar sessão de checkout

Autorizações

Authorization
string
header
obrigatório

Token de autenticação da API do usuário com o formato cash_<64-char-hex>. Valor de exemplo cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2.

Corpo

application/json
country
enum<string>
obrigatório

País do checkout (AR, BR, CL ou BO)

Opções disponíveis:
AR,
BR,
CL,
BO
amount
string
obrigatório

Valor decimal como string

successUrl
string<uri>
obrigatório

URL de redirecionamento após pagamento bem-sucedido

accountId
string<uuid>

ID da conta HG.Cash que receberá o pagamento

cancelUrl
string<uri>

URL de redirecionamento se o pagador cancelar

webhookUrl
string<uri>

URL de webhook opcional para eventos desta sessão

expiresInSeconds
integer

Tempo de expiração da sessão em segundos

idempotencyKey
string

Chave de idempotência opcional para evitar duplicatas

locale
enum<string>

Idioma da interface do checkout

Opções disponíveis:
es,
en
metadata
object

Metadados opacos anexados à sessão

payer
object

BR exige name, document e email; BO exige name, document e email

paymentMethodId
string<uuid>

Obrigatório para CL

customer
object

Obrigatório para CL (veja os campos customer de ClInboundTransactionRequest)

Resposta

Criado

id
string<uuid>
publicToken
string
checkoutUrl
string<uri>
status
string
expiresAt
string<date-time>
accountDisplay
object

Presente para AR (CVU, alias, titular)

qrCode
string
pixCopiaECola
string
checkoutUrlProvider
string<uri>