API – Informações de pagamento

Informacoes do pagamento

Verifique o status do seu pagamento

URL

Autorizacao obrigatoria

GET

https://api.fps.pro/invoices/{invoice}

Formato da requisicaopathParam

invoice

required

uuid

ID da fatura

Formato da respostadata object

`id` uuid	ID da invoice
`info.currency` string \| null	Codigo da moeda fiat da invoice
`info.token` string \| null	Token de pagamento
`info.network` string \| null	Rede de pagamento
`info.address` string \| null	Endereco da carteira para pagamento
`amount.starting_price` number	Valor inicial da invoice em fiat
`amount.discount_percent` number	Valor do desconto em porcentagem
`amount.merchant_fee_percent` number	Taxa do merchant em porcentagem
`amount.service_fee_percent` number \| null	Taxa de servico da plataforma em porcentagem
`amount.total` number	Valor final apos desconto e taxa
`url.webhook` url \| null	URL Webhook do merchant
`url.success` url \| null	URL de redirecionamento apos pagamento bem-sucedido
`url.error` url \| null	URL de redirecionamento apos pagamento com erro
`url.payment` url	Link da pagina de pagamento
`options.part_payment` boolean	Indica se pagamento parcial e permitido
`options.ignore_client_amount` boolean	Indica se o valor exato do cliente e ignorado
`options.payment_accuracy` number	Tolerancia de pagamento permitida
`additional.order_id` string \| null	ID externo do pedido
`additional.info` string \| null	Informacoes adicionais do pedido
`status` string	Status atual da invoice
`expired_at` string (ISO 8601, UTC)	Data de expiracao da invoice
`created_at` string (ISO 8601, UTC)	Data de criacao da invoice
`payment.transactions` array	Lista de transacoes blockchain recebidas
`payment.transactions[].txid` string \| null	Hash da transacao
`payment.transactions[].from` string \| null	Endereco do remetente
`payment.transactions[].amount` string \| null	Valor da transacao recebida nas unidades minimas do token
`payment.fiat_payment_amount` number	Valor fiat pago
`payment.service_fee_amount` number	Taxa de servico acumulada em fiat

Exemplos de requisição

curl --request GET 'https://api.fps.pro/invoices/0a718b02-131d-495a-9641-39ca52139c07' \

Resposta bem-sucedida

{
  "status": 200,
  "message": "success",
  "data": {
    "id": "0a718b02-138d-495a-9661-39ca52139c07",
    "info": {
      "currency": "USD",
      "token": "tether",
      "network": "tron",
      "address": "TQ5x...abc"
    },
    "amount": {
      "starting_price": 1000,
      "discount_percent": 0,
      "merchant_fee_percent": 10,
      "service_fee_percent": 1,
      "total": 1100
    },
    "url": {
      "webhook": "https://merchant.example/webhook",
      "success": "https://merchant.example/success",
      "error": "https://merchant.example/error",
      "payment": "https://frontend.example/0a718b02-138d-495a-9661-39ca52139c07"
    },
    "options": {
      "part_payment": true,
      "ignore_client_amount": false,
      "payment_accuracy": 0
    },
    "additional": {
      "order_id": "1",
      "info": "test order"
    },
    "status": "paid",
    "expired_at": "2026-01-05 14:30:43",
    "created_at": "2026-01-05T13:30:43.000Z",
    "payment": {
      "transactions": [
        {
          "txid": "f4d4f497e6b32b6a4b8e...",
          "from": "TFgN...sender",
          "amount": "1100000000"
        }
      ],
      "fiat_payment_amount": 1100,
      "service_fee_amount": 11
    }
  }
}

Erros

A lista detalhada de erros de autorizacao esta em Autorizacao - Erros

{
  "status": 422,
  "message": "Validation Error",
  "errors": [
    {
      "field": "invoice",
      "message": "The invoice must be UUID."
    }
  ]
}

{
  "status": 404,
  "message": "The invoice is not found"
}

{
  "status": 500,
  "message": "Internal Server Error"
}