{ "info": { "name": "Rapid API", "description": "Requests from the Rapid documentation (https://doc.rapidchargeback.com/en/), generated from the examples on each page.\n\nBefore using it, fill in the collection variables `client_id` and `client_secret` with the credentials from the dashboard. The IDs in the examples are fictitious: replace them with yours.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{client_id}}", "type": "string" }, { "key": "password", "value": "{{client_secret}}", "type": "string" } ] }, "variable": [ { "key": "base_url", "value": "https://api.rapidchargeback.com", "type": "string" }, { "key": "client_id", "value": "", "type": "string" }, { "key": "client_secret", "value": "", "type": "string" } ], "item": [ { "name": "Get started", "item": [ { "name": "First integration · 2. Confirm the credential works", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/chargeback-alert/alerts?per_page=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "chargeback-alert", "alerts" ], "query": [ { "key": "per_page", "value": "1" } ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/primeira-integracao/" } }, { "name": "First integration · 5. Send the first transaction", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/merchants", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "merchants" ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/primeira-integracao/" } }, { "name": "First integration · 5. Send the first transaction (2)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/transactions", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "transactions" ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/primeira-integracao/", "body": { "mode": "raw", "raw": "{\n \"merchant_id\": \"00000000-0000-0000-0000-000000000001\",\n \"external_id\": \"TXN-2026-001\",\n \"transaction_id\": \"cob_8f2a91c4\",\n \"transaction_date\": \"2026-04-01T15:30:00Z\",\n \"amount\": 150.00,\n \"currency\": \"USD\",\n \"card_bin\": \"424242\",\n \"card_last4\": \"4242\",\n \"items\": [\n { \"product_description\": \"Assinatura Premium - Mensal\", \"unit_price\": 150.00 }\n ]\n }", "options": { "raw": { "language": "json" } } } } }, { "name": "First integration · 6. Answer the first alert", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/chargeback-alert/alerts/00000000-0000-0000-0000-000000000099/status", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "chargeback-alert", "alerts", "00000000-0000-0000-0000-000000000099", "status" ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/primeira-integracao/", "body": { "mode": "raw", "raw": "{ \"status\": \"account_suspended\" }", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Integration channels › Merchants", "item": [ { "name": "List merchants · All merchants", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/merchants?per_page=100", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "merchants" ], "query": [ { "key": "per_page", "value": "100" } ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/canais/merchants/listar-merchants/" } }, { "name": "List merchants · By the seller ID in your system", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/merchants?merchant_ref=seller-77", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "merchants" ], "query": [ { "key": "merchant_ref", "value": "seller-77" } ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/canais/merchants/listar-merchants/" } } ] }, { "name": "Integration channels › Transactions", "item": [ { "name": "Create transaction · Request example", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/transactions", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "transactions" ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/canais/transactions/criar-transacao/", "body": { "mode": "raw", "raw": "{\n \"merchant_id\": \"00000000-0000-0000-0000-000000000001\",\n \"external_source\": \"shopify\",\n \"external_id\": \"TXN-2026-001\",\n \"transaction_date\": \"2026-04-01T15:30:00Z\",\n \"amount\": 150.00,\n \"currency\": \"USD\",\n \"card_last4\": \"4242\",\n \"card_bin\": \"424242\",\n \"order_number\": \"ORD-001\",\n \"auth_code\": \"AUTH999\",\n \"network\": \"visa\",\n \"descriptor\": \"LOJA EXEMPLO\",\n \"ip_address\": \"203.0.113.10\",\n \"items\": [\n {\n \"product_description\": \"Assinatura Premium - Mensal\",\n \"product_name\": \"Plano Premium\",\n \"quantity\": 1,\n \"unit_price\": 150.00\n }\n ],\n \"customer\": {\n \"first_name\": \"João\",\n \"last_name\": \"Silva\",\n \"email\": \"joao@exemplo.com\"\n },\n \"addresses\": [\n {\n \"type\": \"shipping\",\n \"street\": \"Rua das Flores\",\n \"number\": \"123\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"postal_code\": \"01001000\",\n \"country\": \"BRA\"\n }\n ]\n }", "options": { "raw": { "language": "json" } } } } }, { "name": "Batch upload · Request example", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/transactions/batch", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "transactions", "batch" ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/canais/transactions/envio-em-lote/", "body": { "mode": "raw", "raw": "{\n \"transactions\": [\n {\n \"merchant_id\": \"00000000-0000-0000-0000-000000000001\",\n \"external_source\": \"custom\",\n \"external_id\": \"TXN-2026-001\",\n \"transaction_date\": \"2026-04-01T10:00:00Z\",\n \"amount\": 150.00,\n \"currency\": \"USD\",\n \"card_last4\": \"4242\",\n \"items\": [{ \"product_description\": \"Item A\", \"unit_price\": 150.00 }]\n },\n {\n \"merchant_id\": \"00000000-0000-0000-0000-000000000001\",\n \"external_source\": \"custom\",\n \"external_id\": \"TXN-2026-002\",\n \"transaction_date\": \"2026-04-01T11:00:00Z\",\n \"amount\": 200.00,\n \"currency\": \"BRL\",\n \"card_last4\": \"1234\",\n \"items\": [{ \"product_description\": \"Item B\", \"unit_price\": 200.00 }]\n }\n ]\n }", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieve transaction · Request example", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/transactions/00000000-0000-0000-0000-000000000042", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "transactions", "00000000-0000-0000-0000-000000000042" ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/canais/transactions/consultar-transacao/" } }, { "name": "Retrieve transaction · Example", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/transactions?external_source=shopify&external_id=TXN-2026-001", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "transactions" ], "query": [ { "key": "external_source", "value": "shopify" }, { "key": "external_id", "value": "TXN-2026-001" } ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/canais/transactions/consultar-transacao/" } }, { "name": "Update transaction · Update only the ARN and auth_code", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/transactions/00000000-0000-0000-0000-000000000042", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "transactions", "00000000-0000-0000-0000-000000000042" ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/canais/transactions/atualizar-transacao/", "body": { "mode": "raw", "raw": "{\n \"arn\": \"74537119547024600128228\",\n \"auth_code\": \"AUTH999\"\n }", "options": { "raw": { "language": "json" } } } } }, { "name": "Update transaction · Update items (replaces all existing items)", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/transactions/00000000-0000-0000-0000-000000000042", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "transactions", "00000000-0000-0000-0000-000000000042" ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/canais/transactions/atualizar-transacao/", "body": { "mode": "raw", "raw": "{\n \"amount\": 300.00,\n \"items\": [\n { \"product_description\": \"Plano Premium\", \"unit_price\": 150.00 },\n { \"product_description\": \"Taxa de Setup\", \"unit_price\": 150.00 }\n ]\n }", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete transaction · Request example", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v1/transactions/00000000-0000-0000-0000-000000000042", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "transactions", "00000000-0000-0000-0000-000000000042" ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/canais/transactions/deletar-transacao/" } } ] }, { "name": "Integration channels › Capture", "item": [ { "name": "Send an event from the browser · Request example", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/capture/your_publishable_token/events", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "capture", "your_publishable_token", "events" ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/canais/capture/enviar-evento-navegador/", "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"type\": \"terms_acceptance\",\n \"order_ref\": \"TXN-2026-001\",\n \"event_id\": \"019b0000-1111-7000-8000-000000000001\",\n \"payload\": { \"url\": \"https://loja.exemplo.com/checkout\" }\n }", "options": { "raw": { "language": "json" } } } } }, { "name": "Send an event from the browser · Request example (2)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/capture/your_publishable_token/events", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "capture", "your_publishable_token", "events" ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/canais/capture/enviar-evento-navegador/", "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"type\": \"checkout\",\n \"order_ref\": \"TXN-2026-001\",\n \"event_id\": \"019b0000-1111-7000-8000-000000000002\",\n \"payload\": {\n \"device_id\": \"8kJ2mQvR1nZxYb0T\",\n \"device_fingerprint\": \"8kJ2mQvR1nZxYb0T\",\n \"fp\": \"pro\",\n \"fp_request_id\": \"1712059781234.Xk9Lp2\"\n }\n }", "options": { "raw": { "language": "json" } } } } }, { "name": "Send an event from the server · Request example", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/capture/events", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "capture", "events" ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/canais/capture/enviar-evento-servidor/", "body": { "mode": "raw", "raw": "{\n \"merchant_id\": \"00000000-0000-0000-0000-000000000001\",\n \"type\": \"delivery_confirmation\",\n \"order_ref\": \"TXN-2026-001\",\n \"event_id\": \"entrega-TXN-2026-001\",\n \"payload\": { \"carrier\": \"correios\", \"tracking\": \"AA123456789BR\" },\n \"captured_at\": \"2026-04-03T11:20:00Z\"\n }", "options": { "raw": { "language": "json" } } } } }, { "name": "Send an event from the server · Request example (2)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/capture/events", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "capture", "events" ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/canais/capture/enviar-evento-servidor/", "body": { "mode": "raw", "raw": "{\n \"merchant_id\": \"00000000-0000-0000-0000-000000000001\",\n \"type\": \"delivery_gps\",\n \"order_ref\": \"TXN-2026-001\",\n \"event_id\": \"gps-TXN-2026-001\",\n \"payload\": { \"lat\": -23.5614, \"lng\": -46.6559 },\n \"captured_at\": \"2026-04-03T11:20:00Z\"\n }", "options": { "raw": { "language": "json" } } } } }, { "name": "Snippet configuration · Request example", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/capture/your_publishable_token/config", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "capture", "your_publishable_token", "config" ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/canais/capture/config-do-snippet/", "auth": { "type": "noauth" } } } ] }, { "name": "Integration channels › Evidence", "item": [ { "name": "Record evidence · Request example", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/evidence", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "evidence" ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/canais/evidence/registrar-evidencia/", "body": { "mode": "raw", "raw": "{\n \"transaction_id\": \"00000000-0000-0000-0000-000000000042\",\n \"type\": \"terms_acceptance\",\n \"payload\": {\n \"accepted_at\": \"2026-04-01T15:29:40Z\",\n \"terms_version\": \"v3.2\",\n \"ip\": \"203.0.113.10\"\n },\n \"captured_at\": \"2026-04-01T15:29:41Z\"\n }", "options": { "raw": { "language": "json" } } } } }, { "name": "Record evidence · Request example (2)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/evidence", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "evidence" ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/canais/evidence/registrar-evidencia/", "body": { "mode": "raw", "raw": "{\n \"transaction_ref\": { \"external_source\": \"shopify\", \"external_id\": \"TXN-2026-001\" },\n \"type\": \"access_log\",\n \"payload\": { \"first_access_at\": \"2026-04-01T16:02:11Z\", \"sessions\": 3 },\n \"captured_at\": \"2026-04-01T16:02:12Z\"\n }", "options": { "raw": { "language": "json" } } } } }, { "name": "List evidence · Request example", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/evidence?transaction_id=00000000-0000-0000-0000-000000000042", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "evidence" ], "query": [ { "key": "transaction_id", "value": "00000000-0000-0000-0000-000000000042" } ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/canais/evidence/consultar-evidencias/" } } ] }, { "name": "Status callback", "item": [ { "name": "Update status · Request example", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/chargeback-alert/alerts/00000000-0000-0000-0000-000000000099/status", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "chargeback-alert", "alerts", "00000000-0000-0000-0000-000000000099", "status" ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/callback/atualizar-status/", "body": { "mode": "raw", "raw": "{\n \"status\": \"account_suspended\"\n }", "options": { "raw": { "language": "json" } } } } }, { "name": "List alerts · Search by your own ID (the provider's)", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/chargeback-alert/alerts?provider_alert_id=ALERT-ETHOCA-12345", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "chargeback-alert", "alerts" ], "query": [ { "key": "provider_alert_id", "value": "ALERT-ETHOCA-12345" } ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/callback/consultar-alertas/" } }, { "name": "List alerts · List the latest pending alerts", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/chargeback-alert/alerts?status=pending&per_page=50", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "chargeback-alert", "alerts" ], "query": [ { "key": "status", "value": "pending" }, { "key": "per_page", "value": "50" } ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/callback/consultar-alertas/" } }, { "name": "List alerts · Alerts from the last 7 days", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/chargeback-alert/alerts?date_from=2026-04-16&date_to=2026-04-23", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "chargeback-alert", "alerts" ], "query": [ { "key": "date_from", "value": "2026-04-16" }, { "key": "date_to", "value": "2026-04-23" } ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/callback/consultar-alertas/" } }, { "name": "List alerts · Search by card (BIN + last digits)", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v1/chargeback-alert/alerts?card_bin=424242&card_last4=4242", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "chargeback-alert", "alerts" ], "query": [ { "key": "card_bin", "value": "424242" }, { "key": "card_last4", "value": "4242" } ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/callback/consultar-alertas/" } }, { "name": "List alerts · Example", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/chargeback-alert/get", "host": [ "{{base_url}}" ], "path": [ "chargeback-alert", "get" ] }, "description": "Documentation: https://doc.rapidchargeback.com/en/callback/consultar-alertas/", "body": { "mode": "raw", "raw": "{ \"alert_id\": \"ETH-99887766\" }", "options": { "raw": { "language": "json" } } } } } ] } ] }