Criar Link de Pagamento

Dados da API

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)

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:

POST /v1/paymentlink/new

Via request Representational State Transfer (REST) com o body:

Requisição

{ 
  "description": "<string>", 
  "value": "<double>", 
  "qttyInstallments": "<integer>", 
  "qttyInstallmentsCustom": ["<integer>"],
  "qttyInstallmentsIntFree": "<integer>", 
  "installmentsFee": "<double>",
  "expirationDate": "<dateTime>" 
} 

Dicionário de dados - Parâmetros

PROPRIEDADE	DESCRIÇÃO	TIPO	LOCAL	OBRIGATÓRIO	TAMANHO
description	Descrição do produto vendido ou serviço prestado	String	Body	sim
value	Valor bruto da cobrança	decimal	Body	sim
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
installmentsFee	Taxa de juros aplicada em parcelas maiores que qttyInstallmentsIntFree (ex: 1.5 = 1.5%)	double	Body	sim
expirationDate	Data de expiração do link	Date	Body	sim

🟢 200

Pagamento realizado com sucesso

{
  "id": "aed32670-c3e5-4192-8ab0-0e96f92e3408", 
  "message": "Link de pagamento cadastrado com sucesso!" 
}

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
id	Identificador do link de pagamento cadastrado.	string
message	Mensagem de sucesso.	string

🔴 400

Erro na requisição ou na validação do 3DS

[ 
    { 
      "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

🔴 500

Erro interno

[ 
    { 
        "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