POST /v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/image HTTP/1.1Host: api-global.fastpaybrasil.comAuthorization: Basic <base64 de "SUA_CHAVE_SECRETA:">Content-Type: multipart/form-data; boundary=----FinviaBoundary------FinviaBoundaryContent-Disposition: form-data; name="file"; filename="plano-premium.png"<conteúdo de plano-premium.png>------FinviaBoundary--
curl -X POST "https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/image" \ -u "$FINVIA_API_KEY:" \ -F "file=@./plano-premium.png"
import { readFile } from 'node:fs/promises';const credentials = Buffer.from(`${process.env.FINVIA_API_KEY}:`).toString('base64');const form = new FormData();const image = await readFile('./plano-premium.png');form.append('file', new Blob([image], { type: 'image/png' }), 'plano-premium.png');const response = await fetch( 'https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/image', { method: 'POST', headers: { Authorization: `Basic ${credentials}` }, body: form, },);if (response.status === 204) { // imagem enviada; consulte o plano para ler imageUrl}
using System.Net.Http.Headers;using System.Text;var apiKey = Environment.GetEnvironmentVariable("FINVIA_API_KEY");var credentials = Convert.ToBase64String(Encoding.UTF8.GetBytes($"{apiKey}:"));using var client = new HttpClient();client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", credentials);using var form = new MultipartFormDataContent();form.Add(new ByteArrayContent(File.ReadAllBytes("./plano-premium.png")), "file", "plano-premium.png");var request = new HttpRequestMessage(HttpMethod.Post, "https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/image");request.Content = form;var response = await client.SendAsync(request);Console.WriteLine((int)response.StatusCode);Console.WriteLine(await response.Content.ReadAsStringAsync());
{ "statusCode": 404, "message": "Subscription plan not found"}
Planos de assinatura
Enviar imagem do plano
Envia a imagem que representa o plano de assinatura, em PNG, JPG ou JPEG.
POST
/
v1
/
subscription-plans
/
{id}
/
image
POST /v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/image HTTP/1.1Host: api-global.fastpaybrasil.comAuthorization: Basic <base64 de "SUA_CHAVE_SECRETA:">Content-Type: multipart/form-data; boundary=----FinviaBoundary------FinviaBoundaryContent-Disposition: form-data; name="file"; filename="plano-premium.png"<conteúdo de plano-premium.png>------FinviaBoundary--
curl -X POST "https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/image" \ -u "$FINVIA_API_KEY:" \ -F "file=@./plano-premium.png"
import { readFile } from 'node:fs/promises';const credentials = Buffer.from(`${process.env.FINVIA_API_KEY}:`).toString('base64');const form = new FormData();const image = await readFile('./plano-premium.png');form.append('file', new Blob([image], { type: 'image/png' }), 'plano-premium.png');const response = await fetch( 'https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/image', { method: 'POST', headers: { Authorization: `Basic ${credentials}` }, body: form, },);if (response.status === 204) { // imagem enviada; consulte o plano para ler imageUrl}
using System.Net.Http.Headers;using System.Text;var apiKey = Environment.GetEnvironmentVariable("FINVIA_API_KEY");var credentials = Convert.ToBase64String(Encoding.UTF8.GetBytes($"{apiKey}:"));using var client = new HttpClient();client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", credentials);using var form = new MultipartFormDataContent();form.Add(new ByteArrayContent(File.ReadAllBytes("./plano-premium.png")), "file", "plano-premium.png");var request = new HttpRequestMessage(HttpMethod.Post, "https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/image");request.Content = form;var response = await client.SendAsync(request);Console.WriteLine((int)response.StatusCode);Console.WriteLine(await response.Content.ReadAsStringAsync());
{ "statusCode": 404, "message": "Subscription plan not found"}
Esta rota anexa uma imagem ao plano, como o logotipo do produto ou uma arte da oferta. Depois do envio, o endereço da imagem passa a aparecer no campo imageUrl do plano, pronto para ser exibido na sua vitrine de planos.
Quando usar
Situação
Como usar esta rota
Plano recém-criado sem imagem
Chame logo depois de Criar plano, com o id devolvido
Tenha uma chave secreta gerada por usuário com a permissão atualizar assinaturas. Nos perfis padrão, são Owner, Manager e Operador. Os perfis Visualizador, Desenvolvedor e Financeiro recebem 403 (veja Permissões por perfil).
Tenha o id do plano.
Tenha o arquivo em PNG, JPG ou JPEG.
Assinaturas não têm modo de teste: as cobranças são reais mesmo com a chave de teste. Veja como homologar em Assinaturas: visão geral.
Para o desenvolvedor: esta é uma das poucas rotas de assinatura que não recebem JSON. O corpo vai como multipart/form-data, com o arquivo no campo file. Não defina o header Content-Type manualmente ao usar FormData no Node.js ou a opção -F do cURL: a biblioteca monta o header com o boundary correto.
Parâmetros de caminho
string
required
Identificador único do plano. Ex.: 2RhQg9M7ZCg3X3nMb9W1kX8Q.
Corpo da requisição
Formato multipart/form-data. Campo obrigatório: file.
file
required
Arquivo de imagem (formato binary): PNG, JPG ou JPEG.
Respostas
A resposta de sucesso não tem corpo. Para obter a URL da imagem, consulte o plano e leia o campo imageUrl.
HTTP
Significado
Corpo
204
Imagem enviada
Sem corpo
401
Credencial inválida
{"statusCode": 401, "message": "Unauthorized"}
403
O usuário que gerou a chave não tem a permissão atualizar assinaturas
{"statusCode": 404, "message": "Subscription plan not found"}
Para o negócio: a imagem é um dado do plano, guardado junto com nome, preço e mensagem ao comprador. A forma de exibi-la (tamanho, recorte, onde aparece) fica a cargo da sua aplicação, que lê o imageUrl.
Envie o arquivo no campo file de um formulário multipart
Resposta vazia interpretada como erro
Sucesso devolve 204 sem corpo
Trate 204 como sucesso e não tente ler JSON da resposta
POST /v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/image HTTP/1.1Host: api-global.fastpaybrasil.comAuthorization: Basic <base64 de "SUA_CHAVE_SECRETA:">Content-Type: multipart/form-data; boundary=----FinviaBoundary------FinviaBoundaryContent-Disposition: form-data; name="file"; filename="plano-premium.png"<conteúdo de plano-premium.png>------FinviaBoundary--
curl -X POST "https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/image" \ -u "$FINVIA_API_KEY:" \ -F "file=@./plano-premium.png"
import { readFile } from 'node:fs/promises';const credentials = Buffer.from(`${process.env.FINVIA_API_KEY}:`).toString('base64');const form = new FormData();const image = await readFile('./plano-premium.png');form.append('file', new Blob([image], { type: 'image/png' }), 'plano-premium.png');const response = await fetch( 'https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/image', { method: 'POST', headers: { Authorization: `Basic ${credentials}` }, body: form, },);if (response.status === 204) { // imagem enviada; consulte o plano para ler imageUrl}
using System.Net.Http.Headers;using System.Text;var apiKey = Environment.GetEnvironmentVariable("FINVIA_API_KEY");var credentials = Convert.ToBase64String(Encoding.UTF8.GetBytes($"{apiKey}:"));using var client = new HttpClient();client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", credentials);using var form = new MultipartFormDataContent();form.Add(new ByteArrayContent(File.ReadAllBytes("./plano-premium.png")), "file", "plano-premium.png");var request = new HttpRequestMessage(HttpMethod.Post, "https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/image");request.Content = form;var response = await client.SendAsync(request);Console.WriteLine((int)response.StatusCode);Console.WriteLine(await response.Content.ReadAsStringAsync());