{ "info": { "name": "ChargeNation Retail v1", "description": "**Amounts are integer minor units.** 4995 is $49.95. Sending 49.95 is a validation error, not a 49-cent charge.\n\n**Every write needs an `Idempotency-Key` header.** Replaying one returns the original transaction with `Idempotency-Replayed: true` rather than billing again. Postman generates a fresh one per send via `{{$guid}}`.\n\n**Billing the same card again uses `card_token`.** Every sale returns one at `data.card.token`. Quote it as `card_token` and you need nothing else \u2014 no number, no expiry, no address. The card itself stays with us, encrypted; you never hold it. \"Sale (charge now)\" saves the token into a collection variable, so \"Bill a saved card\" and \"Pre-authorise\" work straight afterwards. \"Pre-authorise\" saves its id, so \"Capture the pre-authorisation\" follows on.\n\n**A decline is a 201, not an error.** The transaction was created and the processor answered; read `status` and `approved`. HTTP 4xx means the request itself was wrong.\n\n**The tenant comes from the token.** There is no tenant parameter anywhere.\n\n**A billing address is required when you send a `card_number`.** `email`, `first_name`, `last_name`, `address_line_1`, `city`, `postcode` and `country` \u2014 plus `state` for US, CA and AU. AVS is checked against it, and a sale without one declines more often and settles at a worse rate. Billing with `customer_id` or `payment_method_id` reuses the address already on file, so you do not resend it.\n\nAmounts ending .05 decline, .10 decline for insufficient funds, .30 time out, .51 error. Anything else approves.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "variable": [ { "key": "base_url", "value": "https://gateway.chargenation.io/api/v1" }, { "key": "token", "value": "" }, { "key": "transaction_id", "value": "" }, { "key": "customer_id", "value": "" }, { "key": "card_token", "value": "" }, { "key": "test_card", "value": "4242424242424242" } ], "item": [ { "name": "Billing", "item": [ { "name": "Sale (charge now)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/transactions", "host": [ "{{base_url}}" ], "path": [ "transactions" ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 4995,\n \"currency\": \"USD\",\n \"card_number\": \"{{test_card}}\",\n \"exp_month\": 12,\n \"exp_year\": 2030,\n \"cvv\": \"999\",\n \"email\": \"buyer@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"phone\": \"+1 415 555 0132\",\n \"address_line_1\": \"1 Market Street\",\n \"address_line_2\": \"Suite 400\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postcode\": \"94105\",\n \"country\": \"US\",\n \"external_ref\": \"YOUR-ORDER-1\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "const body = pm.response.json();", "", "if (body.data?.id) { pm.collectionVariables.set('transaction_id', body.data?.id); }", "if (body.data?.customer_id) { pm.collectionVariables.set('customer_id', body.data?.customer_id); }", "if (body.data?.card?.token) { pm.collectionVariables.set('card_token', body.data?.card?.token); }" ] } } ] }, { "name": "Bill a saved card", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/transactions", "host": [ "{{base_url}}" ], "path": [ "transactions" ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 2500,\n \"card_token\": \"{{card_token}}\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Pre-authorise (hold, take later)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/transactions", "host": [ "{{base_url}}" ], "path": [ "transactions" ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 12000,\n \"capture\": false,\n \"card_token\": \"{{card_token}}\",\n \"external_ref\": \"YOUR-ORDER-2\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "const body = pm.response.json();", "", "if (body.data?.id) { pm.collectionVariables.set('authorization_id', body.data?.id); }" ] } } ] }, { "name": "Capture the pre-authorisation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/transactions/{{authorization_id}}/capture", "host": [ "{{base_url}}" ], "path": [ "transactions", "{{authorization_id}}", "capture" ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 11500\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "const body = pm.response.json();", "", "if (body.data?.id) { pm.collectionVariables.set('capture_id', body.data?.id); }" ] } } ] }, { "name": "List transactions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/transactions?status=approved&per_page=25", "host": [ "{{base_url}}" ], "path": [ "transactions" ], "query": [ { "key": "status", "value": "approved" }, { "key": "per_page", "value": "25" } ] } } }, { "name": "Get a transaction", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/transactions/{{transaction_id}}", "host": [ "{{base_url}}" ], "path": [ "transactions", "{{transaction_id}}" ] } } } ] }, { "name": "Reversals", "item": [ { "name": "Refund part", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/transactions/{{transaction_id}}/refund", "host": [ "{{base_url}}" ], "path": [ "transactions", "{{transaction_id}}", "refund" ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 2000\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Refund the rest", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/transactions/{{transaction_id}}/refund", "host": [ "{{base_url}}" ], "path": [ "transactions", "{{transaction_id}}", "refund" ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Void", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/transactions/{{transaction_id}}/void", "host": [ "{{base_url}}" ], "path": [ "transactions", "{{transaction_id}}", "void" ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Refund a capture", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/transactions/{{capture_id}}/refund", "host": [ "{{base_url}}" ], "path": [ "transactions", "{{capture_id}}", "refund" ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 1500\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Customers", "item": [ { "name": "Create a customer", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/customers", "host": [ "{{base_url}}" ], "path": [ "customers" ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"buyer@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"phone\": \"+1 415 555 0132\",\n \"address_line_1\": \"1 Market Street\",\n \"address_line_2\": \"Suite 400\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postcode\": \"94105\",\n \"country\": \"US\",\n \"external_ref\": \"YOUR-CUSTOMER-1\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "const body = pm.response.json();", "", "if (body.data?.id) { pm.collectionVariables.set('customer_id', body.data?.id); }" ] } } ] }, { "name": "List customers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/customers", "host": [ "{{base_url}}" ], "path": [ "customers" ] } } }, { "name": "Get a customer", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/customers/{{customer_id}}", "host": [ "{{base_url}}" ], "path": [ "customers", "{{customer_id}}" ] } } } ] }, { "name": "MIDs", "item": [ { "name": "List MIDs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/mids", "host": [ "{{base_url}}" ], "path": [ "mids" ] } } } ] }, { "name": "Failure cases", "item": [ { "name": "Declined (test card)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/transactions", "host": [ "{{base_url}}" ], "path": [ "transactions" ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 4900,\n \"card_number\": \"4000000000000002\",\n \"exp_month\": 12,\n \"exp_year\": 2030,\n \"email\": \"buyer@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"phone\": \"+1 415 555 0132\",\n \"address_line_1\": \"1 Market Street\",\n \"address_line_2\": \"Suite 400\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postcode\": \"94105\",\n \"country\": \"US\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Insufficient funds (test card)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/transactions", "host": [ "{{base_url}}" ], "path": [ "transactions" ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 4900,\n \"card_number\": \"4000000000009995\",\n \"exp_month\": 12,\n \"exp_year\": 2030,\n \"email\": \"buyer@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"phone\": \"+1 415 555 0132\",\n \"address_line_1\": \"1 Market Street\",\n \"address_line_2\": \"Suite 400\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postcode\": \"94105\",\n \"country\": \"US\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Wrong security code (test card)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/transactions", "host": [ "{{base_url}}" ], "path": [ "transactions" ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 4900,\n \"card_number\": \"4000000000000127\",\n \"exp_month\": 12,\n \"exp_year\": 2030,\n \"cvv\": \"999\",\n \"email\": \"buyer@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"phone\": \"+1 415 555 0132\",\n \"address_line_1\": \"1 Market Street\",\n \"address_line_2\": \"Suite 400\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postcode\": \"94105\",\n \"country\": \"US\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Declined (amount ends .05)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/transactions", "host": [ "{{base_url}}" ], "path": [ "transactions" ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 4905,\n \"card_number\": \"{{test_card}}\",\n \"exp_month\": 12,\n \"exp_year\": 2030,\n \"email\": \"buyer@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"phone\": \"+1 415 555 0132\",\n \"address_line_1\": \"1 Market Street\",\n \"address_line_2\": \"Suite 400\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postcode\": \"94105\",\n \"country\": \"US\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Insufficient funds (.10)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/transactions", "host": [ "{{base_url}}" ], "path": [ "transactions" ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 4910,\n \"card_number\": \"{{test_card}}\",\n \"exp_month\": 12,\n \"exp_year\": 2030,\n \"email\": \"buyer@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"phone\": \"+1 415 555 0132\",\n \"address_line_1\": \"1 Market Street\",\n \"address_line_2\": \"Suite 400\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postcode\": \"94105\",\n \"country\": \"US\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Gateway timeout (.30)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/transactions", "host": [ "{{base_url}}" ], "path": [ "transactions" ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 4930,\n \"card_number\": \"{{test_card}}\",\n \"exp_month\": 12,\n \"exp_year\": 2030,\n \"email\": \"buyer@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"phone\": \"+1 415 555 0132\",\n \"address_line_1\": \"1 Market Street\",\n \"address_line_2\": \"Suite 400\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postcode\": \"94105\",\n \"country\": \"US\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Invalid card number", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/transactions", "host": [ "{{base_url}}" ], "path": [ "transactions" ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 1000,\n \"card_number\": \"4111111111111112\",\n \"exp_month\": 12,\n \"exp_year\": 2030,\n \"email\": \"buyer@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"phone\": \"+1 415 555 0132\",\n \"address_line_1\": \"1 Market Street\",\n \"address_line_2\": \"Suite 400\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postcode\": \"94105\",\n \"country\": \"US\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "No billing address", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/transactions", "host": [ "{{base_url}}" ], "path": [ "transactions" ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 1000,\n \"card_number\": \"{{test_card}}\",\n \"exp_month\": 12,\n \"exp_year\": 2030\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Amount in major units", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/transactions", "host": [ "{{base_url}}" ], "path": [ "transactions" ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 49.95,\n \"card_number\": \"{{test_card}}\",\n \"exp_month\": 12,\n \"exp_year\": 2030,\n \"email\": \"buyer@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"phone\": \"+1 415 555 0132\",\n \"address_line_1\": \"1 Market Street\",\n \"address_line_2\": \"Suite 400\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postcode\": \"94105\",\n \"country\": \"US\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }