To use the Liberpay API, you first need to create an account. Please visit https://liberpay.com for a tutorial on creating your account.
\nThe base url for all api calls is https://api.liberpay.com
Visit the \"My Profile\" page at https://app.liberpay.com. Then, click the button to create a new API Key. This key will only be shown once, and is valid until revoked. Copy it somewhere safe.
\nWhen accepting payment, a \"charge\" request first needs to be created by you, the seller. You can create this charge using the create charge endpoint. There are a few things to note about the lifecycle of a charge
\nCharges have 9 possible statuses
\ncreated The default for all new charges
Details about the charge are publicly accessible via the charge shortcode. This is necessary to provide a payment link for the charge. Once the charge leaves created status, only the parties involved in the transaction can retrieve charge details.
Every charge has a payment link like https://app.liberpay.com/charges/:shortcode/pay
When created, updated, or payment currency set a new price quote is retrieved and the currency amount is recalculated.
\nCreated cahrges have an expiration time, by default this is 5 minutes. Once expired, the currency will need to be set or the charge updated to get a new price quote.
\nFiat payments are handled by webhook, and charge status will update automatically. Crypto payments require the transaction to be reported after payment so the backend jobs can verify the validity of the transaction.
\npending A payment has been reported, but not confirmed.
confirmed Payment has been reported and verified as valid.
expired The expiration time has passed. The currency will need to be set or the charge updated to get a new price quote.
failed Payment was reported but failed
underpaid Payment was reported, but not enough was sent.
refund_pending A refund is in progress
refunded Refund(s) were successfully sent, reported, and verified as valid
refund_failed Refund(s) were unsuccessfully sent, or reported and found invalid
The easiest way to create a charge and accept payment is to create the charge over the API, and then relay the payment URL to the buyer. Using this method, LiberPay handles hosting of the payment page including currency selection, charge nonce and hash management, reporting of blockchain transactions and more. This is the easiest method for integrating with LiberPay.
\nIf you wish to build your own payment UI and report payments manually that is possible but a more involved process. Further documentation is coming soon. At a high level you would need to:
\nRetrieve the gateways associated with the charge store
\nLook up supported currencies across the gateways
\nSet the charge currency each time a new one is selected
\nHandle ERC20 token approval and retry of payment after approval
\nIf using Stripe for fiat, create charge fiat_links over the api (Documentation coming soon) and redirect the user to those links
Manage charge nonce and hash by calling the generateCommitment method of the LiberPayReceipt contract
We are more than happy to assist in integration processes. Please reach out to support@liberpay.com for help!
\nA full webhook event system and redirect URLs for the hosted payment page are being actively developed and are coming very soon. In the mean time, you will need to periodically check charge statuses for updates.
\nNFT receipts minted by LiberPay only ever originate from these addresses:
\nPolygon Mainnet: 0x714256086AC8636E95FE28D1b010a0083A684c6d
All gateway and other fees paid over blockchain are only accepted in official USDC ERC20 tokens to the following addresses:
\nMain Fee Wallet: 0xB00a8eb1e0774401208F9507d0d69360F42B9B97
Verifica a validade do token de API
\nMétodo: GET
\nEndpoint: {{baseURL}}/api/auth/verify
Após uma solicitação bem-sucedida, o servidor responde com um objeto JSON contendo a seguinte estrutura:
\ndata (objeto)
\np2p_account (objeto | null): dados da conta P2P (pode ser null se não configurada)
\nuser (objeto):
\nid (integer): ID do usuário
\naddress (string): endereço blockchain (pode ser vazio)
\nemail (string)
\nusername (string)
\nverification (boolean): status de verificação
\nstatus (string): status geral da requisição
\nEste endpoint recupera uma lista de produtos associados a uma loja específica, identificada por seu ID. Os produtos são definidos no nível da empresa e, em seguida, associados a uma ou mais lojas sob a empresa. Este é o endpoint público, que mostrará apenas os produtos publicados para a loja.
\nMétodo: GET
Endpoint: {{baseURL}}/api/stores/{{storeId}}/products
Parâmetros de caminho
\n{\n \"data\": [\n {\n \"business_id\": 1,\n \"description\": \"Foam ear cushions and adjustable headband keep students comfortable.\\nStereo sound offers full audio depth during listening activities.\\nMoisture-resistant storage bag keeps headphones safe and secure.\",\n \"id\": 41,\n \"images\": [\n {\n \"url\": \"https://nftipay-product-images.s3-us-east-2.amazonaws.com/9228e7e3-fc63-4ef5-92f2-cdd1bf197ec3\",\n \"sort\": 1\n }\n ],\n \"is_physical\": true,\n \"name\": \"Headphones\",\n \"price\": {\n \"amount\": \"1\",\n \"currency\": \"BRL\"\n },\n \"sku\": \"2\",\n \"status\": {\n \"id\": 2,\n \"label\": \"Published\"\n },\n \"taxable\": false,\n \"user_id\": 17\n },\n {\n \"business_id\": 1,\n \"description\": \"This is just a test product\",\n \"id\": 3,\n \"images\": [\n {\n \"url\": \"https://nftipay-product-images.s3-us-east-2.amazonaws.com/ed5be128-16ec-4fce-af08-575b44bb5d87\",\n \"sort\": 1\n }\n ],\n \"is_physical\": true,\n \"name\": \"Test Product\",\n \"price\": {\n \"amount\": \"1\",\n \"currency\": \"BRL\"\n },\n \"sku\": \"TEST-1\",\n \"status\": {\n \"id\": 2,\n \"label\": \"Published\"\n },\n \"taxable\": true,\n \"user_id\": 1\n }\n ]\n}\n\ndata: Um array de objetos de produto, cada um contendo:
\nbusiness_id: O ID do negócio associado ao produto.
\ndescription: Uma breve descrição do produto.
\nid: O identificador único do produto.
\nimages: Um array de objetos de imagem associados ao produto, cada um contendo:
\nurl: A URL da imagem do produto.
\nsort: A ordem de exibição da imagem.
\nis_physical: Um valor booleano que indica se o produto é um item físico.
\nname: O nome do produto.
\nprice: Um objeto contendo:
\namount: O valor do preço do produto.
\ncurrency: A moeda do preço.
\nsku: O código de identificação do produto (SKU).
\nstatus: Um objeto contendo:
\nid: O ID do status do produto.
\nlabel: O rótulo do status do produto.
\ntaxable: Um valor booleano que indica se o produto é tributável.
\nuser_id: O ID do usuário associado ao produto.
\nEste endpoint recupera uma lista de produtos associados a uma empresa específica. Os produtos são definidos no nível da empresa e, em seguida, associados a uma ou mais lojas sob a empresa. Este endpoint não é público e requer acesso à empresa.
\nMétodo: GET
Endpoint: {{baseURL}}/api/businesses/{{businessId}}/products
Parâmetros de caminho
\n{\n \"data\": [\n {\n \"business_id\": 1,\n \"description\": \"Foam ear cushions and adjustable headband keep students comfortable.\\nStereo sound offers full audio depth during listening activities.\\nMoisture-resistant storage bag keeps headphones safe and secure.\",\n \"id\": 41,\n \"images\": [\n {\n \"url\": \"https://nftipay-product-images.s3-us-east-2.amazonaws.com/9228e7e3-fc63-4ef5-92f2-cdd1bf197ec3\",\n \"sort\": 1\n }\n ],\n \"is_physical\": true,\n \"name\": \"Headphones\",\n \"price\": {\n \"amount\": \"1\",\n \"currency\": \"BRL\"\n },\n \"sku\": \"2\",\n \"status\": {\n \"id\": 2,\n \"label\": \"Published\"\n },\n \"taxable\": false,\n \"user_id\": 17\n },\n {\n \"business_id\": 1,\n \"description\": \"This is just a test product\",\n \"id\": 3,\n \"images\": [\n {\n \"url\": \"https://nftipay-product-images.s3-us-east-2.amazonaws.com/ed5be128-16ec-4fce-af08-575b44bb5d87\",\n \"sort\": 1\n }\n ],\n \"is_physical\": true,\n \"name\": \"Test Product\",\n \"price\": {\n \"amount\": \"1\",\n \"currency\": \"BRL\"\n },\n \"sku\": \"TEST-1\",\n \"status\": {\n \"id\": 2,\n \"label\": \"Published\"\n },\n \"taxable\": true,\n \"user_id\": 1\n }\n ]\n}\n\ndata: Um array de objetos de produto, cada um contendo:
\nbusiness_id: O ID do negócio associado ao produto.
\ndescription: Uma breve descrição do produto.
\nid: O identificador único do produto.
\nimages: Um array de objetos de imagem associados ao produto, cada um contendo:
\nurl: A URL da imagem do produto.
\nsort: A ordem de exibição da imagem.
\nis_physical: Um valor booleano que indica se o produto é um item físico.
\nname: O nome do produto.
\nprice: Um objeto contendo:
\namount: O valor do preço do produto.
\ncurrency: A moeda do preço.
\nsku: O código de identificação do produto (SKU).
\nstatus: Um objeto contendo:
\nid: O ID do status do produto.
\nlabel: O rótulo do status do produto.
\ntaxable: Um valor booleano que indica se o produto é tributável.
\nuser_id: O ID do usuário associado ao produto.
\nEste endpoint recupera uma lista de produtos associados a uma loja específica, identificada por seu ID. Os produtos são definidos no nível da empresa e, em seguida, associados a uma ou mais lojas sob a empresa. Este é o endpoint privado, que mostrará apenas produtos publicados e não publicados para a loja.
\nMétodo: GET
Endpoint: {{baseURL}}/api/stores/{{storeId}}/products
{\n \"data\": [\n {\n \"business_id\": 1,\n \"description\": \"Foam ear cushions and adjustable headband keep students comfortable.\\nStereo sound offers full audio depth during listening activities.\\nMoisture-resistant storage bag keeps headphones safe and secure.\",\n \"id\": 41,\n \"images\": [\n {\n \"url\": \"https://nftipay-product-images.s3-us-east-2.amazonaws.com/9228e7e3-fc63-4ef5-92f2-cdd1bf197ec3\",\n \"sort\": 1\n }\n ],\n \"is_physical\": true,\n \"name\": \"Headphones\",\n \"price\": {\n \"amount\": \"1\",\n \"currency\": \"BRL\"\n },\n \"sku\": \"2\",\n \"status\": {\n \"id\": 2,\n \"label\": \"Published\"\n },\n \"taxable\": false,\n \"user_id\": 17\n },\n {\n \"business_id\": 1,\n \"description\": \"This is just a test product\",\n \"id\": 3,\n \"images\": [\n {\n \"url\": \"https://nftipay-product-images.s3-us-east-2.amazonaws.com/ed5be128-16ec-4fce-af08-575b44bb5d87\",\n \"sort\": 1\n }\n ],\n \"is_physical\": true,\n \"name\": \"Test Product\",\n \"price\": {\n \"amount\": \"1\",\n \"currency\": \"BRL\"\n },\n \"sku\": \"TEST-1\",\n \"status\": {\n \"id\": 2,\n \"label\": \"Published\"\n },\n \"taxable\": true,\n \"user_id\": 1\n }\n ]\n}\n\nRetorna detalhes completos de um produto.
\nMétodo: GET
\nEndpoint: {{baseURL}}/api/products/{id}
Parâmetros de caminho:
\nid (integer): ID do produto{\n \"data\": {\n \"business_id\": 1,\n \"description\": \"Foam ear cushions and adjustable headband keep students comfortable.\\nStereo sound offers full audio depth during listening activities.\\nMoisture-resistant storage bag keeps headphones safe and secure.\",\n \"id\": 41,\n \"images\": [\n {\n \"url\": \"https://nftipay-product-images.s3-us-east-2.amazonaws.com/9228e7e3-fc63-4ef5-92f2-cdd1bf197ec3\",\n \"sort\": 1\n }\n ],\n \"is_physical\": true,\n \"name\": \"Headphones\",\n \"price\": {\n \"amount\": \"1\",\n \"currency\": \"BRL\"\n },\n \"sku\": \"2\",\n \"status\": {\n \"id\": 2,\n \"label\": \"Published\"\n },\n \"stores\": [\n {\n \"id\": 1,\n \"name\": \"Main Store\"\n }\n ],\n \"taxable\": false,\n \"user_id\": 17\n }\n}\n\nbusiness_id: O ID do negócio associado ao produto.
\ndescription: Uma breve descrição do produto.
\nid: O identificador único do produto.
\nimages: Um array de objetos de imagem associados ao produto, cada um contendo:
\nurl: A URL da imagem do produto.
\nsort: A ordem de exibição da imagem.
\nis_physical: Um valor booleano que indica se o produto é um item físico.
\nname: O nome do produto.
\nprice: Um objeto contendo:
\namount: O valor do preço do produto.
\ncurrency: A moeda do preço.
\nsku: O código de identificação do produto (SKU).
\nstatus: Um objeto contendo:
\nid: O ID do status do produto.
\nlabel: O rótulo do status do produto.
\ntaxable: Um valor booleano que indica se o produto é tributável.
\nuser_id: O ID do usuário associado ao produto.
\nEste endpoint permite criar um novo produto no sistema. Ao enviar uma solicitação POST para {{baseURL}}/api/products, você pode adicionar um produto com vários atributos, como nome, descrição, preço e informações comerciais e da loja associadas.
{\n \"product\": {\n \"product_status_id\": <integer>, // O ID do status do produto. Chame o endpoint de status de produtos para obter a lista de opções.\n \"name\": <string>, // O nome do produto\n \"description\": <string>, // Uma breve descrição do produto\n \"price\": {\n \"currency\": <string>, // O código da moeda (ex.: BRL)\n \"value\": <string> // O valor do preço\n },\n \"is_physical\": <boolean>, // Indica se o produto é um item físico\n \"images\": <array>, // Um array de URLs de imagens do produto\n \"business_id\": <integer>, // O ID do negócio associado ao produto\n \"stores\": <array> // Um array de IDs de lojas onde o produto está disponível\n }\n}\n\nRequest body
\nproduct (object): Os detalhes do produto a ser adicionado.
\nproduct_status_id (integer): O ID do status do produto.
\nname (string): O nome do produto.
\ndescription (string): Uma breve descrição do produto.
\nprice (object): Os detalhes de preço do produto.
\ncurrency (string): O código da moeda (ex.: \"BRL\").
\nvalue (string): O valor do preço.
\nis_physical (boolean): Indica se o produto é um item físico.
\nimages (array): Um array de URLs de imagens associadas ao produto (pode estar vazio).
\nbusiness_id (integer): O ID do negócio proprietário do produto.
\nstores (array): Um array de IDs de lojas onde o produto está disponível.
\nUpon a successful request, the API will respond with a 201 Created status and a JSON object containing the following structure:
```
{
\"data\": {
\"business_id\": 1,
\"description\": \"This is a candle for sale\",
\"id\": 86,
\"images\": [],
\"is_physical\": true,
\"name\": \"Candle\",
\"price\": {
\"amount\": \"1.50\",
\"currency\": \"BRL\"
},
\"sku\": null,
\"status\": {
\"id\": null,
\"label\": \"\"
},
\"taxable\": false,
\"user_id\": 1
}
}
Response
Após uma requisição bem-sucedida, a API responderá com um status 201 Created e um objeto JSON contendo a seguinte estrutura:
\n```json
{
\"data\": {
\"business_id\": 1,
\"description\": \"This is a candle for sale\",
\"id\": 86,
\"images\": [],
\"is_physical\": true,
\"name\": \"Candle\",
\"price\": {
\"amount\": \"1.50\",
\"currency\": \"BRL\"
},
\"sku\": null,
\"status\": {
\"id\": null,
\"label\": \"\"
},
\"taxable\": false,
\"user_id\": 1
}
}
- **taxable** (boolean): Indicates if the product is taxable (default is true).\n- **user_id** (integer): The ID of the user who created the product (default is 0).\n\nThis endpoint allows you to update the details of a specific product identified by its unique ID. The request requires a JSON payload containing the updated product information.
\nMethod: PUT
\nURL: {{baseURL}}/api/products/{id}
The request body must be a JSON object with the following structure:
\n{\n \"product\": {\n \"product_status_id\": <integer>, // The status ID of the product. Call the product statuses endpoint for a list of options.\n \"name\": <string>, // The name of the product\n \"description\": <tring>, // A brief description of the product\n \"price\": {\n \"currency\": <string>, // The currency code (e.g., BRL)\n \"value\": <string> // The price value\n },\n \"is_physical\": <boolean>, // Indicates if the product is a physical item\n \"images\": <array>, // An array of image URLs for the product\n \"business_id\": <integer>, // The ID of the business associated with the product\n \"stores\": <array> // An array of store IDs where the product is available\n }\n}\n\nUpon a successful update, the API will return a response with a status code of 200 and a JSON object containing the updated product details. The response structure is as follows:
\n{\n \"data\": {\n \"business_id\": 1,\n \"description\": \"This is a candle for sale, updated name and price!\",\n \"id\": 86,\n \"images\": [],\n \"is_physical\": true,\n \"name\": \"Candle Updated\",\n \"price\": {\n \"amount\": \"2.50\",\n \"currency\": \"BRL\"\n },\n \"sku\": null,\n \"status\": {\n \"id\": 1,\n \"label\": \"Draft\"\n },\n \"stores\": [\n {\n \"id\": 1,\n \"name\": \"Main Store\"\n }\n ],\n \"taxable\": false,\n \"user_id\": 1\n }\n}\n\nEnsure that the product ID in the URL corresponds to a valid product that exists in the system.
\nThe images field can be left as an empty array if no images are being updated.
The response will include default values for fields that are not updated, such as business_id, description, and name.
This endpoint is used to delete a specific product from the inventory based on the provided product ID. Make a DELETE request to /api/products/{id}
86.204 No Content - This indicates that the request was successful and the product has been deleted. No additional content will be returned in the response body.Ensure that the product ID provided in the request exists in the system before attempting to delete.
\nA successful deletion will not return any content, but the status code will confirm the action.
\nThis operation is irreversible; once a product is deleted, it cannot be recovered.
\nEste endpoint recupera uma lista de cobranças da API em que o \"creator\" é o usuário do token. Ele foi projetado para fornecer informações detalhadas sobre cada cobrança, incluindo metadados associados, detalhes de pagamento e informações do vendedor.
\nMétodo: GET
\nURL: {{baseURL}}/api/charges
Após uma requisição bem-sucedida, a API retorna uma resposta com status 200 e Content-Type application/json. A estrutura da resposta é a seguinte:
{\n \"data\": [\n {\n \"creator\": {\n \"address\": \"0x993b7433d2D6Cf74056Db19E5B3BA523557d5d50\",\n \"email\": \"steve+seller@nftipay.com\",\n \"id\": 1,\n \"username\": \"seller\"\n },\n \"currency\": {\n \"id\": 1,\n \"name\": \"Polygon\",\n \"symbol\": \"POL\",\n \"decimals\": 18,\n \"address\": \"0x0000000000000000000000000000000000000000\"\n },\n \"currency_price\": \"991680711179458560\",\n \"exchange_rate\": \"0.991680711179458600\",\n \"expires_at\": \"2025-07-06T22:25:32Z\",\n \"fiat_currency\": {\n \"id\": 2,\n \"name\": \"Brazilian Real \",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n \"gateway\": {\n \"address\": \"0xf2d1b6e93699f7b2d1f81bd4d72ef3c5ad5d58a4\",\n \"config\": {},\n \"creator_id\": 1,\n \"id\": 73,\n \"is_system\": false,\n \"licensed\": true,\n \"name\": \"NFTiPay Main\",\n \"type\": {\n \"id\": 1,\n \"identifier\": \"polygon\",\n \"label\": \"Polygon\",\n \"platform\": {\n \"id\": 1,\n \"identifier\": \"evm\",\n \"label\": \"Ethereum Virtual Machine\"\n }\n }\n },\n \"hash\": \"0x10fd8da9d8da5c42e5a0582a42c23d7931ef727927b5d769a64b899f44aba6e6\",\n \"id\": 168,\n \"inserted_at\": \"2025-07-06T22:20:31\",\n \"metadata\": {\n \"items\": [\n {\n \"description\": \"Shirt\",\n \"id\": 52,\n \"images\": [\n {\n \"url\": \"https://liberpay-product-images.s3-sa-east-1.amazonaws.com/f9c9ac66-2a07-48d1-bbfe-df24bf850064\"\n }\n ],\n \"is_physical\": true,\n \"name\": \"Shirt\",\n \"price\": {\n \"amount\": \"1\",\n \"currency\": \"BRL\"\n },\n \"price_currency\": \"991680711179458560\",\n \"quantity\": 1,\n \"subtotal\": {\n \"amount\": \"1.00\",\n \"currency\": \"BRL\"\n },\n \"subtotal_currency\": \"991680711179458560\",\n \"tax\": {\n \"amount\": \"0.00\",\n \"currency\": \"BRL\"\n },\n \"tax_currency\": \"0\",\n \"tax_rate\": \"0.00000\",\n \"taxable\": false,\n \"total\": {\n \"amount\": \"1.00\",\n \"currency\": \"BRL\"\n },\n \"total_currency\": \"991680711179458560\",\n \"unit_tax\": {\n \"amount\": \"0\",\n \"currency\": \"BRL\"\n },\n \"unit_tax_currency\": \"0\"\n }\n ]\n },\n \"payments\": [],\n \"price\": {\n \"amount\": \"1.00\",\n \"currency\": \"BRL\"\n },\n \"refunds\": [],\n \"seller_address\": \"0x993b7433d2D6Cf74056Db19E5B3BA523557d5d50\",\n \"shortcode\": \"73cS5lcsI5R2x\",\n \"status\": {\n \"id\": 1,\n \"label\": \"created\"\n },\n \"store\": {\n \"business\": {\n \"id\": 1,\n \"name\": \"NFTiPay\"\n },\n \"id\": 1,\n \"logo\": \"https://nftipay-product-images.s3-us-east-2.amazonaws.com/93d397a8-c06b-43da-aaa9-c26999d9dd4c\",\n \"name\": \"Main Store\"\n },\n \"tokens\": [],\n \"type\": {\n \"id\": 1,\n \"label\": \"Point of Sale\"\n }\n }\n ]\n}\n\ndata: Um array contendo objetos de cobrança.
\ncreator: Informações sobre o criador da cobrança (address, email, id, username).
\ncurrency: Detalhes sobre a moeda usada (id, name, symbol, decimals, address).
\nfiat_currency: Informações sobre a moeda fiduciária (id, name, symbol, sign).
\nprice: O preço total da cobrança em moeda fiduciária ou moeda base.
\ncurrency_price: O preço da cobrança na moeda selecionada.
\nexchange_rate: A taxa de câmbio usada para calcular currency_price a partir de price.
expires_at: Data de expiração da cobrança, após a qual ela não pode ser paga.
\ngateway: Detalhes sobre o gateway de pagamento (address, config, creator_id, id, is_system, licensed, name, type).
\nhash: Identificador único da cobrança.
\nid: Identificador único da cobrança.
\ninserted_at: Data/hora em que a cobrança foi criada.
\nmetadata: Informações adicionais sobre a cobrança, incluindo itens vendidos, preços e impostos.
\npayments: Array de detalhes de pagamentos relacionados à cobrança.
\nrefunds: Array de reembolsos associados à cobrança.
\nseller_address: Endereço do vendedor.
\nshortcode: Código curto da cobrança, usado no link de pagamento e para identificar a cobrança.
\nstatus: Status atual da cobrança (id, label).
\nstore: Informações sobre a loja (detalhes do negócio, id, logo, name).
\ntokens: Quaisquer tokens associados à cobrança.
\ntype: Tipo de cobrança (id, label). Pode ser Point of Sale, Invoice ou Peer to Peer.
\nEste endpoint é essencial para recuperar detalhes abrangentes sobre as cobranças, permitindo que os usuários gerenciem e analisem dados relacionados de forma eficaz.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a16defba-0ba4-4a35-9be6-205191c70606","id":"a16defba-0ba4-4a35-9be6-205191c70606","name":"Documentação da API Liberpay","type":"collection"}},"urlObject":{"path":["api","charges"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6c71356e-1562-4683-854c-b883ff7e123e"},{"name":"listar negócios","id":"61a90980-b8e9-43f8-93b2-7e1a187f7b09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseURL}}/api/stores/1/charges","description":"Este endpoint recupera as cobranças associadas a uma loja específica identificada pelo seu ID. É uma requisição GET feita para {{baseURL}}/api/stores/{storeId}/charges, onde {storeId} é o identificador único da loja.
Você também pode substituir /charges por /sales para recuperar apenas cobranças de ponto de venda ou por /invoices para recuperar apenas cobranças de faturas.
Após uma requisição bem-sucedida (HTTP Status 200), a resposta estará no formato JSON e conterá a seguinte estrutura:
\n{\n \"data\": [\n {\n \"creator\": {\n \"address\": \"0x993b7433d2D6Cf74056Db19E5B3BA523557d5d50\",\n \"email\": \"steve+seller@nftipay.com\",\n \"id\": 1,\n \"username\": \"seller\"\n },\n \"currency\": {\n \"id\": 1,\n \"name\": \"Polygon\",\n \"symbol\": \"POL\",\n \"decimals\": 18,\n \"address\": \"0x0000000000000000000000000000000000000000\"\n },\n \"currency_price\": \"991680711179458560\",\n \"exchange_rate\": \"0.991680711179458600\",\n \"expires_at\": \"2025-07-06T22:25:32Z\",\n \"fiat_currency\": {\n \"id\": 2,\n \"name\": \"Brazilian Real \",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n \"gateway\": {\n \"address\": \"0xf2d1b6e93699f7b2d1f81bd4d72ef3c5ad5d58a4\",\n \"config\": {},\n \"creator_id\": 1,\n \"id\": 73,\n \"is_system\": false,\n \"licensed\": true,\n \"name\": \"NFTiPay Main\",\n \"type\": {\n \"id\": 1,\n \"identifier\": \"polygon\",\n \"label\": \"Polygon\",\n \"platform\": {\n \"id\": 1,\n \"identifier\": \"evm\",\n \"label\": \"Ethereum Virtual Machine\"\n }\n }\n },\n \"hash\": \"0x10fd8da9d8da5c42e5a0582a42c23d7931ef727927b5d769a64b899f44aba6e6\",\n \"id\": 168,\n \"inserted_at\": \"2025-07-06T22:20:31\",\n \"metadata\": {\n \"items\": [\n {\n \"description\": \"Shirt\",\n \"id\": 52,\n \"images\": [\n {\n \"url\": \"https://liberpay-product-images.s3-sa-east-1.amazonaws.com/f9c9ac66-2a07-48d1-bbfe-df24bf850064\"\n }\n ],\n \"is_physical\": true,\n \"name\": \"Shirt\",\n \"price\": {\n \"amount\": \"1\",\n \"currency\": \"BRL\"\n },\n \"price_currency\": \"991680711179458560\",\n \"quantity\": 1,\n \"subtotal\": {\n \"amount\": \"1.00\",\n \"currency\": \"BRL\"\n },\n \"subtotal_currency\": \"991680711179458560\",\n \"tax\": {\n \"amount\": \"0.00\",\n \"currency\": \"BRL\"\n },\n \"tax_currency\": \"0\",\n \"tax_rate\": \"0.00000\",\n \"taxable\": false,\n \"total\": {\n \"amount\": \"1.00\",\n \"currency\": \"BRL\"\n },\n \"total_currency\": \"991680711179458560\",\n \"unit_tax\": {\n \"amount\": \"0\",\n \"currency\": \"BRL\"\n },\n \"unit_tax_currency\": \"0\"\n }\n ]\n },\n \"payments\": [],\n \"price\": {\n \"amount\": \"1.00\",\n \"currency\": \"BRL\"\n },\n \"refunds\": [],\n \"seller_address\": \"0x993b7433d2D6Cf74056Db19E5B3BA523557d5d50\",\n \"shortcode\": \"73cS5lcsI5R2x\",\n \"status\": {\n \"id\": 1,\n \"label\": \"created\"\n },\n \"store\": {\n \"business\": {\n \"id\": 1,\n \"name\": \"NFTiPay\"\n },\n \"id\": 1,\n \"logo\": \"https://nftipay-product-images.s3-us-east-2.amazonaws.com/93d397a8-c06b-43da-aaa9-c26999d9dd4c\",\n \"name\": \"Main Store\"\n },\n \"tokens\": [],\n \"type\": {\n \"id\": 1,\n \"label\": \"Point of Sale\"\n }\n }\n ]\n}\n\ndata: Um array contendo objetos de cobrança.
\ncreator: Informações sobre o criador da cobrança (address, email, id, username).
\ncurrency: Detalhes sobre a moeda usada (id, name, symbol, decimals, address).
\nfiat_currency: Informações sobre a moeda fiduciária (id, name, symbol, sign).
\nprice: O preço total da cobrança em moeda fiduciária ou moeda base.
\ncurrency_price: O preço da cobrança na moeda selecionada.
\nexchange_rate: A taxa de câmbio usada para calcular currency_price a partir de price.
expires_at: Data de expiração da cobrança, após a qual ela não pode ser paga.
\ngateway: Detalhes sobre o gateway de pagamento (address, config, creator_id, id, is_system, licensed, name, type).
\nhash: Identificador único da cobrança.
\nid: Identificador único da cobrança.
\ninserted_at: Data/hora em que a cobrança foi criada.
\nmetadata: Informações adicionais sobre a cobrança, incluindo itens vendidos, preços e impostos.
\npayments: Array de detalhes de pagamentos relacionados à cobrança.
\nrefunds: Array de reembolsos associados à cobrança.
\nseller_address: Endereço do vendedor.
\nshortcode: Código curto da cobrança, usado no link de pagamento e para identificar a cobrança.
\nstatus: Status atual da cobrança (id, label).
\nstore: Informações sobre a loja (detalhes do negócio, id, logo, name).
\ntokens: Quaisquer tokens associados à cobrança.
\ntype: Tipo de cobrança (id, label). Pode ser Point of Sale, Invoice ou Peer to Peer.
\nEste endpoint recupera as cobranças associadas a um gateway específico identificado pelo seu ID. É uma requisição GET feita para {{baseURL}}/api/gateways/{gatewayId}/charges, onde {gatewayId} é o identificador único do gateway.
Você também pode substituir /charges por /sales para recuperar apenas cobranças de ponto de venda ou por /invoices para recuperar apenas cobranças de faturas.
Após uma requisição bem-sucedida (HTTP Status 200), a resposta estará no formato JSON e conterá a seguinte estrutura:
\n{\n \"data\": [\n {\n \"creator\": {\n \"address\": \"0x993b7433d2D6Cf74056Db19E5B3BA523557d5d50\",\n \"email\": \"steve+seller@nftipay.com\",\n \"id\": 1,\n \"username\": \"seller\"\n },\n \"currency\": {\n \"id\": 1,\n \"name\": \"Polygon\",\n \"symbol\": \"POL\",\n \"decimals\": 18,\n \"address\": \"0x0000000000000000000000000000000000000000\"\n },\n \"currency_price\": \"991680711179458560\",\n \"exchange_rate\": \"0.991680711179458600\",\n \"expires_at\": \"2025-07-06T22:25:32Z\",\n \"fiat_currency\": {\n \"id\": 2,\n \"name\": \"Brazilian Real \",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n \"gateway\": {\n \"address\": \"0xf2d1b6e93699f7b2d1f81bd4d72ef3c5ad5d58a4\",\n \"config\": {},\n \"creator_id\": 1,\n \"id\": 73,\n \"is_system\": false,\n \"licensed\": true,\n \"name\": \"NFTiPay Main\",\n \"type\": {\n \"id\": 1,\n \"identifier\": \"polygon\",\n \"label\": \"Polygon\",\n \"platform\": {\n \"id\": 1,\n \"identifier\": \"evm\",\n \"label\": \"Ethereum Virtual Machine\"\n }\n }\n },\n \"hash\": \"0x10fd8da9d8da5c42e5a0582a42c23d7931ef727927b5d769a64b899f44aba6e6\",\n \"id\": 168,\n \"inserted_at\": \"2025-07-06T22:20:31\",\n \"metadata\": {\n \"items\": [\n {\n \"description\": \"Shirt\",\n \"id\": 52,\n \"images\": [\n {\n \"url\": \"https://liberpay-product-images.s3-sa-east-1.amazonaws.com/f9c9ac66-2a07-48d1-bbfe-df24bf850064\"\n }\n ],\n \"is_physical\": true,\n \"name\": \"Shirt\",\n \"price\": {\n \"amount\": \"1\",\n \"currency\": \"BRL\"\n },\n \"price_currency\": \"991680711179458560\",\n \"quantity\": 1,\n \"subtotal\": {\n \"amount\": \"1.00\",\n \"currency\": \"BRL\"\n },\n \"subtotal_currency\": \"991680711179458560\",\n \"tax\": {\n \"amount\": \"0.00\",\n \"currency\": \"BRL\"\n },\n \"tax_currency\": \"0\",\n \"tax_rate\": \"0.00000\",\n \"taxable\": false,\n \"total\": {\n \"amount\": \"1.00\",\n \"currency\": \"BRL\"\n },\n \"total_currency\": \"991680711179458560\",\n \"unit_tax\": {\n \"amount\": \"0\",\n \"currency\": \"BRL\"\n },\n \"unit_tax_currency\": \"0\"\n }\n ]\n },\n \"payments\": [],\n \"price\": {\n \"amount\": \"1.00\",\n \"currency\": \"BRL\"\n },\n \"refunds\": [],\n \"seller_address\": \"0x993b7433d2D6Cf74056Db19E5B3BA523557d5d50\",\n \"shortcode\": \"73cS5lcsI5R2x\",\n \"status\": {\n \"id\": 1,\n \"label\": \"created\"\n },\n \"store\": {\n \"business\": {\n \"id\": 1,\n \"name\": \"NFTiPay\"\n },\n \"id\": 1,\n \"logo\": \"https://nftipay-product-images.s3-us-east-2.amazonaws.com/93d397a8-c06b-43da-aaa9-c26999d9dd4c\",\n \"name\": \"Main Store\"\n },\n \"tokens\": [],\n \"type\": {\n \"id\": 1,\n \"label\": \"Point of Sale\"\n }\n }\n ]\n}\n\ndata: Um array contendo objetos de cobrança.
\ncreator: Informações sobre o criador da cobrança (address, email, id, username).
\ncurrency: Detalhes sobre a moeda usada (id, name, symbol, decimals, address).
\nfiat_currency: Informações sobre a moeda fiduciária (id, name, symbol, sign).
\nprice: O preço total da cobrança em moeda fiduciária ou moeda base.
\ncurrency_price: O preço da cobrança na moeda selecionada.
\nexchange_rate: A taxa de câmbio usada para calcular currency_price a partir de price.
expires_at: Data de expiração da cobrança, após a qual ela não pode ser paga.
\ngateway: Detalhes sobre o gateway de pagamento (address, config, creator_id, id, is_system, licensed, name, type).
\nhash: Identificador único da cobrança.
\nid: Identificador único da cobrança.
\ninserted_at: Data/hora em que a cobrança foi criada.
\nmetadata: Informações adicionais sobre a cobrança, incluindo itens vendidos, preços e impostos.
\npayments: Array de detalhes de pagamentos relacionados à cobrança.
\nrefunds: Array de reembolsos associados à cobrança.
\nseller_address: Endereço do vendedor.
\nshortcode: Código curto da cobrança, usado no link de pagamento e para identificar a cobrança.
\nstatus: Status atual da cobrança (id, label).
\nstore: Informações sobre a loja (detalhes do negócio, id, logo, name).
\ntokens: Quaisquer tokens associados à cobrança.
\ntype: Tipo de cobrança (id, label). Pode ser Point of Sale, Invoice ou Peer to Peer.
\nEste endpoint é usado para recuperar informações detalhadas sobre uma cobrança específica, permitindo que os usuários entendam os atributos da cobrança e seus metadados associados.
\nMétodo: GET
\nEndpoint: {{baseURL}}/api/charges/{shortcode}
Parâmetro de Caminho:
\nStatus Code: 200 OK
\nContent-Type: application/json
\nEstrutura da Resposta:
O retorno será um objeto JSON contendo informações detalhadas sobre a cobrança. Os principais campos incluem:
creator: Informações sobre o criador da cobrança (address, email, id, username).
\ncurrency: Detalhes da moeda usada (id, name, symbol, decimals, address).
\ncurrency_price: O preço da moeda no momento da cobrança.
\nexchange_rate: A taxa de câmbio aplicada.
\nexpires_at: A data e hora de expiração da cobrança.
\nfiat_currency: Informações da moeda fiduciária (id, name, symbol, sign).
\ngateway: Detalhes sobre o gateway de pagamento (address, config, creator_id, id, is_system, licensed, name, type).
\nhash: Hash único da cobrança.
\nid: Identificador único da cobrança.
\ninserted_at: Data/hora em que a cobrança foi criada.
\nmetadata: Array de itens relacionados à cobrança, com detalhes como descrição, id, imagens, se é físico, nome, preço, quantidade, subtotal, impostos, total e imposto unitário.
\npayments: Array de pagamentos associados à cobrança.
\nrefunds: Array de reembolsos relacionados à cobrança.
\nseller_address: Endereço do vendedor (se aplicável).
\nshortcode: Código curto associado à cobrança, usado para identificá-la especialmente no status created.
\nstatus: Status atual da cobrança (id, label).
\nstore: Informações sobre a loja associada (business, id, logo, name).
\ntokens: Tokens associados à cobrança.
\ntype: Tipo da cobrança (id, label).
\n{\n \"creator\": {\n \"address\": \"0x993b7433d2D6Cf74056Db19E5B3BA523557d5d50\",\n \"email\": \"steve+seller@nftipay.com\",\n \"id\": 1,\n \"username\": \"seller\"\n },\n \"currency\": {\n \"id\": 1,\n \"name\": \"Polygon\",\n \"symbol\": \"POL\",\n \"decimals\": 18,\n \"address\": \"0x0000000000000000000000000000000000000000\"\n },\n \"currency_price\": \"76679192534769725440\",\n \"exchange_rate\": \"0.751756789556566000\",\n \"expires_at\": \"2025-08-17T21:47:52Z\",\n \"fiat_currency\": {\n \"id\": 2,\n \"name\": \"Brazilian Real \",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n \"gateway\": {\n \"address\": \"0xf2d1b6e93699f7b2d1f81bd4d72ef3c5ad5d58a4\",\n \"config\": {},\n \"creator_id\": 1,\n \"id\": 73,\n \"is_system\": false,\n \"licensed\": true,\n \"name\": \"NFTiPay Main\",\n \"type\": {\n \"id\": 1,\n \"identifier\": \"polygon\",\n \"label\": \"Polygon\",\n \"platform\": {\n \"id\": 1,\n \"identifier\": \"evm\",\n \"label\": \"Ethereum Virtual Machine\"\n }\n }\n },\n \"hash\": null,\n \"id\": 231,\n \"inserted_at\": \"2025-08-17T21:42:52\",\n \"metadata\": {\n \"items\": [\n {\n \"description\": \"This is just a test product\",\n \"id\": 3,\n \"images\": [\n {\n \"url\": \"https://nftipay-product-images.s3-us-east-2.amazonaws.com/ed5be128-16ec-4fce-af08-575b44bb5d87\"\n }\n ],\n \"is_physical\": true,\n \"name\": \"Test Product\",\n \"price\": {\n \"amount\": \"1\",\n \"currency\": \"BRL\"\n },\n \"price_currency\": \"751756789556566016\",\n \"quantity\": 2,\n \"subtotal\": {\n \"amount\": \"2.00\",\n \"currency\": \"BRL\"\n },\n \"subtotal_currency\": \"1503513579113132032\",\n \"tax\": {\n \"amount\": \"0.00\",\n \"currency\": \"BRL\"\n },\n \"tax_currency\": \"0\",\n \"tax_rate\": \"0.00000\",\n \"taxable\": true,\n \"total\": {\n \"amount\": \"2.00\",\n \"currency\": \"BRL\"\n },\n \"total_currency\": \"1503513579113132032\",\n \"unit_tax\": {\n \"amount\": \"0.00\",\n \"currency\": \"BRL\"\n },\n \"unit_tax_currency\": \"0\"\n },\n {\n \"description\": \"\",\n \"id\": \"f543912d-d957-4bb2-a9a8-182c01f2f932\",\n \"is_physical\": true,\n \"metadata\": {},\n \"name\": \"Test Item\",\n \"price\": {\n \"amount\": \"100.0\",\n \"currency\": \"BRL\"\n },\n \"price_currency\": \"75175678955656593408\",\n \"quantity\": 1.0,\n \"subtotal\": {\n \"amount\": \"100.00\",\n \"currency\": \"BRL\"\n },\n \"subtotal_currency\": \"75175678955656593408\",\n \"tax\": {\n \"amount\": \"0.00\",\n \"currency\": \"BRL\"\n },\n \"tax_currency\": \"0\",\n \"tax_rate\": \"0.00000\",\n \"taxable\": false,\n \"total\": {\n \"amount\": \"100.00\",\n \"currency\": \"BRL\"\n },\n \"total_currency\": \"75175678955656593408\",\n \"unit_tax\": {\n \"amount\": \"0\",\n \"currency\": \"BRL\"\n },\n \"unit_tax_currency\": \"0\"\n }\n ]\n },\n \"payments\": [],\n \"price\": {\n \"amount\": \"102.00\",\n \"currency\": \"BRL\"\n },\n \"refunds\": [],\n \"seller_address\": null,\n \"shortcode\": \"73cJltPHglQdnVH\",\n \"status\": {\n \"id\": 1,\n \"label\": \"created\"\n },\n \"store\": {\n \"business\": {\n \"id\": 1,\n \"name\": \"Liberpay\"\n },\n \"id\": 1,\n \"logo\": \"https://nftipay-product-images.s3-us-east-2.amazonaws.com/93d397a8-c06b-43da-aaa9-c26999d9dd4c\",\n \"name\": \"Main Store\"\n },\n \"tokens\": [],\n \"type\": {\n \"id\": 1,\n \"label\": \"Point of Sale\"\n }\n}\n\nEste endpoint permite criar uma nova cobrança no sistema. Ele aceita um payload em JSON contendo detalhes sobre a cobrança, incluindo a moeda, o ID da moeda fiduciária, o ID do gateway, o ID da loja, o tipo de cobrança, o endereço do vendedor e uma lista de produtos associados à cobrança.
\nO corpo da requisição deve estar em formato JSON e incluir os seguintes parâmetros:
\ncharge (object): O objeto principal contendo os detalhes da cobrança.
\ncurrency_address (string): O endereço da moeda usada na cobrança. Obtido no endpoint currencies.
fiat_currency_id (integer): O ID da moeda fiduciária associada à cobrança. Obtido no endpoint fiat_currencies.
gateway_id (integer): O ID do gateway de pagamento usado para a transação. Gateways pertencem a um negócio e podem estar associados a várias lojas. Obtido no endpoint gateways.
store_id (integer): O ID da loja onde a cobrança está sendo criada. Obtido no endpoint stores.
charge_type_id (integer): O ID que representa o tipo de cobrança.
\n1 => Point of Sale
2 => Invoice
3 => Peer to Peer
seller_address (string|null): O endereço do vendedor (pode ser null). Pode ser obtido chamando o método gatewayAddressSellerAddress do contrato LiberPayReceipt.
products (array): Uma lista de produtos incluídos na cobrança.
\nid (integer): O ID do produto. Deixe null para especificar um valor fixo.
quantity (integer): A quantidade do produto sendo cobrada.
\ntype (string): O tipo do produto. Opcional em produtos com id, mas se especificar um valor fixo deixe id como null e use \"amount\" aqui.
{\n \"charge\": {\n \"currency_address\": \"0x0000000000000000000000000000000000000000\",\n \"fiat_currency_id\": 2,\n \"gateway_id\": 73,\n \"store_id\": 1,\n \"charge_type_id\": 1,\n \"seller_address\": null,\n \"products\": [\n {\n \"id\": 3,\n \"quantity\": 2,\n \"type\": \"product\"\n },\n {\n \"id\": null,\n \"quantity\": 1,\n \"type\": \"amount\",\n \"name\": \"Test Item\",\n \"taxable\": false,\n \"price\": {\n \"currency\": \"BRL\",\n \"amount\": 100\n }\n }\n ]\n }\n}\n\nQuando charge_type_id for 2 (Invoice), será necessário incluir um objeto adicional invoice:
{\n \"title\": \"Invoice Title\",\n \"number\": 12345,\n \"date\": \"2025-08-01\",\n \"due_date\": \"2025-08-15\",\n \"notes\": \"These are some notes\",\n \"customer_id\": 4,\n \"status\": \"draft\"\n}\n\nEm caso de sucesso, a API retornará o status 201 Created junto com um objeto JSON contendo os seguintes dados:
\ndata (object): Detalhes da cobrança criada.
\nid (integer): O identificador único da cobrança.
\nshortcode (string): Um identificador único usado na URL de pagamento da cobrança.
\n Exemplo: https://app.liberpay.com/charges/:shortcode/pay
creator (object): Informações sobre o criador da cobrança. Quando um comprador seleciona a moeda e paga, ele assume a cobrança e se torna o \"creator\".
\ncurrency (object): Detalhes sobre a moeda usada.
\nfiat_currency (object): Informações sobre a moeda fiduciária usada.
\nexchange_rate (string): A taxa de câmbio aplicada.
\ncurrency_price (string): O preço na moeda especificada.
\nexpires_at (string): A data de expiração da cobrança (para garantir cotação válida).
\ngateway (object): Detalhes sobre o gateway de pagamento.
\ninserted_at (string): Data/hora em que a cobrança foi criada.
\nmetadata (object): Informações adicionais incluindo itens e detalhes.
\npayments (array): Lista de pagamentos associados à cobrança.
\nrefunds (array): Lista de reembolsos associados à cobrança.
\nstatus (object): O status atual da cobrança.
\nstore (object): Informações sobre a loja associada.
\ntype (object): O tipo de cobrança criada.
\n{\n \"data\": {\n \"creator\": {\n \"address\": \"0x993b7433d2D6Cf74056Db19E5B3BA523557d5d50\",\n \"email\": \"steve+seller@nftipay.com\",\n \"id\": 1,\n \"username\": \"seller\"\n },\n \"currency\": {\n \"id\": 1,\n \"name\": \"Polygon\",\n \"symbol\": \"POL\",\n \"decimals\": 18,\n \"address\": \"0x0000000000000000000000000000000000000000\"\n },\n \"currency_price\": \"76679192534769725440\",\n \"exchange_rate\": \"0.751756789556566\",\n \"expires_at\": \"2025-08-17T21:47:52Z\",\n \"fiat_currency\": {\n \"id\": 2,\n \"name\": \"Brazilian Real \",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n \"gateway\": {\n \"address\": \"0xf2d1b6e93699f7b2d1f81bd4d72ef3c5ad5d58a4\",\n \"config\": {},\n \"creator_id\": 1,\n \"id\": 73,\n \"is_system\": false,\n \"licensed\": true,\n \"name\": \"NFTiPay Main\",\n \"type\": {\n \"id\": 1,\n \"identifier\": \"polygon\",\n \"label\": \"Polygon\",\n \"platform\": {\n \"id\": 1,\n \"identifier\": \"evm\",\n \"label\": \"Ethereum Virtual Machine\"\n }\n }\n },\n \"hash\": null,\n \"id\": 231,\n \"inserted_at\": \"2025-08-17T21:42:52\",\n \"metadata\": {\n \"items\": [\n {\n \"description\": \"This is just a test product\",\n \"id\": 3,\n \"images\": [\n {\n \"url\": \"https://nftipay-product-images.s3-us-east-2.amazonaws.com/ed5be128-16ec-4fce-af08-575b44bb5d87\"\n }\n ],\n \"is_physical\": true,\n \"name\": \"Test Product\",\n \"price\": {\n \"amount\": \"1\",\n \"currency\": \"BRL\"\n },\n \"price_currency\": \"751756789556566016\",\n \"quantity\": 2,\n \"subtotal\": {\n \"amount\": \"2.00\",\n \"currency\": \"BRL\"\n },\n \"subtotal_currency\": \"1503513579113132032\",\n \"tax\": {\n \"amount\": \"0.00\",\n \"currency\": \"BRL\"\n },\n \"tax_currency\": \"0\",\n \"tax_rate\": \"0.00000\",\n \"taxable\": true,\n \"total\": {\n \"amount\": \"2.00\",\n \"currency\": \"BRL\"\n },\n \"total_currency\": \"1503513579113132032\",\n \"unit_tax\": {\n \"amount\": \"0.00\",\n \"currency\": \"BRL\"\n },\n \"unit_tax_currency\": \"0\"\n }\n ]\n },\n \"payments\": [],\n \"price\": {\n \"amount\": \"102.00\",\n \"currency\": \"BRL\"\n },\n \"refunds\": [],\n \"seller_address\": null,\n \"shortcode\": \"73cJltPHglQdnVH\",\n \"status\": {\n \"id\": 1,\n \"label\": \"created\"\n },\n \"store\": {\n \"business\": {\n \"id\": 1,\n \"name\": \"Liberpay\"\n },\n \"id\": 1,\n \"logo\": \"https://nftipay-product-images.s3-us-east-2.amazonaws.com/93d397a8-c06b-43da-aaa9-c26999d9dd4c\",\n \"name\": \"Main Store\"\n },\n \"tokens\": [],\n \"type\": {\n \"id\": 1,\n \"label\": \"Point of Sale\"\n }\n }\n}\n\nQuando a cobrança for uma fatura (charge_type_id = 2), alguns dados adicionais serão retornados, incluindo o objeto invoice.
{\n \"data\": {\n \"invoice\": {\n \"approved\": false,\n \"customer\": {\n \"address\": {\n \"city\": \"Lex\",\n \"code\": \"02420\",\n \"region\": \"MA0\",\n \"street1\": \"1234\",\n \"street2\": \"Howard\"\n },\n \"business_id\": 2,\n \"email\": \"Tobias@tvpx.com\",\n \"id\": 4,\n \"name\": \"Tobias\"\n },\n \"date\": \"2025-08-01\",\n \"due_date\": \"2025-08-15\",\n \"id\": 94,\n \"notes\": \"These are some notes\",\n \"number\": 12345,\n \"title\": \"Invoice Title\"\n }\n }\n}\n\nCertifique-se de fornecer todos os campos obrigatórios no corpo da requisição para evitar erros de validação.
\nA resposta incluirá vários detalhes da cobrança, que podem ser usados para processamento adicional ou exibição em interfaces de usuário.
\nEste endpoint permite atualizar uma cobrança existente especificando seu identificador único na URL. A requisição utiliza o método HTTP PUT para enviar as informações atualizadas da cobrança.
A atualização também estende o tempo de expiração da cobrança ao atualizar a taxa de câmbio. Apenas um usuário autorizado do negócio pode atualizar a cobrança.
Este endpoint é usado para que um usuário autorizado do negócio atualize os detalhes da cobrança. No caso de um comprador selecionar a moeda para pagamento, deve-se usar o endpoint set currency.
\nMétodo: PUT
\nEndpoint: {{baseURL}}/api/charges/231
O corpo da requisição deve ser um objeto JSON contendo os seguintes parâmetros:
\ncharge: Objeto que representa os detalhes da cobrança.
\nnonce (integer): Um nonce aleatório usado na geração do hash. Recomenda-se um número inteiro aleatório.
\nhash (string): Um hash associado à cobrança. É calculado chamando o método generateCommitment do contrato inteligente LiberPayReceipt. Ele aceita seu nonce, o shortcode como URI, o endereço do comprador e o endereço do vendedor. O endereço do vendedor deve coincidir com o retorno de gatewayAddressSellerAddress no mesmo contrato.
gateway_id (number): O ID do gateway de pagamento usado na cobrança.
\ncurrency_address (string): O endereço da moeda usada na cobrança.
\nfiat_currency_id (number): O ID da moeda fiduciária associada à cobrança.
\nproducts (array): Uma lista de produtos incluídos na cobrança.
\nid (number): O ID do produto.
\nquantity (number): A quantidade do produto.
\ntype (string): O tipo do produto (ex.: \"product\").
{\n \"charge\": {\n \"nonce\": 123456,\n \"hash\": \"w9d8fd9we8d\",\n \"gateway_id\": 73,\n \"currency_address\": \"0x0000000000000000000000000000000000000000\",\n \"fiat_currency_id\": 2,\n \"products\": [\n {\n \"id\": 3,\n \"quantity\": 3,\n \"type\": \"product\"\n },\n {\n \"id\": \"f543912d-d957-4bb2-a9a8-182c01f2f932\",\n \"quantity\": 1,\n \"type\": \"amount\",\n \"name\": \"Test Item\",\n \"taxable\": false,\n \"price\": {\n \"currency\": \"BRL\",\n \"amount\": 100\n }\n }\n ]\n }\n}\n\nEm caso de sucesso, a resposta retornará o status 200 juntamente com um objeto JSON contendo os detalhes atualizados da cobrança.
\nA estrutura da resposta inclui:
\ndata: Objeto com os detalhes da cobrança atualizada.
\ncreator: Informações sobre o criador da cobrança.
\ncurrency: Detalhes sobre a moeda usada.
\ncurrency_price: O preço na moeda especificada.
\nexchange_rate: A taxa de câmbio aplicada.
\nfiat_currency: Informações sobre a moeda fiduciária.
\ngateway: Detalhes sobre o gateway de pagamento.
\nmetadata: Informações adicionais relacionadas à cobrança, incluindo itens e seus detalhes.
\npayments: Lista de registros de pagamentos associados à cobrança.
\nstatus: O status atual da cobrança.
\n{\n \"data\": {\n \"creator\": {\n \"address\": \"0x993b7433d2D6Cf74056Db19E5B3BA523557d5d50\",\n \"email\": \"steve+seller@nftipay.com\",\n \"id\": 1,\n \"username\": \"seller\"\n },\n \"currency\": {\n \"id\": 1,\n \"name\": \"Polygon\",\n \"symbol\": \"POL\",\n \"decimals\": 18,\n \"address\": \"0x0000000000000000000000000000000000000000\"\n },\n \"currency_price\": \"77006288032217081088\",\n \"exchange_rate\": \"0.747633864390457100\",\n \"expires_at\": \"2025-08-17T22:22:48Z\",\n \"fiat_currency\": {\n \"id\": 2,\n \"name\": \"Brazilian Real \",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n \"gateway\": {\n \"address\": \"0xf2d1b6e93699f7b2d1f81bd4d72ef3c5ad5d58a4\",\n \"config\": {},\n \"creator_id\": 1,\n \"id\": 73,\n \"is_system\": false,\n \"licensed\": true,\n \"name\": \"NFTiPay Main\",\n \"type\": {\n \"id\": 1,\n \"identifier\": \"polygon\",\n \"label\": \"Polygon\",\n \"platform\": {\n \"id\": 1,\n \"identifier\": \"evm\",\n \"label\": \"Ethereum Virtual Machine\"\n }\n }\n },\n \"hash\": \"w9d8fd9we8d\",\n \"id\": 231,\n \"inserted_at\": \"2025-08-17T21:42:52\",\n \"metadata\": {\n \"items\": [\n {\n \"description\": \"This is just a test product\",\n \"id\": 3,\n \"images\": [\n {\n \"url\": \"https://nftipay-product-images.s3-us-east-2.amazonaws.com/ed5be128-16ec-4fce-af08-575b44bb5d87\"\n }\n ],\n \"is_physical\": true,\n \"name\": \"Test Product\",\n \"price\": {\n \"amount\": \"1\",\n \"currency\": \"BRL\"\n },\n \"price_currency\": \"747633864390457088\",\n \"quantity\": 3,\n \"subtotal\": {\n \"amount\": \"3.00\",\n \"currency\": \"BRL\"\n },\n \"subtotal_currency\": \"2242901593171371264\",\n \"tax\": {\n \"amount\": \"0.00\",\n \"currency\": \"BRL\"\n },\n \"tax_currency\": \"0\",\n \"tax_rate\": \"0.00000\",\n \"taxable\": true,\n \"total\": {\n \"amount\": \"3.00\",\n \"currency\": \"BRL\"\n },\n \"total_currency\": \"2242901593171371264\",\n \"unit_tax\": {\n \"amount\": \"0.00\",\n \"currency\": \"BRL\"\n },\n \"unit_tax_currency\": \"0\"\n },\n {\n \"description\": \"\",\n \"id\": \"6c11c3b6-ea30-463c-848b-1e7b54707d82\",\n \"is_physical\": true,\n \"metadata\": {},\n \"name\": \"Test Item\",\n \"price\": {\n \"amount\": \"100.0\",\n \"currency\": \"BRL\"\n },\n \"price_currency\": \"74763386439045709824\",\n \"quantity\": 1.0,\n \"subtotal\": {\n \"amount\": \"100.00\",\n \"currency\": \"BRL\"\n },\n \"subtotal_currency\": \"74763386439045709824\",\n \"tax\": {\n \"amount\": \"0.00\",\n \"currency\": \"BRL\"\n },\n \"tax_currency\": \"0\",\n \"tax_rate\": \"0.00000\",\n \"taxable\": false,\n \"total\": {\n \"amount\": \"100.00\",\n \"currency\": \"BRL\"\n },\n \"total_currency\": \"74763386439045709824\",\n \"unit_tax\": {\n \"amount\": \"0\",\n \"currency\": \"BRL\"\n },\n \"unit_tax_currency\": \"0\"\n }\n ]\n },\n \"payments\": [],\n \"price\": {\n \"amount\": \"103.00\",\n \"currency\": \"BRL\"\n },\n \"refunds\": [],\n \"seller_address\": null,\n \"shortcode\": \"73cJltPHglQdnVH\",\n \"status\": {\n \"id\": 1,\n \"label\": \"created\"\n },\n \"store\": {\n \"business\": {\n \"id\": 1,\n \"name\": \"Liberpay\"\n },\n \"id\": 1,\n \"logo\": \"https://nftipay-product-images.s3-us-east-2.amazonaws.com/93d397a8-c06b-43da-aaa9-c26999d9dd4c\",\n \"name\": \"Main Store\"\n },\n \"tokens\": [],\n \"type\": {\n \"id\": 1,\n \"label\": \"Point of Sale\"\n }\n }\n}\n\nEste endpoint é essencial para o gerenciamento do ciclo de vida da cobrança e para garantir que as informações estejam sempre atualizadas.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a16defba-0ba4-4a35-9be6-205191c70606","id":"a16defba-0ba4-4a35-9be6-205191c70606","name":"Documentação da API Liberpay","type":"collection"}},"urlObject":{"path":["api","charges","231"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dfb3d51b-4a9c-4d80-a6d5-608343501219"},{"name":"definir moeda","id":"4a9a5ae5-db8a-474b-989f-4910664a92bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"charge\": {\n \"nonce\": \"123456\",\n \"hash\": \"w9d8fd9we8d\",\n \"gateway_id\": 73,\n \"currency_address\": \"0x0000000000000000000000000000000000000000\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/charges/73c1T4vJwl5KCqD/set_currency","description":"Este endpoint permite que qualquer usuário autenticado atualize uma cobrança existente que esteja com status created, especificando seu identificador único \"shortcode\" na URL.
A requisição utiliza o método HTTP PUT para enviar as informações atualizadas da cobrança.
Estender o tempo de expiração da cobrança atualizando a taxa de câmbio.
\nAtribuir o usuário que chamou o endpoint como o \"creator\", assumindo efetivamente o controle da cobrança em preparação para o pagamento.
\nMétodo: PUT
\nEndpoint: {{baseURL}}/api/charges/{charge_id}/set_currency
O corpo da requisição deve ser um objeto JSON contendo os seguintes parâmetros:
\ncharge: Objeto representando os detalhes da cobrança.
\nnonce (integer): Um nonce aleatório usado na geração do hash. Recomenda-se um número inteiro aleatório.
\nhash (string): Um hash associado à cobrança. Calculado chamando o método generateCommitment do contrato inteligente LiberPayReceipt. Ele aceita seu nonce, o shortcode como URI, o endereço do comprador e o endereço do vendedor. O endereço do vendedor deve coincidir com o retorno de gatewayAddressSellerAddress no mesmo contrato.
gateway_id (number): O ID do gateway de pagamento usado para a cobrança.
\ncurrency_address (string): O endereço da moeda usada na cobrança.
\n{\n \"charge\": {\n \"nonce\": 123456,\n \"hash\": \"w9d8fd9we8d\",\n \"gateway_id\": 73,\n \"currency_address\": \"0x0000000000000000000000000000000000000000\"\n }\n}\n\nEm caso de sucesso, a resposta retornará o status 200 juntamente com um objeto JSON contendo os detalhes atualizados da cobrança.
\nA estrutura da resposta inclui:
\ndata: Objeto com os detalhes da cobrança atualizada.
\ncreator: Informações sobre o criador da cobrança.
\ncurrency: Detalhes sobre a moeda usada.
\ncurrency_price: O preço na moeda especificada.
\nexchange_rate: A taxa de câmbio aplicada.
\nfiat_currency: Informações sobre a moeda fiduciária.
\ngateway: Detalhes sobre o gateway de pagamento.
\nmetadata: Informações adicionais relacionadas à cobrança, incluindo itens e seus respectivos detalhes.
\npayments: Lista de registros de pagamento associados à cobrança.
\nstatus: O status atual da cobrança.
\n{\n \"data\": {\n \"creator\": {\n \"address\": \"\",\n \"email\": \"\",\n \"id\": 0,\n \"username\": \"\"\n },\n \"currency\": {\n \"id\": 0,\n \"name\": \"\",\n \"symbol\": \"\",\n \"decimals\": 0,\n \"address\": \"\"\n },\n \"currency_price\": \"\",\n \"exchange_rate\": \"\",\n \"fiat_currency\": {\n \"id\": 0,\n \"name\": \"\",\n \"symbol\": \"\",\n \"sign\": \"\"\n },\n \"gateway\": {\n \"address\": \"\",\n \"config\": {},\n \"creator_id\": 0,\n \"id\": 0,\n \"is_system\": true,\n \"licensed\": true,\n \"name\": \"\",\n \"type\": {\n \"id\": 0,\n \"identifier\": \"\",\n \"label\": \"\",\n \"platform\": {\n \"id\": 0,\n \"identifier\": \"\",\n \"label\": \"\"\n }\n }\n },\n \"hash\": \"\",\n \"id\": 0,\n \"inserted_at\": \"\",\n \"metadata\": {\n \"items\": []\n },\n \"payments\": [],\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"refunds\": [],\n \"seller_address\": null,\n \"shortcode\": \"\",\n \"status\": {\n \"id\": 0,\n \"label\": \"\"\n },\n \"store\": {\n \"business\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"id\": 0,\n \"logo\": \"\",\n \"name\": \"\"\n },\n \"tokens\": [],\n \"type\": {\n \"id\": 0,\n \"label\": \"\"\n }\n }\n}\n\nEste endpoint é essencial para o gerenciamento do ciclo de vida da cobrança e garante que as informações da cobrança estejam sempre atualizadas.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a16defba-0ba4-4a35-9be6-205191c70606","id":"a16defba-0ba4-4a35-9be6-205191c70606","name":"Documentação da API Liberpay","type":"collection"}},"urlObject":{"path":["api","charges","73c1T4vJwl5KCqD","set_currency"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4a9a5ae5-db8a-474b-989f-4910664a92bb"},{"name":"registrar transaçaõ","id":"f869cd83-56a0-4887-aa64-e410aa16c13e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"transaction\": {\n \"address\": \"0x993b7433d2D6Cf74056Db19E5B3BA523557d5d50\",\n \"nonce\": 15,\n \"identifier\": \"0x1486c2a6724154211d2501f8f0de24067b61a716404b8359b533478bfb8bb067\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/charges/1/transactions","description":"Este endpoint é usado para registrar uma transação de pagamento para uma cobrança específica após ser submetida no blockchain.
Ao enviar uma requisição POST para https://api.liberpay.com/api/charges/{charge_id}/transactions, os usuários podem enviar detalhes da transação associados a uma cobrança identificada por {charge_id}.
Como as transações em blockchain levam tempo para serem concluídas, o processamento desta requisição é feito em segundo plano.
Você pode monitorar o status da cobrança recuperando a cobrança pela API periodicamente. Webhooks em breve estarão disponíveis.
O corpo da requisição deve estar em formato JSON e conter a seguinte estrutura:
\n{\n \"transaction\": {\n \"address\": \"string\", // O endereço associado à transação\n \"nonce\": \"integer\", // Um número único para garantir que a transação seja processada apenas uma vez\n \"identifier\": \"string\" // Um identificador único para a transação\n }\n}\n\ntransaction: Objeto contendo os detalhes da transação.
\naddress (string): O endereço de onde o pagamento foi enviado.
\nnonce (integer): O nonce do endereço de onde o pagamento foi enviado.
\nidentifier (string): O hash da transação. Atenção: este valor pode mudar caso uma transação seja acelerada ou cancelada, por isso o endereço e o nonce também são obrigatórios.
\nA resposta retornará um objeto JSON:
\nEm caso de sucesso, incluirá a mensagem \"job created\".
Em caso de erro, incluirá um objeto error.
\nStatus Code: 404
\nContent-Type: application/json
\nUm status 404 indica que a cobrança especificada não pôde ser encontrada. Certifique-se de que o {charge_id} está correto e que a cobrança existe antes de enviar a requisição.
Sempre verifique a resposta para tratar erros de forma apropriada em sua aplicação.
\nEste endpoint é usado para excluir uma cobrança específica identificada pelo seu ID único.
Neste exemplo, o ID é 231.
Método: DELETE
\nEndpoint: /api/charges/{id}
Parâmetros de Caminho:
\nStatus Code: 204 No Content
Isso indica que a requisição foi bem-sucedida e o recurso foi excluído. Nenhum conteúdo será retornado no corpo da resposta.
Content-Type: text/xml
O cabeçalho de resposta será text/xml, mas sem conteúdo presente.
Certifique-se de que o ID fornecido corresponda a uma cobrança existente.
\nTentar excluir uma cobrança inexistente pode resultar em um código de status diferente.
\nEsta operação é irreversível; uma vez que a cobrança é excluída, ela não pode ser recuperada.
\nEste endpoint recupera os detalhes de uma fatura específica identificada pelo seu ID único.
\nMétodo: GET
\nEndpoint: {{baseURL}}/api/invoices/{id}
Parâmetros de Caminho
\nEm caso de sucesso, a API retornará um objeto JSON contendo os detalhes da fatura.
O formato esperado da resposta inclui vários campos relacionados à fatura, como o número da fatura, a data, o valor total e o status.
{\n \"invoiceId\": 1,\n \"date\": \"2023-10-01\",\n \"totalAmount\": 150.00,\n \"status\": \"Paid\"\n}\n\nEste endpoint permite que os usuários aprovem uma fatura identificada pelo seu ID único.
\nMétodo: PUT
\nEndpoint: {{baseURL}}/api/invoices/{id}/approve
Parâmetros de Caminho
\nEm caso de sucesso, a API retornará uma resposta indicando o status da ação de aprovação.
A resposta normalmente incluirá:
Uma mensagem de confirmação sobre a aprovação.
\nO estado atualizado da fatura.
\nEste endpoint permite atualizar uma fatura existente identificada pelo seu ID único.
Neste exemplo, a fatura com ID 94 está sendo atualizada.
A requisição requer que os detalhes completos da fatura sejam enviados no corpo da requisição.
As faturas estão vinculadas a uma cobrança, e informações gerais sobre a cobrança devem ser atualizadas usando o endpoint update charge.
Este endpoint serve apenas para atualizar os metadados da fatura.
Método: PUT
\nURL: {{baseURL}}/api/invoices/94
Cabeçalhos
\nCorpo da Requisição
O corpo deve ser um objeto JSON contendo a chave invoice.
{\n \"invoice\": {\n \"title\": \"string\", // O título da fatura\n \"number\": integer, // O número da fatura\n \"date\": \"YYYY-MM-DD\", // A data em que a fatura foi emitida\n \"due_date\": \"YYYY-MM-DD\", // A data de vencimento do pagamento\n \"notes\": \"string\" // Notas adicionais relacionadas à fatura\n }\n}\n\n{\n \"invoice\": {\n \"title\": \"Invoice Title\",\n \"number\": 12345,\n \"date\": \"2025-08-01\",\n \"due_date\": \"2025-08-15\",\n \"notes\": \"These are some notes UPDATED\"\n }\n}\n\nEm caso de sucesso, o servidor responderá com uma confirmação da fatura atualizada.
\nA resposta normalmente incluirá:
\nInvoice ID: O identificador único da fatura.
\nCampos Atualizados: Os campos que foram atualizados, refletindo os novos valores enviados na requisição.
\nEste endpoint permite atualizar as informações de uma empresa específica identificada pelo seu ID único.
Neste exemplo, o ID da empresa é 1.
Método: PUT
\nURL: {{baseURL}}/api/businesses/1
Corpo da Requisição
O corpo deve estar em formato JSON e incluir o seguinte parâmetro:
business: Objeto contendo os detalhes da empresa.
\n{\n \"data\": {\n \"creator\": {\n \"address\": \"0x993b7433d2D6Cf74056Db19E5B3BA523557d5d50\",\n \"id\": 1\n },\n \"fee_account\": {\n \"business_id\": 1,\n \"freebies\": 0,\n \"id\": 1,\n \"name\": \"default\",\n \"recharge_amount\": null,\n \"recharge_at\": null\n },\n \"id\": 1,\n \"is_system\": false,\n \"name\": \"Liberpay\",\n \"stripe_connect\": {\n \"account_id\": \"acct_1Ri8LSACXGs4uBJ81\",\n \"account_link\": {\n \"created\": 1751868969,\n \"expires\": 1751869269,\n \"url\": \"https://connect.stripe.com/setup/s/acct_1Ri8LSACXGs4uBJ91/BG8n3BG19Yaw\"\n },\n \"active\": false,\n \"complete\": false\n },\n \"verification\": \"completed\",\n \"verified\": true\n }\n}\n\nEm caso de sucesso, o servidor responderá com status code 200 e um objeto JSON contendo as informações atualizadas da empresa.
\nEstrutura da Resposta
\ndata: Objeto que inclui:
\ncreator: Objeto representando o criador da empresa.
\naddress (string): O endereço do criador.
\nid (integer): O identificador único do criador.
\nfee_account: Objeto representando a conta de taxas associada à empresa.
\nbusiness_id (integer): O ID da empresa.
\nfreebies (integer): Número de bônus gratuitos.
\nid (integer): O identificador único da conta de taxas.
\nname (string): O nome da conta de taxas.
\nrecharge_amount (nullable): O valor de recarga.
\nrecharge_at (nullable): O horário de recarga.
\nid (integer): O identificador único da empresa.
\nis_system (boolean): Indica se é uma empresa do sistema.
\nname (string): O nome da empresa.
\nstripe_connect: Objeto com detalhes da conexão Stripe.
\naccount_id (string): O ID da conta Stripe.
\naccount_link: Objeto contendo:
\ncreated (integer): Timestamp de criação.
\nexpires (integer): Timestamp de expiração.
\nurl (string): URL para o link da conta.
\nactive (boolean): Indica se a conta Stripe está ativa.
\ncomplete (boolean): Indica se a configuração da conta Stripe está concluída.
\nverification (string): Status de verificação da empresa.
\nverified (boolean): Indica se a empresa está verificada.
\nEsta estrutura de resposta fornece informações completas sobre a empresa após a atualização, garantindo que o cliente tenha todos os detalhes necessários.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a16defba-0ba4-4a35-9be6-205191c70606","id":"a16defba-0ba4-4a35-9be6-205191c70606","name":"Documentação da API Liberpay","type":"collection"}},"urlObject":{"path":["api","businesses","1"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f669c1c7-b280-4413-a752-6504eb69523c"},{"name":"detalhes","id":"dd5ca957-dae2-4802-aed5-de8db9fc5d50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/businesses/1","description":"Este endpoint recupera informações detalhadas sobre um negócio específico identificado pelo seu ID único.
A requisição é feita usando o método HTTP GET e requer que o ID do negócio seja especificado na URL.
Método: GET
\nEndpoint: {{baseURL}}/api/businesses/{id}
Parâmetro de Caminho
\nEm caso de sucesso, a API retorna um objeto JSON com status code 200.
\n{\n \"data\": {\n \"creator\": {\n \"address\": \"0x993b7433d2D6Cf74056Db19E5B3BA523557d5d50\",\n \"id\": 1\n },\n \"fee_account\": {\n \"business_id\": 1,\n \"freebies\": 0,\n \"id\": 1,\n \"name\": \"default\",\n \"recharge_amount\": null,\n \"recharge_at\": null\n },\n \"id\": 1,\n \"is_system\": false,\n \"name\": \"NFTiPay\",\n \"stripe_connect\": {\n \"account_id\": \"acct_1Ri8LSC7Gs4uBJ9l\",\n \"account_link\": {\n \"created\": 1751868969,\n \"expires\": 1751869269,\n \"url\": \"https://connect.stripe.com/setup/s/acct_1Ri8LSC7Gs4uBJ9l/BG8n3BG19Yow\"\n },\n \"active\": false,\n \"complete\": false\n },\n \"verification\": \"completed\",\n \"verified\": true\n }\n}\n\ndata: Objeto principal contendo os detalhes do negócio.
\ncreator: Informações sobre o criador do negócio.
\naddress (string): O endereço do criador.
\nid (integer): O identificador único do criador.
\nfee_account: Detalhes sobre a conta de taxas associada ao negócio.
\nbusiness_id (integer): O ID do negócio.
\nfreebies (integer): Número de bônus gratuitos.
\nid (integer): Identificador único da conta de taxas.
\nname (string): Nome da conta de taxas.
\nrecharge_amount (nullable): Valor de recarga (pode ser nulo).
\nrecharge_at (nullable): Timestamp de recarga (pode ser nulo).
\nid (integer): O identificador único do negócio.
\nis_system (boolean): Indica se é um negócio do sistema.
\nname (string): O nome do negócio.
\nstripe_connect: Informações relacionadas à conexão com a conta Stripe.
\naccount_id (string): O ID da conta Stripe.
\naccount_link: Objeto contendo os detalhes do link.
\ncreated (integer): Timestamp de criação do link.
\nexpires (integer): Timestamp de expiração do link.
\nurl (string): URL para o link da conta.
\nactive (boolean): Indica se a conta Stripe está ativa.
\ncomplete (boolean): Indica se a configuração da conta Stripe está concluída.
\nverification (string): Status de verificação do negócio.
\nverified (boolean): Indica se o negócio está verificado.
\nEste endpoint recupera uma lista de negócios a partir da API.
\nMétodo: GET
\nURL: {{baseURL}}/api/businesses
Status Code: 200 OK
\nContent-Type: application/json
\n{\n \"data\": [\n {\n \"creator\": {\n \"address\": \"0x993b7433d2D6Cf74056Db19E5B3BA523557d5d50\",\n \"id\": 1\n },\n \"id\": 1,\n \"is_system\": false,\n \"name\": \"NFTiPay\",\n \"verified\": true\n }\n ]\n}\n\nA resposta retorna um objeto JSON contendo um array de dados de negócios.
\nCada objeto de negócio inclui os seguintes campos:
\nid (integer): O identificador único do negócio.
\nname (string): O nome do negócio.
\nis_system (boolean): Indica se o negócio é um negócio de sistema. Usado internamente pelo Liberpay, principalmente para marcar negócios P2P.
\nverified (boolean): Indica se o negócio foi verificado.
\ncreator (object): Objeto com detalhes sobre o criador do negócio.
\nid (integer): O identificador único do criador.
\naddress (string): O endereço do criador.
\nA resposta conterá um array de negócios no campo data.
\nCertifique-se de que sua requisição esteja devidamente autenticada, se exigido pela API.
\nEste endpoint recupera informações detalhadas sobre uma loja específica identificada pelo seu ID único.
\nMétodo: GET
\nURL: {{baseURL}}/api/stores/{storeId}
Parâmetro de Caminho
\nStatus Code: 200 OK
\nContent-Type: application/json
\n{\n \"address\": null,\n \"business\": {\n \"id\": 1,\n \"name\": \"Liberpay\"\n },\n \"email\": null,\n \"fiat_currencies\": [\n {\n \"id\": 2,\n \"name\": \"Brazilian Real \",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n }\n ],\n \"gateways\": [\n {\n \"address\": \"0xf2d1b6e93699f7b2d1f81bd4d72ef3c5ad5d58a4\",\n \"config\": {},\n \"creator_id\": 1,\n \"id\": 73,\n \"is_system\": false,\n \"licensed\": true,\n \"name\": \"NFTiPay Main\",\n \"type\": {\n \"id\": 1,\n \"identifier\": \"polygon\",\n \"label\": \"Polygon\",\n \"platform\": {\n \"id\": 1,\n \"identifier\": \"evm\",\n \"label\": \"Ethereum Virtual Machine\"\n }\n }\n }\n ],\n \"id\": 1,\n \"logo\": \"https://nftipay-product-images.s3-us-east-2.amazonaws.com/93d397a8-c06b-43da-aaa9-c26999d9dd4c\",\n \"name\": \"Main Store\",\n \"phone\": null,\n \"tax_rate\": \"0.00000\"\n}\n\nid (integer): O identificador único da loja.
\nname (string): O nome da loja.
\naddress (string ou null): O endereço físico da loja.
\nemail (string ou null): O e-mail de contato da loja.
\nphone (string ou null): O telefone de contato da loja.
\nlogo (string): URL do logotipo da loja.
\ntax_rate (string): A taxa de imposto aplicável à loja.
\nbusiness (object): Objeto com detalhes do negócio.
\nid (integer): O identificador único do negócio.
\nname (string): O nome do negócio.
\nfiat_currencies (array): Lista de moedas fiduciárias aceitas pela loja.
\nid (integer): O identificador único da moeda.
\nname (string): O nome da moeda.
\nsymbol (string): O símbolo que representa a moeda.
\nsign (string): O sinal usado para a moeda.
\ngateways (array): Lista de gateways de pagamento associados à loja.
\nid (integer): O identificador único do gateway.
\nname (string): O nome do gateway de pagamento.
\naddress (string): O endereço associado ao gateway.
\nconfig (object): Detalhes de configuração do gateway.
\ncreator_id (integer): O ID do criador do gateway.
\nis_system (boolean): Indica se o gateway é do sistema.
\nlicensed (boolean): Indica se o gateway é licenciado.
\ntype (object): O tipo de gateway.
\nid (integer): O identificador único do tipo.
\nidentifier (string): O identificador do tipo.
\nlabel (string): O rótulo do tipo.
\nplatform (object): Detalhes da plataforma.
\nid (integer): O identificador único da plataforma.
\nidentifier (string): O identificador da plataforma.
\nlabel (string): O rótulo da plataforma.
\nEste endpoint é útil para obter detalhes abrangentes de uma loja, incluindo informações do negócio associado, moedas aceitas e gateways de pagamento.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a16defba-0ba4-4a35-9be6-205191c70606","id":"a16defba-0ba4-4a35-9be6-205191c70606","name":"Documentação da API Liberpay","type":"collection"}},"urlObject":{"path":["api","stores","1"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b97ef15e-5796-45b2-8c3c-0eb0508ba8b9"},{"name":"listar","id":"91bc2d59-2172-4cc2-9833-3a2616ec022d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/stores","description":"Este endpoint recupera uma lista de lojas do sistema.
É uma requisição GET que não requer parâmetros de entrada.
Método: GET
\nURL: {{baseURL}}/api/stores
Em caso de sucesso, a API retorna status code 200 OK com um objeto JSON contendo a seguinte estrutura:
\n{\n \"data\": [\n {\n \"address\": null,\n \"business\": {\n \"id\": 1,\n \"name\": \"Liberpay\"\n },\n \"email\": null,\n \"gateways\": [\n {\n \"address\": \"0xf2d1b6e93699f7b2d1f81bd4d72ef3c5ad5d58a4\",\n \"config\": {},\n \"creator_id\": 1,\n \"id\": 73,\n \"is_system\": false,\n \"licensed\": true,\n \"name\": \"NFTiPay Main\",\n \"type\": {\n \"id\": 1,\n \"identifier\": \"polygon\",\n \"label\": \"Polygon\",\n \"platform\": {\n \"id\": 1,\n \"identifier\": \"evm\",\n \"label\": \"Ethereum Virtual Machine\"\n }\n }\n }\n ],\n \"id\": 1,\n \"logo\": \"https://nftipay-product-images.s3-us-east-2.amazonaws.com/93d397a8-c06b-43da-aaa9-c26999d9dd4c\",\n \"name\": \"Main Store\",\n \"phone\": null,\n \"tax_rate\": \"0.00000\"\n }\n ]\n}\n\ndata: Array de objetos de lojas.
\nid (integer): Identificador único da loja.
\nname (string): Nome da loja.
\nemail (string ou null): E-mail da loja.
\nphone (string ou null): Telefone da loja.
\naddress (string ou null): Endereço físico da loja.
\nlogo (string): URL ou caminho para o logotipo da loja.
\ntax_rate (string): Taxa de imposto aplicável à loja.
\nbusiness (object): Objeto contendo detalhes do negócio associado.
\nid (integer): Identificador único do negócio.
\nname (string): Nome do negócio.
\ngateways (array): Lista de gateways de pagamento associados à loja.
\nid (integer): Identificador único do gateway.
\nname (string): Nome do gateway de pagamento.
\naddress (string): Endereço associado ao gateway.
\nconfig (object): Detalhes de configuração do gateway, se existirem.
\ncreator_id (integer): ID do criador do gateway.
\nis_system (boolean): Indica se o gateway é do sistema.
\nlicensed (boolean): Indica se o gateway é licenciado.
\ntype (object): O tipo do gateway.
\nid (integer): Identificador único do tipo de gateway.
\nidentifier (string): Identificador do tipo de gateway.
\nlabel (string): Rótulo do tipo de gateway.
\nplatform (object): Plataforma associada ao tipo de gateway.
\nid (integer): Identificador único da plataforma.
\nidentifier (string): Identificador da plataforma.
\nlabel (string): Rótulo da plataforma.
\nEste endpoint é útil para obter uma lista abrangente de lojas, incluindo detalhes da loja, do negócio associado e dos gateways de pagamento.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a16defba-0ba4-4a35-9be6-205191c70606","id":"a16defba-0ba4-4a35-9be6-205191c70606","name":"Documentação da API Liberpay","type":"collection"}},"urlObject":{"path":["api","stores"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"91bc2d59-2172-4cc2-9833-3a2616ec022d"}],"id":"e418bcc1-fe96-431b-877c-a38019588624","_postman_id":"e418bcc1-fe96-431b-877c-a38019588624","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a16defba-0ba4-4a35-9be6-205191c70606","id":"a16defba-0ba4-4a35-9be6-205191c70606","name":"Documentação da API Liberpay","type":"collection"}}},{"name":"clientes","item":[{"name":"listar loja","id":"a11bb0aa-70f0-42c7-ae34-a638e86911ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/stores/1/customers","description":"Este endpoint recupera uma lista de clientes associados a uma loja específica identificada pelo seu ID único.
A requisição é feita usando o método HTTP GET e retorna as informações dos clientes no formato JSON.
Método: GET
\nEndpoint: {{baseURL}}/api/stores/{store_id}/customers
Parâmetro de Caminho
\nEm caso de sucesso, a API retorna um objeto JSON com status code 200.
\n{\n \"data\": [\n {\n \"address\": {\n \"city\": \"Logan\",\n \"code\": \"84321\",\n \"region\": \"UT\",\n \"street1\": \"123 Easy Street\",\n \"street2\": \"\"\n },\n \"business_id\": 1,\n \"email\": \"test@liberpay.com\",\n \"id\": 3,\n \"name\": \"Test Customer\"\n },\n {\n \"address\": {\n \"city\": \"\",\n \"code\": \"\",\n \"region\": \"\",\n \"street1\": \"test\",\n \"street2\": \"\"\n },\n \"business_id\": 1,\n \"email\": \"test2@liberpay.com\",\n \"id\": 6,\n \"name\": \"Test Customer #2\"\n }\n ]\n}\n\ndata (array): Lista contendo objetos de clientes.
\nCada objeto de cliente inclui:
\naddress (object): Contém os detalhes de endereço do cliente.
\ncity (string): Cidade onde o cliente reside.
\ncode (string): Código postal ou CEP.
\nregion (string): Estado ou região.
\nstreet1 (string): Endereço principal.
\nstreet2 (string): Endereço secundário (se houver).
\nbusiness_id (integer): O ID do negócio associado ao cliente.
\nemail (string): O e-mail do cliente.
\nid (integer): O identificador único do cliente.
\nname (string): O nome do cliente.
\nEste endpoint é útil para recuperar todos os clientes de uma loja específica e exibir suas informações básicas, incluindo endereço e dados de contato.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a16defba-0ba4-4a35-9be6-205191c70606","id":"a16defba-0ba4-4a35-9be6-205191c70606","name":"Documentação da API Liberpay","type":"collection"}},"urlObject":{"path":["api","stores","1","customers"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a11bb0aa-70f0-42c7-ae34-a638e86911ed"},{"name":"listar negócios","id":"71bf721f-c8ea-495c-a058-fc7a1966e9ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/businesses/1/customers","description":"Este endpoint recupera uma lista de clientes associados a um negócio específico identificado pelo seu ID único.
A requisição é feita usando o método HTTP GET e retorna as informações dos clientes no formato JSON.
Método: GET
\nEndpoint: {{baseURL}}/api/businesses/{business_id}/customers
Parâmetro de Caminho
\nEm caso de sucesso, a API retorna um objeto JSON com status code 200.
\n{\n \"data\": [\n {\n \"address\": {\n \"city\": \"Logan\",\n \"code\": \"84321\",\n \"region\": \"UT\",\n \"street1\": \"123 Easy Street\",\n \"street2\": \"\"\n },\n \"business_id\": 1,\n \"email\": \"test@liberpay.com\",\n \"id\": 3,\n \"name\": \"Test Customer\"\n },\n {\n \"address\": {\n \"city\": \"\",\n \"code\": \"\",\n \"region\": \"\",\n \"street1\": \"test\",\n \"street2\": \"\"\n },\n \"business_id\": 1,\n \"email\": \"test2@liberpay.com\",\n \"id\": 6,\n \"name\": \"Test Customer #2\"\n }\n ]\n}\n\ndata (array): Lista contendo objetos de clientes.
\nCada objeto de cliente inclui:
\naddress (object): Contém os detalhes de endereço do cliente.
\ncity (string): Cidade onde o cliente reside.
\ncode (string): Código postal ou CEP.
\nregion (string): Estado ou região.
\nstreet1 (string): Endereço principal.
\nstreet2 (string): Endereço secundário (se houver).
\nbusiness_id (integer): O ID do negócio associado ao cliente.
\nemail (string): O e-mail do cliente.
\nid (integer): O identificador único do cliente.
\nname (string): O nome do cliente.
\nEste endpoint é útil para recuperar todos os clientes de um negócio específico e exibir suas informações básicas, incluindo endereço e dados de contato.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a16defba-0ba4-4a35-9be6-205191c70606","id":"a16defba-0ba4-4a35-9be6-205191c70606","name":"Documentação da API Liberpay","type":"collection"}},"urlObject":{"path":["api","businesses","1","customers"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"71bf721f-c8ea-495c-a058-fc7a1966e9ae"},{"name":"detalhes","id":"edab25c4-949f-49ba-a774-a8cbe60db8c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/customers/3","description":"Este endpoint recupera informações detalhadas de um cliente específico identificado pelo seu ID único.
\nMétodo: GET
\nURL: {{baseURL}}/api/customers/{id}
Parâmetro de Caminho
\nStatus Code: 200 OK
\nContent-Type: application/json
\nA resposta conterá um objeto JSON com a seguinte estrutura:
\n{\n \"data\": {\n \"address\": {\n \"city\": \"Logan\",\n \"code\": \"84321\",\n \"region\": \"UT\",\n \"street1\": \"123 Easy Street\",\n \"street2\": \"\"\n },\n \"business_id\": 1,\n \"email\": \"test@liberpay.com\",\n \"id\": 3,\n \"name\": \"Test Customer\"\n }\n}\n\ndata: Contém os detalhes do cliente.
\naddress (object): Detalhes do endereço do cliente.
\ncity (string): A cidade do cliente.
\ncode (string): O código postal.
\nregion (string): A região ou estado do cliente.
\nstreet1 (string): O endereço principal.
\nstreet2 (string): O endereço secundário (se houver).
\nbusiness_id (integer): O ID associado ao negócio do cliente.
\nemail (string): O e-mail do cliente.
\nid (integer): O identificador único do cliente.
\nname (string): O nome do cliente.
\nstores (array): Lista de lojas associadas ao cliente.
\nid (integer): O identificador único da loja.
\nname (string): O nome da loja.
\nCertifique-se de que o ID do cliente fornecido na requisição seja válido para receber os detalhes corretos.
\nA resposta pode conter strings vazias para campos que não estejam configurados para o cliente.
\nEste endpoint permite criar um novo cliente no sistema.
Ele aceita os detalhes do cliente no corpo da requisição e retorna as informações do cliente criado em caso de sucesso.
O corpo da requisição deve ser um objeto JSON contendo os seguintes parâmetros:
\ncustomer: Objeto que contém os detalhes do cliente.
\nname (string): O nome do cliente.
\nemail (string): O e-mail do cliente.
\naddress (object): O endereço do cliente.
\nstreet1 (string): O endereço principal.
\ncity (string): A cidade.
\nregion (string): O estado ou região.
\ncode (string): O código postal.
\ncountry (string): O país.
\nbusiness_id (integer): O ID do negócio associado ao cliente.
\nstores (array de integers): Uma lista de IDs de lojas associadas ao cliente.
\n{\n \"customer\": {\n \"name\": \"Test Customer 3\",\n \"email\": \"test+customer3@liberpay.com\",\n \"address\": {\n \"street1\": \"123 Easy Street\",\n \"city\": \"Rio de Janeiro\",\n \"region\": \"Rio de Janeiro\",\n \"code\": \"22450-003\",\n \"country\": \"BR\"\n },\n \"business_id\": 1,\n \"stores\": [1]\n }\n}\n\nEm caso de criação bem-sucedida, a API retornará status code 201 Created e um objeto JSON contendo:
\ndata: Objeto que inclui os seguintes campos:
\naddress (object): Detalhes do endereço, que podem estar vazios na resposta.
\nbusiness_id (integer): O ID do negócio associado ao cliente (pode ser retornado como 0 se não aplicável).
\nemail (string): O e-mail do cliente (pode ser retornado como string vazia).
\nid (integer): O identificador único do cliente recém-criado.
\nname (string): O nome do cliente (pode ser retornado como string vazia).
\n{\n \"data\": {\n \"address\": {\n \"city\": \"Rio de Janeiro\",\n \"code\": \"22450-003\",\n \"country\": \"BR\",\n \"region\": \"Rio de Janeiro\",\n \"street1\": \"123 Easy Street\"\n },\n \"business_id\": 1,\n \"email\": \"test+customer3@liberpay.com\",\n \"id\": 54,\n \"name\": \"Test Customer 3\"\n }\n}\n\nCertifique-se de que todos os campos obrigatórios sejam fornecidos no corpo da requisição para criar um cliente com sucesso.
\nA resposta pode conter strings vazias para campos que não sejam aplicáveis ou que não tenham sido processados corretamente.
\nEste endpoint permite atualizar as informações de um cliente específico identificado pelo seu ID único.
A requisição deve ser enviada usando o método HTTP PUT para a URL especificada.
O corpo da requisição deve estar no formato JSON e incluir os seguintes parâmetros:
\ncustomer: Objeto contendo os detalhes do cliente.
\nname (string): O nome atualizado do cliente.
\nemail (string): O e-mail atualizado do cliente.
\naddress (object): Os detalhes atualizados do endereço do cliente.
\nstreet1 (string): O endereço.
\ncity (string): A cidade onde o cliente reside.
\nregion (string): O estado ou região do endereço.
\ncode (string): O código postal do endereço.
\ncountry (string): O país do endereço.
\nstores (array de integers): Lista de IDs de lojas associadas ao cliente.
\n{\n \"customer\": {\n \"name\": \"Test Customer 3 UPDATED\",\n \"email\": \"test+customer3+updated@liberpay.com\",\n \"address\": {\n \"street1\": \"123 Easy Street UPDATED\",\n \"city\": \"Rio de Janeiro\",\n \"region\": \"Rio de Janeiro\",\n \"code\": \"22450-003\",\n \"country\": \"BR\"\n },\n \"stores\": [1, 2]\n }\n}\n\nEm caso de atualização bem-sucedida, o servidor responderá com status code 200 e retornará um objeto JSON contendo a seguinte estrutura:
\ndata: Objeto representando as informações atualizadas do cliente.
\naddress (object): Objeto contendo os detalhes do endereço (pode retornar campos vazios se não atualizados).
\ncity (string): A cidade atualizada.
\ncode (string): O código postal atualizado.
\ncountry (string): O país atualizado.
\nregion (string): A região ou estado atualizado.
\nstreet1 (string): O endereço atualizado.
\nbusiness_id (integer): O ID do negócio associado ao cliente.
\nemail (string): O e-mail atualizado do cliente.
\nid (integer): O identificador único do cliente.
\nname (string): O nome atualizado do cliente.
\nstores (array de objects): Lista de objetos de lojas associadas ao cliente.
\nid (integer): O ID da loja.
\nname (string): O nome da loja.
\n{\n \"data\": {\n \"address\": {\n \"city\": \"Rio de Janeiro\",\n \"code\": \"22450-003\",\n \"country\": \"BR\",\n \"region\": \"Rio de Janeiro\",\n \"street1\": \"123 Easy Street UPDATED\"\n },\n \"business_id\": 1,\n \"email\": \"test+customer3+updated@liberpay.com\",\n \"id\": 54,\n \"name\": \"Test Customer 3 UPDATED\",\n \"stores\": [\n {\n \"id\": 1,\n \"name\": \"Main Store\"\n }\n ]\n }\n}\n\nCertifique-se de que o ID do cliente na URL corresponda a um cliente existente.
\nNem todos os campos do objeto address são obrigatórios, porém recomenda-se fornecer o máximo de informações possível para uma atualização completa.
\nA estrutura da resposta pode incluir campos vazios para o endereço ou outros detalhes se não tiverem sido atualizados na requisição.
\nEste endpoint é usado para deletar um cliente do sistema com base no ID do cliente fornecido.
A requisição é enviada usando o método HTTP DELETE, indicando que o cliente deseja remover o recurso especificado.
Status Code: 204 No Content
\nIndica que a requisição foi bem-sucedida e o cliente foi deletado.
\nNenhum conteúdo adicional será retornado no corpo da resposta.
\nContent-Type: text/xml
\nPara usar este endpoint, substitua {id} na URL pelo ID real do cliente que deseja deletar.
Uma exclusão bem-sucedida retornará o status 204, confirmando que a operação foi concluída sem nenhum conteúdo no corpo da resposta.
Este endpoint permite recuperar os detalhes de uma conta de taxas específica identificada pelo seu ID único.
\nMétodo: GET
\nEndpoint: {{baseURL}}/api/fee_accounts/{id}
Parâmetro de Caminho
\nEm caso de sucesso, você receberá um status 200 OK junto com uma resposta JSON contendo os seguintes campos:
\nbalance (object): Representa o saldo da conta.
\namount (string): O valor numérico do saldo.
\ncurrency (string): A moeda em que o saldo está denominado.
\nbalance_fiat (object): Representa o saldo em moeda fiduciária.
\namount (string): O valor numérico do saldo fiat.
\ncurrency (string): A moeda em que o saldo fiat está denominado.
\nbusiness_id (integer): Identificador numérico do negócio associado.
\nfreebies (integer): Valor numérico indicando quaisquer bônus/freebies associados à conta.
\nid (integer): O identificador único da conta de taxas.
\nname (string): O nome da conta de taxas.
\nrecharge_amount (integer ou null): O valor necessário para recarregar a conta, se aplicável.
\nrecharge_at (integer ou null): O timestamp para a próxima recarga, se aplicável.
\n{\n \"balance\": {\n \"amount\": \"2.25\",\n \"currency\": \"USD\"\n },\n \"balance_fiat\": {\n \"amount\": \"2.25\",\n \"currency\": \"USD\"\n },\n \"business_id\": 1,\n \"freebies\": 0,\n \"id\": 1,\n \"name\": \"default\",\n \"recharge_amount\": 20,\n \"recharge_at\": 10\n}\n\nEssa estrutura fornece uma visão completa da conta de taxas, incluindo detalhes financeiros e identificadores associados.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a16defba-0ba4-4a35-9be6-205191c70606","id":"a16defba-0ba4-4a35-9be6-205191c70606","name":"Documentação da API Liberpay","type":"collection"}},"urlObject":{"path":["api","fee_accounts","1"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8e4eeb3f-add5-4ad9-9a97-688f0e648445"},{"name":"transações","id":"b217677d-6564-4133-9e8c-7f16e2bae024","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/fee_accounts/1/transactions","description":"Este endpoint recupera uma lista de transações associadas a uma conta de taxas específica identificada pelo seu ID.
A requisição é feita usando o método HTTP GET e retorna informações detalhadas sobre cada transação, incluindo valores monetários, detalhes de moeda e metadados da transação.
Método: GET
\nURL: {{baseURL}}/api/fee_accounts/{id}/transactions
Substitua {id} pelo ID da conta de taxas da qual você deseja recuperar as transações.
\nEm caso de sucesso, a API retornará um array JSON contendo objetos de transações.
Cada objeto de transação inclui os seguintes campos:
amount (string): O valor envolvido na transação.
\namount_fiat (string): O valor equivalente em moeda fiduciária.
\ncharge (nullable): Detalhes adicionais da cobrança relacionada à transação.
\ncharge_token (nullable): Token associado à cobrança, se aplicável.
\ncurrency (object): Detalhes da moeda usada na transação.
\naddress (string): O endereço associado à moeda.
\ndecimals (integer): O número de casas decimais da moeda.
\nid (integer): O identificador único da moeda.
\nname (string): O nome da moeda.
\nsymbol (string): O símbolo que representa a moeda.
\ntype (object): Informações sobre o tipo da moeda.
\nid (integer): O identificador do tipo de moeda.
\nidentifier (string): O identificador único do tipo de moeda.
\nlabel (string): O rótulo do tipo de moeda.
\nplatform (object): Informações sobre a plataforma associada ao tipo de moeda.
\nid (integer): O identificador da plataforma.
\nidentifier (string): O identificador único da plataforma.
\nlabel (string): O rótulo da plataforma.
\ndata (object): Contém dados adicionais da transação.
\nconfirmations (integer): O número de confirmações da transação.
\nfrom (string): O endereço do remetente.
\nid (integer): O identificador único da transação.
\nidentifier (string): Um identificador único para a transação.
\ninserted_at (string): O timestamp de quando a transação foi registrada.
\nto (string): O endereço do destinatário.
\nid (integer): O identificador único da transação.
\ninserted_at (string): O timestamp de quando a transação foi criada.
\ntype (integer): O tipo de transação.
\nupdated_at (string): O timestamp da última atualização da transação.
\nPara utilizar este endpoint de forma eficaz, substitua {id} na URL pelo ID da conta de taxas apropriado.
A resposta fornecerá informações completas sobre cada transação, que podem ser utilizadas para rastreamento financeiro, relatórios ou auditorias.
Este endpoint recupera os detalhes de um gateway específico identificado pelo seu ID único.
É útil para obter configurações e metadados sobre o gateway, que podem ser utilizados em várias aplicações e serviços.
Método: GET
\nURL: {{baseURL}}/api/gateways/{id}
Parâmetro de Caminho
\nEm caso de sucesso, o servidor responderá com status 200 OK e um objeto JSON contendo a seguinte estrutura:
\n{\n \"data\": {\n \"address\": \"\",\n \"config_secret\": null,\n \"id\": 0,\n \"name\": \"\",\n \"stores\": [\n {\n \"id\": 0,\n \"name\": \"\"\n }\n ],\n \"type\": {\n \"id\": 0,\n \"identifier\": \"\",\n \"label\": \"\",\n \"platform\": {\n \"id\": 0,\n \"identifier\": \"\",\n \"label\": \"\"\n }\n }\n }\n}\n\ndata (object): Contém os detalhes do gateway.
\naddress (string): O endereço do gateway.
\nconfig_secret (string ou null): Valor secreto de configuração do gateway.
\nid (integer): O identificador único do gateway.
\nname (string): O nome do gateway.
\nstores (array): Lista de lojas associadas ao gateway.
\nid (integer): O identificador único da loja.
\nname (string): O nome da loja.
\ntype (object): Descreve o tipo do gateway.
\nid (integer): O identificador único do tipo.
\nidentifier (string): O identificador único do tipo.
\nlabel (string): O rótulo do tipo.
\nplatform (object): Representa a plataforma do tipo de gateway.
\nid (integer): O identificador único da plataforma.
\nidentifier (string): O identificador único da plataforma.
\nlabel (string): O rótulo da plataforma.
\nEste endpoint é essencial para aplicações que precisam exibir ou gerenciar configurações de gateways e seus dados associados.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a16defba-0ba4-4a35-9be6-205191c70606","id":"a16defba-0ba4-4a35-9be6-205191c70606","name":"Documentação da API Liberpay","type":"collection"}},"urlObject":{"path":["api","gateways","73"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"35952bd9-0a33-460f-8693-bf54c0ed79a0"},{"name":"listar","id":"6b8f36af-bd2d-4e7c-bdd2-45174102ce7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/gateways?type_id=1","description":"Este endpoint permite recuperar uma lista de gateways com base em um ID de tipo especificado.
É útil para buscar configurações e detalhes de gateways que são categorizados pelo seu tipo.
Método: GET
\nURL: {{baseURL}}/api/gateways
Parâmetros de Query
\nEm caso de sucesso, a API retorna um status 200 OK e um objeto JSON com a seguinte estrutura:
\n{\n \"data\": [\n {\n \"address\": \"0xf2d1b6e93699f7b2d1f81bd4d72ef3c5ad5d58a4\",\n \"config\": {},\n \"creator_id\": 1,\n \"id\": 73,\n \"is_system\": false,\n \"licensed\": true,\n \"name\": \"NFTiPay Main\",\n \"stores\": [\n {\n \"id\": 1,\n \"name\": \"Main Store\"\n }\n ],\n \"type\": {\n \"id\": 1,\n \"identifier\": \"polygon\",\n \"label\": \"Polygon\",\n \"platform\": {\n \"id\": 1,\n \"identifier\": \"evm\",\n \"label\": \"Ethereum Virtual Machine\"\n }\n }\n },\n {\n \"address\": \"0x9b5af6c77d4a2a43e9325d9ad9fb06a3875f9287\",\n \"config\": {},\n \"creator_id\": 1,\n \"id\": 77,\n \"is_system\": false,\n \"licensed\": true,\n \"name\": \"Fireworks Store\",\n \"stores\": [\n {\n \"id\": 58,\n \"name\": \"Firework Store\"\n }\n ],\n \"type\": {\n \"id\": 1,\n \"identifier\": \"polygon\",\n \"label\": \"Polygon\",\n \"platform\": {\n \"id\": 1,\n \"identifier\": \"evm\",\n \"label\": \"Ethereum Virtual Machine\"\n }\n }\n },\n {\n \"address\": null,\n \"config\": {},\n \"creator_id\": 1,\n \"id\": 100,\n \"is_system\": false,\n \"licensed\": false,\n \"name\": \"TEST\",\n \"stores\": [\n {\n \"id\": 1,\n \"name\": \"Main Store\"\n }\n ],\n \"type\": {\n \"id\": 1,\n \"identifier\": \"polygon\",\n \"label\": \"Polygon\",\n \"platform\": {\n \"id\": 1,\n \"identifier\": \"evm\",\n \"label\": \"Ethereum Virtual Machine\"\n }\n }\n }\n ]\n}\n\ndata (array): Lista de objetos de gateways.
\naddress (string): O endereço do gateway.
\nconfig (object): Configurações do gateway.
\ncreator_id (integer): O ID do criador do gateway.
\nid (integer): O identificador único do gateway.
\nis_system (boolean): Indica se o gateway é do sistema.
\nlicensed (boolean): Indica se o gateway é licenciado.
\nname (string): O nome do gateway.
\nstores (array): Lista de lojas associadas ao gateway.
\nid (integer): O identificador único da loja.
\nname (string): O nome da loja.
\ntype (object): O tipo do gateway.
\nid (integer): O identificador único do tipo.
\nidentifier (string): O identificador do tipo.
\nlabel (string): O rótulo do tipo.
\nplatform (object): Informações sobre a plataforma do tipo de gateway.
\nid (integer): O identificador único da plataforma.
\nidentifier (string): O identificador da plataforma.
\nlabel (string): O rótulo da plataforma.
\nEste endpoint é essencial para gerenciar e compreender os gateways disponíveis no sistema com base no seu tipo.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a16defba-0ba4-4a35-9be6-205191c70606","id":"a16defba-0ba4-4a35-9be6-205191c70606","name":"Documentação da API Liberpay","type":"collection"}},"urlObject":{"path":["api","gateways"],"host":["{{baseURL}}"],"query":[{"key":"type_id","value":"1"}],"variable":[]}},"response":[],"_postman_id":"6b8f36af-bd2d-4e7c-bdd2-45174102ce7f"},{"name":"tipos de gateway","id":"f008f0bd-4b98-4e82-a4e8-bae0b7066b63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/gateway_types","description":"GET
\n{{baseURL}}/api/gateway_types
Este endpoint é usado para recuperar uma lista de tipos de gateways disponíveis no sistema.
Ele fornece informações essenciais sobre cada tipo de gateway, incluindo seu identificador único e detalhes da plataforma associada.
Este endpoint não requer corpo na requisição.
É uma chamada simples GET.
Em caso de sucesso, o servidor responde com status 200 OK e um objeto JSON com a seguinte estrutura:
\n{\n \"data\": [\n {\n \"id\": 1,\n \"identifier\": \"polygon\",\n \"label\": \"Polygon\",\n \"platform\": {\n \"id\": 1,\n \"identifier\": \"evm\",\n \"label\": \"Ethereum Virtual Machine\"\n }\n },\n {\n \"id\": 3,\n \"identifier\": \"stripe\",\n \"label\": \"Stripe\",\n \"platform\": {\n \"id\": 2,\n \"identifier\": \"fiat\",\n \"label\": \"Fiat Currency\"\n }\n }\n ]\n}\n\nMétodo: GET
Endpoint: /api/status
Este endpoint é usado para recuperar o status atual da aplicação.
Não requer parâmetros no corpo da requisição.
Método: GET
\nCorpo da Requisição: Nenhum
\nStatus Code: 200 OK
\nContent-Type: application/json
\nA resposta retornará um objeto JSON contendo a chave status, que indica o status operacional atual da aplicação.
Um valor de \"ok\" significa que a API está operacional.
{\n \"status\": \"ok\"\n}\n\n| ID | ","Name | ","Symbol | ","
|---|---|---|
| {{id}} | ","{{name}} | ","{{symbol}} | ","
Método: GET
Endpoint: {{baseURL}}/api/currencies
Este endpoint é usado para recuperar uma lista de moedas disponíveis no aplicativo. Ele não requer nenhum parâmetro no corpo da requisição.
\nMétodo: GET
Corpo da Requisição: Nenhum
Status Code: 200 OK
Content-Type: application/json
{\n \"data\": [\n {\n \"address\": \"0x0000000000000000000000000000000000000000\",\n \"decimals\": 18,\n \"id\": 1,\n \"name\": \"Polygon\",\n \"symbol\": \"POL\",\n \"type\": {\n \"id\": 1,\n \"identifier\": \"polygon\",\n \"label\": \"Polygon\",\n \"platform\": {\n \"id\": 1,\n \"identifier\": \"evm\",\n \"label\": \"Ethereum Virtual Machine\"\n }\n }\n },\n {\n \"address\": \"0xc2132d05d31c914a87c6611c10748aeb04b58e8f\",\n \"decimals\": 6,\n \"id\": 2,\n \"name\": \"Tether USD\",\n \"symbol\": \"USDT\",\n \"type\": {\n \"id\": 1,\n \"identifier\": \"polygon\",\n \"label\": \"Polygon\",\n \"platform\": {\n \"id\": 1,\n \"identifier\": \"evm\",\n \"label\": \"Ethereum Virtual Machine\"\n }\n }\n },\n {\n \"address\": \"stripe_usd\",\n \"decimals\": 2,\n \"id\": 6,\n \"name\": \"USD\",\n \"symbol\": \"USD\",\n \"type\": {\n \"id\": 3,\n \"identifier\": \"stripe\",\n \"label\": \"Stripe\",\n \"platform\": {\n \"id\": 2,\n \"identifier\": \"fiat\",\n \"label\": \"Moeda Fiduciária\"\n }\n }\n },\n {\n \"address\": \"0x3c499c542cef5e3811e1192ce70d8cc03d5c3359\",\n \"decimals\": 6,\n \"id\": 7,\n \"name\": \"USD Coin\",\n \"symbol\": \"USDC\",\n \"type\": {\n \"id\": 1,\n \"identifier\": \"polygon\",\n \"label\": \"Polygon\",\n \"platform\": {\n \"id\": 1,\n \"identifier\": \"evm\",\n \"label\": \"Ethereum Virtual Machine\"\n }\n }\n }\n ],\n \"status\": \"ok\"\n}\n\nA resposta retornará um objeto JSON contendo um array data, onde cada elemento representa uma moeda com a seguinte estrutura:
id (integer): Identificador único da moeda.
\nname (string): Nome da moeda.
\nsymbol (string): Símbolo que representa a moeda.
\ndecimals (integer): Número de casas decimais suportadas pela moeda.
\ntype (object): Contém detalhes sobre o tipo da moeda, incluindo:
\nid (integer): Identificador único do tipo.
\nidentifier (string): Identificador do tipo.
\nlabel (string): Rótulo do tipo.
\nplatform (object): Detalhes sobre a plataforma, incluindo:
\nid (integer): Identificador único da plataforma.
\nidentifier (string): Identificador da plataforma.
\nlabel (string): Rótulo da plataforma.
\nAlém disso, a resposta incluirá uma chave status indicando o status geral da requisição.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a16defba-0ba4-4a35-9be6-205191c70606","id":"a16defba-0ba4-4a35-9be6-205191c70606","name":"Documentação da API Liberpay","type":"collection"}},"urlObject":{"path":["api","currencies"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"afb313cc-5229-45d4-92f8-f6dc180bb95c"},{"name":"moedas fiduciária","event":[{"listen":"test","script":{"exec":["var template = `","","","| ID | ","Name | ","Symbol | ","
|---|---|---|
| {{id}} | ","{{name}} | ","{{symbol}} | ","
Método: GET
Endpoint: {{baseURL}}/api/fiat_currencies
Este endpoint é usado para recuperar uma lista de moedas fiduciárias disponíveis no aplicativo. Ele não requer nenhum parâmetro no corpo da requisição.
\nMétodo: GET
Corpo da Requisição: Nenhum
Status Code: 200 OK
Content-Type: application/json
{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Brazilian Real\",\n \"sign\": \"R$\",\n \"symbol\": \"BRL\"\n }\n ],\n \"status\": \"ok\"\n}\n\nA resposta retornará um objeto JSON contendo um array data, onde cada elemento representa uma moeda fiduciária com a seguinte estrutura:
id (integer): Identificador único da moeda.
\nname (string): Nome da moeda.
\nsign (string): Sinal da moeda.
\nsymbol (string): Símbolo que representa a moeda.
\nAlém disso, a resposta incluirá uma chave status indicando o status geral da requisição.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a16defba-0ba4-4a35-9be6-205191c70606","id":"a16defba-0ba4-4a35-9be6-205191c70606","name":"Documentação da API Liberpay","type":"collection"}},"urlObject":{"path":["api","fiat_currencies"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"68816168-1766-404a-823d-3a920f08513a"},{"name":"status de produtos","id":"a3c9e6f0-dbc7-41a9-ac3c-e2e1c1825101","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseURL}}/api/product_statuses","description":"Método: GET
URL: {{baseURL}}/api/product_statuses
Este endpoint é usado para recuperar os status atuais dos produtos disponíveis no sistema. Ele fornece uma lista de status de produtos que podem ser utilizados em várias operações dentro do aplicativo.
\nEste endpoint não requer nenhum corpo na requisição.
\nNo entanto, é recomendado incluir os seguintes headers:
\nContent-Type: application/json
\nEspecifica que o cliente espera uma resposta em JSON.
\nEm uma requisição bem-sucedida, a API retornará uma resposta com o código de status 200 e a seguinte estrutura em JSON:
\n{\n \"data\": [\n {\n \"id\": 0,\n \"label\": \"\"\n }\n ]\n}\n\ndata: Um array de objetos representando os status de produtos.
\nid: Um identificador único para cada status de produto.
\nlabel: Um rótulo descritivo para o status do produto (pode estar vazio).
\nEssa estrutura de resposta permite que os clientes acessem e utilizem facilmente os status de produtos em suas aplicações.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a16defba-0ba4-4a35-9be6-205191c70606","id":"a16defba-0ba4-4a35-9be6-205191c70606","name":"Documentação da API Liberpay","type":"collection"}},"urlObject":{"path":["api","product_statuses"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a3c9e6f0-dbc7-41a9-ac3c-e2e1c1825101"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"9774e84d-3072-4284-9fd3-f7b26ada188f"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"0e7fd544-4af1-4aad-8872-82147cf18082"}}]}