Criar transações
Developing
POST
https://api.bestfy.io/payment
Regras de uso
paymentMethod, items e customer são obrigatórios. Os demais campos são opcionais e devem ser informados quando aplicável.Dados da Transação
paymentMethod: Método de pagamento (PIX ou BOLETO).items: Lista de produtos ou serviços (veja detalhes abaixo).customer: Objeto contendo os dados do pagador.metadata: Metadados do pagamento em string.address: Objeto contendo os dados do endereço do pagador.postbackUrl: URL de callback para notificações assíncronas. Quando o status do pagamento mudar, a Bestfy enviará um POST para essa URL com os dados da transação, permitindo que seu sistema atualize automaticamente o pedido sem precisar ficar consultando o endpoint.Detalhes do Cliente (customer)
name: Nome completo.email: E-mail.phone: Telefone com código do país (ex: +55 (11) 99999-9999).cpfOrCnpj: CPF ou CNPJ.Detalhes dos Itens (items)
productTitle: Nome do produto.description: Breve descrição do produto.quantity: Quantidade comprada.priceCents: Valor em centavos de cada unidade (ex: R$ 10,00 = 1000).productType: Tipo do produto (DIGITAL ou COMMON)Detalhes do Endereço (address)
postalCode: CEP no formato brasileiro.neighborhood: Bairro.city: Cidade.state: Sigla do estado (UF, 2 letras).streetAddress: Logradouro (rua/avenida) e complemento, se houver.streetNumber: Número do imóvel.Erros comuns
| Código | Motivo |
|---|---|
400 | Requisição inválida |
404 | Algum recurso não encontrado |
500 | Erro interno — reenvie após alguns segundos |
Request
Header Params
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.bestfy.io/payment' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"paymentMethod": "PIX",
"items": [
{
"productTitle": "Produto de teste",
"description": "Este é um produto de teste na criação do pagamento",
"quantity": 1,
"priceCents": 1000,
"productType": "DIGITAL"
}
],
"customer": {
"name": "John Doe",
"email": "johndoe@email.com",
"phone": "+55 (11) 99999-9999",
"cpfOrCnpj": "89.415.463/0001-28"
},
"metadata": "{\"provider\": \"Iugu\", \"user_email\": \"jdoe@example.com\", \"checkout_url\": \"https://example.com\"}",
"postbackUrl": "https://example.com/postback"
}'Response Response Example
201 - Success
{"financialTransactionId":"019c009b-ae07-2c60-cf14-abc48d02ca1d","qrCode":"https://faturas.iugu.com/qr_code/7d531bed-3d3f-4088-a4be-c82e5f08ed5e-7fbd","qrCodeText":"00020101021226890014br.gov.bcb.pix2567qr.iugu.com/public/payload/v2/cobv/7D531BED3D3F4088A4BEC82E5F08ED5E520400005303986540510.005802BR5919JOAO PEDRO PRODUCER6012PORTO ALEGRE62070503***6304D647"}Modified at 2026-02-02 19:55:40