Liberpay is a self-custody payment platform. Buyers pay in crypto (for example, USDC on Polygon) or in fiat (card, Pix). The money goes to the seller's wallet or account. Liberpay does not hold it.
\nTo use the API, you need a Liberpay account. Go to https://liberpay.com to create one.
\nAll API calls use this base URL:
\nhttps://api.liberpay.com
In this collection, the https://api.liberpay.com variable holds the base URL. Every path starts with /api.
An API key does not expire. It stays valid until you revoke it. You can also manage keys with the endpoints in the auth folder.
\nSend the key in the Authorization header of each request:
Authorization: Bearer <your API key>\nIn this collection, put your key in the variable. The collection sends it on every request.
An API key acts as the user who created it. It can do all the things that the user can do. Keep your keys secret. Do not put them in browser or mobile app code.
\nSome endpoints are public and do not need a key. The description of each endpoint tells you if it needs a key.
\nContent-Type: application/json. File uploads use multipart/form-data.data key: {\"data\": {...}} or {\"data\": [...]}.\"102.00\". Amounts in crypto are integer strings in the smallest unit of the token (for example, USDC has 6 decimals, so \"1000000\" is 1 USDC).Z suffix.Liberpay uses standard HTTP status codes. Error bodies use these shapes:
\nThe message text uses the language of the request.
Some business rules return 500 with a message today, for example \"charge must have created status\". Read the message text, not only the status code.
To accept a payment, you, the seller, first create a charge with the charges › create endpoint.
\nA charge has one of 10 statuses:
\nImportant rules:
\nhttps://app.liberpay.com/charges/:shortcode/pay. While a charge is created, anyone with the shortcode can read it. After that, only the parties of the charge can read it.expires_at). After expiry, set the currency again or update the charge to get a new quote.This is the easiest integration:
\nLiberpay hosts the payment page. It handles currency selection, the charge nonce and hash, wallet connection, fiat checkout, and the report of blockchain transactions.
\nYou can build your own payment page. This takes more work. At a high level, you must:
\ngenerateCommitment method of the NFTiPayReceipt contract.We can help you with your integration. Write to support@liberpay.com.
\nLiberpay does not send webhooks to your server yet. To know when a charge changes status, read the charge with charges › get at regular intervals. Stop when the status is final (for example confirmed, expired, failed or canceled).
The events folder is not a webhook system. It records activity on an invoice, for example when a buyer views it.
\nNFT receipts from Liberpay come only from this contract:
\nPolygon Mainnet (NFTiPayReceipt): 0x714256086AC8636E95FE28D1b010a0083A684c6d
Gateway fees and other platform fees on the blockchain are paid only in official USDC to this address:
\nMain fee wallet: 0xB00a8eb1e0774401208F9507d0d69360F42B9B97
Write to support@liberpay.com for help.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"},{"content":"Base URL","slug":"base-url"},{"content":"Authentication","slug":"authentication"},{"content":"Requests and Responses","slug":"requests-and-responses"},{"content":"Errors","slug":"errors"},{"content":"The Charge Lifecycle","slug":"the-charge-lifecycle"},{"content":"Accept a Payment","slug":"accept-a-payment"},{"content":"Webhooks","slug":"webhooks"},{"content":"Smart Contracts and Addresses","slug":"smart-contracts-and-addresses"},{"content":"Support","slug":"support"}],"owner":"47943201","collectionId":"fb7d9328-d944-41b5-8605-d459ea859701","publishedId":"2sBYHVvJcU","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"20a5f3"},"publishDate":"2026-10-27T16:39:37.000Z"},"item":[{"name":"auth","item":[{"name":"verify","id":"0f19b9a3-caf6-4db5-be96-cfd9e4b58089","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/auth/verify","description":"Checks the token in the Authorization header and returns the user that owns it. Use this call to test a new API key.
The response also gives the identity verification (KYC) status of the user and the P2P account of the user. p2p_account is null when the user has no P2P account.
Requires an API key or a session token.
\nLists the API keys of the current user. The list does not include the key value. The API shows the key value only one time, in the create response.
Use the id to revoke a key with delete.
Requires an API key or a session token.
\nCreates a new API key for the current user. The key does not expire. The key has full access to the account.
\nThe token field holds the key value. The API shows it only in this response. Copy the key and keep it in a safe place. If you lose the key, revoke it and create a new key.
You can also create keys on the My Profile page of the Liberpay app.
\nRequires an API key or a session token.
\nRevokes an API key. The key stops working immediately. You cannot undo this action.
\nYou can revoke only your own keys.
\nRequires an API key or a session token.
\nThe API key ID, from list or create.
Check your token and manage your API keys. An API key is a bearer token that does not expire. You can revoke it at any time. Use an API key for server-to-server calls to all endpoints that need a token.
\n","_postman_id":"a1e5c2cb-dd84-4990-a995-32faaf765b93","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fb7d9328-d944-41b5-8605-d459ea859701","id":"fb7d9328-d944-41b5-8605-d459ea859701","name":"Liberpay API Docs","type":"collection"}}},{"name":"charges","item":[{"name":"list","id":"649efe26-9669-47e4-b106-dde1142d33de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/charges","description":"Lists the charges that the caller created, newest first. The list has 25 charges per page.
\nThe items in this list do not include the invoice, p2p_request and requested_buyer blocks. To see them, use get or the store list.
Requires an API key or a session token.
\nThe page number. The first page is 1. The default is 1.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Optional. A fiat symbol from GET /api/fiat_currencies. It overrides the viewer currency for the viewer_fiat block. An unknown symbol gives 422.
Lists all charges of a store (all types), newest first. The caller must be a member of the business that owns the store.
\nWith page, the response is a page of 25 charges. Without page, the response is {\"data\": [...]} with the newest 250 charges and no page fields. Send page in new code.
For one type only, use GET /api/stores/:store_id/sales (point of sale) or GET /api/stores/:store_id/invoices.
Requires an API key or a session token.
\nThe page number. The first page is 1. The default is 1.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Optional. A fiat symbol from GET /api/fiat_currencies. It overrides the viewer currency for the viewer_fiat block. An unknown symbol gives 422.
The id of the store.
\n","type":"text/plain"},"type":"any","value":"5","key":"store_id"}]}},"response":[{"id":"c5e8cacc-94d7-4afc-afd0-912be5467825","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:store_id/charges","host":["https://api.liberpay.com"],"path":["api","stores",":store_id","charges"],"query":[{"key":"page","value":"1","description":"The page number. The first page is 1. The default is 1.","disabled":true},{"key":"viewer_currency","value":"USD","description":"Optional. A fiat symbol from `GET /api/fiat_currencies`. It overrides the viewer currency for the `viewer_fiat` block. An unknown symbol gives 422.","disabled":true}],"variable":[{"key":"store_id","value":"5","description":"The id of the store."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"first\": 1,\n \"last\": 1,\n \"has_next\": false,\n \"has_prev\": false,\n \"prev_page\": null,\n \"next_page\": null,\n \"last_page\": 1,\n \"per_page\": 25,\n \"data\": [\n {\n \"id\": 233,\n \"shortcode\": \"73cOkdcBqtCYlxk\",\n \"hash\": null,\n \"metadata\": {\n \"items\": [\n {\n \"id\": \"f543912d-d957-4bb2-a9a8-182c01f2f932\",\n \"name\": \"Catering service\",\n \"description\": \"\",\n \"is_physical\": false,\n \"taxable\": false,\n \"tax_rate\": \"0.10\",\n \"metadata\": {},\n \"quantity\": 1.0,\n \"price\": {\n \"amount\": \"100.0\",\n \"currency\": \"BRL\"\n },\n \"unit_tax\": {\n \"amount\": \"0\",\n \"currency\": \"BRL\"\n },\n \"subtotal\": {\n \"amount\": \"100.00\",\n \"currency\": \"BRL\"\n },\n \"tax\": {\n \"amount\": \"0.00\",\n \"currency\": \"BRL\"\n },\n \"total\": {\n \"amount\": \"100.00\",\n \"currency\": \"BRL\"\n },\n \"price_currency\": \"17860000\",\n \"unit_tax_currency\": \"0\",\n \"subtotal_currency\": \"17860000\",\n \"tax_currency\": \"0\",\n \"total_currency\": \"17860000\"\n }\n ]\n },\n \"price\": {\n \"amount\": \"100.00\",\n \"currency\": \"BRL\"\n },\n \"currency_price\": \"17860000\",\n \"exchange_rate\": \"0.1786\",\n \"expires_at\": \"2026-10-27T14:15:00Z\",\n \"gateway\": {\n \"id\": 73,\n \"name\": \"Main Gateway\",\n \"address\": \"0x7f3a9c2e5b1d4f6a8c0e2b4d6f8a1c3e5b7d9f0a\",\n \"licensed\": true,\n \"license_status\": \"valid\",\n \"creator_id\": 12,\n \"is_system\": false,\n \"version\": {\n \"identifier\": \"polygon-v1\",\n \"number\": 1\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 \"config\": {\n \"configured\": false\n }\n },\n \"store\": {\n \"id\": 5,\n \"name\": \"Main Store\",\n \"logo\": \"https://example.com/images/store-logo.png\",\n \"business\": {\n \"id\": 4,\n \"name\": \"Steve Coffee\"\n }\n },\n \"seller_address\": null,\n \"creator\": {\n \"id\": 12,\n \"username\": \"steveseller\",\n \"email\": \"steve+seller@example.com\",\n \"address\": \"0x1111aaaa2222bbbb3333cccc4444dddd5555eeee\"\n },\n \"buyer\": null,\n \"currency\": {\n \"id\": 3,\n \"name\": \"USD Coin\",\n \"symbol\": \"USDC\",\n \"decimals\": 6,\n \"address\": \"0x5a1e5c0ffee000000000000000000000000c0ffe\",\n \"supported\": true\n },\n \"fiat_currency\": {\n \"id\": 2,\n \"name\": \"Brazilian Real\",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n \"buyer_fiat_currency\": null,\n \"buyer_price\": null,\n \"buyer_exchange_rate\": null,\n \"viewer_fiat\": null,\n \"business_fiat\": null,\n \"payments\": [],\n \"refunds\": [],\n \"tokens\": [],\n \"type\": {\n \"id\": 2,\n \"label\": \"Invoice\"\n },\n \"status\": {\n \"id\": 1,\n \"label\": \"created\"\n },\n \"inserted_at\": \"2026-10-27T14:00:00\",\n \"updated_at\": \"2026-10-27T14:00:00\",\n \"invoice\": {\n \"id\": 94,\n \"number\": 1001,\n \"title\": \"October services\",\n \"date\": \"2026-10-27\",\n \"due_date\": \"2026-11-10\",\n \"notes\": \"Pay by Pix or USDC.\",\n \"approved\": false,\n \"customer\": {\n \"id\": 8,\n \"name\": \"Steve Customer\",\n \"email\": \"steve+customer@example.com\",\n \"address\": {\n \"street1\": \"Rua Exemplo 100\",\n \"street2\": \"Sala 2\",\n \"city\": \"São Paulo\",\n \"region\": \"SP\",\n \"code\": \"01000-000\"\n },\n \"business_id\": 4\n }\n }\n }\n ]\n}"},{"id":"cb91ff7f-f83e-48ab-a6b2-a471ec1255c1","name":"404 Not a member","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:store_id/charges","host":["https://api.liberpay.com"],"path":["api","stores",":store_id","charges"],"query":[{"key":"page","value":"1","description":"The page number. The first page is 1. The default is 1.","disabled":true},{"key":"viewer_currency","value":"USD","description":"Optional. A fiat symbol from `GET /api/fiat_currencies`. It overrides the viewer currency for the `viewer_fiat` block. An unknown symbol gives 422.","disabled":true}],"variable":[{"key":"store_id","value":"5","description":"The id of the store."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"not found\"\n}"}],"_postman_id":"80ecb962-ef36-4f13-a7b4-8327a37bc3a7"},{"name":"listGateway","id":"b408a04f-26d6-4673-a14d-68e11a15b45c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/gateways/:gateway_id/charges","description":"Lists the charges of a gateway (all stores and types), newest first, 25 per page. The caller must be a member of the business that owns the gateway.
\nFor one type only, use GET /api/gateways/:gateway_id/sales or GET /api/gateways/:gateway_id/invoices.
Requires an API key or a session token.
\nThe page number. The first page is 1. The default is 1.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Optional. A fiat symbol from GET /api/fiat_currencies. It overrides the viewer currency for the viewer_fiat block. An unknown symbol gives 422.
The id of the gateway.
\n","type":"text/plain"},"type":"any","value":"73","key":"gateway_id"}]}},"response":[{"id":"7222580a-639f-4496-84f1-d09e9068d563","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/gateways/:gateway_id/charges","host":["https://api.liberpay.com"],"path":["api","gateways",":gateway_id","charges"],"query":[{"key":"page","value":"1","description":"The page number. The first page is 1. The default is 1.","disabled":true},{"key":"viewer_currency","value":"USD","description":"Optional. A fiat symbol from `GET /api/fiat_currencies`. It overrides the viewer currency for the `viewer_fiat` block. An unknown symbol gives 422.","disabled":true}],"variable":[{"key":"gateway_id","value":"73","description":"The id of the gateway."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"first\": 1,\n \"last\": 1,\n \"has_next\": false,\n \"has_prev\": false,\n \"prev_page\": null,\n \"next_page\": null,\n \"last_page\": 1,\n \"per_page\": 25,\n \"data\": [\n {\n \"id\": 231,\n \"shortcode\": \"73cJltPHglQdnVH\",\n \"hash\": \"0x9b2c4e6a8d0f1b3c5e7a9c1e3b5d7f9a1c3e5b7d9f1a3c5e7b9d1f3a5c7e9b1d\",\n \"metadata\": {\n \"items\": [\n {\n \"id\": 3,\n \"name\": \"Espresso\",\n \"description\": \"Double shot\",\n \"images\": [\n {\n \"url\": \"https://example.com/images/espresso.png\"\n }\n ],\n \"is_physical\": true,\n \"taxable\": true,\n \"tax_rate\": \"0.10\",\n \"quantity\": 2,\n \"price\": {\n \"amount\": \"1.00\",\n \"currency\": \"BRL\"\n },\n \"unit_tax\": {\n \"amount\": \"0.10\",\n \"currency\": \"BRL\"\n },\n \"subtotal\": {\n \"amount\": \"2.00\",\n \"currency\": \"BRL\"\n },\n \"tax\": {\n \"amount\": \"0.20\",\n \"currency\": \"BRL\"\n },\n \"total\": {\n \"amount\": \"2.20\",\n \"currency\": \"BRL\"\n },\n \"price_currency\": \"178600\",\n \"unit_tax_currency\": \"17860\",\n \"subtotal_currency\": \"357200\",\n \"tax_currency\": \"35720\",\n \"total_currency\": \"392920\"\n },\n {\n \"id\": \"f543912d-d957-4bb2-a9a8-182c01f2f932\",\n \"name\": \"Catering service\",\n \"description\": \"\",\n \"is_physical\": false,\n \"taxable\": false,\n \"tax_rate\": \"0.10\",\n \"metadata\": {},\n \"quantity\": 1.0,\n \"price\": {\n \"amount\": \"100.0\",\n \"currency\": \"BRL\"\n },\n \"unit_tax\": {\n \"amount\": \"0\",\n \"currency\": \"BRL\"\n },\n \"subtotal\": {\n \"amount\": \"100.00\",\n \"currency\": \"BRL\"\n },\n \"tax\": {\n \"amount\": \"0.00\",\n \"currency\": \"BRL\"\n },\n \"total\": {\n \"amount\": \"100.00\",\n \"currency\": \"BRL\"\n },\n \"price_currency\": \"17860000\",\n \"unit_tax_currency\": \"0\",\n \"subtotal_currency\": \"17860000\",\n \"tax_currency\": \"0\",\n \"total_currency\": \"17860000\"\n }\n ]\n },\n \"price\": {\n \"amount\": \"102.20\",\n \"currency\": \"BRL\"\n },\n \"currency_price\": \"18252920\",\n \"exchange_rate\": \"0.1786\",\n \"expires_at\": \"2026-10-27T14:15:00Z\",\n \"gateway\": {\n \"id\": 73,\n \"name\": \"Main Gateway\",\n \"address\": \"0x7f3a9c2e5b1d4f6a8c0e2b4d6f8a1c3e5b7d9f0a\",\n \"licensed\": true,\n \"license_status\": \"valid\",\n \"creator_id\": 12,\n \"is_system\": false,\n \"version\": {\n \"identifier\": \"polygon-v1\",\n \"number\": 1\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 \"config\": {\n \"configured\": false\n }\n },\n \"store\": {\n \"id\": 5,\n \"name\": \"Main Store\",\n \"logo\": \"https://example.com/images/store-logo.png\",\n \"business\": {\n \"id\": 4,\n \"name\": \"Steve Coffee\"\n }\n },\n \"seller_address\": null,\n \"creator\": {\n \"id\": 12,\n \"username\": \"steveseller\",\n \"email\": \"steve+seller@example.com\",\n \"address\": \"0x1111aaaa2222bbbb3333cccc4444dddd5555eeee\"\n },\n \"buyer\": {\n \"id\": 34,\n \"username\": \"stevebuyer\",\n \"email\": \"steve+buyer@example.com\",\n \"address\": \"0x6666ffff7777aaaa8888bbbb9999cccc0000dddd\"\n },\n \"currency\": {\n \"id\": 3,\n \"name\": \"USD Coin\",\n \"symbol\": \"USDC\",\n \"decimals\": 6,\n \"address\": \"0x5a1e5c0ffee000000000000000000000000c0ffe\",\n \"supported\": true\n },\n \"fiat_currency\": {\n \"id\": 2,\n \"name\": \"Brazilian Real\",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n \"buyer_fiat_currency\": null,\n \"buyer_price\": null,\n \"buyer_exchange_rate\": null,\n \"viewer_fiat\": null,\n \"business_fiat\": null,\n \"payments\": [\n {\n \"id\": 88,\n \"amount\": \"18252920\",\n \"currency\": {\n \"id\": 3,\n \"name\": \"USD Coin\",\n \"symbol\": \"USDC\",\n \"decimals\": 6,\n \"address\": \"0x5a1e5c0ffee000000000000000000000000c0ffe\",\n \"supported\": true\n },\n \"reference\": null,\n \"transaction\": {\n \"id\": 140,\n \"identifier\": \"0x1486c2a6724154211d2501f8f0de24067b61a716404b8359b533478bfb8bb067\",\n \"from\": \"0x6666ffff7777aaaa8888bbbb9999cccc0000dddd\",\n \"to\": \"0x7f3a9c2e5b1d4f6a8c0e2b4d6f8a1c3e5b7d9f0a\",\n \"confirmations\": 12,\n \"inserted_at\": \"2026-10-27T14:06:10\"\n }\n }\n ],\n \"refunds\": [],\n \"tokens\": [\n {\n \"id\": 51,\n \"token_id\": 1024\n }\n ],\n \"type\": {\n \"id\": 1,\n \"label\": \"Point of Sale\"\n },\n \"status\": {\n \"id\": 3,\n \"label\": \"confirmed\"\n },\n \"inserted_at\": \"2026-10-27T14:00:00\",\n \"updated_at\": \"2026-10-27T14:06:30\"\n }\n ]\n}"}],"_postman_id":"b408a04f-26d6-4673-a14d-68e11a15b45c"},{"name":"listOrders","id":"a4e28aa9-7449-41d6-8f2f-1fb53923fc1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/orders","description":"Lists the point of sale charges (type 1) that the caller created, newest first. The response is one page of up to 250 charges.
\nRequires an API key or a session token.
\nOptional. A fiat symbol from GET /api/fiat_currencies. It overrides the viewer currency for the viewer_fiat block. An unknown symbol gives 422.
Returns one charge by its shortcode. The path parameter has the name :id, but it takes the shortcode only.
Anyone can read a charge in status created, also without a token. The shortcode is long and random, and it works as the access key for the payment page. After the status changes, only the creator, the buyer, or a member of the store's business can read the charge. Other callers get 404.
The response is the charge object itself. It is not wrapped in data.
A token is optional. With a token, the response can include more data for that user.
\nOptional. A fiat symbol from GET /api/fiat_currencies. It overrides the viewer currency for the viewer_fiat block. An unknown symbol gives 422.
The shortcode of the charge (not the numeric id).
\n","type":"text/plain"},"type":"any","value":"73cJltPHglQdnVH","key":"id"}]}},"response":[{"id":"fd9d954d-bb65-4afc-8f4f-d3359a06664d","name":"200 OK (cross-border buyer)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/charges/:id","host":["https://api.liberpay.com"],"path":["api","charges",":id"],"query":[{"key":"viewer_currency","value":"USD","description":"Optional. A fiat symbol from `GET /api/fiat_currencies`. It overrides the viewer currency for the `viewer_fiat` block. An unknown symbol gives 422.","disabled":true}],"variable":[{"key":"id","value":"73cJltPHglQdnVH","description":"The shortcode of the charge (not the numeric id)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 231,\n \"shortcode\": \"73cJltPHglQdnVH\",\n \"hash\": \"0x9b2c4e6a8d0f1b3c5e7a9c1e3b5d7f9a1c3e5b7d9f1a3c5e7b9d1f3a5c7e9b1d\",\n \"metadata\": {\n \"items\": [\n {\n \"id\": 3,\n \"name\": \"Espresso\",\n \"description\": \"Double shot\",\n \"images\": [\n {\n \"url\": \"https://example.com/images/espresso.png\"\n }\n ],\n \"is_physical\": true,\n \"taxable\": true,\n \"tax_rate\": \"0.10\",\n \"quantity\": 2,\n \"price\": {\n \"amount\": \"1.00\",\n \"currency\": \"BRL\"\n },\n \"unit_tax\": {\n \"amount\": \"0.10\",\n \"currency\": \"BRL\"\n },\n \"subtotal\": {\n \"amount\": \"2.00\",\n \"currency\": \"BRL\"\n },\n \"tax\": {\n \"amount\": \"0.20\",\n \"currency\": \"BRL\"\n },\n \"total\": {\n \"amount\": \"2.20\",\n \"currency\": \"BRL\"\n },\n \"price_currency\": \"178600\",\n \"unit_tax_currency\": \"17860\",\n \"subtotal_currency\": \"357200\",\n \"tax_currency\": \"35720\",\n \"total_currency\": \"392920\"\n },\n {\n \"id\": \"f543912d-d957-4bb2-a9a8-182c01f2f932\",\n \"name\": \"Catering service\",\n \"description\": \"\",\n \"is_physical\": false,\n \"taxable\": false,\n \"tax_rate\": \"0.10\",\n \"metadata\": {},\n \"quantity\": 1.0,\n \"price\": {\n \"amount\": \"100.0\",\n \"currency\": \"BRL\"\n },\n \"unit_tax\": {\n \"amount\": \"0\",\n \"currency\": \"BRL\"\n },\n \"subtotal\": {\n \"amount\": \"100.00\",\n \"currency\": \"BRL\"\n },\n \"tax\": {\n \"amount\": \"0.00\",\n \"currency\": \"BRL\"\n },\n \"total\": {\n \"amount\": \"100.00\",\n \"currency\": \"BRL\"\n },\n \"price_currency\": \"17860000\",\n \"unit_tax_currency\": \"0\",\n \"subtotal_currency\": \"17860000\",\n \"tax_currency\": \"0\",\n \"total_currency\": \"17860000\"\n }\n ]\n },\n \"price\": {\n \"amount\": \"102.20\",\n \"currency\": \"BRL\"\n },\n \"currency_price\": \"18252920\",\n \"exchange_rate\": \"0.1786\",\n \"expires_at\": \"2026-10-27T14:20:00Z\",\n \"gateway\": {\n \"id\": 73,\n \"name\": \"Main Gateway\",\n \"address\": \"0x7f3a9c2e5b1d4f6a8c0e2b4d6f8a1c3e5b7d9f0a\",\n \"licensed\": true,\n \"license_status\": \"valid\",\n \"creator_id\": 12,\n \"is_system\": false,\n \"version\": {\n \"identifier\": \"polygon-v1\",\n \"number\": 1\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 \"config\": {\n \"configured\": false\n }\n },\n \"store\": {\n \"id\": 5,\n \"name\": \"Main Store\",\n \"logo\": \"https://example.com/images/store-logo.png\",\n \"business\": {\n \"id\": 4,\n \"name\": \"Steve Coffee\"\n }\n },\n \"seller_address\": null,\n \"creator\": {\n \"id\": 12,\n \"username\": \"steveseller\",\n \"email\": \"steve+seller@example.com\",\n \"address\": \"0x1111aaaa2222bbbb3333cccc4444dddd5555eeee\"\n },\n \"buyer\": {\n \"id\": 34,\n \"username\": \"stevebuyer\",\n \"email\": \"steve+buyer@example.com\",\n \"address\": \"0x6666ffff7777aaaa8888bbbb9999cccc0000dddd\"\n },\n \"currency\": {\n \"id\": 3,\n \"name\": \"USD Coin\",\n \"symbol\": \"USDC\",\n \"decimals\": 6,\n \"address\": \"0x5a1e5c0ffee000000000000000000000000c0ffe\",\n \"supported\": true\n },\n \"fiat_currency\": {\n \"id\": 2,\n \"name\": \"Brazilian Real\",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n \"buyer_fiat_currency\": {\n \"id\": 1,\n \"name\": \"US Dollar\",\n \"symbol\": \"USD\",\n \"sign\": \"$\"\n },\n \"buyer_price\": {\n \"amount\": \"18.25\",\n \"currency\": \"USD\"\n },\n \"buyer_exchange_rate\": \"0.1786\",\n \"viewer_fiat\": {\n \"fiat_currency\": {\n \"id\": 1,\n \"name\": \"US Dollar\",\n \"symbol\": \"USD\",\n \"sign\": \"$\"\n },\n \"rate\": 0.1786,\n \"indicative\": true,\n \"locked\": false,\n \"locked_at\": null,\n \"price\": {\n \"amount\": \"18.25\",\n \"currency\": \"USD\"\n },\n \"items\": [\n {\n \"id\": 3,\n \"price\": \"0.18\",\n \"subtotal\": \"0.36\",\n \"tax\": \"0.04\",\n \"unit_tax\": \"0.02\",\n \"total\": \"0.39\"\n },\n {\n \"id\": \"f543912d-d957-4bb2-a9a8-182c01f2f932\",\n \"price\": \"17.86\",\n \"subtotal\": \"17.86\",\n \"tax\": \"0.00\",\n \"unit_tax\": \"0.00\",\n \"total\": \"17.86\"\n }\n ],\n \"payments\": {},\n \"refunds\": {}\n },\n \"business_fiat\": null,\n \"payments\": [],\n \"refunds\": [],\n \"tokens\": [],\n \"type\": {\n \"id\": 1,\n \"label\": \"Point of Sale\"\n },\n \"status\": {\n \"id\": 1,\n \"label\": \"created\"\n },\n \"inserted_at\": \"2026-10-27T14:00:00\",\n \"updated_at\": \"2026-10-27T14:05:00\"\n}"},{"id":"dd3dc5f5-05f4-4a97-aca6-ca92ed226aba","name":"404 Not visible","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/charges/:id","host":["https://api.liberpay.com"],"path":["api","charges",":id"],"query":[{"key":"viewer_currency","value":"USD","description":"Optional. A fiat symbol from `GET /api/fiat_currencies`. It overrides the viewer currency for the `viewer_fiat` block. An unknown symbol gives 422.","disabled":true}],"variable":[{"key":"id","value":"73cJltPHglQdnVH","description":"The shortcode of the charge (not the numeric id)."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"not found\"\n}"}],"_postman_id":"2c60d2ba-4ce5-47ca-b823-765d6878c754"},{"name":"create","id":"6b342cfd-ebb1-4ede-b971-b64358c7f43b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"charge\": {\n \"charge_type_id\": 1,\n \"gateway_id\": 73,\n \"store_id\": 5,\n \"currency_address\": \"0x5a1e5c0ffee000000000000000000000000c0ffe\",\n \"fiat_currency_id\": 2,\n \"seller_address\": null,\n \"products\": [\n {\n \"type\": \"product\",\n \"id\": 3,\n \"quantity\": 2\n },\n {\n \"type\": \"amount\",\n \"name\": \"Catering service\",\n \"quantity\": 1,\n \"taxable\": false,\n \"is_physical\": false,\n \"price\": {\n \"amount\": 100,\n \"currency\": \"BRL\"\n }\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.liberpay.com/api/charges","description":"Creates a charge in status created and returns it with 201. The API prices every line item in the charge fiat currency, adds the store tax to taxable items, and converts the total to currency at the current rate. The quote is good for 15 minutes.
The gateway and the store must belong to a business of the caller. A system gateway is not allowed, except for P2P. The business must be verified or still under its limit of unverified transactions. The total must not exceed the country limit, and a fiat-gateway charge must reach the country minimum.
\nLine items (products). Each item is one of two kinds. The API decides the kind from id; the type key is optional and only for your own reading.
product: a published catalog product of the store. Send id (integer) and quantity. The API takes the name, price, tax flag and images from the catalog.amount: a free amount. Leave out id (or send null). Send name, quantity, taxable and price: {amount, currency}. If price.currency is not the charge fiat currency, the API converts it.Invoices. Set charge_type_id to 2 and send an invoice object. The customer must belong to the business of the store. With approved: true, the API emails the invoice to the customer at once. Otherwise approve and send it later with the invoices endpoints.
Invoice body example:
\n{\n \"charge\": {\n \"charge_type_id\": 2,\n \"gateway_id\": 73,\n \"store_id\": 5,\n \"currency_address\": \"0x5a1e5c0ffee000000000000000000000000c0ffe\",\n \"fiat_currency_id\": 2,\n \"products\": [\n {\n \"type\": \"amount\",\n \"name\": \"Catering service\",\n \"quantity\": 1,\n \"taxable\": false,\n \"price\": {\n \"amount\": 100,\n \"currency\": \"BRL\"\n }\n }\n ],\n \"invoice\": {\n \"title\": \"October services\",\n \"number\": 1001,\n \"date\": \"2026-10-27\",\n \"due_date\": \"2026-11-10\",\n \"notes\": \"Pay by Pix or USDC.\",\n \"customer_id\": 8,\n \"approved\": false\n }\n }\n}\nRequires an API key or a session token.
\nChanges a charge in status created: its items, gateway, currency or invoice fields. The API prices the charge again, sets a new quote, and moves expires_at to 15 minutes from now.
Any member of the store's business can update the charge. The creator stays the same. The fiat currency, the store and the charge type do not change.
\nThe saved charge must have hash, nonce and buyer_id. If the charge does not have them yet, send them in this call, or the API returns 422. Compute hash with generateCommitment(nonce, shortcode, buyerAddress, sellerAddress) on the receipt contract. The web app sends the caller as a placeholder buyer_id; setCurrency replaces it later with the real buyer.
If you leave out products, the API keeps the current items. For the buyer side, use setCurrency instead.
Requires an API key or a session token.
\nThe numeric id of the charge (data.id). A shortcode does not work here: the API returns 400.
Deletes a charge in status created. A member of the store's business can do this. The response is 204 with no body. You cannot delete a charge after a payment starts.
Requires an API key or a session token.
\nThe numeric id of the charge (data.id). A shortcode does not work here: the API returns 400.
The buyer calls this before payment to pick the currency and the gateway. The API makes the caller the buyer (buyer_id), sets a new quote, and moves expires_at to 15 minutes from now. The creator does not change. If the buyer lives in a different fiat currency, the API also freezes buyer_fiat_currency, buyer_price and buyer_exchange_rate.
The charge must be in status created. If the charge was sent to a user (P2P, or request), only that user can call this. The party who receives the money cannot claim its own P2P charge. Unverified buyers have a per-transaction limit.
gateway_id can be the charge's gateway or another gateway of the same store. The currency must be on the same platform as the gateway. The API keeps only currency_address, nonce, hash and gateway_id from the body.
Requires an API key or a session token.
\nThe shortcode of the charge (data.shortcode). A numeric id does not work here.
Reports a crypto payment that the buyer sent on chain. The API sets the charge to pending and starts a background job 15 seconds later. The job reads the chain for up to about 30 minutes and then sets confirmed, underpaid, expired or failed. Poll get or jobs to follow it.
The charge must be in status created. For P2P charges, only the buyer who claimed the charge with setCurrency can report. For point of sale and invoice charges, any signed-in user can report.
The API checks the expiry against the on-chain confirmation time, not the time of this call.
\nRequires an API key or a session token.
\nThe numeric id of the charge (data.id). A shortcode does not work here: the API returns 400.
Returns the background jobs of a charge, oldest first: the payment check (transaction) and the receipt mint (mint, mint_transaction). Use it to show progress after reportTransaction.
While the charge is created, any signed-in user can read it. After that, only the creator, the buyer or a member of the store's business can.
Requires an API key or a session token.
\nThe shortcode of the charge (data.shortcode). A numeric id does not work here.
Runs the payment check again when the last check stopped (for example discarded). The API reads the chain again for the transaction that was already reported. It never sends a new transaction. Access rules are the same as jobs.
The call is safe to repeat. If a check is already waiting or running, the API returns in_progress.
Requires an API key or a session token.
\nThe shortcode of the charge (data.shortcode). A numeric id does not work here.
Sends an unpaid point of sale charge to a Liberpay user by @username. The charge appears in that user's \"To do\" list, and only that user can pay it until the request is cleared. The API also emails the user when the user has a real email address.
The caller must be a member of the store's business. The charge must be type 1 (point of sale) and in status created. You cannot send a charge to a member of your own business.
The username key is at the top level of the body, not inside charge.
Requires an API key or a session token.
\nThe shortcode of the charge (data.shortcode). A numeric id does not work here.
Removes the user that a point of sale charge was sent to. A member of the store's business can cancel the request, and the user it was sent to can decline it. After this, anyone with the link can pay the charge again. The response is 204 with no body.
\nRequires an API key or a session token.
\nThe shortcode of the charge (data.shortcode). A numeric id does not work here.
A charge is a request for payment. A store creates it, and a buyer pays it in crypto (USDC and other tokens on Polygon) or through a fiat gateway (Stripe, PayPal, Woovi/Pix). Each charge belongs to one store and one gateway. Invoices (invoices) and P2P payments are charges too.
Charge types (type.id → type.label):
Lifecycle. You create a charge in status created (1). The buyer opens the payment page and picks a currency (setCurrency). The buyer pays and reports the transaction, and the charge goes to pending (2). A background job reads the chain and sets confirmed (3), underpaid (6), expired (4) or failed (5). Fiat gateways confirm through their own flow (fiat links).
Price quote and expiry. A charge locks its price in currency for 15 minutes. expires_at is 15 minutes after creation. Each update and each setCurrency sets a new quote and moves expires_at to 15 minutes from that call. A status change does not move it. The API accepts a crypto payment when the chain confirms it before expires_at, even if the report comes later. A refund quote lasts 30 minutes.
The fiat currency is locked. fiat_currency is set at creation and never changes. To change it, delete the charge and create a new one.
Cross-border amounts. Three fields freeze the amount for the other party when that party lives in a different currency: buyer_fiat_currency, buyer_price and buyer_exchange_rate. The API sets them each time that party picks a currency, and clears them when the currencies are the same. After payment they do not change. \"Other party\" means the buyer, except on a P2P send, where it is the recipient.
viewer_fiat block. Each charge response includes the amounts in the fiat currency of the caller. The API uses the country of the signed-in user, or the ?viewer_currency=USD query parameter. The value is null for anonymous callers, when the charge is already in that currency, or when no rate is available. The block has fiat_currency, rate, indicative, locked, locked_at, price, items[] (same order and id as metadata.items), and payments / refunds (maps from payment or refund id to {amount}). When the caller's currency is the frozen buyer_fiat_currency, the block uses the frozen rate, and it is locked: true after payment. Otherwise it uses a live rate with indicative: true. These numbers are for display only. The amount due is always price. business_fiat has the same shape, in the default currency of the business.
:id or :shortcode. Use the right identifier for each route:
A shortcode on a numeric-id route gives 400. A numeric id on a shortcode route gives 404.
\nErrors. Many business rules in this controller return HTTP 500 with {\"message\": \"...\"} (for example \"charge must have created status\"). Read the message text, not only the status code.
Creates a payment session at the fiat provider for the charge total and returns the provider response as data. The API stores the response with the charge. A second call for the same provider replaces the stored session; for Woovi it returns the existing Pix charge.
Any signed-in user can call this; in practice the buyer calls it from the payment page. The provider must match the gateway type of the charge.
\nRequires an API key or a session token.
\nThe numeric id of the charge (data.id). A shortcode does not work here: the API returns 400.
PayPal only. Captures the PayPal order after the buyer approves it and returns to /charges/:shortcode/paypal/return. On success the API sets the charge to confirmed, sends the receipt email, and returns the PayPal order with 201.
The charge must still be in status created. Stripe and Woovi do not use this endpoint: their webhooks confirm the charge.
Requires an API key or a session token.
\nThe numeric id of the charge (data.id). A shortcode does not work here: the API returns 400.
Returns the receipt link and the provider dashboard link for a charge that a fiat gateway paid. A member of the store's business can call this. It supports Stripe and Woovi. PayPal and crypto gateways return 500.
\nRequires an API key or a session token.
\nThe numeric id of the charge (data.id). A shortcode does not work here: the API returns 400.
A fiat link lets the buyer pay a charge with a fiat gateway instead of a crypto wallet. The charge gateway decides the provider:
\nThe charge must be in status created. Call setCurrency first with the fiat gateway and its fiat currency, so the charge has a buyer and a quote. The business of the store must be verified or under its limit of unverified transactions.
Returns the open refund of the charge (created but not reported), or data: null when there is none. Reported refunds are in the refunds list of the charge object.
Requires an API key or a session token.
\nThe numeric id of the charge (data.id). A shortcode does not work here: the API returns 400.
Creates a refund quote for a confirmed charge and returns it with 201. Use type: full to return all items, or type: items with a map of item ids and quantities. The API prices each item (price plus tax) in the charge currency at the current rate, so the token amount can differ from the amount paid.
The charge status does not change here. Send the amount on chain, then call report before expires_at.
Requires an API key or a session token.
\nThe numeric id of the charge (data.id). A shortcode does not work here: the API returns 400.
Deletes an open refund that you did not report yet. The charge stays confirmed. The response is 204 with no body. After this you can create a new refund.
Requires an API key or a session token.
\nThe numeric id of the charge (data.id). A shortcode does not work here: the API returns 400.
The id of the refund (data.id from create).
Reports the on-chain transaction that paid the refund. The API sets the charge to refund_pending and starts a background job 15 seconds later. The job checks the sender, the recipient, the currency and the amount. If they are correct, it records the transaction on the refund and sets the charge back to confirmed.
The charge must be confirmed, the refund must belong to the charge, it must not be reported yet, and its quote must not be expired.
Requires an API key or a session token.
\nThe numeric id of the charge (data.id). A shortcode does not work here: the API returns 400.
The id of the refund.
\n","type":"text/plain"},"type":"any","value":"17","key":"refund_id"}]}},"response":[{"id":"a54e1e96-e746-4fcb-8623-c8db1fbe7123","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"transaction\": {\n \"address\": \"0x1111aaaa2222bbbb3333cccc4444dddd5555eeee\",\n \"nonce\": 42,\n \"identifier\": \"0x7a3e5c9b1d2f4a6c8e0b2d4f6a8c0e2b4d6f8a1c3e5b7d9f1a3c5e7b9d1f3a5c\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/charges/:id/refunds/:refund_id/report","host":["https://api.liberpay.com"],"path":["api","charges",":id","refunds",":refund_id","report"],"variable":[{"key":"id","value":"231","description":"The numeric id of the charge (`data.id`). A shortcode does not work here: the API returns 400."},{"key":"refund_id","value":"17","description":"The id of the refund."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"job created\"\n}"},{"id":"39e24cc6-5943-42b3-b995-b4cbeca86341","name":"500 Expired","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"transaction\": {\n \"address\": \"0x1111aaaa2222bbbb3333cccc4444dddd5555eeee\",\n \"nonce\": 42,\n \"identifier\": \"0x7a3e5c9b1d2f4a6c8e0b2d4f6a8c0e2b4d6f8a1c3e5b7d9f1a3c5e7b9d1f3a5c\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/charges/:id/refunds/:refund_id/report","host":["https://api.liberpay.com"],"path":["api","charges",":id","refunds",":refund_id","report"],"variable":[{"key":"id","value":"231","description":"The numeric id of the charge (`data.id`). A shortcode does not work here: the API returns 400."},{"key":"refund_id","value":"17","description":"The id of the refund."}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"refund expired\"\n}"}],"_postman_id":"867ecb9e-91e6-4537-96d0-2c10905dbd99"}],"id":"eff6ac82-ec22-4de1-bd6a-08dbfa39a97f","description":"A refund returns money for a confirmed crypto charge. The flow has three steps:
create). The API computes the amount in the charge currency at the current rate. The refund quote is good for 30 minutes (expires_at).report). The charge goes to refund_pending (7). A background job reads the chain. When the refund transaction is correct, the job records it and sets the charge back to confirmed (3). The charge stays confirmed also after a full refund. To see what was refunded, read the refunds list of the charge.A charge can have only one open (not reported) refund at a time. To start again, cancel the open refund. You can refund some items now and other items later, until no quantity is left.
\nOnly members of the store's business can use these endpoints. A charge with no recorded payment (for example an invoice marked as paid in cash) cannot be refunded. Here :id is the numeric charge id.
Returns the invoices of a store, newest first, in pages of 250. Each item is a full charge object with a nested invoice.
You must be the creator or a member of the business that owns the store. You can filter by customer and by approval.
\nRequires an API key or a session token.
\nThe page number. The first page is 1. Each page has up to 250 items.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Return only invoices for this customer.
\n","type":"text/plain"},"key":"customer_id","value":"8"},{"disabled":true,"description":{"content":"true returns approved invoices. false returns drafts.
The store id.
\n","type":"text/plain"},"type":"any","value":"5","key":"store_id"}]}},"response":[{"id":"897ea7ca-5a4c-41e3-9602-b832a21c1bc9","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:store_id/invoices","host":["https://api.liberpay.com"],"path":["api","stores",":store_id","invoices"],"query":[{"key":"page","value":"1","description":"The page number. The first page is 1. Each page has up to 250 items.","disabled":true},{"key":"customer_id","value":"8","description":"Return only invoices for this customer.","disabled":true},{"key":"approved","value":"true","description":"`true` returns approved invoices. `false` returns drafts.","disabled":true}],"variable":[{"key":"store_id","value":"5","description":"The store id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"first\": 1,\n \"last\": 1,\n \"has_next\": false,\n \"has_prev\": false,\n \"prev_page\": null,\n \"next_page\": null,\n \"last_page\": 1,\n \"per_page\": 250,\n \"data\": [\n {\n \"id\": 231,\n \"shortcode\": \"k3Hq9ZxT2mPbLwA\",\n \"hash\": null,\n \"metadata\": {\n \"items\": [\n {\n \"id\": 41,\n \"name\": \"Vela aromática\",\n \"description\": \"Vela de cera de soja com aroma de lavanda.\",\n \"quantity\": 2,\n \"is_physical\": true,\n \"taxable\": false,\n \"price\": {\n \"amount\": \"39.90\",\n \"currency\": \"BRL\"\n },\n \"subtotal\": {\n \"amount\": \"79.80\",\n \"currency\": \"BRL\"\n },\n \"tax\": {\n \"amount\": \"0.00\",\n \"currency\": \"BRL\"\n },\n \"total\": {\n \"amount\": \"79.80\",\n \"currency\": \"BRL\"\n }\n }\n ]\n },\n \"price\": {\n \"amount\": \"79.80\",\n \"currency\": \"BRL\"\n },\n \"currency_price\": null,\n \"exchange_rate\": null,\n \"expires_at\": null,\n \"gateway\": {\n \"id\": 73,\n \"name\": \"Loja Centro USDC\",\n \"address\": \"0x5e1f0000000000000000000000000000000a11ce\",\n \"licensed\": true,\n \"license_status\": \"valid\",\n \"creator_id\": 17,\n \"is_system\": false,\n \"version\": {\n \"identifier\": \"polygon-v1\",\n \"number\": 1\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 \"config\": {\n \"configured\": false\n }\n },\n \"store\": {\n \"id\": 5,\n \"name\": \"Loja Centro\",\n \"logo\": null,\n \"business\": {\n \"id\": 3,\n \"name\": \"Velas da Ana\"\n }\n },\n \"seller_address\": null,\n \"creator\": {\n \"id\": 17,\n \"username\": \"seller\",\n \"email\": \"steve+seller@example.com\",\n \"address\": \"0x2b5ad5c4795c026514f8317c7a215e218dccd6cf\"\n },\n \"buyer\": null,\n \"currency\": null,\n \"fiat_currency\": {\n \"id\": 2,\n \"name\": \"Brazilian Real\",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n \"buyer_fiat_currency\": null,\n \"buyer_price\": null,\n \"buyer_exchange_rate\": null,\n \"viewer_fiat\": null,\n \"business_fiat\": null,\n \"payments\": [],\n \"refunds\": [],\n \"tokens\": [],\n \"type\": {\n \"id\": 2,\n \"label\": \"Invoice\"\n },\n \"status\": {\n \"id\": 1,\n \"label\": \"created\"\n },\n \"inserted_at\": \"2026-10-20T14:02:11\",\n \"updated_at\": \"2026-10-20T14:05:40\",\n \"invoice\": {\n \"id\": 94,\n \"number\": 12,\n \"title\": \"Velas para o evento\",\n \"date\": \"2026-10-20\",\n \"due_date\": \"2026-11-03\",\n \"notes\": \"Pagamento por Pix ou USDC.\",\n \"approved\": true,\n \"customer\": {\n \"id\": 8,\n \"name\": \"Maria Souza\",\n \"email\": \"steve+customer@example.com\",\n \"address\": null,\n \"business_id\": 3\n }\n }\n }\n ]\n}"},{"id":"30c11762-2057-4a11-8e5f-b7ad1d56c56f","name":"404 Not a member","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:store_id/invoices","host":["https://api.liberpay.com"],"path":["api","stores",":store_id","invoices"],"query":[{"key":"page","value":"1","description":"The page number. The first page is 1. Each page has up to 250 items.","disabled":true},{"key":"customer_id","value":"8","description":"Return only invoices for this customer.","disabled":true},{"key":"approved","value":"true","description":"`true` returns approved invoices. `false` returns drafts.","disabled":true}],"variable":[{"key":"store_id","value":"5","description":"The store id."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"not found\"\n}"}],"_postman_id":"b08ccfcc-151f-456d-806d-942cc076a5e5"},{"name":"listGateway","id":"902d0761-c090-4977-844c-30f26fa2b28c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/gateways/:gateway_id/invoices","description":"Returns the invoices paid to a gateway, newest first. Each item is a full charge object with a nested invoice.
You must be the creator or a member of the business that owns the gateway. This endpoint returns only the first page of 250 items. It has no page parameter.
Requires an API key or a session token.
\nThe gateway id.
\n","type":"text/plain"},"type":"any","value":"73","key":"gateway_id"}]}},"response":[{"id":"d87dfdaa-5ece-4f65-af08-2193932f4e07","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/gateways/:gateway_id/invoices","host":["https://api.liberpay.com"],"path":["api","gateways",":gateway_id","invoices"],"variable":[{"key":"gateway_id","value":"73","description":"The gateway id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"first\": 1,\n \"last\": 1,\n \"has_next\": false,\n \"has_prev\": false,\n \"prev_page\": null,\n \"next_page\": null,\n \"last_page\": 1,\n \"per_page\": 250,\n \"data\": [\n {\n \"id\": 231,\n \"shortcode\": \"k3Hq9ZxT2mPbLwA\",\n \"hash\": null,\n \"metadata\": {\n \"items\": [\n {\n \"id\": 41,\n \"name\": \"Vela aromática\",\n \"description\": \"Vela de cera de soja com aroma de lavanda.\",\n \"quantity\": 2,\n \"is_physical\": true,\n \"taxable\": false,\n \"price\": {\n \"amount\": \"39.90\",\n \"currency\": \"BRL\"\n },\n \"subtotal\": {\n \"amount\": \"79.80\",\n \"currency\": \"BRL\"\n },\n \"tax\": {\n \"amount\": \"0.00\",\n \"currency\": \"BRL\"\n },\n \"total\": {\n \"amount\": \"79.80\",\n \"currency\": \"BRL\"\n }\n }\n ]\n },\n \"price\": {\n \"amount\": \"79.80\",\n \"currency\": \"BRL\"\n },\n \"currency_price\": null,\n \"exchange_rate\": null,\n \"expires_at\": null,\n \"gateway\": {\n \"id\": 73,\n \"name\": \"Loja Centro USDC\",\n \"address\": \"0x5e1f0000000000000000000000000000000a11ce\",\n \"licensed\": true,\n \"license_status\": \"valid\",\n \"creator_id\": 17,\n \"is_system\": false,\n \"version\": {\n \"identifier\": \"polygon-v1\",\n \"number\": 1\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 \"config\": {\n \"configured\": false\n }\n },\n \"store\": {\n \"id\": 5,\n \"name\": \"Loja Centro\",\n \"logo\": null,\n \"business\": {\n \"id\": 3,\n \"name\": \"Velas da Ana\"\n }\n },\n \"seller_address\": null,\n \"creator\": {\n \"id\": 17,\n \"username\": \"seller\",\n \"email\": \"steve+seller@example.com\",\n \"address\": \"0x2b5ad5c4795c026514f8317c7a215e218dccd6cf\"\n },\n \"buyer\": null,\n \"currency\": null,\n \"fiat_currency\": {\n \"id\": 2,\n \"name\": \"Brazilian Real\",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n \"buyer_fiat_currency\": null,\n \"buyer_price\": null,\n \"buyer_exchange_rate\": null,\n \"viewer_fiat\": null,\n \"business_fiat\": null,\n \"payments\": [],\n \"refunds\": [],\n \"tokens\": [],\n \"type\": {\n \"id\": 2,\n \"label\": \"Invoice\"\n },\n \"status\": {\n \"id\": 1,\n \"label\": \"created\"\n },\n \"inserted_at\": \"2026-10-20T14:02:11\",\n \"updated_at\": \"2026-10-20T14:05:40\",\n \"invoice\": {\n \"id\": 94,\n \"number\": 12,\n \"title\": \"Velas para o evento\",\n \"date\": \"2026-10-20\",\n \"due_date\": \"2026-11-03\",\n \"notes\": \"Pagamento por Pix ou USDC.\",\n \"approved\": true,\n \"customer\": {\n \"id\": 8,\n \"name\": \"Maria Souza\",\n \"email\": \"steve+customer@example.com\",\n \"address\": null,\n \"business_id\": 3\n }\n }\n }\n ]\n}"}],"_postman_id":"902d0761-c090-4977-844c-30f26fa2b28c"},{"name":"nextNumber","id":"8de2052a-ebdb-4e8b-912d-262fc9bfd870","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/stores/:store_id/invoice_number","description":"Returns the next free invoice number for a store. The value is the highest invoice number in the store plus 1, or 1 if the store has no invoices.
\nThe API does not reserve the number. You must be the creator or a member of the business that owns the store.
\nRequires an API key or a session token.
\nThe store id.
\n","type":"text/plain"},"type":"any","value":"5","key":"store_id"}]}},"response":[{"id":"55eeb719-b335-4ef6-9619-d0a3ec6687d6","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:store_id/invoice_number","host":["https://api.liberpay.com"],"path":["api","stores",":store_id","invoice_number"],"variable":[{"key":"store_id","value":"5","description":"The store id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"number\": 13\n }\n}"}],"_postman_id":"8de2052a-ebdb-4e8b-912d-262fc9bfd870"},{"name":"get","id":"2e8c1188-4f46-4ef5-9a65-b6ee09694783","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/invoices/:id","description":"Returns one invoice with its customer. The response has only the invoice fields. To get the price, items and payment status, read the charge with GET /api/charges/:id.
You must be the creator or a member of the business that owns the charge.
\nRequires an API key or a session token.
\nThe invoice id. This is charge.invoice.id, not the charge id.
Updates the fields of an invoice. Send only the fields that you want to change. You cannot change approved here. Use approve.
You can update an invoice after approval. The new customer_id must belong to the business. To change the price or the items, update the charge.
Requires an API key or a session token.
\nThe invoice id. This is charge.invoice.id, not the charge id.
Approves a draft invoice. The API sets approved to true and records an approved event.
This call does not send the email. Call send after you approve. You can approve an invoice only one time.
Requires an API key or a session token.
\nThe invoice id. This is charge.invoice.id, not the charge id.
Sends the invoice to the customer by email and records a sent event. The email has a link to the pay page and a PDF of the invoice. If the business has the email QR option on, the email also has a QR code.
You can call this endpoint again to send the invoice again. Approve the invoice before you send it.
\nRequires an API key or a session token.
\nThe invoice id. This is charge.invoice.id, not the charge id.
Marks an invoice as paid when the customer pays outside Liberpay (for example, in cash). The only allowed status value is paid.
The invoice must be approved, and the charge must have status 1 (created). The API sets the charge status to 3 (confirmed), records a marked_paid event and sends the receipt email.
Requires an API key or a session token.
\nThe invoice id. This is charge.invoice.id, not the charge id.
An invoice is a charge with charge_type_id 2. To create one, call POST /api/charges with charge_type_id: 2 and an invoice object (title, number, date, due_date, customer_id, and optional notes and approved). The API creates the charge and its invoice in one transaction. The customer must belong to the business of the store.
The charge holds the price, items, gateway and payment status. The invoice holds the number, title, dates, notes, customer and approval. The list endpoints return charges with a nested invoice object. The other endpoints here use the invoice id (charge.invoice.id), not the charge id.
Flow: a new invoice is a draft (approved: false). Approve it, then send it to the customer by email. The customer pays on the pay page. If the customer pays outside Liberpay, mark the invoice as paid. If you create the charge with invoice.approved: true, the API sends the email at once.
Returns the published products of a store, sorted by name. This is the public list for a storefront. Anyone can call it.
\nThe items do not include the stores key. Draft products are not in the list.
A token is optional. With a token, the response can include more data for that user.
\nThe store id.
\n","type":"text/plain"},"type":"any","value":"5","key":"store_id"}]}},"response":[{"id":"18180da2-416d-489a-9a0f-b378c842f000","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:store_id/products","host":["https://api.liberpay.com"],"path":["api","stores",":store_id","products"],"variable":[{"key":"store_id","value":"5","description":"The store id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 41,\n \"name\": \"Vela aromática\",\n \"description\": \"Vela de cera de soja com aroma de lavanda.\",\n \"sku\": \"VELA-001\",\n \"price\": {\n \"currency\": \"BRL\",\n \"amount\": \"39.90\"\n },\n \"is_physical\": true,\n \"taxable\": false,\n \"status\": {\n \"id\": 2,\n \"label\": \"Published\"\n },\n \"user_id\": 17,\n \"business_id\": 3,\n \"images\": [\n {\n \"url\": \"https://example-product-images.s3-sa-east-1.amazonaws.com/0b6f1c2e-3d4a-4f5b-8c9d-1e2f3a4b5c6d\",\n \"sort\": 1\n }\n ]\n }\n ]\n}"}],"_postman_id":"e7b38c92-49fd-4805-b6c7-dfd63e5953b0"},{"name":"listAll","id":"f753dc4e-3a4a-483a-889f-db3bf7af9256","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/stores/:store_id/all_products","description":"Returns all products of a store in all statuses, sorted by name. Use it to manage the catalog of a store.
\nYou must be the creator or a member of the business that owns the store.
\nRequires an API key or a session token.
\nThe store id.
\n","type":"text/plain"},"type":"any","value":"5","key":"store_id"}]}},"response":[{"id":"fba4d47a-7d47-4ba2-af78-4a2e6c0ca07e","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:store_id/all_products","host":["https://api.liberpay.com"],"path":["api","stores",":store_id","all_products"],"variable":[{"key":"store_id","value":"5","description":"The store id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 41,\n \"name\": \"Vela aromática\",\n \"description\": \"Vela de cera de soja com aroma de lavanda.\",\n \"sku\": \"VELA-001\",\n \"price\": {\n \"currency\": \"BRL\",\n \"amount\": \"39.90\"\n },\n \"is_physical\": true,\n \"taxable\": false,\n \"status\": {\n \"id\": 2,\n \"label\": \"Published\"\n },\n \"user_id\": 17,\n \"business_id\": 3,\n \"images\": [\n {\n \"url\": \"https://example-product-images.s3-sa-east-1.amazonaws.com/0b6f1c2e-3d4a-4f5b-8c9d-1e2f3a4b5c6d\",\n \"sort\": 1\n }\n ],\n \"stores\": [\n {\n \"id\": 5,\n \"name\": \"Loja Centro\"\n }\n ]\n },\n {\n \"id\": 42,\n \"name\": \"Kit de velas\",\n \"description\": \"Vela de cera de soja com aroma de lavanda.\",\n \"sku\": \"VELA-KIT\",\n \"price\": {\n \"currency\": \"BRL\",\n \"amount\": \"99.00\"\n },\n \"is_physical\": true,\n \"taxable\": false,\n \"status\": {\n \"id\": 1,\n \"label\": \"Draft\"\n },\n \"user_id\": 17,\n \"business_id\": 3,\n \"images\": [\n {\n \"url\": \"https://example-product-images.s3-sa-east-1.amazonaws.com/0b6f1c2e-3d4a-4f5b-8c9d-1e2f3a4b5c6d\",\n \"sort\": 1\n }\n ],\n \"stores\": [\n {\n \"id\": 5,\n \"name\": \"Loja Centro\"\n }\n ]\n }\n ]\n}"},{"id":"0c34f96a-0b2a-4ea0-8a88-1e3ad7ca9b33","name":"404 Not a member","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:store_id/all_products","host":["https://api.liberpay.com"],"path":["api","stores",":store_id","all_products"],"variable":[{"key":"store_id","value":"5","description":"The store id."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"not found\"\n}"}],"_postman_id":"f753dc4e-3a4a-483a-889f-db3bf7af9256"},{"name":"listBusiness","id":"2f58e0ee-5a81-4239-8f48-ec7d38db2348","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/businesses/:business_id/products","description":"Returns all products of a business in all statuses. The list includes products that are not linked to a store. The order is not fixed.
\nYou must be the creator or a member of the business.
\nRequires an API key or a session token.
\nThe business id.
\n","type":"text/plain"},"type":"any","value":"3","key":"business_id"}]}},"response":[{"id":"6f08d720-7fe1-40c8-84f1-450c71b1931a","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/businesses/:business_id/products","host":["https://api.liberpay.com"],"path":["api","businesses",":business_id","products"],"variable":[{"key":"business_id","value":"3","description":"The business id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 41,\n \"name\": \"Vela aromática\",\n \"description\": \"Vela de cera de soja com aroma de lavanda.\",\n \"sku\": \"VELA-001\",\n \"price\": {\n \"currency\": \"BRL\",\n \"amount\": \"39.90\"\n },\n \"is_physical\": true,\n \"taxable\": false,\n \"status\": {\n \"id\": 2,\n \"label\": \"Published\"\n },\n \"user_id\": 17,\n \"business_id\": 3,\n \"images\": [\n {\n \"url\": \"https://example-product-images.s3-sa-east-1.amazonaws.com/0b6f1c2e-3d4a-4f5b-8c9d-1e2f3a4b5c6d\",\n \"sort\": 1\n }\n ],\n \"stores\": [\n {\n \"id\": 5,\n \"name\": \"Loja Centro\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"2f58e0ee-5a81-4239-8f48-ec7d38db2348"},{"name":"get","id":"4e187c11-8f42-4b18-85ba-ce29c7d01f48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/products/:id","description":"Returns one product with its images, status and stores. Anyone can call it.
\nA token is optional. With a token, the response can include more data for that user.
\nThe product id.
\n","type":"text/plain"},"type":"any","value":"41","key":"id"}]}},"response":[{"id":"e731a64f-53fb-4fb1-8cb3-3d2070b74398","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/products/:id","host":["https://api.liberpay.com"],"path":["api","products",":id"],"variable":[{"key":"id","value":"41","description":"The product id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 41,\n \"name\": \"Vela aromática\",\n \"description\": \"Vela de cera de soja com aroma de lavanda.\",\n \"sku\": \"VELA-001\",\n \"price\": {\n \"currency\": \"BRL\",\n \"amount\": \"39.90\"\n },\n \"is_physical\": true,\n \"taxable\": false,\n \"status\": {\n \"id\": 2,\n \"label\": \"Published\"\n },\n \"user_id\": 17,\n \"business_id\": 3,\n \"images\": [\n {\n \"url\": \"https://example-product-images.s3-sa-east-1.amazonaws.com/0b6f1c2e-3d4a-4f5b-8c9d-1e2f3a4b5c6d\",\n \"sort\": 1\n }\n ],\n \"stores\": [\n {\n \"id\": 5,\n \"name\": \"Loja Centro\"\n }\n ]\n }\n}"}],"_postman_id":"4e187c11-8f42-4b18-85ba-ce29c7d01f48"},{"name":"create","id":"d9f819b0-f844-46b2-89c1-14dee297bb80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"product\": {\n \"business_id\": 3,\n \"name\": \"Vela aromática\",\n \"description\": \"Vela de cera de soja com aroma de lavanda.\",\n \"sku\": \"VELA-001\",\n \"price\": {\n \"value\": \"39.90\",\n \"currency\": \"BRL\"\n },\n \"is_physical\": true,\n \"taxable\": false,\n \"product_status_id\": 2,\n \"stores\": [\n 5\n ],\n \"images\": [\n {\n \"url\": \"https://example-product-images.s3-sa-east-1.amazonaws.com/0b6f1c2e-3d4a-4f5b-8c9d-1e2f3a4b5c6d\",\n \"sort\": 1\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.liberpay.com/api/products","description":"Creates a product for a business and links it to stores. You must be the creator or a member of the business in product.business_id.
To add images, first upload each file with POST /api/products/images. Then put the returned url values in product.images. The response has a Location header with the product URL.
Requires an API key or a session token.
\nUpdates a product. You must be the creator or a member of the business that owns the product. You cannot change business_id.
Always send product.stores with the full list of store ids. If you omit it, the API removes the product from all stores. If you send product.images, the list replaces all current images.
Requires an API key or a session token.
\nThe product id.
\n","type":"text/plain"},"type":"any","value":"41","key":"id"}]}},"response":[{"id":"b6669649-bec4-4d5a-ba24-99d605d8ddbb","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"product\": {\n \"name\": \"Vela aromática grande\",\n \"description\": \"Vela de cera de soja com aroma de lavanda, 300 g.\",\n \"price\": {\n \"value\": \"49.90\",\n \"currency\": \"BRL\"\n },\n \"is_physical\": true,\n \"product_status_id\": 2,\n \"stores\": [\n 5\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/products/:id","host":["https://api.liberpay.com"],"path":["api","products",":id"],"variable":[{"key":"id","value":"41","description":"The product id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 41,\n \"name\": \"Vela aromática grande\",\n \"description\": \"Vela de cera de soja com aroma de lavanda, 300 g.\",\n \"sku\": \"VELA-001\",\n \"price\": {\n \"currency\": \"BRL\",\n \"amount\": \"49.90\"\n },\n \"is_physical\": true,\n \"taxable\": false,\n \"status\": {\n \"id\": 2,\n \"label\": \"Published\"\n },\n \"user_id\": 17,\n \"business_id\": 3,\n \"images\": [\n {\n \"url\": \"https://example-product-images.s3-sa-east-1.amazonaws.com/0b6f1c2e-3d4a-4f5b-8c9d-1e2f3a4b5c6d\",\n \"sort\": 1\n }\n ],\n \"stores\": [\n {\n \"id\": 5,\n \"name\": \"Loja Centro\"\n }\n ]\n }\n}"}],"_postman_id":"47584aa8-dcf2-4ad3-8f41-653ffe9aba38"},{"name":"delete","id":"87ed9e99-b5bd-4d66-963c-0504a7a9b4d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.liberpay.com/api/products/:id","description":"Deletes a product, its images and its store links. You must be the creator or a member of the business that owns the product.
\nCharges that used the product keep their own copy of the item in metadata. The response has no body.
Requires an API key or a session token.
\nThe product id.
\n","type":"text/plain"},"type":"any","value":"41","key":"id"}]}},"response":[{"id":"11013fa0-0625-469e-85ff-2a043ffd6229","name":"204 No Content","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.liberpay.com/api/products/:id","host":["https://api.liberpay.com"],"path":["api","products",":id"],"variable":[{"key":"id","value":"41","description":"The product id."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"87ed9e99-b5bd-4d66-963c-0504a7a9b4d3"},{"name":"updateBulk","id":"146a7e0e-c11f-4742-97e7-2757a62125cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"products\": [\n {\n \"id\": 41\n },\n {\n \"id\": 42\n }\n ],\n \"params\": {\n \"product_status_id\": 2\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.liberpay.com/api/update_products","description":"Changes the status of many products in one call. Use it to publish or unpublish a selection. The API applies only params.product_status_id and ignores other keys in params.
The API skips products that are not in your businesses. If no product is left, the API returns 404. All updates run in one transaction.
\nRequires an API key or a session token.
\nDeletes many products in one call. The API skips products that are not in your businesses. If no product is left, the API returns 404. The response has no body.
\nRequires an API key or a session token.
\nThe image file.
\n","value":null}]},"url":"https://api.liberpay.com/api/products/images","description":"Uploads one image file to public storage. The response gives the public url of the file. Put this url in product.images when you create or update a product.
This call does not link the image to a product. Send the file as multipart/form-data in the image field. The maximum request size is 8 MB.
Requires an API key or a session token.
\nA product is an item that a business sells. You create a product at the business level. Then you link it to one or more stores of that business. A product has a status: 1 is Draft and 2 is Published. Only published products show on the public store list. Get all status values from GET /api/product_statuses. Prices use a decimal string and an ISO currency code.
Lists all stores of all businesses that the signed-in user created or is a member of. Each store includes its business and its linked gateways.
\nRequires an API key or a session token.
\nLists the stores of one business. The list is empty when the business does not exist or the caller is not the creator or a member.
\nRequires an API key or a session token.
\nThe business ID.
\n","type":"text/plain"},"type":"any","value":"12","key":"business_id"}]}},"response":[{"id":"18f37698-003e-43e0-80ec-0b85fd66bbe2","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/businesses/:business_id/stores","host":["https://api.liberpay.com"],"path":["api","businesses",":business_id","stores"],"variable":[{"key":"business_id","value":"12","description":"The business ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 31,\n \"name\": \"Loja Centro\",\n \"logo\": \"https://example-public-bucket.s3-sa-east-1.amazonaws.com/0b6c7e52-3f1d-4a8e-9c2b-5d7f8a1e4c39\",\n \"address\": {\n \"street1\": \"Rua das Flores, 120\",\n \"street2\": \"Sala 4\",\n \"city\": \"São Paulo\",\n \"region\": \"SP\",\n \"code\": \"01310-100\",\n \"country\": \"BR\"\n },\n \"phone\": \"+55 11 5555-0123\",\n \"email\": \"steve+store@example.com\",\n \"tax_rate\": \"5.00000\",\n \"settings\": {\n \"quick_pay\": {\n \"enabled\": true,\n \"show_products\": true,\n \"product_ids\": []\n }\n },\n \"business\": {\n \"id\": 12,\n \"name\": \"Café Aurora\"\n },\n \"gateways\": [\n {\n \"id\": 73,\n \"name\": \"Café Aurora Polygon\",\n \"address\": \"0x5a1f0c3e9b7d2a4c6e8f1b3d5a7c9e0f2b4d6a8c\",\n \"licensed\": true,\n \"license_status\": \"valid\",\n \"creator_id\": 7,\n \"is_system\": false,\n \"version\": {\n \"identifier\": \"polygon-v1\",\n \"number\": 1\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 \"config\": {\n \"configured\": false\n }\n }\n ]\n }\n ]\n}"}],"_postman_id":"75c44623-4dd5-4221-8988-0fa01e8bf6c1"},{"name":"get","id":"1ec896ec-bd58-465a-8ba3-7eb0cc083f6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/stores/:id","description":"Gets one store. This endpoint is public: the pay page and the quick pay page use it. No token is necessary.
\nThe response is the store object itself, not wrapped in data. It includes the business, the linked gateways and the fiat currencies that the business accepts (country default first).
A token is optional. With a token, the response can include more data for that user.
\nThe store ID.
\n","type":"text/plain"},"type":"any","value":"31","key":"id"}]}},"response":[{"id":"7ef4ea63-42cb-4cff-a905-76d42fd7174a","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:id","host":["https://api.liberpay.com"],"path":["api","stores",":id"],"variable":[{"key":"id","value":"31","description":"The store ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 31,\n \"name\": \"Loja Centro\",\n \"logo\": \"https://example-public-bucket.s3-sa-east-1.amazonaws.com/0b6c7e52-3f1d-4a8e-9c2b-5d7f8a1e4c39\",\n \"address\": {\n \"street1\": \"Rua das Flores, 120\",\n \"street2\": \"Sala 4\",\n \"city\": \"São Paulo\",\n \"region\": \"SP\",\n \"code\": \"01310-100\",\n \"country\": \"BR\"\n },\n \"phone\": \"+55 11 5555-0123\",\n \"email\": \"steve+store@example.com\",\n \"tax_rate\": \"5.00000\",\n \"settings\": {\n \"quick_pay\": {\n \"enabled\": true,\n \"show_products\": true,\n \"product_ids\": []\n }\n },\n \"business\": {\n \"id\": 12,\n \"name\": \"Café Aurora\"\n },\n \"gateways\": [\n {\n \"id\": 73,\n \"name\": \"Café Aurora Polygon\",\n \"address\": \"0x5a1f0c3e9b7d2a4c6e8f1b3d5a7c9e0f2b4d6a8c\",\n \"licensed\": true,\n \"license_status\": \"valid\",\n \"creator_id\": 7,\n \"is_system\": false,\n \"version\": {\n \"identifier\": \"polygon-v1\",\n \"number\": 1\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 \"config\": {\n \"configured\": false\n }\n }\n ],\n \"fiat_currencies\": [\n {\n \"id\": 2,\n \"name\": \"Brazilian Real\",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n {\n \"id\": 1,\n \"name\": \"US Dollar\",\n \"symbol\": \"USD\",\n \"sign\": \"$\"\n }\n ]\n}"},{"id":"5fb984b3-9336-4c4c-bcd6-b7953706b22e","name":"404 Not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:id","host":["https://api.liberpay.com"],"path":["api","stores",":id"],"variable":[{"key":"id","value":"31","description":"The store ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"detail\": \"Not Found\"\n }\n}"}],"_postman_id":"1ec896ec-bd58-465a-8ba3-7eb0cc083f6c"},{"name":"create","id":"55a95423-92e0-4364-b29a-ba2ca96a06f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"store\": {\n \"business_id\": 12,\n \"name\": \"Loja Centro\",\n \"email\": \"steve+store@example.com\",\n \"phone\": \"+55 11 5555-0123\",\n \"tax_rate\": 5,\n \"address\": {\n \"street1\": \"Rua das Flores, 120\",\n \"street2\": \"Sala 4\",\n \"city\": \"São Paulo\",\n \"region\": \"SP\",\n \"code\": \"01310-100\",\n \"country\": \"BR\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.liberpay.com/api/stores","description":"Creates a store in a business. The caller must be the creator or a member of the business in store.business_id.
The new store has no gateways. Link a gateway to the store before it can take payments.
\nRequires an API key or a session token.
\nUpdates a store. The caller must be the creator or a member of the business of the store. You cannot update a system (P2P) store. PATCH does the same as PUT.
The fields are the same as in create. When you send settings, the value replaces all store settings. When you send business_id, the caller must also be a member of that business.
Requires an API key or a session token.
\nThe store ID.
\n","type":"text/plain"},"type":"any","value":"31","key":"id"}]}},"response":[{"id":"d23e645e-7113-442d-834e-ab29a4116519","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"store\": {\n \"name\": \"Loja Centro\",\n \"logo\": \"https://example-public-bucket.s3-sa-east-1.amazonaws.com/0b6c7e52-3f1d-4a8e-9c2b-5d7f8a1e4c39\",\n \"settings\": {\n \"quick_pay\": {\n \"enabled\": true,\n \"show_products\": true,\n \"product_ids\": [\n 101,\n 102\n ]\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/stores/:id","host":["https://api.liberpay.com"],"path":["api","stores",":id"],"variable":[{"key":"id","value":"31","description":"The store ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 31,\n \"name\": \"Loja Centro\",\n \"logo\": \"https://example-public-bucket.s3-sa-east-1.amazonaws.com/0b6c7e52-3f1d-4a8e-9c2b-5d7f8a1e4c39\",\n \"address\": {\n \"street1\": \"Rua das Flores, 120\",\n \"street2\": \"Sala 4\",\n \"city\": \"São Paulo\",\n \"region\": \"SP\",\n \"code\": \"01310-100\",\n \"country\": \"BR\"\n },\n \"phone\": \"+55 11 5555-0123\",\n \"email\": \"steve+store@example.com\",\n \"tax_rate\": \"5.00000\",\n \"settings\": {\n \"quick_pay\": {\n \"enabled\": true,\n \"show_products\": true,\n \"product_ids\": [\n 101,\n 102\n ]\n }\n },\n \"business\": {\n \"id\": 12,\n \"name\": \"Café Aurora\"\n },\n \"gateways\": [\n {\n \"id\": 73,\n \"name\": \"Café Aurora Polygon\",\n \"address\": \"0x5a1f0c3e9b7d2a4c6e8f1b3d5a7c9e0f2b4d6a8c\",\n \"licensed\": true,\n \"license_status\": \"valid\",\n \"creator_id\": 7,\n \"is_system\": false,\n \"version\": {\n \"identifier\": \"polygon-v1\",\n \"number\": 1\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 \"config\": {\n \"configured\": false\n }\n }\n ]\n }\n}"}],"_postman_id":"e9468d4b-6950-401a-9a35-86524cd84107"},{"name":"delete","id":"a6bd528a-a3ef-494e-b042-495e5790e89e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.liberpay.com/api/stores/:id","description":"Deletes a store. The caller must be the creator or a member of the business of the store. You cannot delete a system (P2P) store. The API also deletes the saved carts of the store.
\nRequires an API key or a session token.
\nThe store ID.
\n","type":"text/plain"},"type":"any","value":"31","key":"id"}]}},"response":[{"id":"2b3819ff-fcaf-4e52-a3e9-1d3178ee3fc6","name":"204 No content","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:id","host":["https://api.liberpay.com"],"path":["api","stores",":id"],"variable":[{"key":"id","value":"31","description":"The store ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a6bd528a-a3ef-494e-b042-495e5790e89e"},{"name":"uploadImage","id":"0cc66099-08bc-4ff9-a4e3-8a39a0ba969a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"image","type":"file","description":"The image file.
\n","value":null}]},"url":"https://api.liberpay.com/api/stores/:id/images","description":"Uploads an image file (for example a store logo) to public storage. The response gives the key and the public URL.
\nThis call does not change the store. To set the logo, send the URL in store.logo with update. The caller must be the creator or a member of the business of the store.
Requires an API key or a session token.
\nThe store ID.
\n","type":"text/plain"},"type":"any","value":"31","key":"id"}]}},"response":[{"id":"0925bde5-0ac1-447b-a87e-c82d613be517","name":"201 Created","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"image","type":"file","description":"The image file.","src":[]}]},"url":{"raw":"https://api.liberpay.com/api/stores/:id/images","host":["https://api.liberpay.com"],"path":["api","stores",":id","images"],"variable":[{"key":"id","value":"31","description":"The store ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"data\": {\n \"key\": \"0b6c7e52-3f1d-4a8e-9c2b-5d7f8a1e4c39\",\n \"url\": \"https://example-public-bucket.s3-sa-east-1.amazonaws.com/0b6c7e52-3f1d-4a8e-9c2b-5d7f8a1e4c39\"\n }\n}"}],"_postman_id":"0cc66099-08bc-4ff9-a4e3-8a39a0ba969a"},{"name":"pay","id":"eec3af80-bd3d-4e93-a382-fe7fc0c3edcf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"charge\": {\n \"items\": [\n {\n \"product_id\": 101,\n \"quantity\": 2\n }\n ],\n \"custom\": {\n \"memo\": \"Gorjeta\",\n \"amount\": \"5.00\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.liberpay.com/api/stores/:id/pay","description":"Quick pay. A customer who scans the store QR code or a saved-cart QR code calls this endpoint. No token is necessary. The API creates a POS charge for the store and returns its shortcode. The customer then pays the charge on the pay page (/charges/:shortcode/pay).
Send one of two forms in charge:
cart_id: pays an active saved cart.items and/or custom: pays published products of the store and/or a custom amount. Quick pay must be on in the store settings.The API takes all prices from the product catalog. Only the custom line has a free amount, in the default fiat currency of the business. The API uses the first non-system gateway of the store. The limit is 30 calls per minute for each IP address.
\nA token is optional. With a token, the response can include more data for that user.
\nThe store ID.
\n","type":"text/plain"},"type":"any","value":"31","key":"id"}]}},"response":[{"id":"a406ab45-ddb5-4cae-9207-0ec84216441b","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"charge\": {\n \"items\": [\n {\n \"product_id\": 101,\n \"quantity\": 2\n }\n ],\n \"custom\": {\n \"memo\": \"Gorjeta\",\n \"amount\": \"5.00\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/stores/:id/pay","host":["https://api.liberpay.com"],"path":["api","stores",":id","pay"],"variable":[{"key":"id","value":"31","description":"The store ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"data\": {\n \"shortcode\": \"73cK8f2Qx\"\n }\n}"},{"id":"f04da51f-4e6e-4ca6-b482-0615f7033203","name":"422 Not available","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"charge\": {\n \"items\": [\n {\n \"product_id\": 101,\n \"quantity\": 2\n }\n ],\n \"custom\": {\n \"memo\": \"Gorjeta\",\n \"amount\": \"5.00\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/stores/:id/pay","host":["https://api.liberpay.com"],"path":["api","stores",":id","pay"],"variable":[{"key":"id","value":"31","description":"The store ID."}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Quick pay isn't available for this store\"\n}"},{"id":"3c4b609a-4d95-4161-a088-a4edf4e54478","name":"429 Rate limit","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"charge\": {\n \"items\": [\n {\n \"product_id\": 101,\n \"quantity\": 2\n }\n ],\n \"custom\": {\n \"memo\": \"Gorjeta\",\n \"amount\": \"5.00\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/stores/:id/pay","host":["https://api.liberpay.com"],"path":["api","stores",":id","pay"],"variable":[{"key":"id","value":"31","description":"The store ID."}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Rate limit reached! Try again in one minute.\"\n}"}],"_postman_id":"eec3af80-bd3d-4e93-a382-fe7fc0c3edcf"}],"id":"cde0d45a-0181-4ec3-a55c-cfb5bdfe0785","description":"A store is a point of sale of a business. Charges, products, invoices, saved carts and quick pay belong to a store. A store takes payments through the gateways that are linked to it.
\n","_postman_id":"cde0d45a-0181-4ec3-a55c-cfb5bdfe0785","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fb7d9328-d944-41b5-8605-d459ea859701","id":"fb7d9328-d944-41b5-8605-d459ea859701","name":"Liberpay API Docs","type":"collection"}}},{"name":"carts","item":[{"name":"list","id":"5aa84472-49ed-421d-be5a-28fb3052fac5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/stores/:id/carts","description":"Lists all saved carts of a store, active and paused, newest first. The caller must be the creator or a member of the business of the store.
\nRequires an API key or a session token.
\nThe store ID.
\n","type":"text/plain"},"type":"any","value":"31","key":"id"}]}},"response":[{"id":"5f789d8d-19af-4109-a8fa-385bc19e201c","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:id/carts","host":["https://api.liberpay.com"],"path":["api","stores",":id","carts"],"variable":[{"key":"id","value":"31","description":"The store ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 4,\n \"name\": \"Combo almoço\",\n \"active\": true,\n \"items\": [\n {\n \"product_id\": 101,\n \"quantity\": 1\n },\n {\n \"product_id\": 102,\n \"quantity\": 2\n }\n ]\n },\n {\n \"id\": 3,\n \"name\": \"Café e pão de queijo\",\n \"active\": false,\n \"items\": [\n {\n \"product_id\": 103,\n \"quantity\": 1\n },\n {\n \"product_id\": 104,\n \"quantity\": 2\n }\n ]\n }\n ]\n}"}],"_postman_id":"5aa84472-49ed-421d-be5a-28fb3052fac5"},{"name":"get","id":"e247e601-97b6-48da-8d8b-96a47efe48b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/stores/:id/carts/:cart_id","description":"Gets one active saved cart. This endpoint is public: the cart QR page uses it to show the cart before the customer pays. No token is necessary. The call creates no charge.
\nA paused cart gives 404, also for the store owner. Use list to see paused carts.
A token is optional. With a token, the response can include more data for that user.
\nThe store ID.
\n","type":"text/plain"},"type":"any","value":"31","key":"id"},{"id":"15c24794-ffcf-4927-9e52-da87924c18a4","description":{"content":"The saved cart ID.
\n","type":"text/plain"},"type":"any","value":"4","key":"cart_id"}]}},"response":[{"id":"c5fc3204-b6fa-4c00-9f78-a7408ad4aecb","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:id/carts/:cart_id","host":["https://api.liberpay.com"],"path":["api","stores",":id","carts",":cart_id"],"variable":[{"key":"id","value":"31","description":"The store ID."},{"key":"cart_id","value":"4","description":"The saved cart ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 4,\n \"name\": \"Combo almoço\",\n \"active\": true,\n \"items\": [\n {\n \"product_id\": 101,\n \"quantity\": 1\n },\n {\n \"product_id\": 102,\n \"quantity\": 2\n }\n ]\n }\n}"},{"id":"c7a15963-2022-4539-9056-881f83b20cfb","name":"404 Not available","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:id/carts/:cart_id","host":["https://api.liberpay.com"],"path":["api","stores",":id","carts",":cart_id"],"variable":[{"key":"id","value":"31","description":"The store ID."},{"key":"cart_id","value":"4","description":"The saved cart ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"This cart isn't available\"\n}"}],"_postman_id":"e247e601-97b6-48da-8d8b-96a47efe48b0"},{"name":"create","id":"59448bfd-b9a6-48d2-9330-2edd70b7fea1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cart\": {\n \"name\": \"Combo almoço\",\n \"active\": true,\n \"items\": [\n {\n \"product_id\": 101,\n \"quantity\": 1\n },\n {\n \"product_id\": 102,\n \"quantity\": 2\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.liberpay.com/api/stores/:id/carts","description":"Creates a saved cart in a store. The caller must be the creator or a member of the business of the store.
\nUse published products of the store. The API does not check the products when you save the cart. The check occurs when a customer pays.
\nRequires an API key or a session token.
\nThe store ID.
\n","type":"text/plain"},"type":"any","value":"31","key":"id"}]}},"response":[{"id":"d0519cd4-155b-4ca8-99b5-d7c63f2d5781","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cart\": {\n \"name\": \"Combo almoço\",\n \"active\": true,\n \"items\": [\n {\n \"product_id\": 101,\n \"quantity\": 1\n },\n {\n \"product_id\": 102,\n \"quantity\": 2\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/stores/:id/carts","host":["https://api.liberpay.com"],"path":["api","stores",":id","carts"],"variable":[{"key":"id","value":"31","description":"The store ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 4,\n \"name\": \"Combo almoço\",\n \"active\": true,\n \"items\": [\n {\n \"product_id\": 101,\n \"quantity\": 1\n },\n {\n \"product_id\": 102,\n \"quantity\": 2\n }\n ]\n }\n}"},{"id":"e0aa66ff-f273-42b1-867b-79729c5d7323","name":"422 Validation error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cart\": {\n \"name\": \"Combo almoço\",\n \"active\": true,\n \"items\": [\n {\n \"product_id\": 101,\n \"quantity\": 1\n },\n {\n \"product_id\": 102,\n \"quantity\": 2\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/stores/:id/carts","host":["https://api.liberpay.com"],"path":["api","stores",":id","carts"],"variable":[{"key":"id","value":"31","description":"The store ID."}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"errors\": {\n \"items\": [\n \"must be product_id + quantity (1–999)\"\n ]\n }\n}"}],"_postman_id":"59448bfd-b9a6-48d2-9330-2edd70b7fea1"},{"name":"update","id":"e53f7054-a120-40d8-97f1-a85592312195","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cart\": {\n \"active\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.liberpay.com/api/stores/:id/carts/:cart_id","description":"Updates a saved cart. Send only the fields to change. Set active to false to pause the cart QR code. When you send items, the list replaces all lines.
The caller must be the creator or a member of the business of the store.
\nRequires an API key or a session token.
\nThe store ID.
\n","type":"text/plain"},"type":"any","value":"31","key":"id"},{"id":"17434bcc-1ea4-4d06-886f-41650458e675","description":{"content":"The saved cart ID.
\n","type":"text/plain"},"type":"any","value":"4","key":"cart_id"}]}},"response":[{"id":"f4495953-2e0e-45b6-8c00-2a0fd972c3d4","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cart\": {\n \"active\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/stores/:id/carts/:cart_id","host":["https://api.liberpay.com"],"path":["api","stores",":id","carts",":cart_id"],"variable":[{"key":"id","value":"31","description":"The store ID."},{"key":"cart_id","value":"4","description":"The saved cart ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 4,\n \"name\": \"Combo almoço\",\n \"active\": false,\n \"items\": [\n {\n \"product_id\": 101,\n \"quantity\": 1\n },\n {\n \"product_id\": 102,\n \"quantity\": 2\n }\n ]\n }\n}"}],"_postman_id":"e53f7054-a120-40d8-97f1-a85592312195"},{"name":"delete","id":"981b0db1-fd7c-4796-a638-9c37717ac91c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.liberpay.com/api/stores/:id/carts/:cart_id","description":"Deletes a saved cart. Its QR code stops working. The caller must be the creator or a member of the business of the store.
\nRequires an API key or a session token.
\nThe store ID.
\n","type":"text/plain"},"type":"any","value":"31","key":"id"},{"id":"27c70f6e-a33f-47bc-a702-cb1cd20bfc63","description":{"content":"The saved cart ID.
\n","type":"text/plain"},"type":"any","value":"4","key":"cart_id"}]}},"response":[{"id":"2efbb58a-d999-44a1-9ab2-ca409af5fcff","name":"204 No content","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:id/carts/:cart_id","host":["https://api.liberpay.com"],"path":["api","stores",":id","carts",":cart_id"],"variable":[{"key":"id","value":"31","description":"The store ID."},{"key":"cart_id","value":"4","description":"The saved cart ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"981b0db1-fd7c-4796-a638-9c37717ac91c"}],"id":"fb8d2e28-529f-4d9a-897c-e16c252845e9","description":"A saved cart is a named set of products of a store, for example a lunch combo. Each cart has its own QR code. A customer scans the code and pays the cart with stores/pay. The cart stores product IDs and quantities only. The prices come from the products when the customer pays.
Lists all customers of a business, sorted by name. The caller must be the creator or a member of the business. The items do not include the linked stores.
\nRequires an API key or a session token.
\nThe business ID.
\n","type":"text/plain"},"type":"any","value":"12","key":"business_id"}]}},"response":[{"id":"148468a7-f31d-448b-8454-a8466125d06d","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/businesses/:business_id/customers","host":["https://api.liberpay.com"],"path":["api","businesses",":business_id","customers"],"variable":[{"key":"business_id","value":"12","description":"The business ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 55,\n \"name\": \"João Lima\",\n \"email\": \"steve+customer2@example.com\",\n \"address\": null,\n \"business_id\": 12\n },\n {\n \"id\": 54,\n \"name\": \"Maria Souza\",\n \"email\": \"steve+customer@example.com\",\n \"address\": {\n \"street1\": \"Av. Paulista, 1000\",\n \"street2\": \"Apto 12\",\n \"city\": \"São Paulo\",\n \"region\": \"SP\",\n \"code\": \"01310-200\",\n \"country\": \"BR\"\n },\n \"business_id\": 12\n }\n ]\n}"}],"_postman_id":"b47abf07-265b-45c5-81bc-074ff55f07d9"},{"name":"listStore","id":"d64436d5-738b-4092-98c5-c12e2d8e6c3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/stores/:store_id/customers","description":"Lists the customers that are linked to a store, sorted by name. The caller must be the creator or a member of the business of the store.
\nmeta gives the invoice count for each customer, keyed by customer ID. A customer with no invoices has no key in meta.
Requires an API key or a session token.
\nThe store ID.
\n","type":"text/plain"},"type":"any","value":"31","key":"store_id"}]}},"response":[{"id":"b0490c80-3a2c-4ec6-974c-05b701ead6d8","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:store_id/customers","host":["https://api.liberpay.com"],"path":["api","stores",":store_id","customers"],"variable":[{"key":"store_id","value":"31","description":"The store ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 55,\n \"name\": \"João Lima\",\n \"email\": \"steve+customer2@example.com\",\n \"address\": null,\n \"business_id\": 12\n },\n {\n \"id\": 54,\n \"name\": \"Maria Souza\",\n \"email\": \"steve+customer@example.com\",\n \"address\": {\n \"street1\": \"Av. Paulista, 1000\",\n \"street2\": \"Apto 12\",\n \"city\": \"São Paulo\",\n \"region\": \"SP\",\n \"code\": \"01310-200\",\n \"country\": \"BR\"\n },\n \"business_id\": 12\n }\n ],\n \"meta\": {\n \"54\": {\n \"id\": 54,\n \"invoice_count\": 3\n }\n }\n}"}],"_postman_id":"d64436d5-738b-4092-98c5-c12e2d8e6c3d"},{"name":"get","id":"39222f40-872c-4a15-8f86-2a55a29b3cff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/customers/:id","description":"Gets one customer with the linked stores. The caller must be the creator or a member of the business of the customer.
\nRequires an API key or a session token.
\nThe customer ID.
\n","type":"text/plain"},"type":"any","value":"54","key":"id"}]}},"response":[{"id":"862ce881-c9f4-4f48-876a-dda659c1a1c7","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/customers/:id","host":["https://api.liberpay.com"],"path":["api","customers",":id"],"variable":[{"key":"id","value":"54","description":"The customer ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 54,\n \"name\": \"Maria Souza\",\n \"email\": \"steve+customer@example.com\",\n \"address\": {\n \"street1\": \"Av. Paulista, 1000\",\n \"street2\": \"Apto 12\",\n \"city\": \"São Paulo\",\n \"region\": \"SP\",\n \"code\": \"01310-200\",\n \"country\": \"BR\"\n },\n \"business_id\": 12,\n \"stores\": [\n {\n \"id\": 31,\n \"name\": \"Loja Centro\"\n }\n ]\n }\n}"},{"id":"28232200-416a-495c-bafc-e2d1d5d9cea0","name":"404 Not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/customers/:id","host":["https://api.liberpay.com"],"path":["api","customers",":id"],"variable":[{"key":"id","value":"54","description":"The customer ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"not found\"\n}"}],"_postman_id":"39222f40-872c-4a15-8f86-2a55a29b3cff"},{"name":"create","id":"7ba884aa-f5d0-4a9e-8827-d5d6f3c05fa5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"business_id\": 12,\n \"name\": \"Maria Souza\",\n \"email\": \"steve+customer@example.com\",\n \"address\": {\n \"street1\": \"Av. Paulista, 1000\",\n \"street2\": \"Apto 12\",\n \"city\": \"São Paulo\",\n \"region\": \"SP\",\n \"code\": \"01310-200\",\n \"country\": \"BR\"\n },\n \"stores\": [\n 31\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.liberpay.com/api/customers","description":"Creates a customer in a business. The caller must be the creator or a member of the business in customer.business_id.
customer.stores links the customer to stores. The API keeps only the stores that the caller can manage and drops the other IDs without an error. The response does not include the stores; use get to read them.
Requires an API key or a session token.
\nUpdates a customer. The caller must be the creator or a member of the business of the customer. You cannot move a customer to another business. PATCH does the same as PUT.
CAUTION: customer.stores replaces all store links. If you do not send stores, the API removes all store links of the customer. Always send the full list of store IDs.
Requires an API key or a session token.
\nThe customer ID.
\n","type":"text/plain"},"type":"any","value":"54","key":"id"}]}},"response":[{"id":"c96b646c-8859-4ce6-aebc-11461dab07d9","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"Maria Souza\",\n \"email\": \"steve+customer@example.com\",\n \"stores\": [\n 31,\n 32\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/customers/:id","host":["https://api.liberpay.com"],"path":["api","customers",":id"],"variable":[{"key":"id","value":"54","description":"The customer ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 54,\n \"name\": \"Maria Souza\",\n \"email\": \"steve+customer@example.com\",\n \"address\": {\n \"street1\": \"Av. Paulista, 1000\",\n \"street2\": \"Apto 12\",\n \"city\": \"São Paulo\",\n \"region\": \"SP\",\n \"code\": \"01310-200\",\n \"country\": \"BR\"\n },\n \"business_id\": 12,\n \"stores\": [\n {\n \"id\": 31,\n \"name\": \"Loja Centro\"\n },\n {\n \"id\": 32,\n \"name\": \"Loja Shopping\"\n }\n ]\n }\n}"}],"_postman_id":"ff84699b-15e7-41a3-9781-6aa0479f92e7"},{"name":"delete","id":"3d4c242e-b8d6-4b0e-8a18-f58cacbadc68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.liberpay.com/api/customers/:id","description":"Deletes a customer and its store links. The caller must be the creator or a member of the business of the customer. You cannot delete a customer that has invoices.
\nRequires an API key or a session token.
\nThe customer ID.
\n","type":"text/plain"},"type":"any","value":"54","key":"id"}]}},"response":[{"id":"3d0f1cf9-e19b-42a7-b60b-d876f921d216","name":"204 No content","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.liberpay.com/api/customers/:id","host":["https://api.liberpay.com"],"path":["api","customers",":id"],"variable":[{"key":"id","value":"54","description":"The customer ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a07b1422-f209-4b4c-83d2-4a3c88e281a9","name":"422 Has invoices","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.liberpay.com/api/customers/:id","host":["https://api.liberpay.com"],"path":["api","customers",":id"],"variable":[{"key":"id","value":"54","description":"The customer ID."}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"errors\": {\n \"id\": [\n \"customer has invoices and cannot be deleted\"\n ]\n }\n}"}],"_postman_id":"3d4c242e-b8d6-4b0e-8a18-f58cacbadc68"}],"id":"e118c6e6-51fe-496d-adf4-91539ffbcf2e","description":"A customer is a buyer that a business saves, usually to send invoices. Each customer belongs to one business and can be linked to one or more stores of that business. Only the creator and the members of the business can read or change its customers.
\n","_postman_id":"e118c6e6-51fe-496d-adf4-91539ffbcf2e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fb7d9328-d944-41b5-8605-d459ea859701","id":"fb7d9328-d944-41b5-8605-d459ea859701","name":"Liberpay API Docs","type":"collection"}}},{"name":"businesses","item":[{"name":"list","id":"4f26aa3a-3d9a-45dd-8611-71a91cecf5f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/businesses","description":"Lists all businesses that the signed-in user created or is a member of. The list includes the system (P2P) business of the user.
\nThe list items do not include fee_account, stripe_connect or verification. Use get for these fields.
Requires an API key or a session token.
\nGets one business. The caller must be the creator or a member of the business.
\nThe response adds the fee account, the creator, the Stripe Connect state (when the business has a Stripe Connect account) and the verification state.
\nRequires an API key or a session token.
\nThe business ID.
\n","type":"text/plain"},"type":"any","value":"12","key":"id"}]}},"response":[{"id":"10da550c-4929-484d-8ae2-ae4f4bb5fe4f","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/businesses/:id","host":["https://api.liberpay.com"],"path":["api","businesses",":id"],"variable":[{"key":"id","value":"12","description":"The business ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 12,\n \"name\": \"Café Aurora\",\n \"legal_name\": \"Café Aurora Ltda\",\n \"is_system\": false,\n \"verified\": true,\n \"country\": {\n \"id\": 1,\n \"code\": \"BR\",\n \"name\": \"Brazil\"\n },\n \"fiat_currency\": {\n \"id\": 2,\n \"name\": \"Brazilian Real\",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n \"fiscal_profile\": \"nf\",\n \"business_kyc_enabled\": true,\n \"gateway_types\": [\n 1,\n 3,\n 4\n ],\n \"fiat_currencies\": [\n {\n \"id\": 2,\n \"name\": \"Brazilian Real\",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n {\n \"id\": 1,\n \"name\": \"US Dollar\",\n \"symbol\": \"USD\",\n \"sign\": \"$\"\n }\n ],\n \"fee_account\": {\n \"id\": 9,\n \"name\": \"Default\",\n \"business_id\": 12,\n \"recharge_at\": null,\n \"recharge_amount\": null,\n \"freebies\": 10\n },\n \"creator\": {\n \"id\": 7,\n \"address\": \"0x3f2a9c1b7e5d4a6c8b0e2f4a6c8e0b2d4f6a8c1e\"\n },\n \"verification\": \"completed\"\n }\n}"},{"id":"7dfc8395-9a2b-4b4c-a5ba-b3d24887f4eb","name":"404 Not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/businesses/:id","host":["https://api.liberpay.com"],"path":["api","businesses",":id"],"variable":[{"key":"id","value":"12","description":"The business ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"not found\"\n}"}],"_postman_id":"90e4fde9-634d-4eff-b2c6-946144aeb84d"},{"name":"create","id":"63bfacaf-8a79-4584-8946-2c025d4f9030","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"business\": {\n \"name\": \"Café Aurora\",\n \"legal_name\": \"Café Aurora Ltda\"\n },\n \"store\": {\n \"name\": \"Loja Centro\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.liberpay.com/api/businesses","description":"Creates a business. The signed-in user becomes the creator. The business gets the country of the creator and the default fiat currency of that country.
\nSend store.name to also create the first store and the fee account in the same transaction. The response then has business, store and fee_account under data. Without store, the response is the business only.
The errors differ for the two forms. With store, a validation error gives 400 and puts the errors under the failed step (business, store, ...). Without store, a validation error gives 422.
Requires an API key or a session token.
\nUpdates a business. The caller must be the creator or a member. You cannot update a system (P2P) business. The country never changes. PATCH does the same as PUT.
You can also set the SMTP settings that the business uses to send email (config_secret.smtp). When you send smtp, all seven SMTP keys are required. The API never returns config_secret.
Requires an API key or a session token.
\nThe business ID.
\n","type":"text/plain"},"type":"any","value":"12","key":"id"}]}},"response":[{"id":"be0049df-cc86-4cb0-936f-8c00528ad010","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"business\": {\n \"name\": \"Café Aurora Centro\",\n \"legal_name\": \"Café Aurora Ltda\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/businesses/:id","host":["https://api.liberpay.com"],"path":["api","businesses",":id"],"variable":[{"key":"id","value":"12","description":"The business ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 12,\n \"name\": \"Café Aurora Centro\",\n \"legal_name\": \"Café Aurora Ltda\",\n \"is_system\": false,\n \"verified\": true,\n \"country\": {\n \"id\": 1,\n \"code\": \"BR\",\n \"name\": \"Brazil\"\n },\n \"fiat_currency\": {\n \"id\": 2,\n \"name\": \"Brazilian Real\",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n \"fiscal_profile\": \"nf\",\n \"business_kyc_enabled\": true,\n \"gateway_types\": [\n 1,\n 3,\n 4\n ],\n \"fiat_currencies\": [\n {\n \"id\": 2,\n \"name\": \"Brazilian Real\",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n {\n \"id\": 1,\n \"name\": \"US Dollar\",\n \"symbol\": \"USD\",\n \"sign\": \"$\"\n }\n ],\n \"fee_account\": {\n \"id\": 9,\n \"name\": \"Default\",\n \"business_id\": 12,\n \"recharge_at\": null,\n \"recharge_amount\": null,\n \"freebies\": 10\n },\n \"creator\": {\n \"id\": 7,\n \"address\": \"0x3f2a9c1b7e5d4a6c8b0e2f4a6c8e0b2d4f6a8c1e\"\n },\n \"verification\": \"completed\"\n }\n}"}],"_postman_id":"1a54f7f2-9fb4-432a-9a38-4ab148dbd525"},{"name":"delete","id":"c367039a-7b1c-4188-ba29-3cc6634fffdf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.liberpay.com/api/businesses/:id","description":"Deletes a business. The caller must be the creator or a member. You cannot delete a system (P2P) business.
\nRequires an API key or a session token.
\nThe business ID.
\n","type":"text/plain"},"type":"any","value":"12","key":"id"}]}},"response":[{"id":"4be1569e-e8fe-49f8-b64f-59487487b57c","name":"204 No content","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.liberpay.com/api/businesses/:id","host":["https://api.liberpay.com"],"path":["api","businesses",":id"],"variable":[{"key":"id","value":"12","description":"The business ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c367039a-7b1c-4188-ba29-3cc6634fffdf"},{"name":"setFiatCurrencies","id":"c854d3fc-9ad9-4a85-bff9-7e98c4aeaf42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fiat_currency_ids\": [\n 2,\n 1\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.liberpay.com/api/businesses/:id/fiat_currencies","description":"Replaces the set of fiat currencies that the business accepts for charges and invoices. The API always keeps the default currency of the country, also when you do not send it. Any currency from GET /api/fiat_currencies is allowed.
The caller must be the creator or a member. You cannot change a system (P2P) business.
\nRequires an API key or a session token.
\nThe business ID.
\n","type":"text/plain"},"type":"any","value":"12","key":"id"}]}},"response":[{"id":"0d2e835d-bb8b-4633-a849-b27538bb5a78","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fiat_currency_ids\": [\n 2,\n 1\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/businesses/:id/fiat_currencies","host":["https://api.liberpay.com"],"path":["api","businesses",":id","fiat_currencies"],"variable":[{"key":"id","value":"12","description":"The business ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Brazilian Real\",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n {\n \"id\": 1,\n \"name\": \"US Dollar\",\n \"symbol\": \"USD\",\n \"sign\": \"$\"\n }\n ]\n}"},{"id":"e8fae018-a089-44fa-868b-21c583b03d19","name":"422 Unknown currency","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fiat_currency_ids\": [\n 2,\n 1\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/businesses/:id/fiat_currencies","host":["https://api.liberpay.com"],"path":["api","businesses",":id","fiat_currencies"],"variable":[{"key":"id","value":"12","description":"The business ID."}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"unknown fiat currency\",\n \"data\": {\n \"unknown\": [\n 99\n ]\n }\n}"}],"_postman_id":"c854d3fc-9ad9-4a85-bff9-7e98c4aeaf42"}],"id":"caed6441-f373-4892-b629-e45713fbd636","description":"A business is the legal entity that sells. A business has one or more stores, gateways, customers and one fee account. Each user also gets one system (P2P) business. Only the creator and the members of a business can read or change it.
\n","_postman_id":"caed6441-f373-4892-b629-e45713fbd636","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fb7d9328-d944-41b5-8605-d459ea859701","id":"fb7d9328-d944-41b5-8605-d459ea859701","name":"Liberpay API Docs","type":"collection"}}},{"name":"gateways","item":[{"name":"list","id":"b652dd2d-52c5-4e8d-ad16-1cac307b53aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/gateways","description":"Returns the gateways that the current user created, in all businesses, ordered by id. Gateways that other members of a business created are not in this list. To see all gateways of one business, use GET /api/businesses/:business_id/gateways.
Each item shows the license state. license_status is valid (licensed), pending (a license job is in progress) or invalid. The config object never contains secrets.
Requires an API key or a session token.
\nOptional. Returns only gateways of this gateway type id (see GET /api/gateway_types). Example: 1 is polygon, 3 is stripe.
Returns all gateways of one business, ordered by id. The caller must be the creator or a member of the business. The items have the same shape as GET /api/gateways.
Requires an API key or a session token.
\nOptional. Returns only gateways of this gateway type id.
\n","type":"text/plain"},"key":"type_id","value":"1"}],"variable":[{"id":"56207eec-ebad-41b7-9483-046ccfd4b38a","description":{"content":"The business id.
\n","type":"text/plain"},"type":"any","value":"12","key":"business_id"}]}},"response":[{"id":"6c9e1ff2-aaec-45f4-a8c2-86913c299497","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/businesses/:business_id/gateways","host":["https://api.liberpay.com"],"path":["api","businesses",":business_id","gateways"],"query":[{"key":"type_id","value":"1","description":"Optional. Returns only gateways of this gateway type id.","disabled":true}],"variable":[{"key":"business_id","value":"12","description":"The business id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 73,\n \"name\": \"Main Store Polygon\",\n \"address\": \"0x5e1f3a9c7b2d4e6f8a0b1c2d3e4f5a6b7c8d9e0f\",\n \"licensed\": true,\n \"license_status\": \"valid\",\n \"creator_id\": 12,\n \"is_system\": false,\n \"version\": {\n \"identifier\": \"polygon-v1\",\n \"number\": 1\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 \"config\": {\n \"configured\": false\n },\n \"stores\": [\n {\n \"id\": 5,\n \"name\": \"Main Store\"\n }\n ]\n }\n ]\n}"},{"id":"722a14db-c806-4a6e-8f30-3abba3724438","name":"404 Not a member","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/businesses/:business_id/gateways","host":["https://api.liberpay.com"],"path":["api","businesses",":business_id","gateways"],"query":[{"key":"type_id","value":"1","description":"Optional. Returns only gateways of this gateway type id.","disabled":true}],"variable":[{"key":"business_id","value":"12","description":"The business id."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"not found\"\n}"}],"_postman_id":"249f22e4-1c77-48aa-90c6-a8e51497afcf"},{"name":"get","id":"6b7ef876-8811-4a4c-9fdf-98550141e736","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/gateways/:id","description":"Returns one gateway with its secret settings. Only the user who created the gateway can call it. Other members of the business get 404.
\nCAUTION: The response contains config_secret in clear text (for example the PayPal client_secret or the Woovi app_id). Do not log it or show it to other people. This response does not have the license fields of the list.
Requires an API key or a session token.
\nThe gateway id.
\n","type":"text/plain"},"type":"any","value":"81","key":"id"}]}},"response":[{"id":"a1b1faa6-cd08-4cfd-8e26-f995a758d82d","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/gateways/:id","host":["https://api.liberpay.com"],"path":["api","gateways",":id"],"variable":[{"key":"id","value":"81","description":"The gateway id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 81,\n \"name\": \"Card and Pix\",\n \"address\": null,\n \"type\": {\n \"id\": 3,\n \"identifier\": \"stripe\",\n \"label\": \"Stripe\",\n \"platform\": {\n \"id\": 2,\n \"identifier\": \"fiat\",\n \"label\": \"Fiat Currency\"\n }\n },\n \"config_secret\": {\n \"payment_methods\": [\n \"card\",\n \"pix\"\n ]\n },\n \"stores\": [\n {\n \"id\": 5,\n \"name\": \"Main Store\"\n }\n ]\n }\n}"},{"id":"a536a37a-5867-4244-a05d-29e1f623f22d","name":"404 Not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/gateways/:id","host":["https://api.liberpay.com"],"path":["api","gateways",":id"],"variable":[{"key":"id","value":"81","description":"The gateway id."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"not found\"\n}"}],"_postman_id":"6b7ef876-8811-4a4c-9fdf-98550141e736"},{"name":"create","id":"e3d7f543-1682-4d50-a1fb-4d6b46f1f477","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"gateway\": {\n \"name\": \"Card and Pix\",\n \"type_id\": 3,\n \"business_id\": 12,\n \"stores\": [\n 5\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.liberpay.com/api/gateways","description":"Creates a gateway in a business. The caller must be the creator or a member of the business. The server sets creator_id to the caller and licensed to false.
For a fiat type (Stripe, PayPal, Woovi), the country of the business must offer the type, or the server returns 409 not_offered. This call does not save config_secret. Send the secret settings after creation with PUT /api/gateways/:id.
For a crypto type, you can create the gateway without address. Such a gateway is a draft. Deploy the gateway contract from the merchant wallet, then send the contract address with PUT /api/gateways/:id (V1).
Requires an API key or a session token.
\nChanges the name, the contract address, the secret settings or the linked stores of a gateway. Only the creator of the gateway can call it. PATCH on the same path does the same thing. A system gateway with an address cannot change (404).
The content of config_secret depends on the type:
stripe: payment_methods, a non-empty list of card, us_bank_account, boleto, pix.paypal: client_id and client_secret.woovi: app_id, or send woovi_linked: true to use the Woovi account that is linked to the business.config_secret.CAUTION: stores replaces the full list of linked stores. If you do not send stores, the server removes all store links. Always send the full list.
Requires an API key or a session token.
\nThe gateway id.
\n","type":"text/plain"},"type":"any","value":"81","key":"id"}]}},"response":[{"id":"4b2890ce-40dd-450e-bee9-ae90259f03e1","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"gateway\": {\n \"name\": \"Card and Pix\",\n \"config_secret\": {\n \"payment_methods\": [\n \"card\",\n \"pix\"\n ]\n },\n \"stores\": [\n 5\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/gateways/:id","host":["https://api.liberpay.com"],"path":["api","gateways",":id"],"variable":[{"key":"id","value":"81","description":"The gateway id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 81,\n \"name\": \"Card and Pix\",\n \"address\": null,\n \"licensed\": false,\n \"license_status\": \"invalid\",\n \"creator_id\": 12,\n \"is_system\": false,\n \"version\": null,\n \"type\": {\n \"id\": 3,\n \"identifier\": \"stripe\",\n \"label\": \"Stripe\",\n \"platform\": {\n \"id\": 2,\n \"identifier\": \"fiat\",\n \"label\": \"Fiat Currency\"\n }\n },\n \"config\": {\n \"payment_methods\": [\n \"card\",\n \"pix\"\n ],\n \"configured\": true\n },\n \"stores\": [\n {\n \"id\": 5,\n \"name\": \"Main Store\"\n }\n ]\n }\n}"},{"id":"22abba84-f1db-4ccd-8509-31bdd9e4d622","name":"422 Invalid settings","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"gateway\": {\n \"name\": \"Card and Pix\",\n \"config_secret\": {\n \"payment_methods\": [\n \"card\",\n \"pix\"\n ]\n },\n \"stores\": [\n 5\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/gateways/:id","host":["https://api.liberpay.com"],"path":["api","gateways",":id"],"variable":[{"key":"id","value":"81","description":"The gateway id."}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"errors\": {\n \"config_secret\": [\n \"Invalid payment methods: crypto\"\n ]\n }\n}"}],"_postman_id":"c634695e-0039-4bfb-9896-bebbfb3f173d"},{"name":"delete","id":"3e376760-bf8e-493e-ab7e-4fc298133055","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.liberpay.com/api/gateways/:id","description":"Deletes a gateway and its store links. Only the creator of the gateway can call it. A system gateway with an address cannot be deleted. This call does not change the contract on chain.
\nRequires an API key or a session token.
\nThe gateway id.
\n","type":"text/plain"},"type":"any","value":"81","key":"id"}]}},"response":[{"id":"c300b6cd-5c81-464d-8bbc-3a4c4c297fb6","name":"204 No Content","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.liberpay.com/api/gateways/:id","host":["https://api.liberpay.com"],"path":["api","gateways",":id"],"variable":[{"key":"id","value":"81","description":"The gateway id."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3e376760-bf8e-493e-ab7e-4fc298133055"}],"id":"105abd20-ef3e-4a4e-884c-73872db6020c","description":"A gateway is the payment rail that receives the money for a charge. Each gateway belongs to one business and links to one or more stores. A gateway has a type (GET /api/gateway_types): a crypto type (for example polygon, platform evm) uses a gateway smart contract at address, and a fiat type (stripe, paypal, woovi) uses the secret settings in config_secret.
A crypto gateway must be licensed before it can take payments. The fee account of the business pays for the license (see the fee accounts folder).
Returns a fee account with its current balance. The caller must be the creator or a member of the business. The server adds all transactions since the last saved balance. balance is in USD. balance_fiat is the same value in the currency query parameter, or in the default currency of the country of the business.
The response has no data wrapper. You find the fee account id in the business (fee_account.id).
Requires an API key or a session token.
\nOptional. The fiat currency symbol for balance_fiat. Default: the default currency of the country of the business, or USD.
The fee account id.
\n","type":"text/plain"},"type":"any","value":"8","key":"id"}]}},"response":[{"id":"5b1e1b78-42e1-4898-9b01-61d4d420c32a","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/fee_accounts/:id","host":["https://api.liberpay.com"],"path":["api","fee_accounts",":id"],"query":[{"key":"currency","value":"BRL","description":"Optional. The fiat currency symbol for `balance_fiat`. Default: the default currency of the country of the business, or `USD`.","disabled":true}],"variable":[{"key":"id","value":"8","description":"The fee account id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 8,\n \"name\": \"default\",\n \"balance\": {\n \"currency\": \"USD\",\n \"amount\": \"2.25\"\n },\n \"balance_fiat\": {\n \"currency\": \"BRL\",\n \"amount\": \"12.38\"\n },\n \"business_id\": 12,\n \"recharge_at\": 10,\n \"recharge_amount\": 50,\n \"freebies\": 97\n}"},{"id":"d405504a-6998-498a-abdf-bdb1d517f546","name":"404 Not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/fee_accounts/:id","host":["https://api.liberpay.com"],"path":["api","fee_accounts",":id"],"query":[{"key":"currency","value":"BRL","description":"Optional. The fiat currency symbol for `balance_fiat`. Default: the default currency of the country of the business, or `USD`.","disabled":true}],"variable":[{"key":"id","value":"8","description":"The fee account id."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"not found\"\n}"}],"_postman_id":"3a4747e1-f335-4d52-a01a-12cb1c0539f0"},{"name":"create","id":"915540fd-3920-4daf-b82b-0d48ee958ebb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fee_account\": {\n \"name\": \"default\",\n \"business_id\": 12,\n \"recharge_at\": 10,\n \"recharge_amount\": 50\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.liberpay.com/api/fee_accounts","description":"Creates the fee account of a business. The caller must be the creator or a member of the business. A business can have only one fee account. The server sets the balance to 0 USD and gives the default number of free transactions (freebies).
Normal onboarding already makes the fee account. Use this call only when a business does not have one.
\nRequires an API key or a session token.
\nChanges the name and the automatic recharge settings of a fee account. The caller must be the creator or a member of the business. You cannot change the balance, the business or freebies. PATCH on the same path does the same thing.
Requires an API key or a session token.
\nThe fee account id.
\n","type":"text/plain"},"type":"any","value":"8","key":"id"}]}},"response":[{"id":"b6239a6e-ed37-4aa8-9368-5a5043ce9b3b","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fee_account\": {\n \"name\": \"default\",\n \"recharge_at\": 20,\n \"recharge_amount\": 100\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/fee_accounts/:id","host":["https://api.liberpay.com"],"path":["api","fee_accounts",":id"],"variable":[{"key":"id","value":"8","description":"The fee account id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 8,\n \"name\": \"default\",\n \"business_id\": 12,\n \"recharge_at\": 20,\n \"recharge_amount\": 100,\n \"freebies\": 97\n }\n}"}],"_postman_id":"e9ff1d37-557b-4b11-8868-517157bf5898"},{"name":"transactions","id":"260ca771-9ec4-42d0-bece-1a12d1578186","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/fee_accounts/:id/transactions","description":"Returns all credits and debits of a fee account, oldest first. The caller must be the creator or a member of the business. type 1 is a credit (USDC transfer or card recharge). type 2 is a fee debit for a charge.
amount is in USDC base units (6 decimals) as a string. amount_fiat is the same value in the currency query parameter, or in the default currency of the country of the business. The response is a plain array with no data wrapper.
Requires an API key or a session token.
\nOptional. The fiat currency symbol for amount_fiat. Default: the default currency of the country of the business, or USD.
The fee account id.
\n","type":"text/plain"},"type":"any","value":"8","key":"id"}]}},"response":[{"id":"d7f93796-5310-49e1-8ebc-076c44949656","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/fee_accounts/:id/transactions","host":["https://api.liberpay.com"],"path":["api","fee_accounts",":id","transactions"],"query":[{"key":"currency","value":"BRL","description":"Optional. The fiat currency symbol for `amount_fiat`. Default: the default currency of the country of the business, or `USD`.","disabled":true}],"variable":[{"key":"id","value":"8","description":"The fee account id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 541,\n \"currency\": {\n \"id\": 2,\n \"name\": \"USD Coin\",\n \"symbol\": \"USDC\",\n \"decimals\": 6,\n \"address\": \"0x3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f\",\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 \"type\": 1,\n \"amount\": \"20000000\",\n \"amount_fiat\": {\n \"currency\": \"BRL\",\n \"amount\": \"110.40\"\n },\n \"charge\": null,\n \"charge_token\": null,\n \"data\": {\n \"id\": 902,\n \"identifier\": \"0x9e8d7c6b5a493827160f5e4d3c2b1a0998877665544332211aabbccddeeff00\",\n \"from\": \"0x1111111111111111111111111111111111111111\",\n \"to\": \"0x3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f\",\n \"confirmations\": 1,\n \"inserted_at\": \"2026-10-01T12:00:00\"\n },\n \"inserted_at\": \"2026-10-01T12:00:05\",\n \"updated_at\": \"2026-10-01T12:00:05\"\n },\n {\n \"id\": 542,\n \"currency\": {\n \"id\": 2,\n \"name\": \"USD Coin\",\n \"symbol\": \"USDC\",\n \"decimals\": 6,\n \"address\": \"0x3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f\",\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 \"type\": 2,\n \"amount\": \"35000\",\n \"amount_fiat\": {\n \"currency\": \"BRL\",\n \"amount\": \"0.19\"\n },\n \"charge\": {\n \"id\": 231,\n \"shortcode\": \"aB3dE9\"\n },\n \"charge_token\": null,\n \"data\": null,\n \"inserted_at\": \"2026-10-03T09:15:00\",\n \"updated_at\": \"2026-10-03T09:15:00\"\n }\n]"}],"_postman_id":"260ca771-9ec4-42d0-bece-1a12d1578186"},{"name":"reportTransfer","id":"49a3088a-1351-4130-aa49-7e2b2140f19b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"transaction\": {\n \"chain\": \"polygon\",\n \"address\": \"0x1111111111111111111111111111111111111111\",\n \"nonce\": 42,\n \"identifier\": \"0x9e8d7c6b5a493827160f5e4d3c2b1a0998877665544332211aabbccddeeff00\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.liberpay.com/api/fee_accounts/:id/transactions","description":"Reports a USDC transfer that adds credit to a fee account. The caller must be the creator or a member of the business. The server queues a job that starts after 15 seconds and tries again while the transaction is not mined.
\nThe job accepts the transfer only when it comes from the wallet of the business creator and goes to the Liberpay fee address. Then it records a credit and checks the license of all crypto gateways of the business on that chain.
\nRequires an API key or a session token.
\nThe fee account id.
\n","type":"text/plain"},"type":"any","value":"8","key":"id"}]}},"response":[{"id":"88d12d46-36f3-4bb2-98ff-84f29ab3235e","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"transaction\": {\n \"chain\": \"polygon\",\n \"address\": \"0x1111111111111111111111111111111111111111\",\n \"nonce\": 42,\n \"identifier\": \"0x9e8d7c6b5a493827160f5e4d3c2b1a0998877665544332211aabbccddeeff00\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/fee_accounts/:id/transactions","host":["https://api.liberpay.com"],"path":["api","fee_accounts",":id","transactions"],"variable":[{"key":"id","value":"8","description":"The fee account id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"job created\",\n \"job\": {\n \"id\": 88123\n }\n}"}],"_postman_id":"49a3088a-1351-4130-aa49-7e2b2140f19b"},{"name":"licenseGateway","id":"b344b648-5f7e-47bf-95cf-9943553dea99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"gateway_id\": 73\n}","options":{"raw":{"language":"json"}}},"url":"https://api.liberpay.com/api/fee_accounts/:id/gateways","description":"Queues a license check for one crypto gateway. The caller must be a creator or member of the business of the fee account and of the business of the gateway.
\nThe job reads the license of the gateway on the receipt contract. If the fee account balance is zero or more and the gateway is not licensed, it sends a transaction that licenses the gateway. If the balance is negative and the gateway is licensed, it removes the license. Use this call after you deploy a V1 gateway, or to check the license again.
\nRequires an API key or a session token.
\nThe fee account id.
\n","type":"text/plain"},"type":"any","value":"8","key":"id"}]}},"response":[{"id":"57293ff1-1849-4ffc-abc6-1f0a214d3399","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"gateway_id\": 73\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/fee_accounts/:id/gateways","host":["https://api.liberpay.com"],"path":["api","fee_accounts",":id","gateways"],"variable":[{"key":"id","value":"8","description":"The fee account id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"job created\"\n}"}],"_postman_id":"b344b648-5f7e-47bf-95cf-9943553dea99"},{"name":"rechargeCard","id":"ddcf87e7-41d5-43d5-a6cd-d4ca5d1a4d22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 5000\n}","options":{"raw":{"language":"json"}}},"url":"https://api.liberpay.com/api/fee_accounts/:id/recharge_card","description":"Charges the saved Stripe card of the business and adds the value to the fee account. The caller must be the creator or a member of the business. The business must have a Stripe customer with a default payment method.
\namount is an integer in cents of the default currency of the country of the business (for example BRL cents in Brazil). The server converts the paid value to USDC, records a credit, and issues the nota fiscal when the business has a nota fiscal profile.
Requires an API key or a session token.
\nThe fee account id.
\n","type":"text/plain"},"type":"any","value":"8","key":"id"}]}},"response":[{"id":"baa2a187-c6c0-498e-9a13-75b2591c25c7","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 5000\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/fee_accounts/:id/recharge_card","host":["https://api.liberpay.com"],"path":["api","fee_accounts",":id","recharge_card"],"variable":[{"key":"id","value":"8","description":"The fee account id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"message\": \"intent created and confirmed\"\n}"},{"id":"c8394943-7eb7-4839-9092-2e4bd6ef5c9f","name":"500 Card failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 5000\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/fee_accounts/:id/recharge_card","host":["https://api.liberpay.com"],"path":["api","fee_accounts",":id","recharge_card"],"variable":[{"key":"id","value":"8","description":"The fee account id."}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"intent failed to create\"\n}"}],"_postman_id":"ddcf87e7-41d5-43d5-a6cd-d4ca5d1a4d22"}],"id":"804678b0-a55c-4dc0-b4e5-a8b13c6c5932","description":"A fee account holds the prepaid balance that pays the Liberpay platform fees of one business. Each business has one fee account. The balance is in USD. Each charge with a fee takes a debit from the balance, but first the account uses its free transactions (freebies).
You add credit in two ways: send USDC from the wallet of the business creator to the Liberpay fee address and report the transaction, or charge the saved Stripe card. When recharge_at and recharge_amount are set and a card is saved, the server recharges the card when the balance goes below recharge_at.
The balance also controls the license of the crypto gateways. A gateway stays licensed while the balance is zero or more, and loses the license when the balance goes negative.
\n","_postman_id":"804678b0-a55c-4dc0-b4e5-a8b13c6c5932","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fb7d9328-d944-41b5-8605-d459ea859701","id":"fb7d9328-d944-41b5-8605-d459ea859701","name":"Liberpay API Docs","type":"collection"}}},{"name":"sales","item":[{"name":"list","id":"f2c41d04-d1be-41a1-b51a-f459bde62d6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/stores/:store_id/sales","description":"Returns the sales of a store in all statuses, newest first, in pages of 250.
\nYou must be the creator or a member of the business that owns the store.
\nRequires an API key or a session token.
\nThe page number. The first page is 1. Each page has up to 250 items.
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[{"id":"3977ea70-9463-49e6-a037-ff535c11929e","description":{"content":"The store id.
\n","type":"text/plain"},"type":"any","value":"5","key":"store_id"}]}},"response":[{"id":"227d97c9-85ad-4958-b90b-a24dd20b8e81","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:store_id/sales","host":["https://api.liberpay.com"],"path":["api","stores",":store_id","sales"],"query":[{"key":"page","value":"1","description":"The page number. The first page is 1. Each page has up to 250 items.","disabled":true}],"variable":[{"key":"store_id","value":"5","description":"The store id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"first\": 1,\n \"last\": 1,\n \"has_next\": false,\n \"has_prev\": false,\n \"prev_page\": null,\n \"next_page\": null,\n \"last_page\": 1,\n \"per_page\": 250,\n \"data\": [\n {\n \"id\": 245,\n \"shortcode\": \"Rt7vN2qLc8XyZpE\",\n \"hash\": \"0x9f3c1e7a2b4d6f8091a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f7081\",\n \"metadata\": {\n \"items\": [\n {\n \"id\": 41,\n \"name\": \"Vela aromática\",\n \"description\": \"Vela de cera de soja com aroma de lavanda.\",\n \"quantity\": 2,\n \"is_physical\": true,\n \"taxable\": false,\n \"price\": {\n \"amount\": \"39.90\",\n \"currency\": \"BRL\"\n },\n \"subtotal\": {\n \"amount\": \"79.80\",\n \"currency\": \"BRL\"\n },\n \"tax\": {\n \"amount\": \"0.00\",\n \"currency\": \"BRL\"\n },\n \"total\": {\n \"amount\": \"79.80\",\n \"currency\": \"BRL\"\n }\n }\n ]\n },\n \"price\": {\n \"amount\": \"79.80\",\n \"currency\": \"BRL\"\n },\n \"currency_price\": \"14250000\",\n \"exchange_rate\": \"5.600000000000000000\",\n \"expires_at\": \"2026-10-21T15:10:00Z\",\n \"gateway\": {\n \"id\": 73,\n \"name\": \"Loja Centro USDC\",\n \"address\": \"0x5e1f0000000000000000000000000000000a11ce\",\n \"licensed\": true,\n \"license_status\": \"valid\",\n \"creator_id\": 17,\n \"is_system\": false,\n \"version\": {\n \"identifier\": \"polygon-v1\",\n \"number\": 1\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 \"config\": {\n \"configured\": false\n }\n },\n \"store\": {\n \"id\": 5,\n \"name\": \"Loja Centro\",\n \"logo\": null,\n \"business\": {\n \"id\": 3,\n \"name\": \"Velas da Ana\"\n }\n },\n \"seller_address\": null,\n \"creator\": {\n \"id\": 17,\n \"username\": \"seller\",\n \"email\": \"steve+seller@example.com\",\n \"address\": \"0x2b5ad5c4795c026514f8317c7a215e218dccd6cf\"\n },\n \"buyer\": {\n \"id\": 52,\n \"username\": \"buyer\",\n \"email\": \"steve+buyer@example.com\",\n \"address\": \"0x8d12a197cb00d4747a1fe03395095ce2a5cc6819\"\n },\n \"currency\": {\n \"id\": 3,\n \"name\": \"USD Coin\",\n \"symbol\": \"USDC\",\n \"decimals\": 6,\n \"address\": \"0x0000000000000000000000000000000000c0ffee\",\n \"supported\": true\n },\n \"fiat_currency\": {\n \"id\": 2,\n \"name\": \"Brazilian Real\",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n \"buyer_fiat_currency\": null,\n \"buyer_price\": null,\n \"buyer_exchange_rate\": null,\n \"viewer_fiat\": null,\n \"business_fiat\": null,\n \"payments\": [\n {\n \"id\": 310,\n \"amount\": \"14250000\",\n \"currency\": {\n \"id\": 3,\n \"name\": \"USD Coin\",\n \"symbol\": \"USDC\",\n \"decimals\": 6,\n \"address\": \"0x0000000000000000000000000000000000c0ffee\",\n \"supported\": true\n },\n \"transaction\": {\n \"id\": 501,\n \"identifier\": \"0x4c7e2a9b1d3f5e7091a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f7a1b\",\n \"from\": \"0x8d12a197cb00d4747a1fe03395095ce2a5cc6819\",\n \"to\": \"0x5e1f0000000000000000000000000000000a11ce\",\n \"confirmations\": 12,\n \"inserted_at\": \"2026-10-21T15:06:02\"\n },\n \"reference\": null\n }\n ],\n \"refunds\": [],\n \"tokens\": [],\n \"type\": {\n \"id\": 1,\n \"label\": \"Point of Sale\"\n },\n \"status\": {\n \"id\": 3,\n \"label\": \"confirmed\"\n },\n \"inserted_at\": \"2026-10-21T15:05:00\",\n \"updated_at\": \"2026-10-21T15:06:30\"\n }\n ]\n}"},{"id":"832898a9-86b0-44f4-aa02-32d6d19eda65","name":"404 Not a member","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:store_id/sales","host":["https://api.liberpay.com"],"path":["api","stores",":store_id","sales"],"query":[{"key":"page","value":"1","description":"The page number. The first page is 1. Each page has up to 250 items.","disabled":true}],"variable":[{"key":"store_id","value":"5","description":"The store id."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"not found\"\n}"}],"_postman_id":"f2c41d04-d1be-41a1-b51a-f459bde62d6a"},{"name":"listGateway","id":"b2e5171e-68fd-421b-9b31-c0be15fd2708","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/gateways/:gateway_id/sales","description":"Returns the sales paid to a gateway in all statuses, newest first.
\nYou must be the creator or a member of the business that owns the gateway. This endpoint returns only the first page of 250 items. It has no page parameter.
Requires an API key or a session token.
\nThe gateway id.
\n","type":"text/plain"},"type":"any","value":"73","key":"gateway_id"}]}},"response":[{"id":"de083a51-3456-46bb-87c6-aedbc935db22","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/gateways/:gateway_id/sales","host":["https://api.liberpay.com"],"path":["api","gateways",":gateway_id","sales"],"variable":[{"key":"gateway_id","value":"73","description":"The gateway id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"first\": 1,\n \"last\": 1,\n \"has_next\": false,\n \"has_prev\": false,\n \"prev_page\": null,\n \"next_page\": null,\n \"last_page\": 1,\n \"per_page\": 250,\n \"data\": [\n {\n \"id\": 245,\n \"shortcode\": \"Rt7vN2qLc8XyZpE\",\n \"hash\": \"0x9f3c1e7a2b4d6f8091a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f7081\",\n \"metadata\": {\n \"items\": [\n {\n \"id\": 41,\n \"name\": \"Vela aromática\",\n \"description\": \"Vela de cera de soja com aroma de lavanda.\",\n \"quantity\": 2,\n \"is_physical\": true,\n \"taxable\": false,\n \"price\": {\n \"amount\": \"39.90\",\n \"currency\": \"BRL\"\n },\n \"subtotal\": {\n \"amount\": \"79.80\",\n \"currency\": \"BRL\"\n },\n \"tax\": {\n \"amount\": \"0.00\",\n \"currency\": \"BRL\"\n },\n \"total\": {\n \"amount\": \"79.80\",\n \"currency\": \"BRL\"\n }\n }\n ]\n },\n \"price\": {\n \"amount\": \"79.80\",\n \"currency\": \"BRL\"\n },\n \"currency_price\": \"14250000\",\n \"exchange_rate\": \"5.600000000000000000\",\n \"expires_at\": \"2026-10-21T15:10:00Z\",\n \"gateway\": {\n \"id\": 73,\n \"name\": \"Loja Centro USDC\",\n \"address\": \"0x5e1f0000000000000000000000000000000a11ce\",\n \"licensed\": true,\n \"license_status\": \"valid\",\n \"creator_id\": 17,\n \"is_system\": false,\n \"version\": {\n \"identifier\": \"polygon-v1\",\n \"number\": 1\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 \"config\": {\n \"configured\": false\n }\n },\n \"store\": {\n \"id\": 5,\n \"name\": \"Loja Centro\",\n \"logo\": null,\n \"business\": {\n \"id\": 3,\n \"name\": \"Velas da Ana\"\n }\n },\n \"seller_address\": null,\n \"creator\": {\n \"id\": 17,\n \"username\": \"seller\",\n \"email\": \"steve+seller@example.com\",\n \"address\": \"0x2b5ad5c4795c026514f8317c7a215e218dccd6cf\"\n },\n \"buyer\": {\n \"id\": 52,\n \"username\": \"buyer\",\n \"email\": \"steve+buyer@example.com\",\n \"address\": \"0x8d12a197cb00d4747a1fe03395095ce2a5cc6819\"\n },\n \"currency\": {\n \"id\": 3,\n \"name\": \"USD Coin\",\n \"symbol\": \"USDC\",\n \"decimals\": 6,\n \"address\": \"0x0000000000000000000000000000000000c0ffee\",\n \"supported\": true\n },\n \"fiat_currency\": {\n \"id\": 2,\n \"name\": \"Brazilian Real\",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n \"buyer_fiat_currency\": null,\n \"buyer_price\": null,\n \"buyer_exchange_rate\": null,\n \"viewer_fiat\": null,\n \"business_fiat\": null,\n \"payments\": [\n {\n \"id\": 310,\n \"amount\": \"14250000\",\n \"currency\": {\n \"id\": 3,\n \"name\": \"USD Coin\",\n \"symbol\": \"USDC\",\n \"decimals\": 6,\n \"address\": \"0x0000000000000000000000000000000000c0ffee\",\n \"supported\": true\n },\n \"transaction\": {\n \"id\": 501,\n \"identifier\": \"0x4c7e2a9b1d3f5e7091a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f7a1b\",\n \"from\": \"0x8d12a197cb00d4747a1fe03395095ce2a5cc6819\",\n \"to\": \"0x5e1f0000000000000000000000000000000a11ce\",\n \"confirmations\": 12,\n \"inserted_at\": \"2026-10-21T15:06:02\"\n },\n \"reference\": null\n }\n ],\n \"refunds\": [],\n \"tokens\": [],\n \"type\": {\n \"id\": 1,\n \"label\": \"Point of Sale\"\n },\n \"status\": {\n \"id\": 3,\n \"label\": \"confirmed\"\n },\n \"inserted_at\": \"2026-10-21T15:05:00\",\n \"updated_at\": \"2026-10-21T15:06:30\"\n }\n ]\n}"}],"_postman_id":"b2e5171e-68fd-421b-9b31-c0be15fd2708"}],"id":"abbf712b-863e-4455-908f-870c0fdff4da","description":"A sale is a point-of-sale charge (charge_type_id 1). These endpoints list the sales of a store or of a gateway, newest first. Each item is the same charge object that GET /api/charges/:id returns. Invoices and P2P charges are not in these lists. You must be the creator or a member of the business.
Returns the events of the invoice of a charge, oldest first. Give the charge shortcode in id, not the invoice id.
You must be the creator or a member of the business that owns the charge.
\nRequires an API key or a session token.
\nThe event type. The only value that the API accepts is charge.invoice.
The shortcode of an invoice charge.
\n","type":"text/plain"},"type":"any","value":"k3Hq9ZxT2mPbLwA","key":"id"}]}},"response":[{"id":"003b36f2-9976-4965-8f0c-e87c3dc99e9b","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/events/:type/:id","host":["https://api.liberpay.com"],"path":["api","events",":type",":id"],"variable":[{"key":"type","value":"charge.invoice","description":"The event type. The only value that the API accepts is `charge.invoice`."},{"key":"id","value":"k3Hq9ZxT2mPbLwA","description":"The shortcode of an invoice charge."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 880,\n \"type\": \"invoice\",\n \"name\": \"approved\",\n \"identifier\": 94,\n \"meta\": {},\n \"inserted_at\": \"2026-10-20T14:05:40\",\n \"updated_at\": \"2026-10-20T14:05:40\"\n },\n {\n \"id\": 881,\n \"type\": \"invoice\",\n \"name\": \"sent\",\n \"identifier\": 94,\n \"meta\": {\n \"type\": \"email\"\n },\n \"inserted_at\": \"2026-10-20T14:05:42\",\n \"updated_at\": \"2026-10-20T14:05:42\"\n },\n {\n \"id\": 890,\n \"type\": \"invoice\",\n \"name\": \"viewed\",\n \"identifier\": 94,\n \"meta\": {},\n \"inserted_at\": \"2026-10-21T09:12:03\",\n \"updated_at\": \"2026-10-21T09:12:03\"\n }\n ]\n}"}],"_postman_id":"b8746f85-4f62-438e-8670-85c3c7502d37"},{"name":"create","id":"306882dd-cc60-426c-9921-cb9cf6da79a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"event\": {\n \"id\": \"k3Hq9ZxT2mPbLwA\",\n \"name\": \"viewed\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.liberpay.com/api/events/:type","description":"Records a viewed event on the invoice of a charge. The only allowed event.name is viewed. Any signed-in user can call it.
The charge must have status 1 (created). The response is the new event object, not wrapped in data.
Requires an API key or a session token.
\nThe event type. The only value that the API accepts is charge.invoice.
An event records one action on an invoice. The API writes these events: approved (approve), sent (send, and approved invoices at create), marked_paid (mark as paid) and viewed. Use these endpoints to show the history of an invoice. The only type value that the code accepts is charge.invoice. The id in these endpoints is the charge shortcode.
Lists the P2P feed of your P2P account, newest first. The list has no pages.
\nWith no filter, the list holds only P2P charges where you are the sender or the recipient. A push payment to you that nobody paid yet does not show. If you have no P2P account, the list is empty.
Requires an API key or a session token.
\nOptional. all: P2P charges plus point-of-sale and invoice charges that you paid, plus unpaid charges sent to your @username. paid: money out (P2P you sent and purchases). received: P2P money in. requested: your requests that are still unpaid. business: point-of-sale and invoice charges that you paid. Any other value works as no filter.
Lists the P2P charges of one store, newest first, 250 per page. Use the store of your P2P account (store_id on the P2P account). You must be a member of the business that owns the store.
Requires an API key or a session token.
\nThe page number. The default is 1.
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[{"id":"e6e4fcf0-3a9f-4d4e-afbd-dab58924c4ef","description":{"content":"The store id. For P2P this is the store of your P2P account.
\n","type":"text/plain"},"type":"any","value":"88","key":"store_id"}]}},"response":[{"id":"18dc9660-a60f-4774-8756-f3cbd20f3715","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:store_id/p2p","host":["https://api.liberpay.com"],"path":["api","stores",":store_id","p2p"],"query":[{"key":"page","value":"1","description":"The page number. The default is 1.","disabled":true}],"variable":[{"key":"store_id","value":"88","description":"The store id. For P2P this is the store of your P2P account."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"first\": 1,\n \"last\": 1,\n \"has_next\": false,\n \"has_prev\": false,\n \"prev_page\": null,\n \"next_page\": null,\n \"last_page\": 1,\n \"per_page\": 250,\n \"data\": [\n {\n \"id\": 412,\n \"shortcode\": \"p2PkR7mQx2LbN4s\",\n \"hash\": null,\n \"metadata\": {\n \"items\": [\n {\n \"id\": \"5b7f0e2a-91c4-4d8e-b3a6-0f2c7d9e1a44\",\n \"name\": \"Pizza night\",\n \"description\": \"\",\n \"is_physical\": false,\n \"metadata\": {},\n \"quantity\": 1,\n \"taxable\": false,\n \"tax_rate\": \"0.00000\",\n \"price\": {\n \"amount\": \"40.00\",\n \"currency\": \"BRL\"\n },\n \"price_currency\": \"7272727\",\n \"subtotal\": {\n \"amount\": \"40.00\",\n \"currency\": \"BRL\"\n },\n \"subtotal_currency\": \"7272727\",\n \"tax\": {\n \"amount\": \"0.00\",\n \"currency\": \"BRL\"\n },\n \"tax_currency\": \"0\",\n \"unit_tax\": {\n \"amount\": \"0\",\n \"currency\": \"BRL\"\n },\n \"unit_tax_currency\": \"0\",\n \"total\": {\n \"amount\": \"40.00\",\n \"currency\": \"BRL\"\n },\n \"total_currency\": \"7272727\"\n }\n ]\n },\n \"price\": {\n \"amount\": \"40.00\",\n \"currency\": \"BRL\"\n },\n \"currency_price\": \"7272727\",\n \"exchange_rate\": \"0.181818181818181818\",\n \"expires_at\": \"2026-10-27T15:12:40Z\",\n \"gateway\": {\n \"id\": 305,\n \"name\": \"P2P\",\n \"address\": \"0x4a1f0c2b9e7d3a6f5c8b1e2d4f6a7c9e0b3d5f71\",\n \"licensed\": true,\n \"license_status\": \"valid\",\n \"creator_id\": 41,\n \"is_system\": true,\n \"version\": {\n \"identifier\": \"polygon-v1\",\n \"number\": 1\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 \"config\": {\n \"configured\": false\n }\n },\n \"store\": {\n \"id\": 88,\n \"name\": \"P2P\",\n \"logo\": null,\n \"business\": {\n \"id\": 77,\n \"name\": \"P2P\"\n }\n },\n \"seller_address\": null,\n \"creator\": {\n \"id\": 41,\n \"username\": \"steve_seller\",\n \"email\": \"steve+seller@example.com\",\n \"address\": \"0x7e3b1d9a2c4f6e8a0b1c3d5e7f9a1b3c5d7e9f02\"\n },\n \"buyer\": null,\n \"currency\": {\n \"id\": 2,\n \"name\": \"USD Coin\",\n \"symbol\": \"USDC\",\n \"decimals\": 6,\n \"address\": \"0x9f8e7d6c5b4a39281706f5e4d3c2b1a098765432\",\n \"supported\": true\n },\n \"fiat_currency\": {\n \"id\": 2,\n \"name\": \"Brazilian Real\",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n \"buyer_fiat_currency\": null,\n \"buyer_price\": null,\n \"buyer_exchange_rate\": null,\n \"viewer_fiat\": null,\n \"business_fiat\": null,\n \"payments\": [],\n \"refunds\": [],\n \"tokens\": [],\n \"type\": {\n \"id\": 3,\n \"label\": \"Peer to Peer\"\n },\n \"status\": {\n \"id\": 1,\n \"label\": \"created\"\n },\n \"inserted_at\": \"2026-10-27T15:02:40\",\n \"updated_at\": \"2026-10-27T15:02:40\",\n \"requested_buyer\": {\n \"id\": 42,\n \"username\": \"steve_buyer\"\n },\n \"p2p_request\": {\n \"id\": 57,\n \"memo\": \"Pizza on Friday\",\n \"sender_account\": {\n \"id\": 19,\n \"name\": \"steve+buyer\",\n \"user\": {\n \"id\": 42,\n \"address\": \"0x2c9e4b7a1d3f5e7a9b0c2d4e6f8a0b2c4d6e8f13\",\n \"username\": \"steve_buyer\",\n \"email\": \"steve+buyer@example.com\",\n \"avatar_url\": null,\n \"legal_name\": null,\n \"has_government_id\": false,\n \"masked_government_id\": null,\n \"country\": {\n \"id\": 1,\n \"code\": \"BR\",\n \"name\": \"Brazil\"\n },\n \"fiat_currency\": {\n \"id\": 2,\n \"name\": \"Brazilian Real\",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n \"locale\": \"pt-BR\",\n \"user_kyc_enabled\": true\n }\n },\n \"recipient_account\": {\n \"id\": 18,\n \"name\": \"steve+seller\",\n \"user\": {\n \"id\": 41,\n \"address\": \"0x7e3b1d9a2c4f6e8a0b1c3d5e7f9a1b3c5d7e9f02\",\n \"username\": \"steve_seller\",\n \"email\": \"steve+seller@example.com\",\n \"avatar_url\": null,\n \"legal_name\": null,\n \"has_government_id\": false,\n \"masked_government_id\": null,\n \"country\": {\n \"id\": 1,\n \"code\": \"BR\",\n \"name\": \"Brazil\"\n },\n \"fiat_currency\": {\n \"id\": 2,\n \"name\": \"Brazilian Real\",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n \"locale\": \"pt-BR\",\n \"user_kyc_enabled\": true\n }\n },\n \"canceled\": false,\n \"canceled_by_account_id\": null,\n \"canceled_by_role\": null\n }\n }\n ]\n}"},{"id":"ccf40b23-ef22-45e9-8cf7-999f175142db","name":"404 Not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/stores/:store_id/p2p","host":["https://api.liberpay.com"],"path":["api","stores",":store_id","p2p"],"query":[{"key":"page","value":"1","description":"The page number. The default is 1.","disabled":true}],"variable":[{"key":"store_id","value":"88","description":"The store id. For P2P this is the store of your P2P account."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"not found\"\n}"}],"_postman_id":"dafcfaca-bc5e-4ff5-b187-a14b95b21149"},{"name":"search","id":"aa7b6f90-cd4a-403b-8ea3-30ca775794b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/p2p/accounts?query=steve","description":"Searches P2P accounts by username. The match is a case-insensitive prefix match. A leading @ is removed. The API returns at most 100 accounts.
A query with fewer than 3 characters returns an empty list. The API sorts the results: favorites first, then accounts with recent activity (newest first), then the rest by username.
\nRequires an API key or a session token.
\nThe start of the username, with or without @. Minimum 3 characters to get results.
Gets one P2P account by its exact username. The API removes @ from the identifier. Use this call to open a pay link such as @steve_buyer.
The response has the same shape as a search result, with is_favorite and last_activity_at for you.
Requires an API key or a session token.
\nThe exact username of the account owner, with or without @.
Creates your P2P account. The API also creates a system business and a store, both named \"P2P\". Without gateway_id, the API also creates a fee account and a new Polygon gateway (not licensed, no contract yet).
The call is idempotent. Most users already have a P2P account, because Liberpay creates one at signup. Then the API returns 200 with the id of the existing account and changes nothing.
\nThis call is open to a user with no country. Send country_id to set the country of the user, one time only.
Requires an API key or a session token.
\nChanges the display name of your P2P account. The path has no id: the call always changes the account of the token user.
\nRequires an API key or a session token.
\nLists the Polygon gateways that you created and that have no charges yet. Use one of them as gateway_id in POST /api/p2p/accounts.
The list can include gateways that are linked to stores. POST /api/p2p/accounts refuses those.
Requires an API key or a session token.
\nStarts the license check for the gateway of your P2P account. The API queues a license job that runs after about 15 seconds. The call does not license the gateway at once: read the gateway again to see licensed.
The gateway must not have a license yet. The balance of the P2P fee account must be zero or more.
\nRequires an API key or a session token.
\nCancels or rejects a P2P request. The sender and the recipient can both call it. The charge must still have status 1 (created). The API locks the charge and checks the status again, so a payment that arrives first wins.
\nThe API sets canceled to true, records your account in canceled_by_account_id, and changes the charge to status 10 (canceled). The other party gets a push notification. When the recipient calls it, the request is \"canceled\" (canceled_by_role = requester). When the sender calls it, the request is \"rejected\" (canceled_by_role = payer).
Requires an API key or a session token.
\nThe P2P request id (p2p_request.id on the charge). This is not the charge id.
A P2P (peer-to-peer) payment moves money from one Liberpay user to another. Each user has one P2P account. The P2P account has its own system business, store and Polygon gateway, each named \"P2P\".
\nA P2P charge is a charge with charge_type_id 3 (\"Peer to Peer\"). Each P2P charge has one P2P request (p2p_request). The P2P request names the sender account (the payer), the recipient account (the person who gets the money) and a memo. The sender's user is the requested_buyer of the charge: no other user can pay it.
Request money (pull). Call POST /api/charges with charge_type_id 3, gateway_id set to your own P2P gateway, and p2p_request.sender_account_id set to the payer's P2P account id. The API makes you the recipient. Liberpay sends the payer an email and a push notification.
Send money (push). Call POST /api/charges with charge_type_id 3 and p2p_request.recipient_account_id set to the recipient's P2P account id. Do not send gateway_id. The API fills in the recipient's gateway, store and wallet address, and makes you the sender.
In both modes the payer then calls setCurrency and pays like any other charge. The recipient does not see an unpaid push payment in the feed.
Find a recipient. GET /api/p2p/accounts?query= searches usernames that start with the query. GET /api/p2p/accounts/:identifier gets one account by its exact username. Both return the P2P account id for sender_account_id or recipient_account_id. Check payable first. GET /api/users/search is a different search: it returns users (not P2P accounts) by username or email. Its id is a user id, not a P2P account id.
No self-charges. You cannot request money from yourself or send money to yourself: POST /api/charges returns 422 with errors.p2p_request = \"You can't request or send a payment to yourself\". The recipient cannot pay the charge: setCurrency returns an error \"You can't pay yourself\". Any user other than the sender gets \"This payment was sent to someone else\". Only the user who claimed the charge in setCurrency can report its transaction.
Cancel vs reject. The two parties use the same call, POST /api/p2p/requests/:id/cancel, while the charge has status 1 (created). The charge changes to status 10 (canceled). The label comes from who did it: canceled_by_role is requester when the recipient withdraws the request (\"canceled\"), and payer when the sender turns it down (\"rejected\"). The other party gets a push notification.
Lists the accounts that you added to your favorites, the newest favorite first. The list has no pages.
\nRequires an API key or a session token.
\nAdds a P2P account to your favorites. The call is idempotent: a second call for the same account succeeds and adds nothing.
\nRequires an API key or a session token.
\nRemoves a P2P account from your favorites. The call is idempotent: it returns 200 also when the account was not a favorite.
\nRequires an API key or a session token.
\nThe P2P account id of the favorite (the same value as favorite_id). This is not the id of a favorite record.
Lists the accounts that you had P2P activity with, the newest activity first. Activity is any P2P request in either direction, with any status. Each account comes once.
\nA recent account can also be a favorite: check is_favorite.
Requires an API key or a session token.
\nThe maximum number of accounts. The default is 15. The maximum is 50. A value that is not a positive integer gives 15.
\n","type":"text/plain"},"key":"limit","value":"15"}],"variable":[]}},"response":[{"id":"eb5ae33c-47ca-4fac-8adb-b29f9b52a4ce","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/p2p/recents","host":["https://api.liberpay.com"],"path":["api","p2p","recents"],"query":[{"key":"limit","value":"15","description":"The maximum number of accounts. The default is 15. The maximum is 50. A value that is not a positive integer gives 15.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"data\": [\n {\n \"id\": 19,\n \"name\": \"steve+buyer\",\n \"username\": \"steve_buyer\",\n \"avatar_url\": \"https://avatars.example.com/9b1d0c.png\",\n \"payable\": true,\n \"is_favorite\": true,\n \"last_activity_at\": \"2026-10-20T14:03:11\"\n },\n {\n \"id\": 23,\n \"name\": \"Ana\",\n \"username\": \"steve_ana\",\n \"avatar_url\": null,\n \"payable\": true,\n \"is_favorite\": false,\n \"last_activity_at\": \"2026-10-02T09:41:55\"\n }\n ]\n}"},{"id":"9933efc0-089e-4b2b-ad77-5596d363d09f","name":"404 No P2P account","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/p2p/recents","host":["https://api.liberpay.com"],"path":["api","p2p","recents"],"query":[{"key":"limit","value":"15","description":"The maximum number of accounts. The default is 15. The maximum is 50. A value that is not a positive integer gives 15.","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"not found\"\n}"}],"_postman_id":"aede24e2-c7a8-4827-bcff-f63d1a558286"}],"id":"51492690-72b5-48fb-b7dd-d52b2fe8b8c7","description":"The pay screen puts each other P2P account in one of three levels. The API computes the levels for you, so all apps agree.
\nis_favorite = true): you added the account with POST /api/p2p/favorites. A favorite is one-way. The other user is not told and has no list of who added them.last_activity_at is not null): you have at least one P2P request with the account, in either direction and with any status. Nobody stores recents: the API reads them from the P2P request history.Every call that returns an account (search, get, favorites, recents) returns the same account object with is_favorite and last_activity_at. You cannot favorite yourself, and you are never your own recent. All calls in this folder need a P2P account; without one they return 404.
Gets the NF profile of the business. When the business has no NF profile, data is null.
Requires an API key or a session token.
\nThe business id. You must be a member of the business.
\n","type":"text/plain"},"type":"any","value":"12","key":"business_id"}]}},"response":[{"id":"4e5a3680-4ef2-40e1-ba28-66bcf3d2dfc7","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/businesses/:business_id/nf_profile","host":["https://api.liberpay.com"],"path":["api","businesses",":business_id","nf_profile"],"variable":[{"key":"business_id","value":"12","description":"The business id. You must be a member of the business."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 4,\n \"business_id\": 12,\n \"tax_id\": \"12345678000195\",\n \"legal_name\": \"Pizzaria Exemplo LTDA\",\n \"email\": \"steve+fiscal@example.com\",\n \"address\": {\n \"postal_code\": \"01310100\",\n \"street\": \"Avenida Paulista\",\n \"number\": \"1000\",\n \"additional_information\": \"Sala 12\",\n \"district\": \"Bela Vista\",\n \"city_code\": \"3550308\",\n \"city_name\": \"São Paulo\",\n \"state\": \"SP\",\n \"country\": \"BRA\"\n }\n }\n}"},{"id":"8b982023-bb98-46e0-8fbf-d9ef4f6193b8","name":"200 No profile","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/businesses/:business_id/nf_profile","host":["https://api.liberpay.com"],"path":["api","businesses",":business_id","nf_profile"],"variable":[{"key":"business_id","value":"12","description":"The business id. You must be a member of the business."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null\n}"}],"_postman_id":"63575c9f-e63d-49b0-a946-668a75a215bb"},{"name":"saveProfile","id":"036e00e8-b04a-427d-9723-f448dbe456cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"nf_profile\": {\n \"tax_id\": \"12.345.678/0001-95\",\n \"legal_name\": \"Pizzaria Exemplo LTDA\",\n \"email\": \"steve+fiscal@example.com\",\n \"address\": {\n \"postal_code\": \"01310100\",\n \"street\": \"Avenida Paulista\",\n \"number\": \"1000\",\n \"additional_information\": \"Sala 12\",\n \"district\": \"Bela Vista\",\n \"city_code\": \"3550308\",\n \"city_name\": \"São Paulo\",\n \"state\": \"SP\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.liberpay.com/api/businesses/:business_id/nf_profile","description":"Creates the NF profile of the business, or replaces it when it exists. The API removes all characters that are not digits from tax_id, then checks the CPF or CNPJ.
Send all fields every time: an update also requires tax_id, legal_name, email and address, and the new address replaces the old one.
Requires an API key or a session token.
\nThe business id. You must be a member of the business.
\n","type":"text/plain"},"type":"any","value":"12","key":"business_id"}]}},"response":[{"id":"9d6ae222-fc1e-4908-901d-f45610541f96","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"nf_profile\": {\n \"tax_id\": \"12.345.678/0001-95\",\n \"legal_name\": \"Pizzaria Exemplo LTDA\",\n \"email\": \"steve+fiscal@example.com\",\n \"address\": {\n \"postal_code\": \"01310100\",\n \"street\": \"Avenida Paulista\",\n \"number\": \"1000\",\n \"additional_information\": \"Sala 12\",\n \"district\": \"Bela Vista\",\n \"city_code\": \"3550308\",\n \"city_name\": \"São Paulo\",\n \"state\": \"SP\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/businesses/:business_id/nf_profile","host":["https://api.liberpay.com"],"path":["api","businesses",":business_id","nf_profile"],"variable":[{"key":"business_id","value":"12","description":"The business id. You must be a member of the business."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 4,\n \"business_id\": 12,\n \"tax_id\": \"12345678000195\",\n \"legal_name\": \"Pizzaria Exemplo LTDA\",\n \"email\": \"steve+fiscal@example.com\",\n \"address\": {\n \"postal_code\": \"01310100\",\n \"street\": \"Avenida Paulista\",\n \"number\": \"1000\",\n \"additional_information\": \"Sala 12\",\n \"district\": \"Bela Vista\",\n \"city_code\": \"3550308\",\n \"city_name\": \"São Paulo\",\n \"state\": \"SP\",\n \"country\": \"BRA\"\n }\n }\n}"},{"id":"27059550-2cdf-4922-8446-6c423e062acd","name":"200 Updated","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"nf_profile\": {\n \"tax_id\": \"12.345.678/0001-95\",\n \"legal_name\": \"Pizzaria Exemplo LTDA\",\n \"email\": \"steve+fiscal@example.com\",\n \"address\": {\n \"postal_code\": \"01310100\",\n \"street\": \"Avenida Paulista\",\n \"number\": \"1000\",\n \"additional_information\": \"Sala 12\",\n \"district\": \"Bela Vista\",\n \"city_code\": \"3550308\",\n \"city_name\": \"São Paulo\",\n \"state\": \"SP\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/businesses/:business_id/nf_profile","host":["https://api.liberpay.com"],"path":["api","businesses",":business_id","nf_profile"],"variable":[{"key":"business_id","value":"12","description":"The business id. You must be a member of the business."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 4,\n \"business_id\": 12,\n \"tax_id\": \"12345678000195\",\n \"legal_name\": \"Pizzaria Exemplo LTDA\",\n \"email\": \"steve+fiscal@example.com\",\n \"address\": {\n \"postal_code\": \"01310100\",\n \"street\": \"Avenida Paulista\",\n \"number\": \"1000\",\n \"additional_information\": \"Sala 12\",\n \"district\": \"Bela Vista\",\n \"city_code\": \"3550308\",\n \"city_name\": \"São Paulo\",\n \"state\": \"SP\",\n \"country\": \"BRA\"\n }\n }\n}"},{"id":"16e2b820-c956-4ed2-80ce-8ab9d8933158","name":"422 Invalid","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"nf_profile\": {\n \"tax_id\": \"12.345.678/0001-95\",\n \"legal_name\": \"Pizzaria Exemplo LTDA\",\n \"email\": \"steve+fiscal@example.com\",\n \"address\": {\n \"postal_code\": \"01310100\",\n \"street\": \"Avenida Paulista\",\n \"number\": \"1000\",\n \"additional_information\": \"Sala 12\",\n \"district\": \"Bela Vista\",\n \"city_code\": \"3550308\",\n \"city_name\": \"São Paulo\",\n \"state\": \"SP\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.liberpay.com/api/businesses/:business_id/nf_profile","host":["https://api.liberpay.com"],"path":["api","businesses",":business_id","nf_profile"],"variable":[{"key":"business_id","value":"12","description":"The business id. You must be a member of the business."}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"address\": [\n \"missing required fields: city_code, state\"\n ],\n \"email\": [\n \"must be a valid email\"\n ]\n }\n}"}],"_postman_id":"036e00e8-b04a-427d-9723-f448dbe456cc"},{"name":"listInvoices","id":"510ca022-33b5-4f0d-9aa7-92382a31a8ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/businesses/:business_id/nf_invoices","description":"Lists the NFS-e records of the business, newest first. The list has no pages.
\nRequires an API key or a session token.
\nThe business id. You must be a member of the business.
\n","type":"text/plain"},"type":"any","value":"12","key":"business_id"}]}},"response":[{"id":"030a895f-045c-42c9-bbe3-28cd1de1b0ee","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/businesses/:business_id/nf_invoices","host":["https://api.liberpay.com"],"path":["api","businesses",":business_id","nf_invoices"],"variable":[{"key":"business_id","value":"12","description":"The business id. You must be a member of the business."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 7,\n \"nf_invoice_type_id\": 1,\n \"type_label\": \"service\",\n \"nfeio_id\": \"6f1c2a9e3b4d5e6f7a8b9c0d\",\n \"status\": \"issued\",\n \"nfeio_status\": \"Issued\",\n \"amount\": \"52.40\",\n \"description\": \"Prepaid transaction fees - LiberPay\",\n \"number\": \"1043\",\n \"verification_code\": \"AB12CD34\",\n \"pdf_url\": \"https://files.example.com/nfse/1043.pdf\",\n \"xml_url\": \"https://files.example.com/nfse/1043.xml\",\n \"error_message\": null,\n \"inserted_at\": \"2026-10-20T13:15:02\"\n },\n {\n \"id\": 6,\n \"nf_invoice_type_id\": 1,\n \"type_label\": \"service\",\n \"nfeio_id\": null,\n \"status\": \"error\",\n \"nfeio_status\": null,\n \"amount\": \"26.20\",\n \"description\": \"Prepaid transaction fees - LiberPay\",\n \"number\": null,\n \"verification_code\": null,\n \"pdf_url\": null,\n \"xml_url\": null,\n \"error_message\": \"HTTP 400: %{\\\"message\\\" => \\\"invalid borrower\\\"}\",\n \"inserted_at\": \"2026-10-12T10:44:19\"\n }\n ]\n}"}],"_postman_id":"510ca022-33b5-4f0d-9aa7-92382a31a8ba"},{"name":"retryInvoice","id":"131edf35-9bd7-48a9-9cd3-316a0705d2f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.liberpay.com/api/businesses/:business_id/nf_invoices/:invoice_id/retry","description":"Tries again to issue an NFS-e. The API sets the status of the record to pending, clears error_message, and queues a new issue job. Use it for a record with status error.
Requires an API key or a session token.
\nThe business id. You must be a member of the business.
\n","type":"text/plain"},"type":"any","value":"12","key":"business_id"},{"id":"5a1fcf4c-6e0f-4ce7-9147-bd8dd46e7195","description":{"content":"The NF invoice id (data[].id from the list).
Brazil only. Liberpay takes its transaction fees from the fee account of each business. For these fees, Liberpay issues a service nota fiscal (NFS-e) to the business through NFe.io. The API queues one NFS-e when a business recharges its fee account (card or USDC).
\nThe NF profile holds the tax data for the NFS-e: CPF or CNPJ, legal name, email and address. A business without an NF profile gets no NFS-e. A P2P business can use the CPF and legal name of its user instead.
\nEach NFS-e is an NF invoice record. Its status starts as pending. NFe.io then reports issued, cancelled or error.
All calls in this folder need a business member. A business in a country without nota fiscal gets 409 not_applicable.
Finds a user by wallet address. Anyone can call this endpoint.
\nIf the token belongs to the same user, the response has the full record (email, legal name, country, locale). For all other callers, the response has only the public fields: id, address, username and avatar_url.
If no user has this address, the response is 200 with data set to null.
A token is optional. With a token, the response can include more data for that user.
\nThe wallet address of the user (not the numeric user ID). The match ignores letter case. Any linked wallet of the user matches.
\n","type":"text/plain"},"type":"any","value":"0x1111222233334444555566667777888899990000","key":"id"}]}},"response":[{"id":"afd06183-16d9-4f84-936c-5b725ae35fca","name":"200 OK (public)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/users/:id","host":["https://api.liberpay.com"],"path":["api","users",":id"],"variable":[{"key":"id","value":"0x1111222233334444555566667777888899990000","description":"The wallet address of the user (not the numeric user ID). The match ignores letter case. Any linked wallet of the user matches."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 42,\n \"address\": \"0x1111222233334444555566667777888899990000\",\n \"username\": \"stevestore\",\n \"avatar_url\": null\n }\n}"},{"id":"c6491a62-85b2-470a-8414-1292956e0afb","name":"200 OK (own record)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/users/:id","host":["https://api.liberpay.com"],"path":["api","users",":id"],"variable":[{"key":"id","value":"0x1111222233334444555566667777888899990000","description":"The wallet address of the user (not the numeric user ID). The match ignores letter case. Any linked wallet of the user matches."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 42,\n \"address\": \"0x1111222233334444555566667777888899990000\",\n \"username\": \"stevestore\",\n \"email\": \"steve+seller@example.com\",\n \"avatar_url\": null,\n \"legal_name\": \"Steve Example\",\n \"has_government_id\": true,\n \"masked_government_id\": \"***.***.***-12\",\n \"country\": {\n \"id\": 1,\n \"code\": \"BR\",\n \"name\": \"Brazil\"\n },\n \"fiat_currency\": {\n \"id\": 2,\n \"name\": \"Brazilian Real\",\n \"symbol\": \"BRL\",\n \"sign\": \"R$\"\n },\n \"locale\": \"pt_BR\",\n \"user_kyc_enabled\": true\n }\n}"},{"id":"c5fb7002-4e2d-4747-89b0-41563673912f","name":"200 OK (no user)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/users/:id","host":["https://api.liberpay.com"],"path":["api","users",":id"],"variable":[{"key":"id","value":"0x1111222233334444555566667777888899990000","description":"The wallet address of the user (not the numeric user ID). The match ignores letter case. Any linked wallet of the user matches."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null\n}"}],"_postman_id":"3f055d13-2495-4e43-bd59-34b56315d038"},{"name":"search","id":"f18d17db-717b-40d1-a57a-6fdf7f67922e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.liberpay.com/api/users/search?query=steve","description":"Searches all users by username or email. The match is a part of the text and ignores letter case. A leading @ is removed, so @steve finds the username steve.
The query must have 3 or more characters. A shorter query, or no query, gives an empty list. The response has a maximum of 20 users, in username order.
\nThe limit is 30 calls per minute for each IP address.
\nRequires an API key or a session token.
\nThe text to find in the username or email. Minimum 3 characters.
\n","type":"text/plain"},"key":"query","value":"steve"}],"variable":[]}},"response":[{"id":"76022da5-ca3f-4c33-99f7-f75db9cb3db8","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/users/search?query=steve","host":["https://api.liberpay.com"],"path":["api","users","search"],"query":[{"key":"query","value":"steve","description":"The text to find in the username or email. Minimum 3 characters."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"data\": [\n {\n \"id\": 42,\n \"username\": \"stevestore\",\n \"email\": \"steve+seller@example.com\",\n \"address\": \"0x1111222233334444555566667777888899990000\"\n },\n {\n \"id\": 57,\n \"username\": \"steve_buyer\",\n \"email\": \"steve+buyer@example.com\",\n \"address\": null\n }\n ]\n}"},{"id":"d2824524-1528-465b-9751-31dace1a56e1","name":"429 Too Many Requests","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/users/search?query=steve","host":["https://api.liberpay.com"],"path":["api","users","search"],"query":[{"key":"query","value":"steve","description":"The text to find in the username or email. Minimum 3 characters."}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Rate limit reached! Try again in one minute.\"\n}"}],"_postman_id":"f18d17db-717b-40d1-a57a-6fdf7f67922e"}],"id":"cf5450ec-b937-46e9-a44b-cdf207fd56dc","description":"Look up Liberpay users. A user is a person with a Liberpay account. A user can own businesses, stores and gateways, and can receive P2P payments.
\n","_postman_id":"cf5450ec-b937-46e9-a44b-cdf207fd56dc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fb7d9328-d944-41b5-8605-d459ea859701","id":"fb7d9328-d944-41b5-8605-d459ea859701","name":"Liberpay API Docs","type":"collection"}}},{"name":"receipts","item":[{"name":"metadata","id":"9f12c6d5-2fcb-4f07-8848-6772979df20b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.liberpay.com/api/npr/metadata/:shortcode/:tokenId","description":"Returns the ERC-721 metadata of an NFT receipt. The metadata has a name, a description, a link to the receipt page and a link to the receipt image.
\nThe response is not wrapped in data, because wallets expect the standard metadata shape.
No token. This endpoint is public.
\nThe shortcode of the charge that the receipt is for.
\n","type":"text/plain"},"type":"any","value":"73cJltPHglQdnVH","key":"shortcode"},{"id":"4b12a09b-1454-4f81-9bce-0e126b0a55dd","description":{"content":"The token ID of the NFT receipt.
\n","type":"text/plain"},"type":"any","value":"128","key":"tokenId"}]}},"response":[{"id":"238928af-6040-4237-96f2-1c487501f866","name":"200 OK","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/npr/metadata/:shortcode/:tokenId","host":["https://api.liberpay.com"],"path":["api","npr","metadata",":shortcode",":tokenId"],"variable":[{"key":"shortcode","value":"73cJltPHglQdnVH","description":"The shortcode of the charge that the receipt is for."},{"key":"tokenId","value":"128","description":"The token ID of the NFT receipt."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Token #128\",\n \"description\": \"This NFT represents a receipt for a LiberPay transaction. Visit https://app.liberpay.com/charges/73cJltPHglQdnVH/receipt for more information.\",\n \"external_url\": \"https://app.liberpay.com/charges/73cJltPHglQdnVH/receipt\",\n \"type\": \"object\",\n \"image\": \"https://api.liberpay.com/api/npr/metadata/73cJltPHglQdnVH/128/image\"\n}"},{"id":"ad2be350-5cd4-4f62-8f8c-56b3fde971dc","name":"404 Not Found","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/npr/metadata/:shortcode/:tokenId","host":["https://api.liberpay.com"],"path":["api","npr","metadata",":shortcode",":tokenId"],"variable":[{"key":"shortcode","value":"73cJltPHglQdnVH","description":"The shortcode of the charge that the receipt is for."},{"key":"tokenId","value":"128","description":"The token ID of the NFT receipt."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"detail\": \"Not Found\"\n }\n}"}],"_postman_id":"9f12c6d5-2fcb-4f07-8848-6772979df20b"},{"name":"image","id":"345cf7cd-eac5-4a90-8379-8bc7d0b495b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.liberpay.com/api/npr/metadata/:shortcode/:tokenId/image","description":"Returns the image of an NFT receipt. The image is an SVG QR code with the Liberpay logo in the center. The QR code opens the receipt page of the charge.
\nThe response has the content type image/svg+xml.
No token. This endpoint is public.
\nThe shortcode of the charge that the receipt is for.
\n","type":"text/plain"},"type":"any","value":"73cJltPHglQdnVH","key":"shortcode"},{"id":"60504290-2bfb-4fa6-bd7a-e455f8e81c55","description":{"content":"The token ID of the NFT receipt. The API does not use it to make the image.
\n","type":"text/plain"},"type":"any","value":"128","key":"tokenId"}]}},"response":[{"id":"2b4eab46-da51-453e-a65d-23b00c3280d1","name":"200 OK (SVG image)","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/npr/metadata/:shortcode/:tokenId/image","host":["https://api.liberpay.com"],"path":["api","npr","metadata",":shortcode",":tokenId","image"],"variable":[{"key":"shortcode","value":"73cJltPHglQdnVH","description":"The shortcode of the charge that the receipt is for."},{"key":"tokenId","value":"128","description":"The token ID of the NFT receipt. The API does not use it to make the image."}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"822eb584-d7bc-459a-b9c2-8b301ed08985","name":"404 Not Found","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":{"raw":"https://api.liberpay.com/api/npr/metadata/:shortcode/:tokenId/image","host":["https://api.liberpay.com"],"path":["api","npr","metadata",":shortcode",":tokenId","image"],"variable":[{"key":"shortcode","value":"73cJltPHglQdnVH","description":"The shortcode of the charge that the receipt is for."},{"key":"tokenId","value":"128","description":"The token ID of the NFT receipt. The API does not use it to make the image."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"detail\": \"Not Found\"\n }\n}"}],"_postman_id":"345cf7cd-eac5-4a90-8379-8bc7d0b495b8"}],"id":"a6140192-55f4-48b6-af8d-4686dc31e071","description":"Metadata for NFT receipts. After a crypto payment, the buyer can mint an NFT receipt from the Liberpay receipt contract. The tokenURI of each receipt points to these endpoints. Wallets and NFT marketplaces read them. Merchants do not usually call them.
Health check. Returns ok and the code of the server region that answered. Use it to check that the API is up.
No token. This endpoint is public.
\nLists the crypto currencies (tokens) that Liberpay knows. Each currency has its token contract address, its decimals, and its type (the network, for example Polygon).
\nThis response is edge-cached for 5 minutes.
\nNo token. This endpoint is public.
\nLists the fiat currencies (for example BRL and USD). Charges and products use these IDs for their fiat price.
\nThis response is edge-cached for 5 minutes.
\nNo token. This endpoint is public.
\nGives the price of one unit of base in units of currency. For example, currency=BRL&base=USDC gives the number of BRL for 1 USDC.
The price comes from an outside rate provider (Coinbase, then CoinMarketCap). The API keeps each pair for about 60 seconds. When both values are the same, the price is 1.0.
No token. This endpoint is public.
\nThe symbol of the currency to price in, for example BRL.
The symbol of the currency to price, for example USDC.
Lists the enabled countries (markets) and their public settings: language, fiat currency, ID formats, fiscal profile, payment rails, KYC and legal document links.
\nUse gateway_types to see which fiat rails (for example Stripe, PayPal, Woovi) a country offers. Crypto rails are not limited by country.
This response is edge-cached for 5 minutes.
\nNo token. This endpoint is public.
\nTells which country a new signup from this request would get. The response is different for each visitor and is not cached.
\npinned is the country that the Origin of the request sets (for example, a market website). detected is the country that the CDN finds from the visitor's IP address. Each value is null when no rule applies, for example for a server-to-server call.
No token. This endpoint is public.
\nLists the gateway types. A gateway type is a payment rail, for example Polygon (crypto), Stripe, PayPal or Woovi (Pix). Each type belongs to a platform: evm for crypto, fiat for card and bank rails.
This response is edge-cached for 5 minutes.
\nNo token. This endpoint is public.
\nLists the product statuses. Use the id as product_status_id when you create or update a product. Only a Published product shows in the public store catalog.
This response is edge-cached for 5 minutes.
\nNo token. This endpoint is public.
\nRead-only lists that other endpoints refer to by ID: currencies, fiat currencies, countries, gateway types, gateway versions and product statuses. No token is necessary.
\nSome lists are edge-cached. A cached response has the header cache-control: public, max-age=0, s-maxage=300, stale-while-revalidate=600. A change can take up to 5 minutes to show.