To get a foreseeable and resource-oriented function call we have implemented our API with REST. All response objects will be delivered as JSON objects.
\nFor an easy switch from test to live mode the gateway supports test keys and live keys. The test key works in the exact same way as the live key, but doesn't do live credit card transactions. You can always use the test key even if you have activated the live key for your staging server.
\nThe request format, which is required for operations with a request body. The syntax is:
\nContent-Type: application/json\nAuthentication to the API occurs via HTTP Basic Auth. \nPass the credentials as a Base64-encoded header or as parameters in an HTTP client.
\nThe credentials must be Base64-encoded. The following is an example of an encoded HTTP Basic Authentication header:
\nAuthorization: Basic dGVzdF9yNnIxNGl6c3JlYms2c255b3kxajZoYnpqejF4Ym8w\nThe credentials are defined per websites. To get your credentials:
\nThe conventional HTTP response codes are used to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with the gateway's servers (these are rare).
\n{\n \"errors\": [\n {\n \"errorType\": \"invalidRequest\",\n \"code\": \"validationError\",\n \"parameter\": \"Amount\",\n \"message\": \"Amount must be greater than 0\"\n }\n ]\n}\nTo create card recurring transactions merchant has to set the \"Recurring\" transaction to 'true' on the transaction request. A merchant should provide the identifier of the first recurring transaction in the series to create a subsequent transaction.
\nThe recurring transactions could be initiated by Customers (Customer initiated transaction - CIT) or initiated by a merchant (Merchant initiated transaction - MIT).
\nFor the subsequest recurring transactions, the cardholder or merchant will not have to provide card details, CVV2/CVC2/CAV2 (Secure code), or pass 3-D Secure again.
\n","_postman_id":"4af512a4-27dc-464c-bc17-ebd2733654af"},{"name":"Sources","item":[{"name":"Create Card source","id":"9eabcdb4-9c96-4b05-8d58-e6cc9887716f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{API_KEY}}"},{"key":"password","value":"{{API_SECRET}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Request-Id","type":"text","value":"24412d74-d5db-4e96-9476-ebde3da1f6ad"},{"key":"","type":"text","value":""}],"body":{"mode":"raw","raw":"{\n \"paymentMethod\": \"VISA\",\n \"holder\": \"Pat Beatty\",\n \"cardNumber\":\"4000000000000002\",\n \"expiryMonth\": 5,\n \"expiryYear\": 21,\n \"cvc\": \"123\",\n \"billingAddress\": {\n \"streetAddress\":\"StreetAddress\",\n \"city\": \"Boston\",\n \"postcode\":\"01010\",\n \"country\":\"US\"\n }\n}"},"url":"{{GATEWAY_API_URL}}/v1/sources/","urlObject":{"path":["v1","sources",""],"host":["{{GATEWAY_API_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9eabcdb4-9c96-4b05-8d58-e6cc9887716f"}],"id":"288d001b-1d66-432a-9a95-3620a7dd3000","description":"Create a payment source object for a customer that you can use for one or more payments. The payment source data is saved in the secure data vault and can be used for later payments.
\nPlease, check Transactions -> Create transaction with existing payment source.
\nCreating a transaction using an existing source is very similar to Recurring, but the difference is that in this case each transaction is made with Cardholder presence and requires CVV2/CVC2/CAV2 (Secure code) and 3-D Secure if available. The cardholder will not have to enter card details again, only CVV2/CVC2/CAV2 (Secure code) and pass 3-D Secure if needed.
\n","_postman_id":"288d001b-1d66-432a-9a95-3620a7dd3000"},{"name":"Customers","item":[{"name":"Create customer","id":"ac0cd0f8-4126-47db-96fa-ed5b330df3e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{API_KEY}}"},{"key":"password","value":"{{API_SECRET}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Request-Id","type":"text","value":"be385a40-b3b7-4653-a0a1-8b1a1b964f87"},{"key":"","type":"text","value":""}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Mustafa\",\n \"lastName\": \"Labadie\",\n \"email\": \"john2@doe.com\",\n \"phone\": \"+234323423\",\n \"accountReference\":\"acc0002\",\n \"category\": \"gaming\",\n \"address\": {\n \"streetAddress\":\"StreetAddress\",\n \"city\": \"Boston\",\n \"postcode\":\"01010\",\n \"country\":\"US\"\n }\n}"},"url":"{{GATEWAY_API_URL}}/v1/customers/","description":"Create and store the customer object to reuse it for later payments.
\n","_postman_id":"5e2a5af5-ee00-4f61-8fa3-cfb8df052259"},{"name":"Refunds","item":[{"name":"Create Refund request","id":"cc015032-99ea-479b-be6b-d43e554d8c73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{API_KEY}}"},{"key":"password","value":"{{API_SECRET}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"amount\":1.55,\r\n \"currency\": \"GBP\",\r\n \"reason\": \"becouse of\",\r\n \"reference\": \"ORD-2354234\"\r\n}"},"url":"{{GATEWAY_API_URL}}/v1/transactions/{{transactionId}}/refunds","urlObject":{"path":["v1","transactions","{{transactionId}}","refunds"],"host":["{{GATEWAY_API_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cc015032-99ea-479b-be6b-d43e554d8c73"}],"id":"c7fd0406-c4d6-4077-93bd-c34902c76486","_postman_id":"c7fd0406-c4d6-4077-93bd-c34902c76486","description":""},{"name":"Reversals","item":[{"name":"Create Reversal","id":"b7cd0cd7-51e3-457f-b77b-980d3a2ec45c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{API_KEY}}"},{"key":"password","value":"{{API_SECRET}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"reason\": \"becouse of\",\r\n \"reference\": \"ORD-2354234\"\r\n}"},"url":"{{GATEWAY_API_URL}}/v1/transactions/{{transactionId}}/reversals","urlObject":{"path":["v1","transactions","{{transactionId}}","reversals"],"host":["{{GATEWAY_API_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b7cd0cd7-51e3-457f-b77b-980d3a2ec45c"}],"id":"24688a9e-c79e-4554-bfc7-e2b7aa1aa842","_postman_id":"24688a9e-c79e-4554-bfc7-e2b7aa1aa842","description":""},{"name":"Payouts","item":[{"name":"Direct Payouts","item":[{"name":"Create PayTM Payout Direct","id":"d9812d3f-9512-4318-bc46-a400b275693d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{API_KEY}}"},{"key":"password","value":"{{API_SECRET}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"amount\":195,\r\n\t\"currency\":\"INR\",\r\n\t\"recipient\":{\r\n \"firstName\": \"Garry\",\r\n\t\t\"lastName\": \"Auer\",\r\n\t\t\"email\": \"Willy.Carter@hotmail.com\",\r\n\t\t\"phone\": \"506-271-0892\",\r\n\t\t\"accountReference\":\"acc-0007\",\r\n \"category\": \"gaming\"\r\n\t},\r\n\t\"destination\":{\r\n\t\t\"paymentMethod\": \"PAYTM\",\r\n \"walletnumber\":\"3737462123\",\r\n \"walletname\":\"My walletX\"\r\n\t},\r\n\t\"statementDescriptor\":\"Purchase my-shop.com\",\r\n\t\"description\":\"T-Shirt XXL\",\r\n\t\"reference\":\"ORD24234\",\r\n\t\"ipAddress\":\"43.248.24.130\",\r\n \"userDefinedField1\": \"blah1\",\r\n \"userDefinedField2\": \"blah2\",\r\n \"userDefinedField3\": \"blah3\"\r\n}"},"url":"{{GATEWAY_API_URL}}/v1/payouts","urlObject":{"path":["v1","payouts"],"host":["{{GATEWAY_API_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d9812d3f-9512-4318-bc46-a400b275693d"},{"name":"Create UPI Payout Direct","id":"bd132618-e71f-40f0-92ab-c5cb9c19d6c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{API_KEY}}"},{"key":"password","value":"{{API_SECRET}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"amount\":50,\r\n\t\"currency\":\"INR\",\r\n\t\"recipient\":{\r\n\t\t\"firstName\": \"Francisco\",\r\n\t\t\"lastName\": \"Hartmann\",\r\n\t\t\"email\": \"Joshuah.Gottlieb41@hotmail.com\",\r\n\t\t\"phone\": \"494-325-2345\",\r\n\t\t\"accountReference\":\"acc-0007\",\r\n \"category\": \"gaming\"\r\n\t},\r\n\t\"destination\":{\r\n\t\t\"paymentMethod\": \"UPI\",\r\n\t\t\"bankAccountNumber\":\"85131429\",\r\n \"bankAccountHolder\": \"Anahi Walsh\",\r\n \"ifscCode\":\"01022\",\r\n \"bankName\":\"Wells Fargo\"\r\n\t},\r\n\t\"statementDescriptor\":\"Purchase my-shop.com\",\r\n\t\"description\":\"Reward for good grades\",\r\n\t\"reference\":\"ORD24234\",\r\n\t\"ipAddress\":\"43.248.24.130\",\r\n \"userDefinedField1\": \"blah1\",\r\n \"userDefinedField2\": \"blah2\",\r\n \"userDefinedField3\": \"blah3\"\r\n}"},"url":"{{GATEWAY_API_URL}}/v1/payouts","urlObject":{"path":["v1","payouts"],"host":["{{GATEWAY_API_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bd132618-e71f-40f0-92ab-c5cb9c19d6c8"},{"name":"Create IMPS Payout Direct","id":"acd6a535-65af-4cd5-b3a0-52c2e7960aee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{API_KEY}}"},{"key":"password","value":"{{API_SECRET}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"amount\":50,\r\n\t\"currency\":\"INR\",\r\n\t\"recipient\":{\r\n\t\t\"firstName\": \"Brody\",\r\n\t\t\"lastName\": \"Mohr\",\r\n\t\t\"email\": \"Nathaniel.Zieme69@yahoo.com\",\r\n\t\t\"phone\": \"753-685-0056\",\r\n\t\t\"accountReference\":\"acc-0007\",\r\n \"category\": \"gaming\"\r\n\t},\r\n\t\"destination\":{\r\n\t\t\"paymentMethod\": \"IMPS\",\r\n\t\t\"bankAccountNumber\":\"16366029\",\r\n \"bankAccountHolder\": \"Devyn Orn\",\r\n \"ifscCode\":\"01022\",\r\n \"bankName\":\"Wells Fargo\"\r\n\t},\r\n\t\"statementDescriptor\":\"Purchase my-shop.com\",\r\n\t\"description\":\"Reward for good grades\",\r\n\t\"reference\":\"ORD24234\",\r\n\t\"ipAddress\":\"43.248.24.130\",\r\n \"userDefinedField1\": \"blah1\",\r\n \"userDefinedField2\": \"blah2\",\r\n \"userDefinedField3\": \"blah3\"\r\n}"},"url":"{{GATEWAY_API_URL}}/v1/payouts","urlObject":{"path":["v1","payouts"],"host":["{{GATEWAY_API_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"acd6a535-65af-4cd5-b3a0-52c2e7960aee"},{"name":"Create Direct Credit Nigeria","id":"7139d14f-0397-4703-a99c-05ec08586ed0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{API_KEY}}"},{"key":"password","value":"{{API_SECRET}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"amount\":20,\r\n\t\"currency\":\"NGN\",\r\n\t\"recipient\":{\r\n\t\t\"firstName\": \"Ahmed\",\r\n\t\t\"lastName\": \"Bogan\",\r\n\t\t\"email\": \"Caroline.OHara@yahoo.com\",\r\n\t\t\"phone\": \"515-963-5739\",\r\n\t\t\"accountReference\":\"acc-0007\",\r\n \"category\": \"gaming\"\r\n\t},\r\n\t\"destination\":{\r\n\t\t\"paymentMethod\": \"DIRECTCREDIT\",\r\n\t\t\"accountHolderName\": \"Chesley Bode\",\r\n \"accountNumber\":\"58121238\",\r\n \"bankCode\":\"34565\"\r\n\t},\r\n\t\"statementDescriptor\":\"Purchase my-shop.com\",\r\n\t\"description\":\"Reward for good grades\",\r\n\t\"reference\":\"ORD24234\",\r\n\t\"ipAddress\":\"43.248.24.130\",\r\n \"userDefinedField1\": \"blah1\",\r\n \"userDefinedField2\": \"blah2\",\r\n \"userDefinedField3\": \"blah3\"\r\n}"},"url":"{{GATEWAY_API_URL}}/v1/payouts","urlObject":{"path":["v1","payouts"],"host":["{{GATEWAY_API_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7139d14f-0397-4703-a99c-05ec08586ed0"},{"name":"Create VISA Direct Payout Canada","id":"21f4fd1c-06a4-4aa6-a9f1-0073eebdb7dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{API_KEY}}"},{"key":"password","value":"{{API_SECRET}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"amount\":50,\r\n\t\"currency\":\"CAD\",\r\n\t\"recipient\":{\r\n\t\t\"firstName\": \"Eriberto\",\r\n\t\t\"lastName\": \"Johns\",\r\n\t\t\"email\": \"Mandy.Murazik@hotmail.com\",\r\n\t\t\"phone\": \"+14034881071\",\r\n\t\t\"accountReference\":\"acc-0007\",\r\n \"category\": \"gaming\"\r\n\t},\r\n\t\"destination\":{\r\n\t\t\"paymentMethod\": \"VISADIRECT\",\r\n\t\t\"holder\": \"Emilio Johns\",\r\n\t\t\"cardNumber\":\"5531 8866 5214 2950\",\r\n\t\t\"expiryMonth\": 1,\r\n\t\t\"expiryYear\": 23,\r\n\t\t\"cvc\": \"003\",\r\n\t\t\"billingAddress\": {\r\n\t\t\t\"streetAddress\":\"Street Address\",\r\n\t\t\t\"city\": \"Toronto\",\r\n\t\t\t\"postcode\":\"01010\",\r\n\t\t\t\"country\":\"CA\",\r\n \"state\": \"AB\"\r\n\t\t}\r\n\t},\r\n\t\"statementDescriptor\":\"Purchase my-shop.com\",\r\n\t\"description\":\"Reward for good grades\",\r\n\t\"reference\":\"ORD24234\",\r\n\t\"ipAddress\":\"43.248.24.130\",\r\n \"userDefinedField1\": \"blah1\",\r\n \"userDefinedField2\": \"blah2\",\r\n \"userDefinedField3\": \"blah3\"\r\n}"},"url":"{{GATEWAY_API_URL}}/v1/payouts","urlObject":{"path":["v1","payouts"],"host":["{{GATEWAY_API_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"21f4fd1c-06a4-4aa6-a9f1-0073eebdb7dc"},{"name":"Create MasterCard Send Payout Canada","id":"a7878672-06e0-41bd-b7ed-4a2008514582","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{API_KEY}}"},{"key":"password","value":"{{API_SECRET}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"amount\":50,\r\n\t\"currency\":\"CAD\",\r\n\t\"recipient\":{\r\n\t\t\"firstName\": \"Jerrod\",\r\n\t\t\"lastName\": \"Weimann\",\r\n\t\t\"email\": \"Mattie_Stoltenberg15@hotmail.com\",\r\n\t\t\"phone\": \"+14034881071\",\r\n\t\t\"accountReference\":\"acc-0007\",\r\n \"category\": \"gaming\"\r\n\t},\r\n\t\"destination\":{\r\n\t\t\"paymentMethod\": \"MASTERCARDSEND\",\r\n\t\t\"holder\": \"Deanna Kiehn\",\r\n\t\t\"cardNumber\":\"5531 8866 5214 2950\",\r\n\t\t\"expiryMonth\": 1,\r\n\t\t\"expiryYear\": 23,\r\n\t\t\"cvc\": \"003\",\r\n\t\t\"billingAddress\": {\r\n\t\t\t\"streetAddress\":\"Street Address\",\r\n\t\t\t\"city\": \"Toronto\",\r\n\t\t\t\"postcode\":\"01010\",\r\n\t\t\t\"country\":\"CA\",\r\n \"state\": \"AB\"\r\n\t\t}\r\n\t},\r\n\t\"statementDescriptor\":\"Purchase my-shop.com\",\r\n\t\"description\":\"Reward for good grades\",\r\n\t\"reference\":\"ORD24234\",\r\n\t\"ipAddress\":\"43.248.24.130\",\r\n \"userDefinedField1\": \"blah1\",\r\n \"userDefinedField2\": \"blah2\",\r\n \"userDefinedField3\": \"blah3\"\r\n}"},"url":"{{GATEWAY_API_URL}}/v1/payouts","urlObject":{"path":["v1","payouts"],"host":["{{GATEWAY_API_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a7878672-06e0-41bd-b7ed-4a2008514582"},{"name":"Create Direct Credit Payout Canada","id":"6e94bc19-b033-44ad-b688-2ae692395f24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{API_KEY}}"},{"key":"password","value":"{{API_SECRET}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"amount\":50,\r\n\t\"currency\":\"CAD\",\r\n\t\"recipient\":{\r\n\t\t\"firstName\": \"Bill\",\r\n\t\t\"lastName\": \"Haag\",\r\n\t\t\"email\": \"Easter.OKeefe60@yahoo.com\",\r\n\t\t\"phone\": \"+14034881071\",\r\n\t\t\"accountReference\":\"acc-0007\",\r\n \"category\": \"gaming\"\r\n\t},\r\n\t\"destination\":{\r\n\t\t\"paymentMethod\": \"DIRECTCREDIT\",\r\n\t\t\"accountHolderName\": \"Mireille Kshlerin\",\r\n\t\t\"accountNumber\":\"123456789\",\r\n\t\t\"bankCode\": \"123\",\r\n\t\t\"transitNumber\": \"12345\",\r\n\t\t\"billingAddress\": {\r\n\t\t\t\"streetAddress\":\"Street Address\",\r\n\t\t\t\"city\": \"Toronto\",\r\n\t\t\t\"postcode\":\"01010\",\r\n\t\t\t\"country\":\"CA\",\r\n \"state\": \"AB\"\r\n\t\t}\r\n\t},\r\n\t\"statementDescriptor\":\"Purchase my-shop.com\",\r\n\t\"description\":\"Reward for good grades\",\r\n\t\"reference\":\"ORD24234\",\r\n\t\"ipAddress\":\"43.248.24.130\",\r\n \"userDefinedField1\": \"blah1\",\r\n \"userDefinedField2\": \"blah2\",\r\n \"userDefinedField3\": \"blah3\"\r\n}"},"url":"{{GATEWAY_API_URL}}/v1/payouts","urlObject":{"path":["v1","payouts"],"host":["{{GATEWAY_API_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6e94bc19-b033-44ad-b688-2ae692395f24"},{"name":"Create Direct Credit Payout Argentina","id":"b7bbc970-bc69-4b48-a22d-76e9f48143de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{API_KEY}}"},{"key":"password","value":"{{API_SECRET}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"amount\": 20,\r\n \"currency\": \"ARS\",\r\n \"recipient\": {\r\n \"firstName\": \"Myra\",\r\n \"lastName\": \"Schimmel\",\r\n \"email\": \"Harrison_Herzog64@gmail.com\",\r\n \"phone\": \"655-970-2288\",\r\n \"accountReference\": \"acc-0007\",\r\n \"category\": \"gaming\"\r\n },\r\n \"destination\": {\r\n \"paymentMethod\": \"DIRECTCREDIT\",\r\n \"accountNumber\": \"1234567891\",\r\n \"accountHolder\": \"Stevie Hermiston\",\r\n \"bankName\": \"CITIBANK N.A.\",\r\n \"country\": \"AR\",\r\n \"documentType\": \"2\",\r\n \"documentNumber\": \"123456789\",\r\n \"accountType\": \"1\"\r\n },\r\n \"statementDescriptor\": \"Purchase my-shop.com\",\r\n \"description\": \"Reward for good grades\",\r\n \"reference\": \"ORD24234\",\r\n \"ipAddress\": \"43.248.24.130\",\r\n \"userDefinedField1\": \"blah1\",\r\n \"userDefinedField2\": \"blah2\",\r\n \"userDefinedField3\": \"blah3\"\r\n}"},"url":"{{GATEWAY_API_URL}}/v1/payouts","urlObject":{"path":["v1","payouts"],"host":["{{GATEWAY_API_URL}}"],"query":[],"variable":[]}},"response":[{"id":"259b82a8-24f3-4374-b8f0-5963c5b2652c","name":"Response Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"po_8gt7j6fnvp\",\r\n \"status\": \"Pending\",\r\n \"amount\": 20,\r\n \"currency\": \"ARS\",\r\n \"created\": \"2022-11-23T16:07:23.1363983Z\",\r\n \"links\": []\r\n}","options":{"raw":{"language":"json"}}},"url":"{{GATEWAY_API_URL}}/v1/payouts"},"status":"Created","code":201,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b7bbc970-bc69-4b48-a22d-76e9f48143de"},{"name":"Create E-Transfer Payout Canada","event":[{"listen":"test","script":{"exec":["pm.globals.set(\"transactionId\", pm.response.json().id);"],"type":"text/javascript","id":"e50445c1-c2a3-426e-808f-cbb2db2c689e"}}],"id":"e6c888e7-266d-4c06-ad87-554ce98e621b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{API_KEY}}"},{"key":"password","value":"{{API_SECRET}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"amount\":50,\r\n\t\"currency\":\"CAD\",\r\n\t\"recipient\":{\r\n\t\t\"firstName\": \"Marilie\",\r\n\t\t\"lastName\": \"Howell\",\r\n\t\t\"email\": \"Verla.McClure84@yahoo.com\",\r\n\t\t\"phone\": \"+14034881071\",\r\n\t\t\"accountReference\":\"acc-0007\",\r\n \"category\": \"gaming\"\r\n\t},\r\n\t\"destination\":{\r\n\t\t\"paymentMethod\": \"ETRANSFER\",\r\n\t\t\"billingAddress\": {\r\n\t\t\t\"streetAddress\":\"Street Address\",\r\n\t\t\t\"city\": \"Toronto\",\r\n\t\t\t\"postcode\":\"01010\",\r\n\t\t\t\"country\":\"CA\",\r\n \"state\": \"AB\"\r\n\t\t}\r\n\t},\r\n\t\"statementDescriptor\":\"Purchase my-shop.com\",\r\n\t\"description\":\"Reward for good grades\",\r\n\t\"reference\":\"ORD24234\",\r\n\t\"ipAddress\":\"43.248.24.130\",\r\n \"userDefinedField1\": \"blah1\",\r\n \"userDefinedField2\": \"blah2\",\r\n \"userDefinedField3\": \"blah3\",\r\n\t\"successUrl\":\"https://demo.turnstiles.io/home/success\",\r\n\t\"cancelUrl\":\"https://demo.turnstiles.io\",\r\n\t\"failureUrl\":\"https://demo.turnstiles.io/home/cancel\"\r\n}"},"url":"{{GATEWAY_API_URL}}/v1/payouts","urlObject":{"path":["v1","payouts"],"host":["{{GATEWAY_API_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e6c888e7-266d-4c06-ad87-554ce98e621b"},{"name":"Create TigerPay Payout","event":[{"listen":"test","script":{"exec":["pm.globals.set(\"transactionId\", pm.response.json().id);"],"type":"text/javascript","id":"5a18a4e6-c653-4380-b8fa-ad9f5163153c"}}],"id":"932849f3-3d14-4218-a9fb-09de001d113b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{API_KEY}}"},{"key":"password","value":"{{API_SECRET}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"amount\":1000,\r\n\t\"currency\":\"USD\",\r\n\t\"recipient\":{\r\n \"firstName\": \"Peter\",\r\n\t\t\"lastName\": \"Trantow\",\r\n\t\t\"email\": \"Rosario_Crist93@yahoo.com\",\r\n\t\t\"phone\": \"494-583-6815\",\r\n\t\t\"accountReference\":\"0003\",\r\n \"category\": \"gaming\"\r\n\t},\r\n\t\"destination\":{\r\n\t\t\"paymentMethod\": \"TIGERPAY\"\r\n\t},\r\n\t\"statementDescriptor\":\"Purchase my-shop.com\",\r\n\t\"description\":\"T-Shirt XXL\",\r\n\t\"reference\":\"ORD24234\",\r\n\t\"ipAddress\":\"43.248.24.130\",\r\n \"userDefinedField1\": \"blah1\",\r\n \"userDefinedField2\": \"blah2\",\r\n \"userDefinedField3\": \"blah3\"\r\n}"},"url":"{{GATEWAY_API_URL}}/v1/payouts","urlObject":{"path":["v1","payouts"],"host":["{{GATEWAY_API_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"932849f3-3d14-4218-a9fb-09de001d113b"}],"id":"8722507c-3ab0-4fb0-835f-8ca9ed4e4935","_postman_id":"8722507c-3ab0-4fb0-835f-8ca9ed4e4935","description":""},{"name":"Create Payout","event":[{"listen":"test","script":{"id":"f60470f4-d144-47ca-b9dd-ee7aceef8849","exec":[""],"type":"text/javascript"}}],"id":"675a7d15-7b7f-4570-abca-6f3f7e7421f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{API_KEY}}"},{"key":"password","value":"{{API_SECRET}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"amount\":1,\r\n \"currency\": \"EUR\",\r\n \"reason\": \"because of\",\r\n \"reference\": \"ORD-2354234\"\r\n}"},"url":"{{GATEWAY_API_URL}}/v1/transactions/{{transactionId}}/payouts","urlObject":{"path":["v1","transactions","{{transactionId}}","payouts"],"host":["{{GATEWAY_API_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"675a7d15-7b7f-4570-abca-6f3f7e7421f5"}],"id":"c6a08916-484d-40ee-84cb-e441191f9383","_postman_id":"c6a08916-484d-40ee-84cb-e441191f9383","description":""},{"name":"Voids","item":[{"name":"Void Auth request","id":"5e0ceb09-f3b7-4ae9-b201-f2bc29bfeb9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{API_KEY}}"},{"key":"password","value":"{{API_SECRET}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"reason\": \"becouse of\",\r\n \"reference\": \"ORD-2354234\"\r\n}"},"url":"{{GATEWAY_API_URL}}/v1/transactions/{{transactionId}}/voids","urlObject":{"path":["v1","transactions","{{transactionId}}","voids"],"host":["{{GATEWAY_API_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5e0ceb09-f3b7-4ae9-b201-f2bc29bfeb9b"}],"id":"6c71f332-2da2-4311-bf71-6aee9884cc95","_postman_id":"6c71f332-2da2-4311-bf71-6aee9884cc95","description":""},{"name":"Hosted Payment Page","item":[{"name":"Create HPP request","id":"5930e060-826a-4060-b82d-ffccc364bfb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{API_KEY}}"},{"key":"password","value":"{{API_SECRET}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Request-Id","value":"589c6836-4045-4d8d-ac16-37f5006de5b7","type":"text"},{"key":"","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"amount\":30,\n\t\"currency\":\"NGN\",\n\t\"action\":\"Purchase\",\n\t\"customer\":{\n\t\t\"firstName\": \"Norbert\",\n\t\t\"lastName\": \"Watsica\",\n\t\t\"email\": \"Lenny57@example.net\",\n\t\t\"phone\": \"425-625-2131\",\n\t\t\"accountReference\":\"acc-23456\",\n \"category\": \"gaming\",\n\t\t\"address\": {\n\t\t\t\"streetAddress\":\"Travis Lights\",\n\t\t\t\"city\": \"Guaynabo\",\n\t\t\t\"postcode\":\"01010\",\n\t\t\t\"country\":\"CA\",\n \"state\": \"AB\"\n\t\t}\n\t},\n //\"paymentMethods\": [\"PAYTM\"],\n\t\"statementDescriptor\":\"Purchase my-shop.com\",\n\t\"Description\":\"T-Shirt XXL\",\n\t\"Reference\":\"ORD24234\",\n\t\"ipAddress\":\"127.0.0.1\",\n\t\"successUrl\":\"https://demo.turnstiles.io/home/success\",\n\t\"cancelUrl\":\"https://demo.turnstiles.io\",\n\t\"failureUrl\":\"https://demo.turnstiles.io/home/cancel\"\n}"},"url":"{{GATEWAY_API_URL}}/v1/transactions/","urlObject":{"path":["v1","transactions",""],"host":["{{GATEWAY_API_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5930e060-826a-4060-b82d-ffccc364bfb1"}],"id":"0ffe8e7b-68d1-4ae5-8531-4d402130ef63","_postman_id":"0ffe8e7b-68d1-4ae5-8531-4d402130ef63","description":""}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"019bc8d5-757c-46dc-b596-b9eb4fc78961"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"751d9705-ae49-4cca-b500-1d5fd517c358"}}]}