Links de Pagamento
Criar link de pagamento
Cria um novo link de pagamento.
Cria um novo link de pagamento.
basicAuth In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
curl -X POST "https://example.com/v1/payment-links" \ -H "Content-Type: application/json" \ -d '{ "title": "string", "product_type": "physical", "allowed_payment_methods": [ "credit_card" ] }'ID do submerchant. Quando informado, a cobrança gerada será processada com split para o submerchant.
Título do link
Descrição
Valor em centavos. Se omitido, o comprador poderá informar o valor.
Código da moeda
Tipo do produto
Métodos de pagamento aceitos
Máximo de parcelas
Data de expiração (ISO 8601)
Limite de usos
Dados adicionais
URL para redirecionar o comprador apos o pagamento ser confirmado
Cor primária do checkout em hexadecimal (ex: #FF5733)
Cor do painel de resumo em hexadecimal
URL do logo do merchant no checkout
application/json
application/json
Autenticação via chave de API. Use publicKey:secretKey codificado em Base64 no header Authorization: Basic {credentials}.
{
"success": true,
"message": "string",
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
"submerchant_id": "0534fe1e-3158-45a7-83b1-35fcc9d94bc5",
"title": "string",
"description": "string",
"amount": 0,
"checkout_url": "http://example.com",
"currency": "BRL",
"product_type": "physical",
"allowed_payment_methods": [
"credit_card"
],
"max_installments": 0,
"expires_at": "2019-08-24T14:15:22Z",
"max_uses": 0,
"current_uses": 0,
"status": "active",
"redirect_url": "http://example.com",
"cover_image_url": "string",
"metadata": {},
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}{
"success": false,
"message": "string",
"error": "string"
}{
"success": false,
"message": "string",
"error": "string"
}