Criar Link de Pagamento
API Gateway
Esta API é utilizada para operações do gateway de pagamento:
- Produção: https://api.sopague.com.br/gateway
- Homologação: https://api-hmg.sopague.com.br/gateway
- Arquitetura: Representational State Transfer (REST)
O link de pagamento gerado será válido apenas até a data de expiração (expirationDate) informada na requisição. Após essa data, o link será automaticamente desativado e não poderá mais ser utilizado para pagamentos.
Realizar Operação de Criação de Link de Pagamento
A API de Pagamento Online também permite a criação de links de pagamento prontos, com valor
definido, fornecendo um checkout pronto para ser usado pelo pagador.
Para criar um link de pagamento, basta enviar um POST para o endpoint /v1/paymentlink/new conforme o exemplo:
Notificações Webhook
Quando um pagamento é realizado através do link de pagamento, nossa plataforma automaticamente envia uma notificação para sua aplicação com os dados da transação. Esse é um recurso opcional, ou seja, você pode utilizá-lo caso seja interessante para a sua aplicação.
POST /v1/paymentlink/new
Via request Representational State Transfer (REST) com o body:
{
"description": "<string>",
"value": "<double>",
"qttyInstallments": "<integer>",
"qttyInstallmentsCustom": ["<integer>"],
"qttyInstallmentsIntFree": "<integer>",
"installmentsFee": "<double>",
"expirationDate": "<dateTime>",
"urlCallBack": "<string>",
}
Dicionário de dados - Parâmetros
| PROPRIEDADE | DESCRIÇÃO | TIPO | LOCAL | OBRIGATÓRIO | VALIDAÇÃO |
|---|---|---|---|---|---|
| description | Descrição do produto vendido ou serviço prestado | String | Body | sim | Máximo 250 caracteres |
| value | Valor bruto da cobrança | decimal | Body | sim | Mínimo 1,01 e máximo 999.999,99 |
| qttyInstallments | Quantidade de parcelas permitida. Obrigatório caso qttyInstallmentsCustom não esteja preenchido | Int | Body | condicional | |
| qttyInstallmentsCustom | Array com quantidades de parcelas personalizadas. Obrigatório caso qttyInstallments não esteja preenchido | Array[Int] | Body | condicional | |
| qttyInstallmentsIntFree | Quantidade de parcelas sem juros | Int | Body | sim | De 1 a 12 |
| installmentsFee | Taxa de juros aplicada em parcelas maiores que qttyInstallmentsIntFree (ex: 1.5 = 1.5%) | double | Body | sim | De 0 a 100 |
| expirationDate | Data de expiração do link | Date | Body | sim | Maior do que hoje |
| urlCallBack | URL para receber notificações webhook quando o pagamento for processado | String | Body | não | Máximo 500 caracteres |
- 🟢 200
- 🔴 400
- 🔴 500
{
"id": "3c228652-122e-4da6-b572-4aea64caad63",
"message": "Link de pagamento cadastrado com sucesso!",
"description": "MENSALIDADE JOÃO DA SILVA SAURO",
"value": 10.00,
"expirationDate": "2025-08-29",
"link": "https://faturas.sopague.com.br/link/3c228652-122e-4da6-b572-4aea64caad63"
}
Dicionário de dados - Retorno
| PROPRIEDADE | DESCRIÇÃO | TIPO |
|---|---|---|
| id | Identificador do link de pagamento cadastrado. | string |
| message | Mensagem de sucesso. | string |
| description | Descrição do produto/serviço do link criado. | string |
| value | Valor do link de pagamento. | decimal |
| expirationDate | Data de expiração do link. | string |
| link | URL do link de pagamento gerado. | string |
[
{
"tag": "",
"description": "Bandeira não identificada"
}
]
Dicionário de dados - Retorno
| PROPRIEDADE | DESCRIÇÃO | TIPO |
|---|---|---|
| tag | Tag do erro | string |
| description | Descrição do erro | string |
[
{
"tag": "",
"description": "Não foi possível executar comando. Erro desconhecido."
}
]
Dicionário de dados - Retorno
| PROPRIEDADE | DESCRIÇÃO | TIPO |
|---|---|---|
| tag | Tag do erro | string |
| description | Descrição do erro | string |
Consulte também
Em caso de falha na transação, consulte nossa tabela completa de códigos de resposta para identificar e tratar adequadamente os erros: