This is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"10.00\",\n \"currency\": \"AUD\",\n \"customer_id\":\"5e4bfbd86d244b438451fbd7\",\n \"payment_source_id\": \"5e4bfbc96d244b438451fbd6\"\n}"},"url":"{{url}}/v1/charges","description":"A Charge is a one-time payment that can be requested against any connected processing service.
\nCharges can be initatied through of the following payment instruments in Paydock. Charges can have different states (i.e. when used within a 3DS or anti-fraud workflow) and can be manipulated based on the various states.
\nFlow
\nYou can create a charge using:
\n- \n
One-time token
\n \nAn existing customer (with default or non-default payment source)
\n \nDirect with credit card
\n \nDirect with bank account
\n \nTransfer, using any of the payment options (e.g for stripe connect)
\n \nAuthorisation of a one time charge (all authorised payments can be captured or cancelled in future.)
\n \nWith pre-auth (3ds) charge id
\n \nFraud
\n \nDirect with vault token (permanent or session)
\n \nDirect with vault token reference (permanent or session)
\n \nAn existing customer (with vault token payment source)
\n \n3DS is performed within the charge flow
\n \n
For a one time charge, payments are made using a one-time token, credit card or direct debit. Otherwise if you are making a payment for an existing customer, it’s simpler to store the payment source with the customer and make a payment using the customer ID.
\nYou can also use Stripe Connect through PayDock. You can support this by sending through requests inside the Transfer object, or by sending through meta parameters. Paydock fully supports all aspects of Stripe Connect, including Direct Charges, Destination Charges and Charges and Transfers.
\nNetwork Tokens Support: For flows 9, 10, and 11, if the Vault token has an active Network Token, it will be used during payment processing. If the Network Token can't be used, the charge will be processed with card details. Network Tokens are supported only for permanent Vault.
\nRequest query params
\nRequest body
\nFraud mode
\n","urlObject":{"path":["v1","charges"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"de62e2a1-b1d1-4e50-bc26-cd463604eb4e","name":"Charge with one-time token","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"amount\":\"100\",\n\t\"currency\":\"AUD\",\n\t\"token\":\"2839b39b-1865-4cbb-9387-fb2f3c83c822\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/charges"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 May 2020 07:45:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"945"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json
\n"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"reference\": \"charge-refference\",\n \"description\": \"Manually defined description for authorization update\",\n \"fraud\": {\n \"status\": \"approve\",\n \"source\": \"source\",\n \"reason\": \"reason\",\n \"specific_code\": \"123\",\n \"specific_message\": \"Country Not Equal to US;Total Amount Greater Than 500:500\",\n \"score\": \"1000\"\n }\n}"},"url":"{{url}}/v1/charges/:id/update-authorization","description":"Request to update an existing authorization. If successful, this operation allows you to extend the authorization validity period and/or update the authorized amount for this order
\nFlows
\n- \n
Extend Authorization Validity Period
\n
Update Authorization API should be called without passing the Amount \nIncrease/Decrease Authorized Amount
\n
Update Authorization API should be called, passing the new order Amount \n
Supported Gateways
\n- \n
MPGS
\n \nPayPal
\n \n
Request params
\nRequest body
\n","urlObject":{"path":["v1","charges",":id","update-authorization"],"host":["{{url}}"],"query":[],"variable":[{"id":"8df27af6-c75c-4715-9aa9-756d8e76185f","type":"any","value":"","key":"id"}]}},"response":[{"id":"8f553436-17cf-4cc7-a860-06bff8ad6974","name":"extend auth validity period","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","description":"This is your PayDock API Secret Key"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json"}],"body":{"mode":"raw","raw":"{\n \"reference\": \"charge-refference\",\n \"description\": \"Manually defined description for authorization update\"\n}"},"url":{"raw":"{{url}}/v1/charges/:id/update-authorization","host":["{{url}}"],"path":["v1","charges",":id","update-authorization"],"variable":[{"key":"id","value":""}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 25 Jul 2025 07:48:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1964"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"0\",\n \"currency\": \"AUD\",\n \"customer\": {\n \"payment_source\": {\n \"gateway_id\": \"6397a3a6dd22c3ce7e4db904\",\n \"card_name\": \"Wanda Mertz\",\n \"card_number\": \"4111111111111111\",\n \"expire_month\": \"09\",\n \"expire_year\": \"25\",\n \"card_ccv\": \"123\"\n }\n }\n}"},"url":"{{url}}/v1/charges/verification","description":"A Verification charge is used to allow merchants to validate a customer's card prior to submitting a financial transaction to the gateway.
\nFlow
\nYou can create a verification charge using:
\n- \n
Credit card
\n \nVault token
\n \nVault token reference
\n \nAn existing customer (with default or non-default payment source)
\n \n
Request body
\n","urlObject":{"path":["v1","charges","verification"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"eff1a34c-d3d2-4782-beaf-ce107b4cb654","name":"verification with cof fields","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"AUD\", \n \"initialization_source\": \"internet\",\n \"order_id\": \"13597\",\n \"transaction_id\": \"24687\",\n \"reference\": \"Reference 123\",\n \"reference2\": \"Reference2 123\",\n \"description\": \"Description\",\n \"customer\": {\n \"first_name\": \"Wanda\",\n \"last_name\": \"Mertz\",\n \"email\": \"test@paydock.com\",\n \"payment_source\": {\n \"gateway_id\": \"6397a3a6dd22c3ce7e4db904\",\n \"expire_year\": \"2025\",\n \"expire_month\": \"01\",\n \"address_country\": \"US\",\n \"address_line1\": \"706 Brazos St\",\n \"address_line2\": \"Suite A20241\",\n \"address_city\": \"Austin\",\n \"address_state\": \"Texas\",\n \"address_postcode\": \"78701\",\n \"card_name\": \"WANDA MERTZ\",\n \"card_number\": \"4111111111111111\",\n \"card_ccv\": \"123\",\n \"type\": \"card\",\n \"source\": \"card_on_file\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/charges/verification"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 May 2020 07:53:38 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1066"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"AUD\",\n \"amount\": \"10\",\n \"customer\": {\n \"payment_source\": {\n \"gateway_id\": \"5f7ebe83c9867e1d66fbc6e8\",\n \"card_name\": \"Wanda Mertz\",\n \"card_number\": \"4242424242424242\",\n \"expire_month\": \"12\",\n \"expire_year\": \"2021\",\n \"card_ccv\": \"000\"\n }\n }\n}"},"url":"{{url}}/v1/charges/refunds","description":"A Standalone Refund is a refund that is not linked to a previous transaction and can be of any amount specified by the merchant.
\nFlow
\nYou can create a charge using:
\n- \n
Direct with credit card
\n \nDirect with vault token
\n \nAn existing customer (with default or non-default payment source)
\n \n
Request body
\n","urlObject":{"path":["v1","charges","refunds"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"9f70c854-818c-4876-8fd5-b9cdf11482ad","name":"common","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"AUD\",\n \"amount\": \"10\",\n \"customer\": {\n \"payment_source\": {\n \"gateway_id\": \"5f7ebe83c9867e1d66fbc6e8\",\n \"card_name\": \"Wanda Mertz\",\n \"card_number\": \"4242424242424242\",\n \"expire_month\": \"12\",\n \"expire_year\": \"2021\",\n \"card_ccv\": \"000\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/charges/refunds"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 04 Mar 2021 13:36:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"946"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"x-powered-by","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/charges/:id","description":"Retrieves data on a charge with specified ID.
\nRequest params
\n","urlObject":{"path":["v1","charges",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"2b530928-0755-4e06-9e26-9bc606e1d56f","type":"string","value":"5f084eb39c63b80a26e52b01","key":"id"}]}},"response":[{"id":"1ea5aba6-f867-4fd4-a9b4-5b1c9d7c3ce3","name":"get with expand","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/v1/charges/:id?expand=current_subscription_details,subscription","host":["{{url}}"],"path":["v1","charges",":id"],"query":[{"key":"expand","value":"current_subscription_details,subscription"}],"variable":[{"key":"id","value":"5ec7b21cb12c99579e46f270"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 22 May 2020 14:46:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"6304"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/charges/:id/capture","description":"For capturing an authorised charge, make a POST call
\nRequest params
\nRequest body
\n","urlObject":{"path":["v1","charges",":id","capture"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5f084eb39c63b80a26e52b01","key":"id"}]}},"response":[{"id":"2b0a67ee-e1ab-4339-a7a7-4730a5ce1b9c","name":"capture not pending status","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/v1/charges/:id/capture","host":["{{url}}"],"path":["v1","charges",":id","capture"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 22 May 2020 15:03:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1095"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/charges/:id/capture","description":"For cancelling an authorised charge, make a DELETE call.
\nRequest params
\nRequest body
\n","urlObject":{"path":["v1","charges",":id","capture"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5ec7b6b3b12c99579e46f27d","key":"id"}]}},"response":[{"id":"8546339e-7f63-4384-bf91-97f4d9681679","name":"cancel authorised not pending status","originalRequest":{"method":"DELETE","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/v1/charges/:id/capture","host":["{{url}}"],"path":["v1","charges",":id","capture"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 22 May 2020 15:05:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"118"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockArchive Charge to hide it from charges list. You can still retrieve archived charges
\nRequest params
\n","urlObject":{"path":["v1","charges",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"42b91b8a-9731-4c2f-946b-9a5395002dd9","type":"string","value":"5ec691dfb12c99579e46ee4e","key":"id"}]}},"response":[{"id":"964fc4af-b6ff-46a6-843a-d1076b67c4ab","name":"archive success","originalRequest":{"method":"DELETE","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/charges/:id","host":["{{url}}"],"path":["v1","charges",":id"],"variable":[{"key":"id","value":"5ec691dfb12c99579e46ee4e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 25 May 2020 10:18:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1121"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockrefund request for a previously made financial charge.
\nRequest params
\nRequest body
\n","urlObject":{"path":["v1","charges",":id","refunds"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5ecd108a51eff9228f882b8b","key":"id"}]}},"response":[{"id":"530c87e6-93de-4ca8-b111-730c54174c13","name":"refund of already refunded transaction with gateway error","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/charges/5f085abf9c63b80a26e52b45/refunds","host":["{{url}}"],"path":["v1","charges","5f085abf9c63b80a26e52b45","refunds"],"variable":[{"key":"id","value":"5ecd108a51eff9228f882b8b"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 26 May 2020 13:01:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2268"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockrefund request for specified transaction.
\nRequest params
\nRequest body
\n","urlObject":{"path":["v1","charges",":charge_id","transactions",":transaction_id","refunds"],"host":["{{url}}"],"query":[],"variable":[{"id":"5abfc11d-eaf2-4cdc-9c0a-f0b54626b833","type":"any","value":"","key":"charge_id"},{"id":"d7eb00be-2bf4-4a5e-9efc-714d6c8a8017","type":"any","value":"","key":"transaction_id"}]}},"response":[{"id":"a0f00ada-2e9a-48c3-8055-af2abdbdbaa0","name":"refund of already refunded transaction with gateway error","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/charges/5f085abf9c63b80a26e52b45/transactions/5f085a929c63b80a26e52b3e/refunds"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 26 May 2020 13:01:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2268"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockManually request update the refund transaction status and get charge with actual refund info
\nRequest params
\n","urlObject":{"path":["v1","charges",":id","refunds"],"host":["{{url}}"],"query":[],"variable":[{"id":"e7403a56-fc03-437f-b8ef-a40cff5780c8","type":"string","value":"5ecd108a51eff9228f882b8b","key":"id"}]}},"response":[{"id":"f5a8295d-ef81-439c-b806-c3f4b39b7835","name":"refund of already refunded transaction with gateway error","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/charges/:id/refunds","host":["{{url}}"],"path":["v1","charges",":id","refunds"],"variable":[{"key":"id","value":"5ecd108a51eff9228f882b8b"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 26 May 2020 13:01:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2268"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"subscription_id\": \"5ec7b20ab12c99579e46f26b\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/charges/:id","description":"Request params
\nRequest body
\nRequest body for charges of a wallet type (Apple Pay, Flypay, PayPal Smart Button)
\n","urlObject":{"path":["v1","charges",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5ecd186b51eff9228f882bb0","key":"id"}]}},"response":[{"id":"456c0c8d-1c32-4a73-8792-14617843f05d","name":"assign to a subscription with unfulfilled condition","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"subscription_id\": \"5ec7b20ab12c99579e46f26b\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/charges/:id","host":["{{url}}"],"path":["v1","charges",":id"],"variable":[{"key":"id","value":"5ecd186b51eff9228f882bb0"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 26 May 2020 13:24:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"164"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Public Key
\n","key":"x-user-public-key","value":"{{publickey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"100\",\n \"currency\": \"AUD\",\n \"token\": \"079f5a99-ac71-44ed-b8e9-0f78defc5d79\",\n \"_3ds\": {\n \"browser_details\": {\n \"name\": \"CHROME\",\n \"java_enabled\": \"true\",\n \"language\": \"en-US\",\n \"screen_height\": \"640\",\n \"screen_width\": \"480\",\n \"time_zone\": \"273\",\n \"color_depth\": \"24\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/charges/3ds","description":"You can make pre-auth (3ds) for a charge, then accept with the client-sdk (Canvas3ds widget) and use this charge id to create a common charge. For pre-auth (3DS) charge made with Vault Token. (session or permanent) a gateway_id is required in the request
\nFlow
\n- \n
One-time token
\n \nVault token
\n \nVault token reference
\n \nAn existing customer (with default or non-default payment source)
\n \n
Request body
\n","urlObject":{"path":["v1","charges","3ds"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3684ba81-8bdd-4deb-aa44-87dc4920fa6b","name":"pre-auth success with secret key","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json"},{"key":"x-user-secret-key","value":"{{secretkey}}"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"100\",\n \"currency\": \"AUD\",\n \"token\": \"6c1ff557-b234-4b26-8a64-0471b776919b\",\n \"_3ds\": {\n \"browser_details\": {\n \"name\": \"CHROME\",\n \"java_enabled\": \"true\",\n \"language\": \"en-US\",\n \"screen_height\": \"640\",\n \"screen_width\": \"480\",\n \"time_zone\": \"273\",\n \"color_depth\": \"24\"\n }\n },\n \"customer\": {\n \"phone2\": \"+12345678910\",\n \"first_name\": \"Wanda\",\n \"last_name\": \"Wanda\",\n \"email\": \"wanda.mertz@example.com\",\n \"phone\": \"+12345678910\",\n \"payment_source\": {\n \"address_line1\": \"Suite 660\",\n \"address_line2\": \"822 Ruiz Square\",\n \"address_line3\": \"123 Ruiz Square\",\n \"address_city\": \"Lake Robyn\",\n \"address_postcode\": \"07396\",\n \"address_state\": \"WY\",\n \"address_country\": \"AU\",\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/charges/3ds"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 11 Sep 2020 13:16:53 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2999"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockProcess charge functionality gives an ability to send payment transaction request after transaction successfully authenticated using 3ds.
\nRequest body
\n","urlObject":{"path":["v1","charges"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"efcb704a-0054-4e56-a371-7963b757b694","name":"process charge with 3DS success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-user-secret-key","value":"{{secretkey}}"}],"body":{"mode":"raw","raw":"{\n\t\"amount\": \"10\",\n \"currency\": \"AUD\",\n \"reference\": \"some_reference\",\n \"description\": \"some_description\",\n \"_3ds\": {\n \t\"id\": \"9d6147d9-30f5-488b-88d9-0cf47420f230\"\n }\n}"},"url":"{{url}}/v1/charges"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 11 Sep 2020 13:37:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"3869"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/charges/:id/process","description":"For finalizing a charge after fraud review process, make a POST call
\nRequest params
\n","urlObject":{"path":["v1","charges",":id","process"],"host":["{{url}}"],"query":[],"variable":[{"id":"369f806e-e6cb-42a1-a769-6f48728ff69d","type":"string","value":"605347b608a83e6e02a3fb1f","key":"id"}]}},"response":[{"id":"99b22697-3536-49ea-aff0-ba1dfaca636d","name":"process","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/v1/charges/:id/process","host":["{{url}}"],"path":["v1","charges",":id","process"],"variable":[{"key":"id","value":"605347b608a83e6e02a3fb1f"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 22 May 2020 15:02:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1039"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/charges/:id/decline","description":"For declining a charge after fraud review process, make a POST call
\nRequest params
\n","urlObject":{"path":["v1","charges",":id","decline"],"host":["{{url}}"],"query":[],"variable":[{"id":"df23f8dd-7400-4943-ad61-e60544148e67","type":"string","value":"60534e9a9fd08f11ceb3ba1c","key":"id"}]}},"response":[{"id":"2ebbc99f-d824-4ac6-8a98-a7f3a9e85658","name":"decline","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/v1/charges/:id/decline","host":["{{url}}"],"path":["v1","charges",":id","decline"],"variable":[{"key":"id","value":"60534e9a9fd08f11ceb3ba1c"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 22 May 2020 15:02:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1039"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"customer\": {\n \"payment_source\": {\n \"gateway_id\": \"60197a61595c657ec05cc94c\"\n }\n }\n}"},"url":"{{url}}/v1/charges/wallet","description":"A сharge for the wallet is a method that creates a token to utilize in the Client SDK. It initializes payments using Apple/Google Pay, Flypay, PayPal Smart, AfterPay, etc.
\nRequest query params
\nRequest body
\nResponse body
\n","urlObject":{"path":["v1","charges","wallet"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"9bf5558f-8be2-4ee3-a676-36d65e1bd634","name":"initialize charge for wallet payments","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","description":"This is your PayDock API Secret Key"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"first_name\": \"Wanda\",\n \"last_name\": \"Mertz\",\n \"email\": \"wanda.mertz@example.com\",\n \"phone\": \"+1234567890\",\n \"payment_source\": {\n \"gateway_id\": \"60e84f19a7cc2c2e513d6c99\"\n }\n },\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"reference\": \"reference123\",\n \"reference2\": \"reference 2\",\n \"reference3\": \"reference 3\",\n \"description\": \"description123\",\n \"meta\": {\n \"store_name\": \"123\",\n \"store_id\": \"123\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/charges/wallet"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 02 Feb 2021 16:17:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"668"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"x-powered-by","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"foreign_currency\": \"AUD\",\n \"gateway_id\": \"60197a61595c657ec05cc94c\"\n}"},"url":"{{url}}/v1/charges/dynamic-pricing","description":"Check currency rates and convert the amount in foreign currency to the amount in the default currency of your gateway account.
\nRequest body
\nResponse body
\n","urlObject":{"path":["v1","charges","dynamic-pricing"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"4ea84218-fe45-4d3b-bfbd-d2a20d6812ca","name":"check currency rates","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"foreign_currency\": \"AUD\",\n \"gateway_id\": \"60197a61595c657ec05cc94c\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/charges/dynamic-pricing"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 02 Feb 2021 16:17:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"668"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"x-powered-by","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"custom_key\": \"custom value\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/charges/:charge_id/transactions/:id/custom-fields","description":"This endpoint, allows you to modify, delete and add new custom fields.
\nRequest params
\nRequest body
\nResponse body
\nInclude an actual list of custom fields with the same format as the request body inside the transaction
\n","urlObject":{"path":["v1","charges",":charge_id","transactions",":id","custom-fields"],"host":["{{url}}"],"query":[],"variable":[{"id":"c6008ac0-62a7-440d-ab9e-b5e9aa245f58","type":"any","value":"6051e84bb2dee34c9ff3ed8b","key":"charge_id"},{"id":"f116ab96-4316-4a61-a0bb-086a96db83da","type":"any","value":"6051e84bb2dee34c9ff3ed8c","key":"id"}]}},"response":[{"id":"b483acd8-2b15-46ca-9ff1-56a612f9b373","name":"common","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"custom_key\": \"custom value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/charges/:charge_id/transactions/:id/custom-fields","host":["{{url}}"],"path":["v1","charges",":charge_id","transactions",":id","custom-fields"],"variable":[{"key":"charge_id","value":"60536a6eaa7b27148d636478"},{"key":"id","value":"60536a6eaa7b27148d636479"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 18 Mar 2021 15:14:55 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"425"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"x-powered-by","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"status\": \"complete\",\n \"external_id\": \"1234123\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/charges/:charge_id/transactions/:id","description":"This endpoint allows you to modify a transaction and charge status and specify a potential error code and an identificator of a transaction on a gateway side. It is allowed to update charges and transactions in the \"requested\" status only.
\nRequest body
\nResponse body
\nCharge resource with an updated status
\n","urlObject":{"path":["v1","charges",":charge_id","transactions",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"c6008ac0-62a7-440d-ab9e-b5e9aa245f58","type":"any","value":"6051e84bb2dee34c9ff3ed8b","key":"charge_id"},{"id":"f116ab96-4316-4a61-a0bb-086a96db83da","type":"any","value":"6051e84bb2dee34c9ff3ed8c","key":"id"}]}},"response":[{"id":"0ba62a05-c06b-447f-91b4-1df8a8795e81","name":"modify transaction status","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"status\": \"complete\",\n \"external_id\": \"1234123\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/charges/:charge_id/transactions/:id","host":["{{url}}"],"path":["v1","charges",":charge_id","transactions",":id"],"variable":[{"id":"c6008ac0-62a7-440d-ab9e-b5e9aa245f58","key":"charge_id","value":"6051e84bb2dee34c9ff3ed8b"},{"id":"f116ab96-4316-4a61-a0bb-086a96db83da","key":"id","value":"6051e84bb2dee34c9ff3ed8c"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"transaction\",\n \"data\": {\n \"_id\": \"60f805c353f4df4691cb917d\",\n \"amount\": 10,\n \"currency\": \"NZD\",\n \"status\": \"complete\",\n \"external_id\": \"1234123\",\n \"subscription_id\": \"60f805ad53f4df4691cb9144\",\n \"capture\": true,\n \"one_off\": false,\n \"amount_surcharge\": null,\n \"amount_original\": null,\n \"created_at\": \"2021-07-21T11:32:19.770Z\",\n \"updated_at\": \"2021-07-22T07:48:59.367Z\",\n \"_3ds\": {},\n \"shipping\": {\n \"contact\": {}\n },\n \"schedule\": {\n \"stopped\": false\n },\n \"transactions\": [\n {\n \"_id\": \"60f805c353f4df4691cb917e\",\n \"external_id\": \"1234123\",\n \"amount\": 10,\n \"amount_fee\": null,\n \"currency\": \"NZD\",\n \"type\": \"sale\",\n \"status\": \"complete\",\n \"created_at\": \"2021-07-21T11:32:19.767Z\",\n \"error_message\": null,\n \"updated_at\": \"2021-07-22T07:48:59.307Z\",\n \"pended_at\": \"2021-07-22T11:32:20.198Z\",\n \"include_authorization\": false,\n \"gateway_specific_code\": null,\n \"gateway_specific_description\": null,\n \"error_code\": null,\n \"status_code\": null,\n \"status_code_description\": null,\n \"_source_ip_address\": \"127.0.0.1\",\n \"_3ds\": {},\n \"service_logs\": []\n }\n ],\n \"customer\": {\n \"customer_id\": \"60f7cf2c8970eb28e1582db3\",\n \"last_name\": \"F2C\",\n \"first_name\": \"Bank\",\n \"payment_source\": {\n \"type\": \"bank_account\",\n \"gateway_id\": \"60f6b97a8970eb28e155eb9d\",\n \"gateway_name\": \"Flo 2 Cash\",\n \"gateway_type\": \"Flo2Cash\",\n \"address_country\": \"NZ\"\n }\n },\n \"meta\": {}\n }\n }\n}"}],"_postman_id":"75a1442d-d77a-4bec-b83f-68866a9aa08f"},{"name":"standalone fraud","id":"c17c82f6-a404-441d-a804-716547525b4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"currency\": \"USD\",\n \"first_name\": \"Wanda\",\n \"last_name\": \"Mertz\",\n \"customer\": {\n \"payment_source\": {\n \"vault_token\": \"e4fb7389-3efc-4b39-b9a6-8d71466c6169\"\n }\n },\n \"fraud\": {\n \"service_id\": \"61518e99ea9aea650e28e8ba\",\n \"data\": {}\n }\n}"},"url":"{{url}}/v1/charges/fraud","description":"A fraud charge is a one-time charge that allows sending a fraud transaction separately from the sale transaction to be able to gather and validate fraud data without making charges.
\nFlows
\nYou can create a charge using:
\n- \n
Vault Token
\n \nVault Token Reference
\n \nAn existing customer (with default or non-default payment source)
\n \nCredit Card
\n \n
Request body
\n","urlObject":{"path":["v1","charges","fraud"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"80abf6d6-23e1-4356-bcc8-da56fdaa1058","name":"standalone fraud with vault token","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"currency\": \"USD\",\n \"customer\": {\n \"payment_source\": {\n \"vault_token\": \"6ec0103b-a2f9-49a9-b156-6359a48381d0\"\n }\n },\n \"fraud\": {\n \"service_id\": \"5f58ed3b1f3a4238e1d73082\",\n \"data\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/charges/fraud"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fraud_charge_id\": \"616570a2d475c4b805f2acff\"\n}"},"url":"{{url}}/v1/charges/:id/fraud/attach","description":"Allows attaching a completed fraud charge to a financial charge with a sale transaction. It can be done either when creating a financial charge or after it was already created.
\nRequest params
\nRequest body
\n","urlObject":{"path":["v1","charges",":id","fraud","attach"],"host":["{{url}}"],"query":[],"variable":[{"id":"065d626f-1ca9-4115-8ff0-ba2b529769d2","type":"any","value":null,"key":"id"}]}},"response":[{"id":"e64dfd8c-be6b-47db-af5a-7a7eaad1c3f7","name":"attach fraud","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fraud_charge_id\": \"616570a2d475c4b805f2acff\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/charges/:id/fraud/attach","host":["{{url}}"],"path":["v1","charges",":id","fraud","attach"],"variable":[{"key":"id","value":null}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"4\",\n \"currency\": \"AUD\",\n \"payment_source_preference\": \"network_token\",\n \"customer\": {\n \"payment_source\": {\n \"vault_token\": \"8617374d-2a5f-405b-aa9e-a9e942dd7c95\"\n }\n },\n \"_3ds\": {\n \"authentication\": {\n \"type\": \"01\",\n \"date\": \"2021-12-13T20:06:05.521Z\"\n }\n }\n}"},"url":"{{url}}/v1/charges/standalone-3ds","description":"A Standalone 3DS charge is a one-time charge that allows authorizing a transaction separately from the sale transaction, to be able to gather and validate authentication data without making charges. After processing, these 3ds charges can be attached with a regular financial charge to skip the authentication flow when charging takes place.
\nFlows
\n- \n
Vault token
\n \nVault token reference
\n \nAn existing customer (with default or non-default payment source)
\n \n
Network Token support is available with standalone 3DS when:
\n- \n
The Vault has an active NT
\n \nRegistration status is \"completed.\"
\n \nMerchant either:
\n- \n
Enables Routing Rules and provides payment_source_preference = network_token
\n \nProvides a gateway_id that will be provided for /charges
\n \n
\n
Request body
\n","urlObject":{"path":["v1","charges","standalone-3ds"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"237bf6d0-dd87-4080-9470-f6b80845737d","name":"standalone 3ds with vault token full","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","description":"This is your PayDock API Secret Key"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"4\",\n \"currency\": \"AUD\",\n \"reference\": \"8ab9acec-edd2-4399-80c9-ded64a362abb\",\n \"payment_source_preference\": \"network_token\",\n \"customer\": {\n \"first_name\": \"Wanda\",\n \"last_name\": \"Mertz\",\n \"email\": \"wanda.mertz@example.com\", \n \"phone\": \"+1234567890\",\n \"phone2\": \"+1234567890\",\n \"payment_source\": {\n \"vault_token\": \"8617374d-2a5f-405b-aa9e-a9e942dd7c95\",\n \"address_city\": \"Lake Robyn\",\n \"address_country\": \"US\",\n \"address_line1\": \"61426 Osvaldo Plains\",\n \"address_line2\": \"Apt. 276\",\n \"address_line3\": \"Apt. 276\",\n \"address_postcode\": \"07396\",\n \"address_state\": \"WY\"\n }\n },\n \"shipping\": {\n \"address_city\": \"Lake Robyn\",\n \"address_country\": \"US\",\n \"address_line1\": \"61426 Osvaldo Plains\",\n \"address_line2\": \"Apt. 276\",\n \"address_line3\": \"Apt. 276\",\n \"address_postcode\": \"07396\",\n \"address_state\": \"WY\",\n \"method\": \"02\",\n \"contact\": {\n \"email\": \"wanda.mertz@example.com\",\n \"first_name\": \"Wanda\",\n \"last_name\": \"Mertz\"\n }\n },\n \"_3ds\": {\n \"service_id\": \"61518e99ea9aea650e28e8ba\",\n \"browser_details\": {\n \"screen_height\": 460,\n \"screen_width\": 270\n },\n \"authentication\": {\n \"account_id\": \"Account ID\",\n \"type\": \"01\",\n \"challenge_type\": \"01\",\n \"merchant_name\": \"Test Merchant\",\n \"previous_authentication_id\": \"61bbae7ac25ed442b1b91cec\",\n \"date\": \"2021-12-13T20:06:05.521Z\",\n \"whitelisted\": true,\n \"version\": \"2.1.0\",\n \"method\": \"01\",\n \"auth_data\": \"auth_data\",\n \"customer\": {\n \"created_at\": \"2020-12-13T20:06:05.521Z\",\n \"updated_at\": \"2020-12-13T20:06:05.521Z\",\n \"credentials_updated_at\": \"2020-12-13T20:06:05.521Z\",\n \"suspicious\": false,\n \"payment_source\": {\n \"created_at\": \"2020-12-13T20:06:05.521Z\",\n \"add_attempts\": [\"2020-12-13T20:06:05.521Z\"],\n \"card_type\": \"02\"\n },\n \"activity_history\": {\n \"transactions_count_last_day\": 1,\n \"transactions_count_last_six_months\": 6,\n \"transactions_count_last_year\": 10,\n \"shipping_address_created_at\": \"2020-12-13T20:06:05.521Z\"\n }\n },\n \"risk\": {\n \"redeem_amount\": \"0\",\n \"redeem_currency\": \"USD\",\n \"redeem_count\": 0,\n \"pre_order_date\": \"2021-12-13T20:06:05.521Z\",\n \"reorder\": \"01\",\n \"shipping\": \"01\"\n },\n \"decoupled\": {\n \"timeout\": \"00010\",\n \"enabled\": true\n },\n \"recurring\": {\n \"expiry\": \"2021-12-13T20:06:05.521Z\",\n \"frequency_days\": 2\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/charges/standalone-3ds"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockFlow
\nYou can check balance using:
\n- \n
With credit card
\n \nWith vault token
\n \nWith vault token reference
\n \n
Request body
\nCheck Balance With Vii
\nAfter 3 unsuccessful attempts to get the gift card's balance with an incorrect PIN, the card is blocked for approximately 10 hours.
For the first 3 attempts to check the balance with an invalid PIN the error message will be: Invalid PIN.\nAfter the fourth attempt, the error will say: The card has been temporarily locked. It will be unlocked on DD/MM/YYYY hh:mm:ss a
This is your PayDock API Secret Key
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json
\n"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"currency\": \"USD\",\n \"first_name\": \"Wanda\",\n \"last_name\": \"Mertz\",\n \"customer\": {\n \"payment_source\": {\n \"items\": [\n {\n \"amount\": 3,\n \"vault_token\": \"e4fb7389-3efc-4b39-b9a6-8d71466c6169\"\n },\n {\n \"amount\": 7,\n \"vault_token\": \"ff3ed811-47ef-4b1f-9ab0-816861ef2b5\"\n }\n ]\n }\n },\n \"fraud\": {\n \"service_id\": \"61518e99ea9aea650e28e8ba\",\n \"data\": {}\n }\n}"},"url":"{{url}}/v1/charges/split-fraud","description":"A split fraud charge is a one-off charge that allows performing a standalone fraud check with few payment sources separately from the sale transaction to be able to gather and validate fraud data.
\nFlows
\nYou can create a charge using:
\n- \n
Vault Token
\n \nVault Token Reference
\n \nCredit Card
\n \n
Request body
\n","urlObject":{"path":["v1","charges","split-fraud"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"4c5fa687-0554-4c43-9197-584d5c44c2aa","name":"split fraud with vault token","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","description":"This is your PayDock API Secret Key"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"currency\": \"USD\",\n \"first_name\": \"Wanda\",\n \"last_name\": \"Mertz\",\n \"customer\": {\n \"payment_source\": {\n \"items\": [\n {\n \"amount\": 3,\n \"vault_token\": \"e4fb7389-3efc-4b39-b9a6-8d71466c6169\"\n },\n {\n \"amount\": 7,\n \"vault_token\": \"ff3ed811-47ef-4b1f-9ab0-816861ef2b5\"\n }\n ]\n }\n },\n \"fraud\": {\n \"service_id\": \"61518e99ea9aea650e28e8ba\",\n \"data\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/charges/split-fraud"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockA charge that was previously initialized but for some reason not used in a wallet payment, is possible to specify abandon that wallet charge.
\nWill work only for wallet charges only with status initialized.
\nRequest params
\n","urlObject":{"path":["v1","charges","wallet",":charge_id","abandon"],"host":["{{url}}"],"query":[],"variable":[{"id":"66292795-2afa-40a1-a591-f1c6a227cfeb","description":{"content":"Wallet initialized charge id
\n","type":"text/plain"},"type":"any","value":"","key":"charge_id"}]}},"response":[{"id":"8a905698-4c59-4101-a72e-d5f39feb5d58","name":"abandon wallet charge successful response","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/v1/charges/wallet/:charge_id/abandon","host":["{{url}}"],"path":["v1","charges","wallet",":charge_id","abandon"],"variable":[{"key":"charge_id","value":"","description":"Wallet initialized charge id"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"charge\",\n \"data\": {\n \"_id\": \"67b49054029f23b601b409f1\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"reference\": \"97b961c9-d58b-4d85-b7c0-c49796b06235\",\n \"reference2\": \"97b961c9-d58b-4d85-b7c0-c49796b06235\",\n \"company_id\": \"5adacf0c30efdb1c6d055ae5\",\n \"description\": \"description\",\n \"type\": \"financial\",\n \"status\": \"abandoned\",\n \"capture\": true,\n \"authorization\": false,\n \"one_off\": true,\n \"created_at\": \"2025-02-18T13:51:16.836Z\",\n \"updated_at\": \"2025-02-18T13:51:45.845Z\",\n \"shipping\": {\n \"contact\": {}\n },\n \"schedule\": {\n \"stopped\": false\n },\n \"archived\": false,\n \"_3ds\": {},\n \"fraud\": {},\n \"meta\": {\n \"store_id\": \"123\",\n \"restrict_loyalty\": false,\n \"restrict_gift_card\": true,\n \"merchant_name\": \"456\"\n },\n \"customer\": {\n \"last_name\": \"Mertz\",\n \"first_name\": \"Wanda\",\n \"email\": \"example@doc.com\",\n \"phone\": \"+5555555555\",\n \"payment_source\": {\n \"type\": \"wallet\",\n \"wallet_type\": \"flypay_v2\",\n \"gateway_id\": \"6745e1c79a66a4a868a2e551\",\n \"gateway_name\": \"FlypayV2\",\n \"gateway_type\": \"FlypayV2\"\n }\n },\n \"transactions\": [],\n \"items\": []\n }\n }\n}"},{"id":"1e23603a-d34c-4603-b7b6-b33453e25145","name":"abandon wallet charge wallet not in initialized status","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/v1/charges/wallet/:charge_id/abandon","host":["{{url}}"],"path":["v1","charges","wallet",":charge_id","abandon"],"variable":[{"key":"charge_id","value":"","description":"Wallet initialized charge id"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"Only wallet initialized charges could be abandoned\",\n \"code\": \"UnfulfilledCondition\",\n \"details\": {\n \"path\": \"\",\n \"messages\": []\n }\n },\n \"resource\": {\n \"type\": \"charge\"\n },\n \"error_summary\": {\n \"message\": \"Only wallet initialized charges could be abandoned\",\n \"code\": \"unfulfilled_condition\",\n \"details\": {\n \"messages\": []\n }\n }\n}"}],"_postman_id":"a27c6740-f629-4704-8ae3-1ac1f08de418"}],"id":"595d3eba-c965-4fb1-9bcc-aa2b8f673b2b","description":"A сharge is a one-time payment that can be requested against any connected processing service.
\nCharges can be created through one of the following payment instruments at Paydock. Charges can have different states (i.e. when used within a 3DS or anti-fraud workflow) and can be manipulated based on the various states.
\nConditions
\nThe response is different depending on the following conditions:
\n- \n
Created with a credit card payment source
\n \nCreated with a bank account payment source
\n \nCreated with an existing customer
\n \nCreated by a subscription
\n \nCreated with a transfer, using any of the payment options (e.g for Stripe connect)
\n \nProcessed on a gateway with a failed status
\n \nPre-auth charge
\n \nCharge with a pre-auth charge_id
\n \nCharge with a fraud check
\n \nCreated with a vault token
\n \nCreated with a vault token reference
\n \nCreated with a checkout payment source type
\n \nCreated with an external 3ds authentication results
\n \n
Charge Resource
\nStatus
\nTransaction types
\nTransaction status
\nFraud status
\nFraud mode
\n","event":[{"listen":"prerequest","script":{"id":"500ee046-1221-4f83-8088-1ed51318abf8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9e478505-3bb8-409a-a40c-29a550a091d2","type":"text/javascript","exec":[""]}}],"_postman_id":"595d3eba-c965-4fb1-9bcc-aa2b8f673b2b"},{"name":"customers","item":[{"name":"create","id":"43baa31d-4dc4-4058-a0c2-c55463ffe102","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Wanda\",\n \"payment_source\": {\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_name\": \"Wanda Mertz\",\n \"card_number\": \"4242424242424242\",\n \"expire_month\": \"09\",\n \"expire_year\": \"21\",\n \"card_ccv\": \"123\"\n }\n}"},"url":"{{url}}/v1/customers","description":"Flow
\nYou can create a customer using:
\n- \n
Created with credit card payment source
\n \nCreated with the bank account payment source
\n \nCreate with one-time token
\n \nCreate with permanent vault token
\n \nCreate with permanent vault token and without gateway Id
\n \nCreate with vault token reference
\n \n
Request body
\n","urlObject":{"path":["v1","customers"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"6214871f-7396-4c5e-969d-14087acc2d15","name":"create with validation error","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"payment_source\": {\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"vault_token\": \"0fd20631-509e-45c7-a8f0-f1f36d6ad292\"\n }\n}"},"url":"{{url}}/v1/customers"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 May 2020 12:23:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"130"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/customers","description":"Returns all charges for the account
\nRequest query params
\nPagination
\nfilters
\nOther
\n","urlObject":{"path":["v1","customers"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"417f9d35-dba7-4ac1-a8c3-61321ebb4e6e","name":"search with filter","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/v1/customers?gateway_id=5cbede1f151b842653e987be","host":["{{url}}"],"path":["v1","customers"],"query":[{"key":"gateway_id","value":"5cbede1f151b842653e987be"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 May 2020 12:32:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1921"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/customers/:id","description":"Retrieves data on the customer with specified ID.
\nRequest params
\n","urlObject":{"path":["v1","customers",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"6b71bf4a-00c2-4a7a-93a5-15d4084181e5","type":"string","value":"5ece59dc9c49c657d60630ed","key":"id"}]}},"response":[{"id":"96e897dd-4b96-47be-8e75-6eecb3d8ac75","name":"get success","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/v1/customers/:id","host":["{{url}}"],"path":["v1","customers",":id"],"variable":[{"key":"id","value":"5ece59dc9c49c657d60630ed"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 May 2020 12:32:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1921"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"first_name\": \"test\"\n}"},"url":"{{url}}/v1/customers/:id","description":"You can use this API to update customer information (eg email address) or add more payment sources to a customer.
\nFlow
\nYou can:
\n- \n
- Add a new payment source with credit card \n
- Add a new payment source with bank account \n
- Add a new payment source with one-time token \n
- Add a new payment source with vault token \n
- Add a new payment source with vault token reference \n
- Set default source. By default default source always equal a new added payment source \n
Request params
\nRequest body
\n","urlObject":{"path":["v1","customers",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5ece59dc9c49c657d60630ed","key":"id"}]}},"response":[{"id":"0cc1b6b6-845c-46e8-a2d2-e536ce4df0c7","name":"add a new payment source and set it by default","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payment_source\": {\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_name\": \"Wanda Mertz\",\n \"card_number\": \"4242424242424242\",\n \"expire_month\": \"09\",\n \"expire_year\": \"21\",\n \"card_ccv\": \"123\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/customers/:id","host":["{{url}}"],"path":["v1","customers",":id"],"variable":[{"key":"id","value":"5ece59dc9c49c657d60630ed"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 May 2020 12:36:34 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1229"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"vault_token\": \"123254c6-abc7-49ec-b633-df9f8c22252c\"\n}"},"url":"{{url}}/v1/customers/:id/payment_sources/:payment_source_id","description":"You can use this API request to update the expiration date of a payment source using a vault token.
\nAs a result of this action, a new payment source will be created on the gateway side.
\nRequest params
\nRequest body
\n","urlObject":{"path":["v1","customers",":id","payment_sources",":payment_source_id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"6012c6e54e58807751780ff6","key":"id"},{"type":"any","value":"6012c6e64e58807751780ff7","key":"payment_source_id"}]}},"response":[{"id":"87d9f6e9-dbe2-4463-8e9f-797f7e31c480","name":"common","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"vault_token\": \"123254c6-abc7-49ec-b633-df9f8c22252c\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/customers/:id/payment_sources/:payment_source_id","host":["{{url}}"],"path":["v1","customers",":id","payment_sources",":payment_source_id"],"variable":[{"key":"id","type":"string","value":"6012c6e54e58807751780ff6"},{"key":"payment_source_id","value":"6012c6e64e58807751780ff7"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 28 Jan 2021 14:29:19 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"454"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"verification_amounts\": [\"10\", \"25\"]\n}"},"url":"{{url}}/v1/customers/:id/payment_sources/:payment_source_id/verify","description":"A customer's bank account must first be verified before it can be charged. You can use this API request to verify a customer's payment source.
\nAs a result of this action, a payment source will be verified and ready to be used on the gateway side for further charges.
\nRequest params
\nRequest body
\n","urlObject":{"path":["v1","customers",":id","payment_sources",":payment_source_id","verify"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"6012c6e54e58807751780ff6","key":"id"},{"type":"any","value":"6012c6e64e58807751780ff7","key":"payment_source_id"}]}},"response":[{"id":"38425d69-36a1-498a-be04-ef11bebdb5d5","name":"common","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","description":"This is your PayDock API Secret Key"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json"}],"body":{"mode":"raw","raw":"{\n\t\"verification_amounts\": [\"10\", \"25\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/customers/:id/payment_sources/:payment_source_id/verify","host":["{{url}}"],"path":["v1","customers",":id","payment_sources",":payment_source_id","verify"],"variable":[{"key":"id","value":"6012c6e54e58807751780ff6"},{"key":"payment_source_id","value":"6012c6e64e58807751780ff7"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 28 Jan 2021 14:29:19 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"454"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/customers/:id","description":"Customer with specified id will be archived. You can retrieve archived customers using
\nRequest params
\n","urlObject":{"path":["v1","customers",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"90630e1d-3644-4f2f-b223-45dd5466f7ca","type":"string","value":"5ece6a89ce7ad559e487cec0","key":"id"}]}},"response":[{"id":"55dd0320-90d3-4e65-925c-0015b86c5933","name":"archive success","originalRequest":{"method":"DELETE","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/v1/customers/:id","host":["{{url}}"],"path":["v1","customers",":id"],"variable":[{"key":"id","value":"5ece6a89ce7ad559e487cec0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 May 2020 13:27:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"842"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/customers/:id/payment_sources/:payment_source_id","description":"Customers payment source with specified id will be archived.
\nRequest params
\n","urlObject":{"path":["v1","customers",":id","payment_sources",":payment_source_id"],"host":["{{url}}"],"query":[],"variable":[{"id":"15717cef-599c-40b0-9d50-53cb806c5c21","type":"string","value":"5ece6a89ce7ad559e487cec0","key":"id"},{"id":"707465cc-abb7-4137-992f-4476badc209e","type":"any","value":"5ece6a89ce7ad559e487cec1","key":"payment_source_id"}]}},"response":[{"id":"33dfc96b-393c-4f56-9f50-5313c83e66ea","name":"archive success","originalRequest":{"method":"DELETE","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/v1/customers/:id/payment_sources/:payment_source_id","host":["{{url}}"],"path":["v1","customers",":id","payment_sources",":payment_source_id"],"variable":[{"key":"id","value":""},{"key":"payment_source_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 May 2020 13:27:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"842"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Public Key
\n","key":"x-user-public-key","value":"{{publickey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/customers/payment_sources?query_token=eyJhbGciOiJIUzI1Ni5cCI6IkpXVCJ9.eyJpZCI6IjVlY2U1OWRjOWM0OWM2NTdkNjA2MzBlZCIsImxpbWpudWxsLCJza2lwIjpudWxsLCJpYXQiOjE1OTA1ODMzMDB9.flDRW1pNU2e3eKJSfrXT9rSDhWPo1X60UEwTbhjU","description":"Get payment sources of customers by query_token generated from /search customers with params endpoint
\nRequest query
\nResponse body
\nCollection of payment sources (see payment_sources[])
\n","urlObject":{"path":["v1","customers","payment_sources"],"host":["{{url}}"],"query":[{"description":{"content":"A payload of jwt query_token should contain a customer's id and/or customer's reference field(s)
\ne.g.
\n{\n \"id\": \"63183fbae04e4d2ad89c30a0\",\n \"reference\": \"067wgvm3ynmaxv04daqp\"\n}
\nThese fields might be included in the payload which is obtained from the search stage (but only in case these fields were provided in query parameters)
\ne.g.:\nGET search\n{{url}}/v1/customers?id=63183fbae04e4d2ad89c30a0&reference=067wgvm3ynmaxv04daqp
\n","type":"text/plain"},"key":"query_token","value":"eyJhbGciOiJIUzI1Ni5cCI6IkpXVCJ9.eyJpZCI6IjVlY2U1OWRjOWM0OWM2NTdkNjA2MzBlZCIsImxpbWpudWxsLCJza2lwIjpudWxsLCJpYXQiOjE1OTA1ODMzMDB9.flDRW1pNU2e3eKJSfrXT9rSDhWPo1X60UEwTbhjU"}],"variable":[]}},"response":[{"id":"8aa37359-178a-4410-ab8a-dca8c5898173","name":"get payment sources success","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Public Key","key":"x-user-public-key","value":"{{publickey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/v1/customers/payment_sources?query_token=eyJhbGciOiNiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlY2U1OWRjOWM0OWM2NTdkNjA2MzBlZWl0IjpudWxsLCJza2lwIjpudWxsLCJpYXQiOjE1OTA1ODMzMDB9.flDRW1pNU2e3eKJSfrXT9rSDhWPo10Pp1UEhjU","host":["{{url}}"],"path":["v1","customers","payment_sources"],"query":[{"key":"query_token","value":"eyJhbGciOiNiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlY2U1OWRjOWM0OWM2NTdkNjA2MzBlZWl0IjpudWxsLCJza2lwIjpudWxsLCJpYXQiOjE1OTA1ODMzMDB9.flDRW1pNU2e3eKJSfrXT9rSDhWPo10Pp1UEhjU"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 May 2020 13:13:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"686"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockA customer represents an individual who can make or receive payments. Through the use of vaulted tokens, Customers store one or more payment sources, so that payment information doesn’t need to be collected again. Customers can also be associated with Subscriptions and can have Charges added against them. Also, there is ability to use a Ccustomer as a destination for transferring money Transfers. A customer must have at least one payment source (eg. credit card) that can be used for payment or a payment destination that can be used fot transfers.
\nConditions
\nThe response is different depends on such conditions:
\n- \n
- Created with credit card payment source \n
- Created with the bank account payment source \n
- Created with checkout payment source type \n
Customer resource
\nStatus
\nPayment Source status
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b3e6f357-d5db-4d91-8b9a-8165859034ee"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"e25906f9-1ff3-43d7-b4a4-cac39f4fcd8c"}}],"_postman_id":"bccd97cb-bfbb-4551-a526-c1aeea72fa05"},{"name":"subscriptions","item":[{"name":"search","id":"7dffefcd-8853-42e8-8c78-3a3c6f6670da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/subscriptions","description":"Returns all subscriptions for the account
\nRequest query params
\nPagination
\nFilters
\nOther
\n","urlObject":{"path":["v1","subscriptions"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"64e64e4c-f0ee-4ae3-80fd-caabd63b22b0","name":"search by gatewayId","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/v1/subscriptions?gateway_id=5dde1f3799cfea21ed2fc942","host":["{{url}}"],"path":["v1","subscriptions"],"query":[{"key":"gateway_id","value":"5dde1f3799cfea21ed2fc942"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 02 Sep 2020 15:27:38 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"7649"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/subscriptions/:id","description":"Retrieves data on a subscription with a specified ID.
\nRequest params
\n","urlObject":{"path":["v1","subscriptions",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"878c35f7-2fdc-4666-99b0-ef32bb95e3d6","type":"string","value":"5ef064763dcfec0ac5e0622e","key":"id"}]}},"response":[{"id":"6414bde6-b5f2-4b9d-aa2b-81b1ba3b5cc9","name":"get","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"url":"{{url}}/v1/subscriptions/5ef064763dcfec0ac5e0622e"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 02 Sep 2020 15:42:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1889"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"10.00\",\n \"currency\": \"AUD\",\n \"reference\": \"Fuga consequuntur sint ab magnam\",\n \"description\": \"Vitae commodi provident assumenda\",\n \"customer\": {\n \"first_name\": \"Wanda\",\n \"last_name\": \"Mertz\",\n \"email\": \"wanda.mertz@example.com\",\n \"reference\": \"CustomReference\",\n \"payment_source\": {\n \"address_line1\": \"Suite 660\",\n \"address_line2\": \"822 Ruiz Square\",\n \"address_city\": \"Lake Edward\",\n \"address_state\": \"TAS\",\n \"address_country\": \"AU\",\n \"address_postcode\": \"1234\",\n \"gateway_id\": \"5dde1f3799cfea21ed2fc942\",\n \"card_name\": \"Wanda Mertz\",\n \"card_number\": \"4242424242424242\",\n \"expire_month\": \"09\",\n \"expire_year\": \"21\",\n \"card_ccv\": \"123\"\n }\n },\n \"schedule\": {\n \"frequency\": \"1\",\n \"interval\": \"month\"\n }\n}"},"url":"{{url}}/v1/subscriptions","description":"Flow
\nYou can create a subscription using:
\n- \n
One-time token (customer will be created automatically before creating a subscription)
\n \nAn existing customer (with default or non-default payment source)
\n \nDirect with credit card (customer will be created automatically before creating a subscription)
\n \nDirect with bank account (customer will be created automatically before creating a subscription)
\n \nUsing vault-token (customer will be created automatically before creating a subscription)
\n \nUsing vault-token reference (customer will be created automatically before creating a subscription)
\n \nAn existing customer (with default or non-default vault token payment source)
\n \n
Subscriptions can run on different intervals (ie daily, weekly, monthly etc) and frequencies (ie ‘every X days’). You can also control the start date for a subscription.
\nSubscriptions can also be configured to end after:
\n- \n
a certain number of transactions
\n \nan amount (eg end before reaching $1000 or end after reaching $1000)
\n \na date
\n \n
If a subscription is created without a customer ID, a new customer will be created and the customer ID will be returned in the response.
\nNetwork Tokens Support: For flow 7, if the default Customer payment source is a Vault token that has an active Network Token, it will be used during payment processing. If the Network Token can't be used, the charge will be processed with card details.
\nRequest body
\n","urlObject":{"path":["v1","subscriptions"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d66fe264-34ac-4f34-af59-55726cae6f1e","name":"create with vault-token","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"10.00\",\n \"currency\": \"AUD\",\n \"reference\": \"Fuga consequuntur sint ab magnam\",\n \"description\": \"Vitae commodi provident assumenda\",\n \"customer\": {\n \"payment_source\": {\n \"gateway_id\": \"5dde1f3799cfea21ed2fc942\",\n \"vault_token\": \"1f062e68-89cf-4554-bc0b-1225013163e9\"\n }\n },\n \"schedule\": {\n \"frequency\": \"1\",\n \"interval\": \"month\",\n \"start_date\": \"2020-07-20\",\n \"end_date\": \"2020-09-25T07:35:11Z\"\n }\n}"},"url":"{{url}}/v1/subscriptions"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 03 Sep 2020 09:50:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1006"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockDelete Subscription to change subsscription status to \"deleted\". You can still retrieve subscriptions with \"deleted\" status.
\nRequest params
\n","urlObject":{"path":["v1","subscriptions",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"9a55bb8f-6553-47a1-ba67-49a9ce734728","type":"string","value":"5ef064763dcfec0ac5e0622e","key":"id"}]}},"response":[{"id":"c4ceca6b-b0c1-4670-bd1a-879053cacc99","name":"delete success","originalRequest":{"method":"DELETE","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/subscriptions/:id","host":["{{url}}"],"path":["v1","subscriptions",":id"],"variable":[{"key":"id","value":"5ef064763dcfec0ac5e0622e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 03 Sep 2020 07:47:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1134"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"status\": \"active\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/subscriptions/:id","description":"Update subscription settings or/and apply an additional flow.
\nAdditional Flow
\n- \n
- Restart a subscription starting on a specific day. (The payment cycle will start on the specified date.) \n
- Reactivate an expired or deleted subscription starting on a specific day by updating its status to active. (The payment cycle will start on the specified date.) \n
- Reactivate a failed subscription by updating the status to active. After reactivation, the system will charge all the skipped payments. \n
- Transfer an active subscription to the held status. Records on charges will still be created, however, the payment itself is not sent to the gateway and thus not processed. \n
- Transfer a held subscription to the active status. All held charges remain held, i.e. it is not possible to re-process them. \n
- Transfer a subscription to the final status (deleted or expired) manually. \n
Status modification
\nThe diagram below shows all possible ways of status modification and how it affects the payment cycle.\n
Request params
\nRequest body
\n","urlObject":{"path":["v1","subscriptions",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"12ae9dc0-f367-4d2d-a641-35d2b117099e","type":"string","value":"5f50f59580c950150a6038a9","key":"id"}]}},"response":[{"id":"8427e35e-fc1c-4fb8-bd31-7696fee57a11","name":"modify deleted subscription error","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"schedule\" : {\n \"start_date\": \"2020-09-14T21:00:00.000Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/subscriptions/:id","host":["{{url}}"],"path":["v1","subscriptions",":id"],"variable":[{"key":"id","value":"5f5e1eb189201b0866d045f5"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Sun, 13 Sep 2020 19:33:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"413"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockSubscriptions are recurring billing events. These can be set up to take scheduled payments from a customer without having to re-enter the billing details.
\nConditions
\nThe response is different depending on such conditions:
\n- \n
- Created with a credit card payment source \n
- Created with a bank account payment source \n
- Created with an existing customer \n
- Created with a one-time token \n
Subscription resource
\nStatus
\nExpire reason
\nSchedule status
\n","event":[{"listen":"prerequest","script":{"id":"858542b7-1bd0-4665-812c-0a724785f32b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b0439719-3377-4fa2-8481-eb3a415caadb","type":"text/javascript","exec":[""]}}],"_postman_id":"0a3a21d6-a17c-406b-9aef-144157f8d00e"},{"name":"transfers","item":[{"name":"search","id":"3ff04a98-b53c-4541-aa3e-eba51a8b9464","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/transfers","description":"Returns all transfers for the account
\nRequest query params
\nPagination
\nfilters
\n","urlObject":{"path":["v1","transfers"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"96da4b52-a44f-40f2-aa3c-3358794070bf","name":"search by archived","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/v1/transfers?archived=true","host":["{{url}}"],"path":["v1","transfers"],"query":[{"key":"archived","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 07 Sep 2020 11:24:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"410"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/transfers/:id","description":"Retrieves data on a transfer with specified ID.
\nRequest params
\n","urlObject":{"path":["v1","transfers",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"be9a33b7-8b13-4230-a669-942bc714a33a","type":"string","value":"5e1874032139a47666c372f4","key":"id"}]}},"response":[{"id":"d0f07947-cd9b-460b-a7bd-3908a36e9907","name":"get","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/v1/transfers/:id","host":["{{url}}"],"path":["v1","transfers",":id"],"variable":[{"key":"id","value":"5e1874032139a47666c372f4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 07 Sep 2020 11:30:55 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2457"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reference\": \"Fuga consequuntur sint ab magnam\",\n \"description\": \"Vitae commodi provident assumenda\",\n \"gateway_id\": \"5df1e8a28dfcf018377928fd\",\n \"payouts\": [\n {\n \"amount\": \"10.00\",\n \"currency\": \"AUD\",\n \"customer_id\": \"5f50f59480c950150a6038a6\"\n }\n ]\n}"},"url":"{{url}}/v1/transfers","description":"You can create a transfer using direct debit payment destination. Transfers are creating in two steps: prepare a transfer and then capture it. All prepared transfers can be captured or archived in future.
\nRequest body
\n","urlObject":{"path":["v1","transfers"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"846959f0-b73f-4e90-9a80-10f6f1c4e795","name":"create with customer_id","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reference\": \"Fuga consequuntur sint ab magnam\",\n \"description\": \"Vitae commodi provident assumenda\",\n \"gateway_id\": \"5df1e8a28dfcf018377928fd\",\n \"payouts\": [\n {\n \"amount\": \"10.00\",\n \"currency\": \"AUD\",\n \"customer_id\": \"5f50f59480c950150a6038a6\"\n }\n ]\n}"},"url":"{{url}}/v1/transfers"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 07 Sep 2020 12:49:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"695"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"x-powered-by","value":"PayDockArchive Transfer to hide it from transfers list. You can still retrieve archived transfers.
\nRequest params
\n","urlObject":{"path":["v1","transfers",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"83ba3b97-3ca0-4c0d-87fc-8fdff72a0178","type":"string","value":"5e1874032139a47666c372f4","key":"id"}]}},"response":[{"id":"84366ea5-0fdf-4264-b291-b763e6f11df1","name":"delete success","originalRequest":{"method":"DELETE","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/transfers/:id","host":["{{url}}"],"path":["v1","transfers",":id"],"variable":[{"key":"id","value":"5e1874032139a47666c372f4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 07 Sep 2020 11:27:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2457"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/transfers/:id/capture","description":"For capturing a transfer, make a POST call
\nRequest params
\n","urlObject":{"path":["v1","transfers",":id","capture"],"host":["{{url}}"],"query":[],"variable":[{"id":"3464cfc1-8a5a-4709-8ce0-689ed9df6d56","type":"string","value":"5f561fa9bb8a75181d42c1a0","key":"id"}]}},"response":[{"id":"50a60e83-3796-4fbe-9f29-930308dfbcc2","name":"capture not pending status","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/v1/transfers/:id/capture","host":["{{url}}"],"path":["v1","transfers",":id","capture"],"variable":[{"key":"id","value":"5e1874032139a47666c372f4"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 07 Sep 2020 11:32:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"211"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"x-powered-by","value":"PayDockTransfers help sending money from a connected payment services to a bank account and retrieve transfers details.
\nTransfer resource
\nStatus
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"4bd60666-51c9-40fe-aa16-b4bf0c65e18e"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"5f8c48a4-ea7b-42d3-80bd-450a37274bc3"}}],"_postman_id":"e6b0938e-62f6-47da-bf7f-54348798942a"},{"name":"services","item":[{"name":"search","id":"ce24d7f8-754c-4768-85ce-841523225906","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/services?archived=true","description":"Returns all services for the account, limited to 100 records.
\nRequest query parameters
\nPagination
\nFilters
\nOther
\n","urlObject":{"path":["v1","services"],"host":["{{url}}"],"query":[{"key":"archived","value":"true"}],"variable":[]}},"response":[{"id":"979082b0-ecdd-4bdf-a07c-4dccedb83ef9","name":"search by archived","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/v1/services?archived=true","host":["{{url}}"],"path":["v1","services"],"query":[{"key":"archived","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 08 Sep 2020 10:33:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"981"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/services/:id","description":"Retrieves data on a service with the specified ID.
\nRequest parameters
\n","urlObject":{"path":["v1","services",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"a3276f13-c174-4108-8da8-5aa345ccb44c","type":"string","value":"5f57571fbb8a75181d42c231","key":"id"}]}},"response":[{"id":"59660c77-b9a2-4723-ba6f-b9ffb8470226","name":"[fraud group] common","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/v1/services/:id","host":["{{url}}"],"path":["v1","services",":id"],"variable":[{"key":"id","value":"5f57571fbb8a75181d42c231"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 08 Sep 2020 10:11:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"772"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/services/:id","description":"Retrieves data on available types and route labels.
\nFilters
\nProxy Link Option Resource
\n","urlObject":{"path":["v1","services",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"a3276f13-c174-4108-8da8-5aa345ccb44c","type":"string","value":"5f57571fbb8a75181d42c231","key":"id"}]}},"response":[{"id":"999a9855-1cd0-41c2-9587-2f607633b5e3","name":"common","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/services/proxy-links"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 Jan 2021 08:55:31 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"154"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"Accertify\",\n \"name\": \"First service\",\n \"group\": \"fraud\",\n \"credentials\": {\n \"username\": \"username\",\n \"password\": \"password\",\n \"merchant\": \"merchant\"\n },\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": true,\n \"mode\": \"passive\"\n }\n}"},"url":"{{url}}/v1/services","description":"You can connect to a service account more than once by using a different name each time.
\nA different set of parameters is required for every service. For more details, see the list below.
\nRequest body for the fraud group
\nRequest body for the proxy_link group
\nRequest body for the 3ds group
\n3ds services can be created in two different modes:
\n- \n
Direct integration: this mode is the default and most common one, where merchant provides all the credentials to connect to a service
\n \nMaster Merchant integration: in this mode we create a sub merchant account under PayDock master merchant account. Please ask for access to your PayDock point of contact.
\n \n
Request body for the card_scheme group
\nRequest body for the network_token group
\nThe corresponding feature option should be enabled (Feature Options Allowed Services Network Token) to be able to create a network_token service.
Before creating a network_token service the corresponding registration should be created and the status of the registration should be completed.
If the flag network_token_options.default is true and there is already existed default service for the current type, then the flag network_token_options.default of the existing service will be updated to false. If no Network Token Service is configured as default=true network tokens will not be created under the hood of Vault API.
Note: Creating more than one Network Token Service per Registration is not recommended.
\n","urlObject":{"path":["v1","services"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"41408e6b-040e-47bc-8adc-0fe607e1ebfb","name":"[fraud group] common","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"Accertify\",\n \"name\": \"Service Name\",\n \"group\": \"fraud\",\n \"credentials\": {\n \"username\": \"username\",\n \"password\": \"password\",\n \"merchant\": \"merchant\"\n },\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": true,\n \"mode\": \"passive\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/services"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 08 Sep 2020 09:51:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"349"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"15d-LgWibDtEMz4803fznyEeAIEXQhY\""},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"error\": null,\n \"resource\": {\n \"type\": \"services\",\n \"data\": {\n \"_id\": \"5f575421bb8a75181d42c224\",\n \"name\": \"Service Name\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": true,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-09-08T09:51:29.529Z\",\n \"updated_at\": \"2020-09-08T09:51:30.777Z\"\n }\n }\n}"},{"id":"d110fd2a-c828-449d-a493-23101fb05a9e","name":"[proxy_link group] common","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"Booking\",\n \"name\": \"Booking Get Card Info\",\n \"group\": \"proxy_link\",\n \"mode\": \"live\",\n \"proxy_link_options\": {\n \"route_label\": \"GetCardInfo\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/services"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 Jan 2021 09:07:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"331"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"14b-zTDRgkDyCFL/aNW0be3ISymqBa0\""},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"error\": null,\n \"resource\": {\n \"type\": \"services\",\n \"data\": {\n \"_id\": \"6009445b7e96201f71a83a3f\",\n \"name\": \"Booking Get Card Info\",\n \"group\": \"proxy_link\",\n \"type\": \"Booking\",\n \"mode\": \"live\",\n \"archived\": false,\n \"created_at\": \"2021-01-21T09:07:39.961Z\",\n \"updated_at\": \"2021-01-21T09:07:39.961Z\",\n \"proxy_link_options\": {\n \"route_label\": \"GetCardInfo\"\n }\n }\n }\n}"},{"id":"046be706-5928-4634-b5df-8eb82cde4bf9","name":"[3ds group] direct","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","description":"This is your PayDock API Secret Key"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Service Name\",\n \"group\": \"3ds\",\n \"type\": \"GPayments\",\n \"credentials\": {\n \"merchant\": \"merchant ID\",\n \"username\": \"merchant name\",\n \"certificate\": \"Merchant Certificate Base64\",\n \"certificate_passphrase\": \"Merchant Certificate Password\",\n \"certificate2\": \"CA Certificate Base64\"\n },\n \"mode\": \"test\",\n \"_3ds_options\": {\n \"default\": true,\n \"mode\": \"direct\",\n \"url\": \"Base API URL\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/services"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 Jan 2021 09:07:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"331"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"14b-zTDRgkDyCFL/aNW0be3ISymqBa0\""},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"error\": null,\n \"resource\": {\n \"type\": \"services\",\n \"data\": {\n \"_id\": \"61d724778738150e843e8bfc\",\n \"name\": \"Service Name\",\n \"group\": \"3ds\",\n \"type\": \"GPayments\",\n \"mode\": \"test\",\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2022-01-06T17:18:47.612Z\",\n \"updated_at\": \"2022-01-06T17:18:47.650Z\",\n \"_3ds_options\": {\n \"default\": true,\n \"mode\": \"direct\",\n \"url\": \"Base API URL\"\n }\n }\n }\n}"},{"id":"51a2bc51-f582-4428-a0b4-e595716ef777","name":"[3ds group] paydock master merchant","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","description":"This is your PayDock API Secret Key"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Service Name\",\n \"group\": \"3ds\",\n \"type\": \"GPayments\",\n \"credentials\": {\n \"username\": \"merchant name\"\n },\n \"mode\": \"test\",\n \"_3ds_options\": {\n \"mode\": \"master_merchant\",\n \"currency\": \"AUD\",\n \"country\": \"AU\",\n \"url\": \"url\",\n \"default\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/services"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 Jan 2021 09:07:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"331"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"14b-zTDRgkDyCFL/aNW0be3ISymqBa0\""},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"error\": null,\n \"resource\": {\n \"type\": \"services\",\n \"data\": {\n \"_id\": \"61d726908738150e843e8c05\",\n \"name\": \"Service Name\",\n \"group\": \"3ds\",\n \"type\": \"GPayments\",\n \"mode\": \"test\",\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2022-01-06T17:27:44.378Z\",\n \"updated_at\": \"2022-01-06T17:27:44.378Z\",\n \"_3ds_options\": {\n \"default\": false,\n \"mode\": \"master_merchant\",\n \"currency\": \"USD\",\n \"country\": \"AU\",\n \"url\": \"url\"\n }\n }\n }\n}"},{"id":"8e60f055-a279-4feb-9267-8ec8fa7e9618","name":"[click to pay] create service from registration","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","description":"This is your PayDock API Secret Key"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Click to Pay Service\",\n \"group\": \"click_to_pay\",\n \"type\": \"ClickToPay\",\n \"mode\": \"test\",\n \"registration_id\": \"65e9a27b586f8714510b5dc5\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/services"},"status":"Created","code":201,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"error\": null,\n \"resource\": {\n \"type\": \"services\",\n \"data\": {\n \"_id\": \"65eb5663426082149b459d04\",\n \"name\": \"Click to Pay Service\",\n \"group\": \"click_to_pay\",\n \"type\": \"ClickToPay\",\n \"mode\": \"test\",\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2024-03-08T18:18:11.687Z\",\n \"updated_at\": \"2024-03-08T18:18:11.687Z\",\n \"registration_id\": \"65e9a27b586f8714510b5dc5\"\n }\n }\n}"},{"id":"0cbeaea0-e6e3-4f5d-a840-0f7d41dd13ba","name":"[network_token] create service","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","description":"This is your PayDock API Secret Key"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Network Token Service\",\n \"group\": \"network_token\",\n \"type\": \"MastercardSCOF\",\n \"mode\": \"test\",\n \"registration_id\": \"65e9a27b586f8714510b5dc6\",\n \"network_token_options\": {\n \"default\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/services"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"error\": null,\n \"resource\": {\n \"type\": \"services\",\n \"data\": {\n \"_id\": \"65eb5663426082149b459d05\",\n \"name\": \"Network Token Service\",\n \"group\": \"network_token\",\n \"type\": \"MastercardSCOF\",\n \"mode\": \"test\",\n \"archived\": false,\n \"created_at\": \"2024-15-08T18:18:11.687Z\",\n \"updated_at\": \"2024-15-08T18:18:11.687Z\",\n \"registration_id\": \"65e9a27b586f8714510b5dc5\",\n \"network_token_options\": {\n \"default\": true\n }\n }\n }\n}"}],"_postman_id":"269e8771-d3fc-4dd2-af2e-c8e61eda9fbc"},{"name":"delete","id":"c05fa4d1-8ca0-4b88-8341-eb603ddeac4b","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"host":true,"user-agent":true,"accept":true,"connection":true,"accept-encoding":true}},"request":{"method":"DELETE","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/services/:id","description":"Archives a service to hide it from the service list. You can still retrieve archived services.
\nRequest parameters
\nDelete network_token group
\nIt's forbidden to delete a network_token service if:
- \n
provided service is a default and there are no other services for the current card scheme
\n \nat least one active network token is created using the provided service
\n \n
This is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Name\",\n\t\"fraud_options\": {\n\t\t\"mode\": \"active\",\n\t\t\"default\": false\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/services/:id","description":"Updates configuration for a service.
\nRequest parameters
\nRequest body for the fraud group
\nRequest body for the proxy_link group
\nRequest body for the 3ds group
\nRequest body for the network_token group
\nIf the flag network_token_options.default is true and there is already existed default service for the current type, then the flag network_token_options.default of the existing service will be updated to false.
This is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"credentials\": {\n \"username\": \"wanda\",\n \"password\": \"ieSf2zrSHm7w2}C~)\",\n \"merchant\": \"100000000\"\n },\n \"mode\": \"virtual\"\n}"},"url":"{{url}}/v1/services/:id/verify","urlObject":{"path":["v1","services",":id","verify"],"host":["{{url}}"],"query":[],"variable":[{"id":"170e5e19-60af-473c-b233-902553018b80","type":"string","value":"5f58ed3b1f3a4238e1d73082","key":"id"}]}},"response":[{"id":"dc28a9ec-01e6-4983-aca9-6593dd1842fd","name":"common","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"credentials\": {\n \"username\": \"wanda\",\n \"password\": \"ieSf2zrSHm7w2}C~)\",\n \"merchant\": \"100000000\"\n },\n \"mode\": \"virtual\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/services/:id/verify","host":["{{url}}"],"path":["v1","services",":id","verify"],"variable":[{"key":"id","value":"5f58ed3b1f3a4238e1d73082"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 Jan 2021 11:00:29 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"360"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"x-powered-by","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mode\": \"test\",\n \"credentials\": {\n \"username\": \"username\"\n },\n \"_3ds_options\": {\n \"default\": true,\n \"currency\": \"AUD\",\n \"country\": \"AU\",\n \"url\": \"url\"\n }\n}"},"url":"{{url}}/v1/services/:id/generate-access","urlObject":{"path":["v1","services",":id","generate-access"],"host":["{{url}}"],"query":[],"variable":[{"id":"6a8cdc01-dd6f-487b-99da-d3049c849323","type":"string","value":"61d726908738150e843e8c05","key":"id"}]}},"response":[{"id":"5d614c2b-8291-4ef6-8391-d5bf7199f0e4","name":"[3ds group] paydock master merchant","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"mode\": \"test\",\n \"credentials\": {\n \"username\": \"username\"\n },\n \"_3ds_options\": {\n \"default\": true,\n \"currency\": \"AUD\",\n \"country\": \"AU\",\n \"url\": \"url\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/services/:id/generate-access","host":["{{url}}"],"path":["v1","services",":id","generate-access"],"variable":[{"key":"id","value":"61d726908738150e843e8c05"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 Jan 2021 11:00:29 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"360"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"x-powered-by","value":"PayDockPayDock enables you to connect to different services (gateways, fraud, etc.) within a single PayDock account.
\nServices can be added through the API or via the PayDock Dashboard.
\nBefore you proceed, you should register an account with the required service in their system, where specific data can be found (service username, merchant ID, API key, etc.).
\nService resource
\nFlow
\n- \n
Created with the
\nfraudgroup \nCreated with the
\nproxy_linkgroup \nCreated with the
\nnetwork_tokengroup \n
Status
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"97aa7d5e-08f4-4570-9475-a74f3d280f70"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"8cfead1c-cd4d-409b-a44b-b456b24cdb14"}}],"_postman_id":"0ae9dbd7-2912-43b4-b900-70fe332bc08d"},{"name":"tokens","item":[{"name":"create","id":"4d8d3f81-5b4c-4da9-acbc-afc5a3fab6c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-user-public-key","value":"{{publickey}}","description":"This is your PayDock API Public Key
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json
\n"}],"body":{"mode":"raw","raw":"{\n \"gateway_id\": \"5eda22bb37356514ddaabee7\",\n \"card_name\": \"Wanda Mertz\",\n \"card_number\": \"5123450000000008\",\n \"expire_month\": \"09\",\n \"expire_year\": \"21\",\n \"card_ccv\": \"123\",\n \"store_ccv\": false\n}"},"url":"{{url}}/v1/payment_sources/tokens","description":"Create one-time token
\nTokens can also be created using client-sdk
\nThis endpoint is available both with a secret and public token
\nFlow
\nYou can create a one time token using:
\n- \n
- Create OTT using a Credit Card \n
- Create OTT using a Bank Account \n
- Create OTT using a Gift Card \n
- Create OTT using a Credit Card and without Gateway_ID \n
- Create OTT using a Bank Account and without Gateway_ID \n
Request body
\n","urlObject":{"path":["v1","payment_sources","tokens"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"6b09df26-a38a-4155-a479-552b5fcf5823","name":"create with credit card","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Public Key","key":"x-user-public-key","value":"{{publickey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_name\": \"Wanda Mertz\",\n \"card_number\": \"4242424242424242\",\n \"expire_month\": \"09\",\n \"expire_year\": \"21\",\n \"card_ccv\": \"123\"\n}"},"url":"{{url}}/v1/payment_sources/tokens"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 26 May 2020 14:56:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"101"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockOne-time token represents payment source information including Credit cards or Direct Debit account details. It is a disposable token for creating charges/subscriptions/customers or updating customers. One-time tokens expire after 3 hours.
\n","_postman_id":"64a29074-66fe-4a4c-a7ea-7529d84d5af0"},{"name":"gateways","item":[{"name":"create","id":"1f48daf1-0f6f-411c-beda-36c855e81188","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key
\n","key":"x-user-secret-key","type":"text","value":"{{secretkey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"Stripe\",\n \"name\": \"first strip gateway\",\n \"username\": \"secret_key\"\n}"},"url":"{{url}}/v1/gateways","description":"You can add a gateway account more than once by using a different name each time.
\nEach of the gateways requires a different set of parameters. Refer to the list below for more information.
\n- \n
- Add gateway using your credentials. \n
- Add gateway using your credentials and activate wallet payments (Apple/Google Pay) \n
Gateway types
\nRequest body
\nRequest body for each gateway
\n","urlObject":{"path":["v1","gateways"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3141d10b-cf8d-44f5-9184-bda51813bc42","name":"create with incorrect credentials","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"Stripe\",\n \"name\": \"first strip gateway\",\n \"username\": \"test\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/gateways"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 25 May 2020 13:13:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"97"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"Stripe\",\n \"name\": \"first strip gateway\",\n \"username\": \"m5Jlhv0P2ASyFZYd2UEksqabQt5S92ut\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/gateways/:id","description":"Retrieves data on a gateway with specified ID
\nRequest params
\n","urlObject":{"path":["v1","gateways",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"96d93ccb-d607-44c4-89d7-09b943cb9b19","type":"string","value":"5ecbc728b12c99579e47002e","key":"id"}]}},"response":[{"id":"2ca489d7-f32b-45dd-9df5-c4d4bd249b45","name":"get success","originalRequest":{"method":"GET","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{url}}/v1/gateways/:id","host":["{{url}}"],"path":["v1","gateways",":id"],"variable":[{"key":"id","value":"5ecbc728b12c99579e47002e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 25 May 2020 13:26:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"272"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/gateways?limit=1&skip=1&sort_key=created_at&sort_direction=DESC","description":"Returns all gateways for the account
\nRequest query params
\nPagination
\nOther
\n","urlObject":{"path":["v1","gateways"],"host":["{{url}}"],"query":[{"key":"limit","value":"1"},{"key":"skip","value":"1"},{"key":"sort_key","value":"created_at"},{"key":"sort_direction","value":"DESC"}],"variable":[]}},"response":[{"id":"53f12b8a-5559-4ed3-ab93-71451a3df5c1","name":"search by phrase","originalRequest":{"method":"GET","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{url}}/v1/gateways?search=first strip gateway","host":["{{url}}"],"path":["v1","gateways"],"query":[{"key":"search","value":"first strip gateway"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 25 May 2020 14:11:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"395"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"PayDockThis is your PayDock API Secret Key
\n"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"first updated strip gateway\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/gateways/:id","description":"Updates configuration for a gateway. Use query parameter ‘action=check’ to check gateway credentials before updating.
\nRequest params
\nRequest query
\nRequest body
\n","urlObject":{"path":["v1","gateways",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5ecbc728b12c99579e47002e","key":"id"}]}},"response":[{"id":"ab0e6063-0f8e-40a8-a4d3-8b71b35cac07","name":"update with an incorrect format","originalRequest":{"method":"PUT","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": {}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/gateways/:id","host":["{{url}}"],"path":["v1","gateways",":id"],"variable":[{"key":"id","value":"5ecbc728b12c99579e47002e"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 25 May 2020 14:19:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"90"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"Stripe\",\n \"name\": \"first strip gateway\",\n \"username\": \"m5Jlhv0P2ASyFZYd2UEksqabQt5S92ut\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/gateways/:id","description":"Archive gateway with the specified ID. A gateway cannot be archived if it has subscriptions running through it.
\nRequest params
\n","urlObject":{"path":["v1","gateways",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"e4c2fb71-de94-4c5d-8569-955eb256c437","type":"string","value":"5ecbc728b12c99579e47002e","key":"id"}]}},"response":[{"id":"5feb9ca0-1503-4c2e-97b3-621bedc9a13a","name":"archive success","originalRequest":{"method":"DELETE","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"Stripe\",\n \"name\": \"first strip gateway\",\n \"username\": \"m5Jlhv0P2ASyFZYd2UEksqabQt5S92ut\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/gateways/:id","host":["{{url}}"],"path":["v1","gateways",":id"],"variable":[{"key":"id","value":"5ecbc728b12c99579e47002e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 25 May 2020 14:21:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"255"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockPayDock enables multiple gateways to be connected to a single PayDock account, see our list of Supported Gateways
\nGateways can be added through the API where the third-party gateway supports it or through the PayDock Admin Portal.
\nBefore assigning a gateway to a company, there should be an account registered with required gateway in their system, where specific data can be found (gateway token, merchant ID, etc.).
\nGateway resource
\n","_postman_id":"2c8379d7-3953-4f8d-aca4-8c41fb4e08a5"},{"name":"network-tokens","item":[{"name":"create for existing vault","id":"270644f7-46fe-4b75-bf60-cf93cb26dc68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"default\": true,\n \"service_id\": \"66c4a9ba8cb041c6f4b86654\" \n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/vault-tokens/:vault_token/network-tokens","description":"Create a new network token for an existing vault.
\nNote: Network Tokens can't be created for Visa vaults without email. If Email is not provided in the Vault creation request, Paydock will automatically generate it. It’s highly recommended for merchants to provide email and use Paydock generation in rare cases. Network Tokens are supported only for permanent vaults.
\nRequest body
\nRequest params
\n","urlObject":{"path":["v1","vault-tokens",":vault_token","network-tokens"],"host":["{{url}}"],"query":[],"variable":[{"description":{"content":"The vault token UUID that a new network token should be created for
\n","type":"text/plain"},"type":"any","value":"288f776f-0391-4aae-8280-21a612a55841","key":"vault_token"}]}},"response":[{"id":"dbaab32e-aec9-4b05-a5d6-e608423530cc","name":"success","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"default\": true,\n \"service_id\": \"66c4a9ba8cb041c6f4b86654\" \n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/vault-tokens/:vault_token/network-tokens","host":["{{url}}"],"path":["v1","vault-tokens",":vault_token","network-tokens"],"variable":[{"key":"vault_token","value":"288f776f-0391-4aae-8280-21a612a55841","description":"The vault token UUID that a new network token should be created for"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"PayDockGet information about a given network token.
\nRequest Params
\n","urlObject":{"path":["v1","vault-tokens",":vault_token","network-tokens",":network_token_id"],"host":["{{url}}"],"query":[],"variable":[{"id":"e471df12-2296-42ea-a9b2-9c8eed931bf2","description":{"content":"The vault token UUID of the network token that should gotten
\n","type":"text/plain"},"type":"any","value":"b52f1448-2a5f-447f-8a6c-c64ea8af899c","key":"vault_token"},{"id":"d2c4f33d-7757-42e1-a4dc-86f78ca3e9f9","description":{"content":"The ID of the network token
\n","type":"text/plain"},"type":"any","value":"66c708db3ba53d8f417be515","key":"network_token_id"}]}},"response":[{"id":"682496e3-cd7f-479a-9bfe-49427aa53da0","name":"success","originalRequest":{"method":"GET","header":[{"key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/vault-tokens/:vault_token/network-tokens/:network_token_id","host":["{{url}}"],"path":["v1","vault-tokens",":vault_token","network-tokens",":network_token_id"],"variable":[{"key":"vault_token","value":"b52f1448-2a5f-447f-8a6c-c64ea8af899c","description":"The vault token UUID of the network token that should gotten"},{"key":"network_token_id","value":"66c708db3ba43d8f417be515","description":"The ID of the network token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:15:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PayDockChange the default network token for payment processing.
\nRequest Body
\nRequest params
\n","urlObject":{"path":["v1","vault-tokens",":vault_token","network-tokens",":network_token_id"],"host":["{{url}}"],"query":[],"variable":[{"id":"1d51e521-c840-48de-acb2-95569c9b05f7","description":{"content":"The vault token UUID that a new network token should be created for
\n","type":"text/plain"},"type":"any","value":"288f776f-0391-4aae-8280-21a612a55841","key":"vault_token"},{"id":"7bf2103c-c8e0-4537-bb3d-a960d3e1b3d0","description":{"content":"The ID of the network token to be updated
\n","type":"text/plain"},"type":"any","value":"66c4b7dc4e80bd6a51710b24","key":"network_token_id"}]}},"response":[{"id":"21445316-8a58-4064-bad5-965e2fb0af6f","name":"success","originalRequest":{"method":"PUT","header":[{"key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"default\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/vault-tokens/:vault_token/network-tokens/:network_token_id","host":["{{url}}"],"path":["v1","vault-tokens",":vault_token","network-tokens",":network_token_id"],"variable":[{"key":"vault_token","value":"288f776f-0391-4aae-8280-21a612a55841","description":"The vault token UUID that a new network token should be created for"},{"key":"network_token_id","value":"66c4b7dc4e80bd6a51710b24","description":"The ID of the network token to be updated "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"PayDockDelete a network token from an existing vault.
\nA single request to delete one network token for a given vault will also delete all other network tokens for the vault which were created with services connected to the same(single) registration.
\nRequest Body
\nRequest params
\n","urlObject":{"path":["v1","vault-tokens",":vault_token","network-tokens",":network_token_id"],"host":["{{url}}"],"query":[],"variable":[{"id":"213ef81e-4336-4b0d-8058-3eb9d5ff4691","description":{"content":"The vault token UUID of the network token that should be deleted
\n","type":"text/plain"},"type":"any","value":"288f776f-0391-4aae-8280-21a612a55841","key":"vault_token"},{"id":"f1cbbe24-3943-4b40-b892-4b3b3d0c209d","description":{"content":"The ID of the network token to be deleted
\n","type":"text/plain"},"type":"any","value":"66c4b7dc4e80bd6a51710b24","key":"network_token_id"}]}},"response":[{"id":"533589f2-8684-42f1-b90a-75dc56f4d8b5","name":"success","originalRequest":{"method":"DELETE","header":[{"key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/vault-tokens/:vault_token/network-tokens/:network_token_id","host":["{{url}}"],"path":["v1","vault-tokens",":vault_token","network-tokens",":network_token_id"],"variable":[{"key":"vault_token","value":"288f776f-0391-4aae-8280-21a612a55841","description":"The vault token UUID of the network token that should be deleted"},{"key":"network_token_id","value":"66c4b7dc4e80bd6a51710b24","description":"The ID of the network token to be deleted"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 20 Aug 2024 14:40:53 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockNetwork tokenization is a security technology that replaces sensitive payment information, like the Primary Account Number (PAN), expiry date, and CVV, with a unique identifier called a token. Schemes (payment networks) like Visa, Mastercard, and Amex offer network tokenization services, issuing tokens that are interoperable across many merchants and processors within their networks. This allows for secure transactions without ever exposing the full PAN, although the PAN might be required initially to create the token. Network tokenization enhances security, reduces data storage requirements, and improves the customer experience by streamlining checkout and enabling automatic card updates for recurring payments.
\nNetwork Token Resource
\nPossible Statuses
\n","_postman_id":"f0eed57e-6548-415c-b210-ca13fc6690a1"},{"name":"vaults","item":[{"name":"create","id":"381ac9a4-2e56-4dcb-afeb-14bc7d63b8eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","description":"This is your PayDock API Secret Key
\n"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json
\n"}],"body":{"mode":"raw","raw":"{\n \"card_name\": \"Carlie Kuvalis\",\n \"card_number\": \"4242424242424242\",\n \"expire_month\": \"09\",\n \"expire_year\": \"21\",\n \"card_ccv\": \"123\",\n \"email\": \"carlie.kuvalis@example.com\",\n \"network_token_service_id\": \"66c46c0d8cb041c6f4b80122\",\n \"data_source\": \"stored\"\n}"},"url":"{{url}}/v1/vault/payment_sources","description":"Create a new vault payment token representing user’s payment information.
\nFlow
\nYou can create a vault using:
\n- \n
credit card
\n \nbank account
\n \none-time token
\n \ngift card
\n \n
When vault is created using credit card or one-time token created from credit card, if the credit card is tokenizable(mastercard or visa card), network token is also created for the vault if Network Token Service is connected for the scheme as default=true and Registration is in completed status.
Information about the network token created can be seen by making a GET call to {{url}}/v1/vault-tokens/{{vault_token}}, vault_token being the vault token UUID from the create vault request.
Note: Network Tokens can't be created for Visa vaults without email. Email is required by Visa for Network Token provisioning. Network Tokens are supported only for permanent vaults.
\nRequest body
\n","urlObject":{"path":["v1","vault","payment_sources"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0dc23231-276d-405c-a0c2-944570394da6","name":"create with credit card","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","description":"This is your PayDock API Secret Key"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json"}],"body":{"mode":"raw","raw":"{\n \"card_name\": \"Carlie Kuvalis\",\n \"card_number\": \"4242424242424242\",\n \"expire_month\": \"09\",\n \"expire_year\": \"21\",\n \"card_ccv\": \"123\",\n \"email\": \"carlie.kuvalis@example.com\",\n \"network_token_service_id\": \"66c46c0d8cb041c6f4b80122\",\n \"data_source\": \"stored\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/vault/payment_sources"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 26 May 2020 15:05:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"472"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"expire_month\": \"01\",\n \"expire_year\": \"22\"\n}"},"url":"{{url}}/v1/vault-tokens/:vault_token","description":"Update a payment information
\nRequest params
\nRequest body
\nResponse body
\n","urlObject":{"path":["v1","vault-tokens",":vault_token"],"host":["{{url}}"],"query":[],"variable":[{"id":"d0f15c3b-928c-49dc-8570-b3a1af384267","type":"string","value":"bfd538f5-e4e5-43bd-871d-3ffa6db7f59a","key":"vault_token"}]}},"response":[{"id":"ef3386b8-2bec-41a2-b01d-ccf84adda8ec","name":"modify expiry date of a vault token","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"expire_month\": \"01\",\n \"expire_year\": \"22\"\n}"},"url":{"raw":"{{url}}/v1/vault-tokens/:vault_token","host":["{{url}}"],"path":["v1","vault-tokens",":vault_token"],"variable":[{"key":"vault_token","value":"bfd538f5-e4e5-43bd-871d-3ffa6db7f59a"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 26 May 2020 15:15:02 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"108"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/vault/payment_sources?limit=2&skip=1&sortkey=updated_at&sortdirection=DESC","description":"Pagination
\nfilters
\nOther
\n","urlObject":{"path":["v1","vault","payment_sources"],"host":["{{url}}"],"query":[{"key":"limit","value":"2"},{"key":"skip","value":"1"},{"key":"sortkey","value":"updated_at"},{"key":"sortdirection","value":"DESC"}],"variable":[]}},"response":[{"id":"f683ac58-7041-4f7e-948f-5d7cc655e2e4","name":"search with filter","originalRequest":{"method":"GET","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","description":"This is your PayDock API Secret Key"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json"}],"url":{"raw":"{{url}}/v1/vault/payment_sources?type=card","host":["{{url}}"],"path":["v1","vault","payment_sources"],"query":[{"key":"type","value":"card"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 May 2020 11:55:48 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"977"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"expire_month\": \"01\",\n \"expire_year\": \"22\"\n}"},"url":"{{url}}/v1/vault-tokens/:vault_token","description":"Returns payment source information associated with a vault token, including network tokens associated with the given vault if any.
\nRequest params
\nOther
\n","urlObject":{"path":["v1","vault-tokens",":vault_token"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"b52f1448-2a5f-447f-8a6c-c64ea8af899c","key":"vault_token"}]}},"response":[{"id":"d413c62b-0285-4afa-b325-97ea4421cc62","name":"error","originalRequest":{"method":"GET","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","description":"This is your PayDock API Secret Key"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json"}],"body":{"mode":"raw","raw":"{\n \"expire_month\": \"01\",\n \"expire_year\": \"22\"\n}"},"url":{"raw":"{{url}}/v1/vault-tokens/:vault_token","host":["{{url}}"],"path":["v1","vault-tokens",":vault_token"],"variable":[{"key":"vault_token","value":"bfd538f5-e4e5-43bd-871d-3ffa6db7f59a"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"fraud\",\n \"requestor\": \"cardholder\",\n \"reason_desc\": \"Deleting because of fraud\"\n}"},"url":"{{url}}/v1/vault-tokens/:vault_token","description":"Archive a vault token.
\nThis request will also delete all network tokens associated with the given vault.
\nRequest params
\nRequest body
\n","urlObject":{"path":["v1","vault-tokens",":vault_token"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"bfd538f5-e4e5-43bd-871d-3ffa6db7f59a","key":"vault_token"}]}},"response":[{"id":"113e86a2-e6a3-4143-a143-44b7721dfac7","name":"archive success","originalRequest":{"method":"DELETE","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/v1/vault-tokens/:vault_token","host":["{{url}}"],"path":["v1","vault-tokens",":vault_token"],"variable":[{"key":"vault_token","value":"bfd538f5-e4e5-43bd-871d-3ffa6db7f59a"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 May 2020 12:01:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"61"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/vault/payment_sources/all","description":"Remove all vaults in your company
\nResponse body
\nvoid
\n","urlObject":{"path":["v1","vault","payment_sources","all"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"de07d9a4-2399-4904-89f7-dd4f278f4bb0","name":"remove all success","originalRequest":{"method":"DELETE","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/vault/payment_sources/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 May 2020 12:02:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"106"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"expire_month\": \"01\",\n \"expire_year\": \"22\"\n}"},"url":"{{url}}/v1/vault/cvv/:vault_token","description":"Get information associated with a CVV vault token
\nRequest params
\n","urlObject":{"path":["v1","vault","cvv",":vault_token"],"host":["{{url}}"],"query":[],"variable":[{"id":"8e3fad55-af24-4be1-97ad-40dfe09b4582","type":"string","value":"9ca20eb5-c1f5-440b-a41d-86a6f612d57c","key":"vault_token"}]}},"response":[{"id":"f8802996-66c7-4543-a6df-d10a0446fbc5","name":"common","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"expire_month\": \"01\",\n \"expire_year\": \"22\"\n}"},"url":{"raw":"{{url}}/v1/vault/cvv/:vault_token","host":["{{url}}"],"path":["v1","vault","cvv",":vault_token"],"variable":[{"key":"vault_token","value":"9ca20eb5-c1f5-440b-a41d-86a6f612d57c","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 04 Jun 2021 06:02:38 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"expires_at\": \"2021-06-28T00:00:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/vault/cvv/:vault_token","description":"Modify a CVV vault token.
\nRequest params
\nRequest body
\nResponse body
\n","urlObject":{"path":["v1","vault","cvv",":vault_token"],"host":["{{url}}"],"query":[],"variable":[{"id":"9a9f42ad-4465-452f-a2fb-59b14f176b5b","type":"any","value":"9ca20eb5-c1f5-440b-a41d-86a6f612d57c","key":"vault_token"}]}},"response":[{"id":"83bf3874-af04-4c0c-9211-c0a4ab351fc3","name":"UnfulfilledCondition","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","description":"This is your PayDock API Secret Key","type":"text"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"expires_at\": \"2022-05-28T00:00:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/vault/cvv/:vault_token","host":["{{url}}"],"path":["v1","vault","cvv",":vault_token"],"variable":[{"key":"vault_token","value":"9ca20eb5-c1f5-440b-a41d-86a6f612d57c"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 04 Jun 2021 05:56:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockPaydock has a PCI compliant vault that lets you access and store customer payment details from all of your payment gateways. Our vault enables you to pre-fill customer card details and help your customers transact faster - regardless of the payment gateway you process transactions with.
\nThe vault is built on the Paydock infrastructure so you do not take any liabilities or data risks.
\nConditions
\nThe response can differ depending on the payment method:
\n- \n
credit card
\n \nbank account
\n \nCreated by fetch
\n \n
Vault resource
\nStatus
\n","event":[{"listen":"prerequest","script":{"id":"fcf214cc-8b5e-4d37-be3a-cfbfd9bbc31a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c6f3673d-a5aa-4a73-8735-e72fb72bff09","type":"text/javascript","exec":[""]}}],"_postman_id":"a0061608-b78e-4f6a-b690-e7211bdc5d02"},{"name":"notifications","item":[{"name":"logs","item":[{"name":"search logs","id":"191c4375-a16d-448b-abae-286a7d9a470d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/notifications/logs","description":"Retrieve list of all notifications, with parameter list.
\nRequest query params
\nPagination
\nFilters
\nOther
\n","urlObject":{"path":["v1","notifications","logs"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"11cc6a2d-f902-45e2-8a82-bcbcc883fbe8","name":"search logs by type","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/v1/notifications/logs?type=email&limit=2","host":["{{url}}"],"path":["v1","notifications","logs"],"query":[{"key":"type","value":"email"},{"key":"limit","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 11:27:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"862"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/notifications/logs?_id=5f5789d5e2f9bf184bcd2062","description":"Get specific notification log by log id.
\nRequest query params
\n","urlObject":{"path":["v1","notifications","logs"],"host":["{{url}}"],"query":[{"key":"_id","value":"5f5789d5e2f9bf184bcd2062"}],"variable":[]}},"response":[{"id":"3b4c65eb-35eb-4a0d-9303-d170e6f60434","name":"get log","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/v1/notifications/logs?_id=5f5789d5e2f9bf184bcd2062","host":["{{url}}"],"path":["v1","notifications","logs"],"query":[{"key":"_id","value":"5f5789d5e2f9bf184bcd2062"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 13:26:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"473"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/notifications/logs/:id","description":"Archive a notification log.
\nRequest params
\n","urlObject":{"path":["v1","notifications","logs",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"929d1bce-c0f4-41e0-bec6-54779b60072a","type":"string","value":"5f5789d5e2f9bf184bcd2062","key":"id"}]}},"response":[{"id":"b40b8d73-497a-4828-b6dc-d580f3df707e","name":"archive log","originalRequest":{"method":"DELETE","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"label\": \"Sms first template\",\n\t\"notification_event\": \"transaction_failure\",\n\t\"body\": \"Charge {{CHARGE_ID}} with {{AMOUNT}} {{CURRENCY}} edited\",\n\t\"destination\": \"{{{PHONE}}}\",\n\t\"type\": \"sms\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/notifications/logs/:id","host":["{{url}}"],"path":["v1","notifications","logs",":id"],"variable":[{"key":"id","value":"5f5789d5e2f9bf184bcd2062"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 19:34:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"510"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockLogs generating automatically after sending notification.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"0886d43f-08bd-4890-8e85-87befa992b8b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"7e7c296d-c31f-489b-b912-93d34325a939"}}],"_postman_id":"95b2e97d-095b-4b22-a2d9-cf9987736763"},{"name":"templates","item":[{"name":"create template","id":"f5f5f5a1-6147-4154-a272-b80d60378943","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"html\": false,\n \"type\": \"message\",\n \"label\": \"The template for transactions\",\n \"notification_event\": \"transaction_success\",\n \"body\": \"Charge {{CHARGE_ID}} with {{AMOUNT}} {{CURRENCY}} created.\"\n}"},"url":"{{url}}/v1/notifications/templates","description":"Create a notification template (available for email, sms and webhook notifications types).
\nRequest body
\nNote:
\n* If the type is message and the html is true the body will be validated on the valid html format.
* If the type is message and the html is false the body will be considered as plain text.
* If the type is fields and the html is true then an error will occur (incompatible values).
Charge {{CHARGE_ID}} with {{AMOUNT}} {{CURRENCY}} created.
\",\n \"type\": \"message\",\n \"html\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/notifications/templates"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 13:54:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"328"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockCharge {{CHARGE_ID}} with {{AMOUNT}} {{CURRENCY}} created.
\",\n \"label\": \"The template for transactions\",\n \"notification_event\": \"transaction_success\",\n \"type\": \"message\"\n }\n }\n}"},{"id":"7b14c62d-cfff-4128-9240-24222fcb1b61","name":"create the plain text template","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","description":"This is your PayDock API Secret Key"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json"}],"body":{"mode":"raw","raw":"{\n \"label\": \"The template for transactions\",\n \"notification_event\": \"transaction_success\",\n \"body\": \"Charge {{CHARGE_ID}} with {{AMOUNT}} {{CURRENCY}} created.\",\n \"type\": \"message\",\n \"html\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/notifications/templates"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 13:54:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"328"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/notifications/templates","description":"Returns notification templates limited to 100.
\nRequest query params
\nPagination
\nFilters
\nOther
\n","urlObject":{"path":["v1","notifications","templates"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"da5abe03-02a6-4630-9cd8-94b29553050f","name":"search templates by html","originalRequest":{"method":"GET","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","description":"This is your PayDock API Secret Key"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json"}],"url":{"raw":"{{url}}/v1/notifications/templates?html=false","host":["{{url}}"],"path":["v1","notifications","templates"],"query":[{"key":"html","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 10:57:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"351"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock\\n\\n\\n\\t\\t\\t\\n\\t\\t\\t
| \\n\\t
\\n\\n\\n\\t\\t\\t\\n\\t\\t\\t
| \\n\\t
This is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/notifications/templates/:id","description":"Get specific notification template by template id.
\nRequest params
\n","urlObject":{"path":["v1","notifications","templates",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"3ee5ee6e-cf9c-42d0-86f8-5835adf175d7","type":"string","value":"5ebe7c762da56d524c66edf8","key":"id"}]}},"response":[{"id":"39135bc1-42e6-4286-96f5-e8156a728a67","name":"get template","originalRequest":{"method":"GET","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","description":"This is your PayDock API Secret Key"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json"}],"url":{"raw":"{{url}}/v1/notifications/templates/:id","host":["{{url}}"],"path":["v1","notifications","templates",":id"],"variable":[{"key":"id","value":"635a587c4daae13a18f846d7"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 13:22:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"282"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockCharge {{CHARGE_ID}} with {{AMOUNT}} {{CURRENCY}} created.
\",\n \"label\": \"The template for transactions\",\n \"notification_event\": \"transaction_success\",\n \"type\": \"message\",\n \"_id\": \"635a587c4daae13a18f846d7\",\n \"created_at\": \"2022-10-27T10:07:56.637Z\",\n \"updated_at\": \"2022-10-27T10:07:56.637Z\",\n \"is_used\": false\n }\n }\n}"}],"_postman_id":"f11b17ad-6ee7-4275-9e30-3ab12ad4ea85"},{"name":"modify template","id":"899c26bd-fe42-4249-98ed-aba9e2121774","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"html\": true,\n \"body\": \"Charge {{CHARGE_ID}} with {{AMOUNT}} {{CURRENCY}} created.
\",\n \"label\": \"The template for transactions\",\n \"notification_event\": \"transaction_failure\",\n \"type\": \"message\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/notifications/templates/:id","description":"Update a notification template (available for email, sms and webhook notifications types).
\nRequest params
\nRequest body
\n","urlObject":{"path":["v1","notifications","templates",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"635a57f24daae13a18f84690","key":"id"}]}},"response":[{"id":"b1b1a5fd-3edd-46a7-96a3-3c7a35f0617d","name":"modify template","originalRequest":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","description":"This is your PayDock API Secret Key"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json"}],"body":{"mode":"raw","raw":"{\n \"html\": true,\n \"body\": \"Charge {{CHARGE_ID}} with {{AMOUNT}} {{CURRENCY}} created.
\",\n \"label\": \"The template for transactions\",\n \"notification_event\": \"transaction_failure\",\n \"type\": \"message\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/notifications/templates/:id","host":["{{url}}"],"path":["v1","notifications","templates",":id"],"variable":[{"key":"id","value":"635a57f24daae13a18f84690"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 14:02:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"318"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockCharge {{CHARGE_ID}} with {{AMOUNT}} {{CURRENCY}} created.
\",\n \"label\": \"The template for transactions\",\n \"notification_event\": \"transaction_failure\",\n \"type\": \"message\"\n }\n }\n}"}],"_postman_id":"899c26bd-fe42-4249-98ed-aba9e2121774"},{"name":"delete template","id":"d4541653-6dd2-4fe8-bf95-5d84c9a75370","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"This is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/notifications/templates/:id","description":"Delete a notification template.
\nRequest params
\n","urlObject":{"path":["v1","notifications","templates",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"35188f89-f132-4a21-b58b-035dcbffb4c5","type":"string","value":"5f58de89fb861d6300bdfdff","key":"id"}]}},"response":[{"id":"8461284e-4ffc-4ed1-b9b5-041868a12679","name":"delete template","originalRequest":{"method":"DELETE","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","description":"This is your PayDock API Secret Key"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json"}],"body":{"mode":"raw","raw":"{\n\t\"label\": \"Sms first template\",\n\t\"notification_event\": \"transaction_failure\",\n\t\"body\": \"Charge {{CHARGE_ID}} with {{AMOUNT}} {{CURRENCY}} edited\",\n\t\"destination\": \"{{{PHONE}}}\",\n\t\"type\": \"sms\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/notifications/templates/:id","host":["{{url}}"],"path":["v1","notifications","templates",":id"],"variable":[{"key":"id","value":"635a587c4daae13a18f846d7"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 19:30:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"318"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockCharge {{CHARGE_ID}} with {{AMOUNT}} {{CURRENCY}} created.
\",\n \"label\": \"The template for transactions\",\n \"notification_event\": \"transaction_success\",\n \"type\": \"message\",\n \"_id\": \"635a587c4daae13a18f846d7\",\n \"created_at\": \"2022-10-27T10:07:56.637Z\",\n \"updated_at\": \"2022-10-27T10:07:56.637Z\",\n \"is_used\": false\n }\n }\n}"}],"_postman_id":"d4541653-6dd2-4fe8-bf95-5d84c9a75370"},{"name":"get template variables","id":"c58fdb14-69f3-431a-bd99-2079cf5d2c8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/notifications/templates/variables","description":"Get list of existing variables for each type of notification event.
\n","urlObject":{"path":["v1","notifications","templates","variables"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"638ba086-d085-436b-bfd8-6a185dae1831","name":"get template variables","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"url":"{{url}}/v1/notifications/templates/variables"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Sun, 13 Sep 2020 15:21:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"3554"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockTemplates are used for creating email and sms notifications.
\nTemplates resource
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"46128594-ddea-4e2f-9d43-75caffad8766"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"119a719b-84a7-45db-8f40-052e665bbb85"}}],"_postman_id":"239bbdbd-4f29-4635-bab4-50b19b1f66e0"},{"name":"create","id":"ac194fce-0ddc-4a8d-82e7-2c99d1010973","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"event\": \"transaction_success\",\n \"destination\": \"http://hahn.mertz.llc.biz\",\n \"type\": \"webhook\",\n \"transaction_only\": false\n}"},"url":"{{url}}/v1/notifications","description":"Creates a trigger to send a notification to a customer or endpoint. To send an email or SMS to a customer, use swap values (eg {{PHONE}} or {{EMAIL}}) which are loaded from the customer (See Swap Values for templates for the full list).
\nRequest body
\n","urlObject":{"path":["v1","notifications"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3c496141-6d72-42e7-9e74-835201da2401","name":"create notification webhook","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"event\": \"transaction_success\",\n \"destination\": \"https://hahn.mertz.llc.biz\",\n \"type\": \"webhook\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/notifications"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 10:13:51 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"188"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/notifications","description":"Returns all notification triggers for the account, limited to 100 records.
\nRequest query params
\nPagination
\nFilters
\n","urlObject":{"path":["v1","notifications"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3c8731f7-c3aa-4226-b84c-d08f4828d5cf","name":"search","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"url":"{{url}}/v1/notifications"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 10:49:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"724"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/notifications/:id","description":"Retrive details on a specific notification.
\nRequest params
\n","urlObject":{"path":["v1","notifications",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"9c4b32ac-6005-45ee-ba8f-b081077f972a","type":"string","value":"5ebe7c9e2da56d524c66edf9","key":"id"}]}},"response":[{"id":"620e121b-9610-45bd-bf6e-434465c1f025","name":"get","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/v1/notifications/:id","host":["{{url}}"],"path":["v1","notifications",":id"],"variable":[{"key":"id","value":"5ebe7c9e2da56d524c66edf9"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 13:20:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"272"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/notifications/logs/:id","description":"Resend webhook notification.
\nRequest params
\nRequest body
\n","urlObject":{"path":["v1","notifications","logs",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"e8e8198e-f29e-4be7-afa7-f8efe8e2671d","type":"string","value":"5f58eb6d61d0d5314e1089dc","key":"id"}]}},"response":[{"id":"e38887bc-0489-4047-9a63-a299024dd01d","name":"resend webhook notification with another destination","originalRequest":{"method":"PUT","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"distanation\": \"http://hahn.mertz.llc.biz\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/notifications/logs/:id","host":["{{url}}"],"path":["v1","notifications","logs",":id"],"variable":[{"key":"id","value":"5f58eb6d61d0d5314e1089dc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 11 Sep 2020 09:59:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"486"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/notifications/:id","description":"Delete a notification.
\nRequest params
\n","urlObject":{"path":["v1","notifications",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"9e8287f0-2f6a-488b-81df-742cfbb28dcc","type":"string","value":"5ebe7c9e2da56d524c66edf9","key":"id"}]}},"response":[{"id":"cf908241-c951-497f-9a20-106e04e55954","name":"delete","originalRequest":{"method":"DELETE","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"label\": \"Sms first template\",\n\t\"notification_event\": \"transaction_failure\",\n\t\"body\": \"Charge {{CHARGE_ID}} with {{AMOUNT}} {{CURRENCY}} edited\",\n\t\"destination\": \"{{{PHONE}}}\",\n\t\"type\": \"sms\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/notifications/:id","host":["{{url}}"],"path":["v1","notifications",":id"],"variable":[{"key":"id","value":"5ebe7c9e2da56d524c66edf9"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 19:32:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"272"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDockNotifications are automated messages that are triggered in response to events within the system.
\nWithin PayDock, notification triggers are set up to fire on different events. Notification triggers can have different types (i.e. Webhook, Email, Sms) and events (i.e. Transaction Success).
\nNotifications for email and SMS require templates for the notification.
\nSee also Examples of webhook payloads
\nNotification Templates also provide swap values (eg {{PHONE}} or {{EMAIL}}) that will be populated from the customer, charge or subscription that triggered the notification (See Swap Values for templates for the full list).
\nNotification resource
\nEvent
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"9bc34f62-3698-4ca8-aa1d-8cbfdc797fc2"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a20a5143-e1ae-46f1-8086-d9af85b3e7bd"}}],"_postman_id":"52a7b557-20c6-444f-856a-a37adfb1a26c"},{"name":"gateways-accounts","item":[{"name":"create","id":"40dd851c-f48e-4fce-b0e8-cbfedc61b690","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key
\n","key":"x-user-secret-key","type":"text","value":"{{secretkey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"wanda.mertz@example.com\",\n \"company_name\": \"Hahn Mertz LLC\",\n \"reference\": \"Ref to Account\",\n \"business_type\": \"company\",\n \"address\": {\n \"city\": \"Lake Robyn\",\n \"line1\": \"61426 Osvaldo Plains\",\n \"line2\": \"Apt. 276\",\n \"postal_code\": \"07396\",\n \"country\": \"US\"\n },\n \"meta\": {\n \"type\": \"custom\",\n \"capabilities\": {\n \"card_payments\": {\n \"requested\": true\n },\n \"transfers\": {\n \"requested\": true\n }\n },\n \"company\": {\n \"registration_number\": \"664558728\"\n }\n }\n}"},"url":"{{url}}/v1/gateways/:gateway_id/accounts","description":"Create gateway account
\nRequest params
\nRequest body
\nBusiness types
\n","urlObject":{"path":["v1","gateways",":gateway_id","accounts"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"","key":"gateway_id"}]}},"response":[{"id":"a48add36-0eab-4cb9-b530-3860e2300ffd","name":"gateway error","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","type":"text","value":"{{secretkey}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"wanda.mertz@example.com\",\n \"company_name\": \"Hahn Mertz LLC\",\n \"reference\": \"Ref to Account\",\n \"business_type\": \"company\",\n \"address\": {\n \"city\": \"Lake Robyn\",\n \"line1\": \"61426 Osvaldo Plains\",\n \"line2\": \"Apt. 276\",\n \"postal_code\": \"07396\",\n \"country\": \"US\"\n },\n \"meta\": {\n \"type\": \"custom\",\n \"capabilities\": {\n \"card_payments\": {\n \"requested\": true\n },\n \"transfers\": {\n \"requested\": true\n }\n },\n \"company\": {\n \"registration_number\": \"664558728\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/gateways/:gateway_id/accounts","host":["{{url}}"],"path":["v1","gateways",":gateway_id","accounts"],"variable":[{"key":"gateway_id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 12 Jan 2021 14:33:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"438"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"x-powered-by","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","type":"text","value":"{{secretkey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"wanda.mertz@example.com\",\n \"company_name\": \"Hahn Mertz LLC\",\n \"reference\": \"Ref to Account\",\n \"business_type\": \"individual\",\n \"address\": {\n \"city\": \"Lake Robyn\",\n \"line1\": \"61426 Osvaldo Plains\",\n \"line2\": \"Apt. 276\",\n \"postal_code\": \"07396\",\n \"country\": \"US\"\n },\n \"meta\": {\n \"company\": {\n \"registration_number\": \"6645587281\"\n }\n }\n}"},"url":"{{url}}/v1/gateways/:gateway_id/accounts/:id","description":"Modify gateway account
\nRequest params
\nRequest body
\nBusiness types
\n","urlObject":{"path":["v1","gateways",":gateway_id","accounts",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"b6019399-d692-4b61-9277-c75e4c456953","type":"string","value":"","key":"gateway_id"},{"id":"de4e2e75-963d-43a6-8f2b-e62150eecf77","type":"string","value":"","key":"id"}]}},"response":[{"id":"d280288f-563d-4598-b4b4-280148e9a20e","name":"gateway error","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","type":"text","value":"{{secretkey}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"wanda.mertz@example.com\",\n \"company_name\": \"Hahn Mertz LLC\",\n \"reference\": \"Ref to Account\",\n \"business_type\": \"individual\",\n \"address\": {\n \"city\": \"Lake Robyn\",\n \"line1\": \"61426 Osvaldo Plains\",\n \"line2\": \"Apt. 276\",\n \"postal_code\": \"07396\",\n \"country\": \"US\"\n },\n \"meta\": {\n \"company\": {\n \"registration_number\": \"6645587281\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/gateways/:gateway_id/accounts/:id","host":["{{url}}"],"path":["v1","gateways",":gateway_id","accounts",":id"],"variable":[{"key":"gateway_id","value":""},{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 12 Jan 2021 14:58:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"438"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"x-powered-by","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","type":"text","value":"{{secretkey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{url}}/v1/gateways/:gateway_id/accounts/:id","description":"Get gateway account
\nRequest params
\n","urlObject":{"path":["v1","gateways",":gateway_id","accounts",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"10fa8e10-5058-4ca8-b94a-5336be3930fc","type":"string","value":"","key":"gateway_id"},{"id":"26d07e33-9d32-4c3f-b586-7978e0b708fc","type":"string","value":"","key":"id"}]}},"response":[{"id":"ac761558-bd12-4b34-b482-dd2edbc49790","name":"get success","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","type":"text","value":"{{secretkey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{url}}/v1/gateways/:gateway_id/accounts/:id","host":["{{url}}"],"path":["v1","gateways",":gateway_id","accounts",":id"],"variable":[{"key":"gateway_id","value":"5fcca767dabe9b028df619f1"},{"key":"id","value":"5ffdb5b70c4a94401a154369"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 12 Jan 2021 15:00:34 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"10869"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","type":"text","value":"{{secretkey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{url}}/v1/gateways/:gateway_id/accounts","description":"Returns all gateway accounts for the gateway, limited to 100 records.
\nRequest params
\nRequest query params
\nPagination
\nFilters
\nOther
\nBusiness types
\n","urlObject":{"path":["v1","gateways",":gateway_id","accounts"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"","key":"gateway_id"}]}},"response":[{"id":"5c5cd1d8-f385-4ccf-a8fb-3111b30b8a01","name":"search by company_name","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","type":"text","value":"{{secretkey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{url}}/v1/gateways/:gateway_id/accounts?company_name=Hahn Mertz LLC","host":["{{url}}"],"path":["v1","gateways",":gateway_id","accounts"],"query":[{"key":"company_name","value":"Hahn Mertz LLC"}],"variable":[{"key":"gateway_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 12 Jan 2021 15:06:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1050"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"PayDockArchive Gateway Accounts to hide it it from gateway accounts list. You can still retrieve archived Gateway Accounts.
\nRequest params
\n","urlObject":{"path":["v1","gateways",":gateway_id","accounts",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"4085e45b-9745-4913-8a4a-6d53cbddd7f4","type":"string","value":"","key":"gateway_id"},{"id":"4401e02d-77bf-40b9-bab8-6e557ad30951","type":"string","value":"","key":"id"}]}},"response":[{"id":"5e075241-2355-401f-9715-9270759bf45b","name":"delete failed","originalRequest":{"method":"DELETE","header":[{"key":"x-user-secret-key","type":"text","value":"{{secretkey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/gateways/:gateway_id/accounts/:id","host":["{{url}}"],"path":["v1","gateways",":gateway_id","accounts",":id"],"variable":[{"key":"gateway_id","value":""},{"key":"id","type":"string","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 12 Jan 2021 15:07:48 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"29"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"PayDockGateway Sub-accounts like Stripe are used to route payments between business, customers, and recipients who need to get paid. This functionality helps to create, update accounts using e.g. Stripe and store information inside Paydock for the future payments.
\nGateway resource
\nBusiness types
\n","event":[{"listen":"prerequest","script":{"id":"f476c3f2-2c2d-41d9-be25-5784e77a19e3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8d56eb21-2c62-4be5-944e-5531d927aaa1","type":"text/javascript","exec":[""]}}],"_postman_id":"2e1281f8-d6fc-4d72-9335-1b4d73f63255"},{"name":"fetches","item":[{"name":"create","id":"25e6748c-a0b8-428f-b49a-89688906fe98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Content-Type depends on body
\n","key":"Content-Type","value":"application/xml"},{"description":"This is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"x-original-url","value":"https://example.com/enpoint","description":"Original url
\n","type":"text"},{"key":"x-original-method","value":"GET","description":"Original method
\n","type":"text"},{"key":"x-original-Authorization","value":"Basic dXNlcm5hbWU6cGFzc3dvcmQ=","description":"Any custom original header
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/fetches","description":"This endpoint takes the original header, body, URL and request method, delivers it to a specific service and replaces some card data with vault tokens in the response.
\nThe original means that this is the exact data that a particular service expects to receive.
\nThe service is detected automatically. However, it must be previously connected (See the endpoint services create with the proxy_link group).
All card data (except for the number and CVV), external IDs and vault tokens can also be obtained with get by ID and search endpoints.
\nRequest headers
\nRequest body
\nThe original body that a particular service expects to receive.
\nResponse body
\nThe original body that a particular service is expected to return with sanitized card number and CVV.
\nResponse headers
\nVirtual flow
\nOriginal URL
\n","urlObject":{"path":["v1","fetches"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"aea9fb66-7f57-4bd4-999f-fbc7c177ba57","name":"create","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","description":"Content-Type depends on body","type":"text"},{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"x-original-url","value":"https://secure-supply-xml.booking.com/hotels/ota/OTA_HotelResNotif","description":"Original url","type":"text"},{"key":"x-original-method","value":"GET","description":"Original method","type":"text"},{"key":"x-original-Authorization","value":"Basic dXNlcm5hbWU6cGFzc3dvcmQ=","description":"Any custom original header","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"xml"}}},"url":"{{url}}/v1/fetches"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 24 Feb 2021 15:28:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"188"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDockThis is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/fetches/:id","description":"Retrieves data on a fetch with the specified ID.
\nRequest params
\n","urlObject":{"path":["v1","fetches",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"2b530928-0755-4e06-9e26-9bc606e1d56f","type":"string","value":"5f084eb39c63b80a26e52b01","key":"id"}]}},"response":[{"id":"f63f1f28-6008-4b86-9d92-8ef56f02622e","name":"common","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/fetches/:id","host":["{{url}}"],"path":["v1","fetches",":id"],"variable":[{"id":"2b530928-0755-4e06-9e26-9bc606e1d56f","key":"id","type":"string","value":"5f084eb39c63b80a26e52b01"}]}},"status":"Ok","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"fetch\",\n \"data\": {\n \"_id\": \"6036772db68daaa5adcc6ba9\",\n \"created_at\": \"2021-02-24T15:56:29.969Z\",\n \"updated_at\": \"2021-02-24T15:56:29.969Z\",\n \"archived\": \"false\",\n \"response_properties\": [\n [\n {\n \"sanitized_as\": \"original\",\n \"type\": \"cardholder_name\",\n \"path\": \"OTA_HotelResNotifRQ.HotelReservations.HotelReservation[0].ResGlobalInfo.Guarantee.GuaranteesAccepted.GuaranteeAccepted.PaymentCard[0].CardHolderName\",\n \"value\": \"Wanda Mertz\"\n },\n {\n \"sanitized_as\": \"card_number_vault\",\n \"type\": \"card_number\",\n \"path\": \"OTA_HotelResNotifRQ.HotelReservations.HotelReservation[0].ResGlobalInfo.Guarantee.GuaranteesAccepted.GuaranteeAccepted.PaymentCard[0].$CardNumber\",\n \"value\": \"2e5a168f-c769-4c05-805a-abadbe2aff78\"\n },\n {\n \"sanitized_as\": \"cvv_vault\",\n \"type\": \"card_cvv\",\n \"path\": \"OTA_HotelResNotifRQ.HotelReservations.HotelReservation[1].ResGlobalInfo.Guarantee.GuaranteesAccepted.GuaranteeAccepted.PaymentCard[0].$SeriesCode\",\n \"value\": \"2e5a168f-c769-4c05-805a-abadbe2aff79\"\n },\n {\n \"sanitized_as\": \"original\",\n \"type\": \"expire_month\",\n \"path\": \"OTA_HotelResNotifRQ.HotelReservations.HotelReservation[0].ResGlobalInfo.Guarantee.GuaranteesAccepted.GuaranteeAccepted.PaymentCard[0].$ExpireDate\",\n \"value\": \"01\"\n },\n {\n \"sanitized_as\": \"original\",\n \"type\": \"expire_year\",\n \"path\": \"OTA_HotelResNotifRQ.HotelReservations.HotelReservation[1].ResGlobalInfo.Guarantee.GuaranteesAccepted.GuaranteeAccepted.PaymentCard[0].$ExpireDate\",\n \"value\": \"20\"\n },\n {\n \"sanitized_as\": \"original\",\n \"type\": \"actual_till\",\n \"path\": \"OTA_HotelResNotifRQ.HotelReservations.HotelReservation[1].RoomRate[1].$EffectiveDate\",\n \"value\": \"2021-02-24T15:56:29.969Z\"\n },\n {\n \"sanitized_as\": \"original\",\n \"type\": \"external_id\",\n \"path\": \"OTA_HotelResNotifRQ.HotelReservations.HotelReservation[1].ResGlobalInfo.HotelReservationIDs.HotelReservationID.$ResID_Value\",\n \"value\": \"1e5a168f-c769-4c05-805a-abadbe2aff76\"\n }\n ] \n ],\n \"service_id\": \"6036772bb68daaa5adcc6ba6\",\n \"mode\": \"test\",\n \"logs\": [],\n \"status\": \"completed\"\n }\n }\n}"}],"_postman_id":"15cf7b26-a65c-48d5-b04e-de4b37796866"},{"name":"search","id":"3423b2c0-9d67-4197-a6ee-4b7c2a2f71c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key
\n","key":"x-user-secret-key","value":"{{secretkey}}"},{"description":"Content-Type will always be application/json
\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/fetches","description":"Returns all fetches.
\nRequest query params
\nPagination
\nFilters
\n","urlObject":{"path":["v1","fetches"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"379bc6e0-031a-49a2-acd7-abad5a09020e","name":"common","originalRequest":{"method":"GET","header":[{"description":"This is your PayDock API Secret Key","key":"x-user-secret-key","value":"{{secretkey}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/fetches"},"status":"Ok","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"fetch\",\n \"data\": [\n {\n \"_id\": \"6036772db68daaa5adcc6ba9\",\n \"created_at\": \"2021-02-24T15:56:29.969Z\",\n \"updated_at\": \"2021-02-24T15:56:29.969Z\",\n \"archived\": \"false\",\n \"response_properties\": [\n [\n {\n \"sanitized_as\": \"original\",\n \"type\": \"cardholder_name\",\n \"path\": \"OTA_HotelResNotifRQ.HotelReservations.HotelReservation[0].ResGlobalInfo.Guarantee.GuaranteesAccepted.GuaranteeAccepted.PaymentCard[0].CardHolderName\",\n \"value\": \"Wanda Mertz\"\n },\n {\n \"sanitized_as\": \"card_number_vault\",\n \"type\": \"card_number\",\n \"path\": \"OTA_HotelResNotifRQ.HotelReservations.HotelReservation[0].ResGlobalInfo.Guarantee.GuaranteesAccepted.GuaranteeAccepted.PaymentCard[0].$CardNumber\",\n \"value\": \"2e5a168f-c769-4c05-805a-abadbe2aff78\"\n },\n {\n \"sanitized_as\": \"cvv_vault\",\n \"type\": \"card_cvv\",\n \"path\": \"OTA_HotelResNotifRQ.HotelReservations.HotelReservation[1].ResGlobalInfo.Guarantee.GuaranteesAccepted.GuaranteeAccepted.PaymentCard[0].$SeriesCode\",\n \"value\": \"2e5a168f-c769-4c05-805a-abadbe2aff79\"\n },\n {\n \"sanitized_as\": \"original\",\n \"type\": \"expire_month\",\n \"path\": \"OTA_HotelResNotifRQ.HotelReservations.HotelReservation[0].ResGlobalInfo.Guarantee.GuaranteesAccepted.GuaranteeAccepted.PaymentCard[0].$ExpireDate\",\n \"value\": \"01\"\n },\n {\n \"sanitized_as\": \"original\",\n \"type\": \"expire_year\",\n \"path\": \"OTA_HotelResNotifRQ.HotelReservations.HotelReservation[1].ResGlobalInfo.Guarantee.GuaranteesAccepted.GuaranteeAccepted.PaymentCard[0].$ExpireDate\",\n \"value\": \"20\"\n },\n {\n \"sanitized_as\": \"original\",\n \"type\": \"actual_till\",\n \"path\": \"OTA_HotelResNotifRQ.HotelReservations.HotelReservation[1].RoomRate[1].$EffectiveDate\",\n \"value\": \"2021-02-24T15:56:29.969Z\"\n },\n {\n \"sanitized_as\": \"original\",\n \"type\": \"external_id\",\n \"path\": \"OTA_HotelResNotifRQ.HotelReservations.HotelReservation[1].ResGlobalInfo.HotelReservationIDs.HotelReservationID.$ResID_Value\",\n \"value\": \"1e5a168f-c769-4c05-805a-abadbe2aff76\"\n }\n ]\n \n ],\n \"service_id\": \"6036772bb68daaa5adcc6ba6\",\n \"mode\": \"test\",\n \"status\": \"completed\"\n }\n ],\n \"skip\": 0,\n \"limit\": 100,\n \"sortkey\": \"created_at\",\n \"sortdirection\": \"DESC\",\n \"count\": 1\n }\n}"}],"_postman_id":"3423b2c0-9d67-4197-a6ee-4b7c2a2f71c9"}],"id":"1738f720-bc73-4033-9e35-23318e9d4f64","description":"Every proxy request generates a fetch entity that includes common information and relations with vaults etc.
\nFetch resource
\nFetch status
\nSanitize types
\nProperty types
\n","event":[{"listen":"prerequest","script":{"id":"542aa0f4-0227-4ffa-9d96-5944e32fde11","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c713ba74-bd70-4f98-bfb8-d579459b0831","type":"text/javascript","exec":[""]}}],"_postman_id":"1738f720-bc73-4033-9e35-23318e9d4f64"},{"name":"bulk-charges","item":[{"name":"cancel","id":"1578bf05-0ed8-4ac8-955b-1c14080a81b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Token-Id","value":"Performs cancel operation for all charges attached to the bulk
\n\n
Request body
\nIf the request body has empty charges array all charges attached to the bulk will be processed.
\nResponse body
\n","urlObject":{"path":["v1","bulk-charges",":bulk_reference","cancel"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"Bulk reference UUID identifier","key":"bulk_reference"}]}},"response":[{"id":"930c8217-ee54-4f22-814c-f4988c829eb1","name":"Charge cancel operation has been successful.","originalRequest":{"method":"POST","header":[{"key":"X-Scope","value":"company","description":"(Required) "},{"key":"X-Scope-Id","value":"