{"info":{"_postman_id":"7e82d226-746a-48c8-a9bd-3e3d6e28593e","name":"Paydock API v13.09.20_old","description":"

This is a quick start guide on how to navigate the Paydock API.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6912944","collectionId":"7e82d226-746a-48c8-a9bd-3e3d6e28593e","publishedId":"TVYM5GDe","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-11-02T21:58:59.000Z"},"item":[{"name":"charges","item":[{"name":"search","id":"16b167b8-8d75-4915-b3fd-01f5ecd9c762","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

This is your PayDock API Secret Key

\n","key":"x-user-secret-key","value":"c403aa219be2306c0d216adf5d2061857f690bf7"},{"description":"

Content-Type will always be application/json

\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/charges","description":"

Returns all charges.

Request query params

Pagination

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required[flow]	type	description
skip	-	number	Pagination parameter to skip first n transactions from list, default = 0
limit	-	number	Pagination parameter to limit output to n , default = 100 , maximum value = 1000
sortkey	-	string	Sorting key parameter i.e. created_at
sortdirection	-	string	Sorting order direction parameter ASC or DESC (DESC by default)

filters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required[flow]	type	description
subscription_id	-	string (24 byte hex)	To only fetch transactions related to particular subscription
gateway_id	-	string (24 byte hex)	ID of a gateway with which charges were created
company_id	-	string (24 byte hex)	ID of a company with which charges were created
status	-	string	See Status table
archived	-	bool	Set to true to show all the archived charges. Default: false
reference	-	string	Charge reference declared on creation. transaction_external_id can also be used to search by reference
one_off	-	bool	Set to true to get charges without a subscription only. Set to false to get charges created by subscriptions only.

Other

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required[flow]	type	description
created_at.from	-	string	Parameter to set range
created_at.to	-	string	Parameter to set range
updated_at.from	-	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Parameter to set range
updated_at.to	-	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Parameter to set range
search	-	string	Word of phrase Customer want to search in created charges (search works by fields: First, Last names and Emails)
expand	-	array(value,value,...)	`current_subscription_details` Displays detailed information from the subscription history. This parameter returns a ‘snapshot’ of the Subscription at the point in time the Charge request was triggered. `subscription` Displays ‘live’ information from the Subscription service at the time of the API request.

","urlObject":{"path":["v1","charges"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0018a452-deb2-48e9-976a-05f7b511dfc0","name":"search with filters","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?customer_id=5e4bfbd86d244b438451fbd7","host":["{{url}}"],"path":["v1","charges"],"query":[{"key":"customer_id","value":"5e4bfbd86d244b438451fbd7"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 May 2020 14:33:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2162"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-info-limit","value":"2"},{"key":"x-info-skip","value":"0"},{"key":"x-info-sort-key","value":"created_at"},{"key":"x-info-sort-direction","value":"DESC"},{"key":"x-info-count","value":"4"},{"key":"etag","value":"W/\"872-2+aAQVFVJoo94Eq2y4buQktatmo\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"charges\",\n \"data\": [\n {\n \"_id\": \"5ec63451b12c99579e46ee31\",\n \"created_at\": \"2020-05-21T07:57:05.911Z\",\n \"updated_at\": \"2020-05-21T07:57:06.565Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"transactions\": [\n {\n \"created_at\": \"2020-05-21T07:57:05.909Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ec63451b12c99579e46ee32\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"status\": \"complete\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"customer_id\": \"5e4bfbd86d244b438451fbd7\",\n \"first_name\": \"First\",\n \"last_name\": \"Last\",\n \"company_name\": \"COMP-NAME\",\n \"payment_source\": {\n \"source_id\": \"5e4bfbc96d244b438451fbd6\",\n \"type\": \"card\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"expire_month\": 12,\n \"expire_year\": 2020,\n \"address_country\": \"AU\",\n \"gateway_id\": \"5cbede1f151b842653e987be\"\n }\n },\n \"capture\": true,\n \"status\": \"complete\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n },\n \"external_id\": \"ch_0Gl9H4jQKtR4Rpd2kZBVPd2l\"\n },\n {\n \"_id\": \"5ec63445b12c99579e46ee27\",\n \"created_at\": \"2020-05-21T07:56:53.298Z\",\n \"updated_at\": \"2020-05-21T07:56:53.841Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"transactions\": [\n {\n \"created_at\": \"2020-05-21T07:56:53.291Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ec63445b12c99579e46ee28\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"status\": \"pending\",\n \"type\": \"sale\",\n \"pended_at\": \"2020-05-22T07:56:53.840Z\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"customer_id\": \"5e4bfbd86d244b438451fbd7\",\n \"first_name\": \"First\",\n \"last_name\": \"Last\",\n \"company_name\": \"COMP-NAME\",\n \"payment_source\": {\n \"source_id\": \"5e4bfbc96d244b438451fbd6\",\n \"type\": \"card\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"expire_month\": 12,\n \"expire_year\": 2020,\n \"address_country\": \"AU\",\n \"gateway_id\": \"5cbede1f151b842653e987be\"\n }\n },\n \"capture\": true,\n \"status\": \"pending\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n },\n \"external_id\": \"ch_0Gl9GrjQKtR4Rpd2pRu8np3P\"\n }\n ],\n \"skip\": 0,\n \"limit\": 2,\n \"sortkey\": \"created_at\",\n \"sortdirection\": \"DESC\",\n \"count\": 4\n }\n}"},{"id":"85e328f9-df50-4ddf-9fdb-8aa15caaec8a","name":"search 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?expand=subscription,current_subscription_details","host":["{{url}}"],"path":["v1","charges"],"query":[{"key":"expand","value":"subscription,current_subscription_details"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 22 May 2020 14:48:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1090"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-info-limit","value":"1"},{"key":"x-info-skip","value":"0"},{"key":"x-info-sort-key","value":"created_at"},{"key":"x-info-sort-direction","value":"DESC"},{"key":"x-info-count","value":"1"},{"key":"etag","value":"W/\"442-h7hly/GbeF7vmk9oiNvn0Q8BnEA\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"charges\",\n \"data\": [\n {\n \"_id\": \"5ec7b21cb12c99579e46f270\",\n \"created_at\": \"2020-05-22T11:06:04.900Z\",\n \"updated_at\": \"2020-05-22T11:06:06.000Z\",\n \"amount\": 1,\n \"currency\": \"AUD\",\n \"subscription_id\": \"5ec7b20ab12c99579e46f26b\",\n \"_source_ip_address\": \"127.0.0.1\",\n \"transactions\": [\n {\n \"created_at\": \"2020-05-22T11:06:04.894Z\",\n \"amount\": 1,\n \"currency\": \"AUD\",\n \"_id\": \"5ec7b21cb12c99579e46f271\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"127.0.0.1\",\n \"status\": \"complete\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": false,\n \"archived\": false,\n \"customer\": {\n \"customer_id\": \"5ec7b209b12c99579e46f268\",\n \"email\": \"test12345678@test.test\",\n \"payment_source\": {\n \"type\": \"card\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"expire_month\": 3,\n \"expire_year\": 2020,\n \"address_country\": \"AU\",\n \"gateway_id\": \"5cffefaa18b6546015794998\"\n }\n },\n \"capture\": true,\n \"status\": \"complete\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n },\n \"external_id\": \"b7vyt6xm\",\n \"subscription\": {\n\t \"created_at\": \"2020-05-22T11:05:46.160Z\",\n\t \"updated_at\": \"2020-05-22T11:06:06.039Z\",\n\t \"status\": \"active\",\n\t \"statistics\": {\n\t \"total_collected_amount\": 1,\n\t \"successful_transactions\": 1\n\t },\n\t \"schedule\": {\n\t \"interval\": \"day\",\n\t \"start_date\": \"2020-05-22T11:05:45.440Z\",\n\t \"end_transactions\": 2,\n\t \"next_assessment\": \"2020-05-23T11:05:45.440Z\",\n\t \"next_assessment_planned\": \"2020-05-23T11:05:45.440Z\",\n\t \"last_assessment_planned\": \"2020-05-22T11:05:45.440Z\",\n\t \"first_assessment\": \"2020-05-22T11:05:45.440Z\",\n\t \"last_assessment\": \"2020-05-22T11:06:06.025Z\",\n\t \"completed_count\": 1,\n\t \"held_count\": 0,\n\t \"retry_count\": 0,\n\t \"frequency\": 1,\n\t \"status\": \"complete\"\n\t }\n }\n }\n ],\n \"skip\": 0,\n \"limit\": 100,\n \"sortkey\": \"created_at\",\n \"sortdirection\": \"DESC\",\n \"count\": 1\n }\n}"},{"id":"ab513649-ef27-41e3-a8a5-62e274d5257f","name":"search with pagination and sorts","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?limit=2&skip=1&sortkey=updated_at&sortdirection=DESC","host":["{{url}}"],"path":["v1","charges"],"query":[{"key":"limit","value":"2"},{"key":"skip","value":"1"},{"key":"sortkey","value":"updated_at"},{"key":"sortdirection","value":"DESC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 May 2020 14:29:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2163"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-info-limit","value":"2"},{"key":"x-info-skip","value":"1"},{"key":"x-info-sort-key","value":"updated_at"},{"key":"x-info-sort-direction","value":"DESC"},{"key":"x-info-count","value":"19"},{"key":"etag","value":"W/\"873-2n8rca7tWEniayvsaGdhSjGTSD0\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"charges\",\n \"data\": [\n {\n \"_id\": \"5ec63451b12c99579e46ee31\",\n \"created_at\": \"2020-05-21T07:57:05.911Z\",\n \"updated_at\": \"2020-05-21T07:57:06.565Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"transactions\": [\n {\n \"created_at\": \"2020-05-21T07:57:05.909Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ec63451b12c99579e46ee32\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"status\": \"complete\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"customer_id\": \"5e4bfbd86d244b438451fbd7\",\n \"first_name\": \"First\",\n \"last_name\": \"Last\",\n \"company_name\": \"COMP-NAME\",\n \"payment_source\": {\n \"source_id\": \"5e4bfbc96d244b438451fbd6\",\n \"type\": \"card\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"expire_month\": 12,\n \"expire_year\": 2020,\n \"address_country\": \"AU\",\n \"gateway_id\": \"5cbede1f151b842653e987be\"\n }\n },\n \"capture\": true,\n \"status\": \"complete\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n },\n \"external_id\": \"ch_0Gl9H4jQKtR4Rpd2kZBVPd2l\"\n },\n {\n \"_id\": \"5ec63445b12c99579e46ee27\",\n \"created_at\": \"2020-05-21T07:56:53.298Z\",\n \"updated_at\": \"2020-05-21T07:56:53.841Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"transactions\": [\n {\n \"created_at\": \"2020-05-21T07:56:53.291Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ec63445b12c99579e46ee28\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"status\": \"pending\",\n \"type\": \"sale\",\n \"pended_at\": \"2020-05-22T07:56:53.840Z\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"customer_id\": \"5e4bfbd86d244b438451fbd7\",\n \"first_name\": \"First\",\n \"last_name\": \"Last\",\n \"company_name\": \"COMP-NAME\",\n \"payment_source\": {\n \"source_id\": \"5e4bfbc96d244b438451fbd6\",\n \"type\": \"card\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"expire_month\": 12,\n \"expire_year\": 2020,\n \"address_country\": \"AU\",\n \"gateway_id\": \"5cbede1f151b842653e987be\"\n }\n },\n \"capture\": true,\n \"status\": \"pending\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n },\n \"external_id\": \"ch_0Gl9GrjQKtR4Rpd2pRu8np3P\"\n }\n ],\n \"skip\": 1,\n \"limit\": 2,\n \"sortkey\": \"updated_at\",\n \"sortdirection\": \"DESC\",\n \"count\": 19\n }\n}"},{"id":"eea67251-d70c-4e79-af44-fd3aa4152e8f","name":"search by phrase","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?search=First_Name","host":["{{url}}"],"path":["v1","charges"],"query":[{"key":"search","value":"First_Name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 May 2020 14:39:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1049"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-info-limit","value":"100"},{"key":"x-info-skip","value":"0"},{"key":"x-info-sort-key","value":"created_at"},{"key":"x-info-sort-direction","value":"DESC"},{"key":"x-info-count","value":"1"},{"key":"etag","value":"W/\"419-GTaNC0tX/cSU+NnmCBh7HoFz8h8\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"charges\",\n \"data\": [\n {\n \"_id\": \"5ec69295b12c99579e46ee58\",\n \"created_at\": \"2020-05-21T14:39:17.056Z\",\n \"updated_at\": \"2020-05-21T14:39:17.783Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"transactions\": [\n {\n \"created_at\": \"2020-05-21T14:39:17.054Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ec69295b12c99579e46ee59\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"status\": \"complete\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"first_name\": \"First_Name\",\n \"last_name\": \"Last_Name\",\n \"payment_source\": {\n \"card_name\": \"First_Name Last_Name\",\n \"card_number_last4\": \"4242\",\n \"expire_month\": 9,\n \"expire_year\": 21,\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_scheme\": \"visa\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_type\": \"Stripe\"\n }\n },\n \"capture\": true,\n \"status\": \"complete\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n },\n \"external_id\": \"ch_0GlFYHjQKtR4Rpd2Vtykp0x2\"\n }\n ],\n \"skip\": 0,\n \"limit\": 100,\n \"sortkey\": \"created_at\",\n \"sortdirection\": \"DESC\",\n \"count\": 1\n }\n}"}],"_postman_id":"16b167b8-8d75-4915-b3fd-01f5ecd9c762"},{"name":"create","id":"e854658a-f25f-4ad2-9f61-b5ef1ee48a67","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.00\",\n \"currency\": \"AUD\",\n \"customer_id\":\"5e4bfbd86d244b438451fbd7\",\n \"payment_source_id\": \"5e4bfbc96d244b438451fbd6\"\n}"},"url":"{{url}}/v1/charges","description":"

Flow

A Charge is a one-time payment that can be requested against any connected processing service.

Charges can be initatied through 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.

A One-Time-Token (returned as part of a checkout flow)
\n
A Customer (Customer's default Payment Source will be used)
\n
A Payment Source (Belonging to a Customer)
\n
A Transfer (When used as part of Paydock's Transfer/remittance API).
\n
A Vault Token (Directly charging a payment instrument stored in the Paydock Vault independent of any Customer)
\n

You 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.

Request query params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required[flow]	type	description
capture	+6	bool	Automatically capturing or just authorize. By default true

Request body

field	required[flow]	type	description
amount	+	float	Amount of payment
currency	+	string (iso4217 alpha-3)	Currency code
description	-	string	Manually defined description for payments in payment systems
reference	-	string	Manually defined reference for customer in payment systems
token	+1	string(UUID)	One-time token with all the payment source information
customer_id	+2	string (24 byte hex)	Existing customer ID
payment_source_id	-2	string (24 byte hex)	Payment source ID for creating charge with non-default payment source
customer	+3, +4	object	Object with the customer’s information.
customer.first_name	-	string	Customer first name
customer.last_name	-	string	Customer last name
customer.email	-	string	Customer email
customer.phone	-	string(E.164)	Customer phone in E.164 international notation (Example: +12345678901)
customer.payment_source	+	object	Object with payment information
customer.payment_source.gateway_id	+	string (24 byte hex)	Gateway id
customer.payment_source.type	+4	string	Type of payment. By default card. Use card for payment with credit card. Use bank_account for using direct debit payments
customer.payment_source.card_name	+3	string	Cardholder name (as on card)
customer.payment_source.card_number	+3	string(numeric)	Card number
customer.payment_source.expire_month	+3	string(mm)	Card expiration month mm
customer.payment_source.expire_year	+3	string(yyyy)	Card expiration year
customer.payment_source.card_ccv	-3	string(numeric)	Card CCV number
customer.payment_source.account_name	+4	string	Customer account name.
customer.payment_source.account_number	+4	string	Number of Customer account.
customer.payment_source.account_bsb	-4	string	Customer bank state branch number.
customer.payment_source.account_routing	-4	string(numeric)	Number of Customer account. BSB/Routing/SWIFT/IBAN Number.
customer.payment_source.account_holder_type	-4	string	account type (personal or business)
customer.payment_source.account_bank_name	-4	string	Name of account bank
customer.payment_source.address_line1	-	string	Customer Address, line 1
customer.payment_source.address_line2	-	string	Customer Address, line 2
customer.payment_source.address_state	-	string	Customer Address, State
customer.payment_source.address_country	-	string	Customer Address, Country Code
customer.payment_source.address_city	-	string	Customer Address, City
customer.payment_source.address_postcode	-	string(numeric)	Customer Address, Postcade
custom_fields	-	array	Optional array of objects for sending custom fields to a payment gateway
custom_fields[].key	+	string	Name of a key to send to gateway
custom_fields[].value	-	string	Value of a key to send to a gateway
meta	-	object	Optional object with specific fields for different gateways
meta.stripe_direct_account_id	-	string	ID of an existing, connected stripe account. Use to create Stripe connect Direct Charges
meta.stripe_application_fee	-	string	A fee in cents that will be applied to the charge and transferred to the application owner’s Stripe account
meta.stripe_destination_account_id	-	string	ID of an existing, connected stripe account. Use to create Stripe connect Destination Charges
meta.stripe_destination_amount	-	string	The amount to transfer to the destination account without creating an Application Fee
meta.securepay_fraud_guard	-	bool	applies only for Secure Pay, enables SecurePay fraud guard for this transaction
meta.ip_address	-	string	applies only for Secure Pay, pass through the client IP for fraud validation
meta.customer_storage_number	-	string	Bambora gateway only. This value dictates which account the card details will be stored against
meta.tokenise_algorithm	-	number	Bambora alorithm Id for creating charges. (Default - 8, if not specified.)
transfer	-5	object	Object, optional
transfer.stripe_transfer_group	-	string	transfer group Id (specific field for Stripe)
transfer.items	+	array	items
transfer.items[].amount	+	float	Amount of a transfer
transfer.items[].currency	+	string (iso4217 alpha-3)	Currency of a transfer
transfer.items[].destination	+	string	transfer destination (e.g. stripe destination account Id)
_3ds	+7	object	3ds option
_3ds.charge_id	+	string (24 byte hex)	Pre-auth (3ds) charge Id
fraud	+8	object	Fraud payload
fraud.token	+8	string	Token for fraud
fraud.service_id	-8	string (24 byte hex)	id of fraud service
fraud.mode	-8	string	fraud service mode: look at Fraud mode table
fraud.data	+8	object	Fraud data

Fraud mode

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

mode	description
active	fraud service is able to reject charges deteted by the service
passive	Fraud does no affect charges. Charge may be rejected by gateway, Paydock or 3ds but not by fraud

","urlObject":{"path":["v1","charges"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0fe6a16c-a50b-44b4-b148-7f991e2d5306","name":"create 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":"PayDock "},{"key":"ETag","value":"W/\"3b1-VFzSJOLQeQaLr8ag4N8oFQ\""},{"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\": \"charge\",\n \"data\": {\n \"external_id\": \"ch_0GkmcUjQKtR4Rpd2LCjGdkmw\",\n \"_id\": \"5ec4e026b12c99579e46e852\",\n \"created_at\": \"2020-05-20T07:45:42.574Z\",\n \"updated_at\": \"2020-05-20T07:45:43.294Z\",\n \"amount\": 100,\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"currency\": \"AUD\",\n \"__v\": 0,\n \"transactions\": [\n {\n \"created_at\": \"2020-05-20T07:45:42.574Z\",\n \"currency\": \"AUD\",\n \"amount\": 100,\n \"_id\": \"5ec4e026b12c99579e46e853\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"status\": \"complete\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"payment_source\": {\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"type\": \"card\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"expire_month\": 9,\n \"expire_year\": 2020,\n \"card_scheme\": \"visa\"\n }\n },\n \"capture\": true,\n \"status\": \"complete\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n }\n}"},{"id":"11097254-95fa-476a-9d7e-32f6b200147f","name":"create authorized","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 \"customer\": {\n \"payment_source\": {\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_name\": \"First_Name Last_Name\",\n \"card_number\": \"4242424242424242\",\n \"expire_month\": \"01\",\n \"expire_year\": \"21\",\n \"card_ccv\": \"123\"\n }\n }\n}"},"url":{"raw":"{{url}}/v1/charges?capture=false","host":["{{url}}"],"path":["v1","charges"],"query":[{"key":"capture","value":"false"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 May 2020 07:44:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"974"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"3ce-9tDe4KdWGUtzRwsVWeU02A\""},{"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\": \"charge\",\n \"data\": {\n \"external_id\": \"ch_0Gl94xjQKtR4Rpd2I9ssjATJ\",\n \"_id\": \"5ec63162b12c99579e46ee13\",\n \"created_at\": \"2020-05-21T07:44:34.960Z\",\n \"updated_at\": \"2020-05-21T07:44:35.457Z\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"__v\": 0,\n \"transactions\": [\n {\n \"pended_at\": \"2020-05-22T07:44:35.456Z\",\n \"created_at\": \"2020-05-21T07:44:34.959Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ec63162b12c99579e46ee14\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"status\": \"pending\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"payment_source\": {\n \"card_name\": \"First_Name_Last_Name\",\n \"card_number_last4\": \"4242\",\n \"expire_month\": 1,\n \"expire_year\": 21,\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_scheme\": \"visa\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_type\": \"Stripe\"\n }\n },\n \"capture\": false,\n \"status\": \"pending\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n }\n}"},{"id":"2264b942-ac13-41e9-b773-6cb448597a71","name":"gateway 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 \"amount\": \"10.00\",\n \"currency\": \"AUD\",\n \"customer\": {\n \"payment_source\": {\n \"gateway_id\": \"5de6660699f6910cede12651\",\n \"type\": \"bank_account\",\n \"account_name\": \"test test\", \n \"account_number\": \"064000\",\n \"account_routing\": \"invalid\"\n }\n }\n}"},"url":"{{url}}/v1/charges"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 May 2020 10:19:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1155"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"483-ULvU8iKBImc2AQR/xQ2UPQ\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"Invalid Bank Account Details\",\n \"details\": [\n {\n \"gateway_specific_code\": \"bsb\",\n \"gateway_specific_description\": \"Invalid BSB number\",\n \"param_name\": null,\n \"description\": \"Invalid Bank Account Details\",\n \"hard_error\": true\n }\n ]\n },\n \"resource\": {\n \"type\": \"charge\",\n \"data\": {\n \"_id\": \"5f08533e9c63b80a26e52b0a\",\n \"created_at\": \"2020-07-10T11:38:38.695Z\",\n \"updated_at\": \"2020-07-10T11:38:38.929Z\",\n \"company_id\": \"5de656818ebed20cee14ff86\",\n \"user_id\": \"5de656818ebed20cee14ff85\",\n \"amount\": 50,\n \"currency\": \"AUD\",\n \"__v\": 0,\n \"transactions\": [\n {\n \"created_at\": \"2020-07-10T11:38:38.692Z\",\n \"amount\": 50,\n \"currency\": \"AUD\",\n \"_id\": \"5f08533e9c63b80a26e52b0b\",\n \"status_code_description\": null,\n \"status_code\": null,\n \"error_code\": null,\n \"error_message\": \"Invalid Bank Account Details\",\n \"gateway_specific_description\": \"Invalid BSB number\",\n \"gateway_specific_code\": \"bsb\",\n \"_source_ip_address\": \"31.202.25.210\",\n \"service_logs\": [],\n \"status\": \"failed\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"payment_source\": {\n \"type\": \"bank_account\",\n \"account_name\": \"test test\",\n \"account_routing\": \"invalid\",\n \"account_number\": \"XXXX00\",\n \"gateway_id\": \"5de6660699f6910cede12651\",\n \"gateway_name\": \"Pay Way\",\n \"gateway_type\": \"PaywayRest\"\n }\n },\n \"capture\": true,\n \"status\": \"failed\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n },\n \"error_summary\": {\n \"message\": \"Invalid Bank Account Details\",\n \"code\": \"unspecified_error\",\n \"details\": {\n \"gateway_specific_code\": \"bsb\",\n \"gateway_specific_description\": \"Invalid BSB number\",\n \"messages\": [\n \"Invalid Bank Account Details\"\n ]\n }\n }\n}"},{"id":"4aeddeac-9aa1-4c17-8d00-25a855378144","name":"create with customer and non-default payment source","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 \"customer_id\":\"5e4bfbd86d244b438451fbd7\",\n \"payment_source_id\": \"5e4bfbc96d244b438451fbd6\"\n}"},"url":"{{url}}/v1/charges"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 May 2020 07:57:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1064"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"428-QTOZp0KY0P6tcgJr6xQvVA\""},{"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\": \"charge\",\n \"data\": {\n \"external_id\": \"ch_0Gl9H4jQKtR4Rpd2kZBVPd2l\",\n \"_id\": \"5ec63451b12c99579e46ee31\",\n \"created_at\": \"2020-05-21T07:57:05.911Z\",\n \"updated_at\": \"2020-05-21T07:57:06.565Z\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"__v\": 0,\n \"transactions\": [\n {\n \"created_at\": \"2020-05-21T07:57:05.909Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ec63451b12c99579e46ee32\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"status\": \"complete\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"customer_id\": \"5e4bfbd86d244b438451fbd7\",\n \"first_name\": \"First\",\n \"last_name\": \"Last\",\n \"company_name\": \"COMP-NAME\",\n \"payment_source\": {\n \"source_id\": \"5e4bfbc96d244b438451fbd6\",\n \"type\": \"card\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"expire_month\": 12,\n \"expire_year\": 2020,\n \"address_country\": \"AU\",\n \"gateway_id\": \"5cbede1f151b842653e987be\"\n }\n },\n \"capture\": true,\n \"status\": \"complete\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n }\n}"},{"id":"64ffa40a-cf7b-4ea6-a98b-ac8e12c25b53","name":"one-time token cration with fraud. Passive","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text","description":"This is your PayDock API Secret Key"},{"key":"x-user-secret-key","value":"{{secretkey}}","type":"text","description":"Content-Type will always be application/json"},{"key":"x-access-token","value":"{{vault:json-web-token}}"}],"body":{"mode":"raw","raw":"{\n\t\"amount\": \"101\",\n\t\"currency\": \"AUD\",\n\t\"token\": \"a5b290f3-1bfc-481c-be35-688f9d26045f\",\n\n\t\"fraud\": {\n\t\t\"token\": \"eyJpdGVtcyI6W3sicHJvdmlkZXIiOiJBY2NlcnRpZnkiLCJ2YWx1ZSI6IlZJUlRVQUwiLCJ2ZXJzaW9uIjoibGF0ZXN0In1dfQ==\",\n\t\t\"service_id\": \"5f19e2756f48941648a490d9\",\n\t\t\"mode\": \"passive\",\n\t\t\"data\": {\n\t\t\t\"billing\": {\n\t\t\t\t\"shippingFirstName\": \"First_Name\",\n\t\t\t\t\"shippingLastName\": \"Last_Name\",\n\t\t\t\t\"shippingAddress1\": \"Collins Street\",\n\t\t\t\t\"shippingAddress2\": \"\",\n\t\t\t\t\"shippingCity\": \"Melbourne\",\n\t\t\t\t\"shippingState\": \"VIC\",\n\t\t\t\t\"shippingPostcode\": \"3000\",\n\t\t\t\t\"shippingCountry\": \"GG\",\n\t\t\t\t\"shippingPhone\": \"231231\",\n\t\t\t\t\"shippingMethod\": \"N\",\n\t\t\t\t\"shippingEmail\": \"abc@efg.com\"\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"{{url}}/v1/charges"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 201,\r\n \"error\": null,\r\n \"resource\": {\r\n \"type\": \"charge\",\r\n \"data\": {\r\n \"status\": \"complete\",\r\n \"external_id\": \"75b3d3f9-6fcc-4175-b08c-301e9b424e92:f72c9f10-fff0-491d-8e80-f54210f94384\",\r\n \"_id\": \"5f1eb972435632337dab1862\",\r\n \"created_at\": \"2020-07-27T11:24:34.654Z\",\r\n \"updated_at\": \"2020-07-27T11:24:35.905Z\",\r\n \"user_id\": \"5de656818ebed20cee14ff85\",\r\n \"company_id\": \"5de656818ebed20cee14ff86\",\r\n \"amount\": 101,\r\n \"currency\": \"AUD\",\r\n \"__v\": 0,\r\n \"fraud\": {\r\n \"mode\": \"passive\",\r\n \"service_id\": \"5f19e2756f48941648a490d9\"\r\n },\r\n \"transactions\": [\r\n {\r\n \"external_id\": \"75b3d3f9-6fcc-4175-b08c-301e9b424e92:f72c9f10-fff0-491d-8e80-f54210f94384\",\r\n \"created_at\": \"2020-07-27T11:24:34.654Z\",\r\n \"currency\": \"AUD\",\r\n \"amount\": 101,\r\n \"_id\": \"5f1eb972435632337dab1863\",\r\n \"fraud\": {\r\n \"specific_code\": null,\r\n \"specific_message\": \"5237260000001540565:liquor_Transaction Is REJECT:5000;\",\r\n \"status\": \"reject\",\r\n \"score\": \"5000\"\r\n },\r\n \"status_code_description\": null,\r\n \"status_code\": null,\r\n \"error_code\": null,\r\n \"error_message\": null,\r\n \"gateway_specific_description\": null,\r\n \"gateway_specific_code\": null,\r\n \"_source_ip_address\": \"31.202.25.210\",\r\n \"status\": \"complete\",\r\n \"type\": \"sale\"\r\n }\r\n ],\r\n \"one_off\": true,\r\n \"archived\": false,\r\n \"customer\": {\r\n \"first_name\": \"First_Name\",\r\n \"last_name\": \"Last_Name\",\r\n \"email\": \"reject@example.com\",\r\n \"payment_source\": {\r\n \"gateway_type\": \"MasterCard\",\r\n \"gateway_name\": \"MasterCardTest\",\r\n \"type\": \"card\",\r\n \"gateway_id\": \"5eeb7470c6f56c58107671ab\",\r\n \"card_name\": \"test test\",\r\n \"card_number_last4\": \"2346\",\r\n \"expire_month\": 12,\r\n \"expire_year\": 2020,\r\n \"card_scheme\": \"mastercard\",\r\n \"address_country\": \"AU\"\r\n }\r\n },\r\n \"capture\": true,\r\n \"items\": [],\r\n \"transfer\": {\r\n \"items\": []\r\n }\r\n }\r\n }\r\n}"},{"id":"7b22aea6-a6ef-4993-9510-20f76147f94f","name":"create direct with bank-account","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.00\",\n \"currency\": \"AUD\",\n \"customer\": {\n \"payment_source\": {\n \"gateway_id\": \"5d1df20be205944082f778b8\",\n \"type\": \"bank_account\",\n \"account_name\": \"test test\", \n \"account_number\": \"064000\",\n \"account_routing\": \"064000\"\n }\n }\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 08:30:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"950"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"3b6-uqtdDNY0gE4Hw+3ifEhA4w\""},{"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\": \"charge\",\n \"data\": {\n \"external_id\": \"2697785196\",\n \"_id\": \"5ec4ea81b12c99579e46e87e\",\n \"created_at\": \"2020-05-20T08:29:53.516Z\",\n \"updated_at\": \"2020-05-20T08:30:04.210Z\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"__v\": 0,\n \"transactions\": [\n {\n \"pended_at\": \"2020-05-21T08:30:04.208Z\",\n \"created_at\": \"2020-05-20T08:29:53.515Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ec4ea81b12c99579e46e87f\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"status\": \"requested\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"payment_source\": {\n \"type\": \"bank_account\",\n \"account_name\": \"test test\",\n \"account_routing\": \"064000\",\n \"account_number\": \"XXXX00\",\n \"gateway_id\": \"5d1df20be205944082f778b8\",\n \"gateway_name\": \"Pay Way\",\n \"gateway_type\": \"PaywayRest\"\n }\n },\n \"capture\": true,\n \"status\": \"requested\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n }\n}"},{"id":"80295307-c7d1-4e4b-8277-ca82bcaa6df3","name":"one-time token charge cration with fraud. Failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text","description":"This is your PayDock API Secret Key"},{"key":"x-user-secret-key","value":"{{secretkey}}","type":"text","description":"Content-Type will always be application/json"},{"key":"x-access-token","value":"{{vault:json-web-token}}"}],"body":{"mode":"raw","raw":"{\n\t\"amount\": \"101\",\n\t\"currency\": \"AUD\",\n\t\"token\": \"76884a44-2a56-4c55-a413-fd264075f000\",\n\n\t\"fraud\": {\n\t\t\"token\": \"eyJpdGVtcyI6W3sicHJvdmlkZXIiOiJBY2NlcnRpZnkiLCJ2YWx1ZSI6IlZJUlRVQUwiLCJ2ZXJzaW9uIjoibGF0ZXN0In1dfQ==\",\n\t\t\"service_id\": \"5f19e2756f48941648a490d9\",\n\t\t\"mode\": \"active\",\n\t\t\"data\": {\n\t\t\t\"billing\": {\n\t\t\t\t\"shippingFirstName\": \"First_Name\",\n\t\t\t\t\"shippingLastName\": \"Last_Name\",\n\t\t\t\t\"shippingAddress1\": \"Collins Street\",\n\t\t\t\t\"shippingAddress2\": \"\",\n\t\t\t\t\"shippingCity\": \"Melbourne\",\n\t\t\t\t\"shippingState\": \"VIC\",\n\t\t\t\t\"shippingPostcode\": \"3000\",\n\t\t\t\t\"shippingCountry\": \"GG\",\n\t\t\t\t\"shippingPhone\": \"231231\",\n\t\t\t\t\"shippingMethod\": \"N\",\n\t\t\t\t\"shippingEmail\": \"abc@efg.com\"\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"{{url}}/v1/charges"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 400,\r\n \"error\": {\r\n \"message\": \"Fraud check failed\",\r\n \"code\": \"SystemError\",\r\n \"details\": {}\r\n },\r\n \"resource\": {\r\n \"type\": \"charge\",\r\n \"data\": {\r\n \"__v\": 0,\r\n \"created_at\": \"2020-07-27T11:17:03.576Z\",\r\n \"updated_at\": \"2020-07-27T11:17:03.576Z\",\r\n \"status\": \"failed\",\r\n \"user_id\": \"5de656818ebed20cee14ff85\",\r\n \"company_id\": \"5de656818ebed20cee14ff86\",\r\n \"amount\": 101,\r\n \"currency\": \"AUD\",\r\n \"_id\": \"5f1eb7af435632337dab185f\",\r\n \"fraud\": {\r\n \"mode\": \"active\",\r\n \"service_id\": \"5f19e2756f48941648a490d9\"\r\n },\r\n \"transactions\": [\r\n {\r\n \"created_at\": \"2020-07-27T11:17:03.576Z\",\r\n \"currency\": \"AUD\",\r\n \"amount\": 101,\r\n \"_id\": \"5f1eb7af435632337dab1860\",\r\n \"fraud\": {\r\n \"specific_code\": null,\r\n \"specific_message\": \"The request could not be processed\",\r\n \"status\": \"failed\"\r\n },\r\n \"status_code_description\": null,\r\n \"status_code\": null,\r\n \"error_code\": \"system_error\",\r\n \"error_message\": \"System Error\",\r\n \"gateway_specific_description\": null,\r\n \"gateway_specific_code\": null,\r\n \"_source_ip_address\": \"31.202.25.210\",\r\n \"service_logs\": [],\r\n \"status\": \"failed\",\r\n \"type\": \"sale\",\r\n \"id\": \"5f1eb7af435632337dab1860\"\r\n }\r\n ],\r\n \"one_off\": true,\r\n \"archived\": false,\r\n \"customer\": {\r\n \"first_name\": \"First_Name\",\r\n \"last_name\": \"Last_Name\",\r\n \"email\": \"failed@example.com\",\r\n \"payment_source\": {\r\n \"gateway_type\": \"MasterCard\",\r\n \"gateway_name\": \"MasterCardTest\",\r\n \"type\": \"card\",\r\n \"gateway_id\": \"5eeb7470c6f56c58107671ab\",\r\n \"card_name\": \"test test\",\r\n \"card_number_last4\": \"4242\",\r\n \"expire_month\": 12,\r\n \"expire_year\": 2020,\r\n \"card_scheme\": \"visa\",\r\n \"address_country\": \"AU\",\r\n \"ref_token\": \"9146960566347838\"\r\n }\r\n },\r\n \"capture\": true,\r\n \"items\": [],\r\n \"transfer\": {\r\n \"items\": []\r\n },\r\n \"id\": \"5f1eb7af435632337dab185f\"\r\n }\r\n },\r\n \"error_summary\": {\r\n \"message\": \"Fraud check failed\",\r\n \"code\": \"system_error\",\r\n \"details\": {\r\n \"messages\": []\r\n }\r\n }\r\n}"},{"id":"93497f27-f70e-4566-aaf5-9218bf0ab4b8","name":"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 \"amount\": \"incorrect\",\n \"currency\": \"AUD\",\n \"customer\": {\n \"payment_source\": {\n \"gateway_id\": \"5d1df20be205944082f778b8\",\n \"type\": \"bank_account\",\n \"account_name\": \"test test\", \n \"account_number\": \"064000\",\n \"account_routing\": \"064000\"\n }\n }\n}"},"url":"{{url}}/v1/charges"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 20 May 2020 10:23:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"177"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"b1-l6EqWEfmxlTdo6jXRBz2ZA\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"Invalid Transaction Details\",\n \"details\": [\n {\n \"gateway_specific_code\": \"107\",\n \"gateway_specific_description\": \"Invalid transaction amount\",\n \"param_name\": null,\n \"description\": \"Invalid Transaction Details\",\n \"hard_error\": true\n }\n ]\n },\n \"resource\": {\n \"type\": \"charge\",\n \"data\": {\n \"_id\": \"5f0851259c63b80a26e52b04\",\n \"created_at\": \"2020-07-10T11:29:41.489Z\",\n \"updated_at\": \"2020-07-10T11:29:41.769Z\",\n \"company_id\": \"5de656818ebed20cee14ff86\",\n \"user_id\": \"5de656818ebed20cee14ff85\",\n \"amount\": 0,\n \"currency\": \"AUD\",\n \"__v\": 0,\n \"transactions\": [\n {\n \"created_at\": \"2020-07-10T11:29:41.486Z\",\n \"amount\": 0,\n \"currency\": \"AUD\",\n \"_id\": \"5f0851259c63b80a26e52b05\",\n \"status_code_description\": null,\n \"status_code\": null,\n \"error_code\": null,\n \"error_message\": \"Invalid Transaction Details\",\n \"gateway_specific_description\": \"Invalid transaction amount\",\n \"gateway_specific_code\": \"107\",\n \"_source_ip_address\": \"31.202.25.210\",\n \"service_logs\": [],\n \"status\": \"failed\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"payment_source\": {\n \"type\": \"bank_account\",\n \"account_name\": \"test test\",\n \"account_routing\": \"064000\",\n \"account_number\": \"XXXX00\",\n \"gateway_id\": \"5e29a154e8e3dc7bc5aa4db6\",\n \"gateway_name\": \"*********\",\n \"gateway_type\": \"IpPayments\"\n }\n },\n \"capture\": true,\n \"status\": \"failed\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n },\n \"error_summary\": {\n \"message\": \"Invalid Transaction Details\",\n \"code\": \"unspecified_error\",\n \"details\": {\n \"gateway_specific_code\": \"107\",\n \"gateway_specific_description\": \"Invalid transaction amount\",\n \"messages\": [\n \"Invalid Transaction Details\"\n ]\n }\n }\n}"},{"id":"941d94e7-b5de-414c-b7df-44fc413bcfcf","name":"one-time token charge creation with fraud active. Rejected","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text","description":"This is your PayDock API Secret Key"},{"key":"x-user-secret-key","value":"{{secretkey}}","type":"text","description":"Content-Type will always be application/json"},{"key":"x-access-token","value":"{{vault:json-web-token}}"}],"body":{"mode":"raw","raw":"{\n\t\"amount\": \"101\",\n\t\"currency\": \"AUD\",\n\t\"token\": \"fbcecd0a-7afe-48d1-87b3-068395ca1f2a\",\n\n\t\"fraud\": {\n\t\t\"token\": \"eyJpdGVtcyI6W3sicHJvdmlkZXIiOiJBY2NlcnRpZnkiLCJ2YWx1ZSI6IlZJUlRVQUwiLCJ2ZXJzaW9uIjoibGF0ZXN0In1dfQ==\",\n\t\t\"service_id\": \"5f19e2756f48941648a490d9\",\n\t\t\"mode\": \"active\",\n\t\t\"data\": {\n\t\t\t\"billing\": {\n\t\t\t\t\"shippingFirstName\": \"First_Name\",\n\t\t\t\t\"shippingLastName\": \"Last_Name\",\n\t\t\t\t\"shippingAddress1\": \"Collins Street\",\n\t\t\t\t\"shippingAddress2\": \"\",\n\t\t\t\t\"shippingCity\": \"Melbourne\",\n\t\t\t\t\"shippingState\": \"VIC\",\n\t\t\t\t\"shippingPostcode\": \"3000\",\n\t\t\t\t\"shippingCountry\": \"GG\",\n\t\t\t\t\"shippingPhone\": \"231231\",\n\t\t\t\t\"shippingMethod\": \"N\",\n\t\t\t\t\"shippingEmail\": \"abc@efg.com\"\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"{{url}}/v1/charges"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"\"status\": 400,\r\n \"error\": {\r\n \"message\": \"Fraud check failed\",\r\n \"code\": \"FraudWarning\",\r\n \"details\": {\r\n \"status_code\": \"59\",\r\n \"status_code_description\": \"Suspected fraud\"\r\n }\r\n },\r\n \"resource\": {\r\n \"type\": \"charge\",\r\n \"data\": {\r\n \"__v\": 0,\r\n \"created_at\": \"2020-07-27T11:12:50.944Z\",\r\n \"updated_at\": \"2020-07-27T11:12:50.944Z\",\r\n \"status\": \"failed\",\r\n \"user_id\": \"5de656818ebed20cee14ff85\",\r\n \"company_id\": \"5de656818ebed20cee14ff86\",\r\n \"amount\": 101,\r\n \"currency\": \"AUD\",\r\n \"_id\": \"5f1eb6b2435632337dab1858\",\r\n \"fraud\": {\r\n \"mode\": \"active\",\r\n \"service_id\": \"5f19e2756f48941648a490d9\"\r\n },\r\n \"transactions\": [\r\n {\r\n \"created_at\": \"2020-07-27T11:12:50.944Z\",\r\n \"currency\": \"AUD\",\r\n \"amount\": 101,\r\n \"_id\": \"5f1eb6b2435632337dab1859\",\r\n \"fraud\": {\r\n \"specific_code\": null,\r\n \"specific_message\": \"5237260000001540565:liquor_Transaction Is REJECT:5000;\",\r\n \"status\": \"reject\",\r\n \"score\": \"5000\"\r\n },\r\n \"status_code_description\": \"Suspected fraud\",\r\n \"status_code\": \"59\",\r\n \"error_code\": \"fraud_warning\",\r\n \"error_message\": \"Fraud Warning\",\r\n \"gateway_specific_description\": null,\r\n \"gateway_specific_code\": null,\r\n \"_source_ip_address\": \"31.202.25.210\",\r\n \"service_logs\": [],\r\n \"status\": \"rejected\",\r\n \"type\": \"sale\",\r\n \"id\": \"5f1eb6b2435632337dab1859\"\r\n }\r\n ],\r\n \"one_off\": true,\r\n \"archived\": false,\r\n \"customer\": {\r\n \"first_name\": \"First_Name\",\r\n \"last_name\": \"Last_Name\",\r\n \"email\": \"reject@example.com\",\r\n \"payment_source\": {\r\n \"gateway_type\": \"MasterCard\",\r\n \"gateway_name\": \"MasterCardTest\",\r\n \"type\": \"card\",\r\n \"gateway_id\": \"5eeb7470c6f56c58107671ab\",\r\n \"card_name\": \"test test\",\r\n \"card_number_last4\": \"4242\",\r\n \"expire_month\": 12,\r\n \"expire_year\": 2020,\r\n \"card_scheme\": \"visa\",\r\n \"address_country\": \"AU\",\r\n \"ref_token\": \"9370231019726318\"\r\n }\r\n },\r\n \"capture\": true,\r\n \"items\": [],\r\n \"transfer\": {\r\n \"items\": []\r\n },\r\n \"id\": \"5f1eb6b2435632337dab1858\"\r\n }\r\n },\r\n \"error_summary\": {\r\n \"message\": \"Fraud check failed\",\r\n \"code\": \"fraud_warning\",\r\n \"details\": {\r\n \"messages\": []\r\n }\r\n }\r\n}"},{"id":"a5797dc6-6dbb-4893-bff9-af91d76b0c08","name":"create with customer","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\"customer_id\":\"5e4bfbd86d244b438451fbd7\"\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: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":"PayDock "},{"key":"ETag","value":"W/\"42a-Lib0kj6GVhzlJSZAhyanog\""},{"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\": \"charge\",\n \"data\": {\n \"external_id\": \"ch_0Gkmk9jQKtR4Rpd2GZJNT9Q6\",\n \"_id\": \"5ec4e201b12c99579e46e862\",\n \"created_at\": \"2020-05-20T07:53:37.286Z\",\n \"updated_at\": \"2020-05-20T07:53:38.258Z\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"amount\": 100,\n \"currency\": \"AUD\",\n \"__v\": 0,\n \"transactions\": [\n {\n \"created_at\": \"2020-05-20T07:53:37.285Z\",\n \"amount\": 100,\n \"currency\": \"AUD\",\n \"_id\": \"5ec4e201b12c99579e46e863\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"status\": \"complete\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"customer_id\": \"5e4bfbd86d244b438451fbd7\",\n \"first_name\": \"First\",\n \"last_name\": \"Last\",\n \"company_name\": \"COMP-NAME\",\n \"payment_source\": {\n \"source_id\": \"5e4bfbc96d244b438451fbd6\",\n \"type\": \"card\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"expire_month\": 12,\n \"expire_year\": 2020,\n \"address_country\": \"AU\",\n \"gateway_id\": \"5cbede1f151b842653e987be\"\n }\n },\n \"capture\": true,\n \"status\": \"complete\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n }\n}"},{"id":"bc8fcfea-c5ca-46ba-b7f0-7bd94328518c","name":"Error when processing charge is in status not pre_authenticated","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\"amount\": \"17\",\n \"currency\": \"USD\",\n \"reference\": \"ch_ref\",\n \"description\": \"ch_desc\",\n \"_3ds\": {\n \t\"charge_id\": \"5f084eb39c63b80a26e52b01\"\n }\n}"},"url":"{{url}}/v1/charges"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 05 Jun 2020 14:07:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"153"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"99-K3pdssv5GvA1//6kThdWuQ\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"Charge authenticated using different currency\",\n \"code\": \"UnfulfilledCondition\"\n },\n \"resource\": {\n \"type\": \"charge\",\n \"data\": null\n },\n \"error_summary\": {\n \"message\": \"Charge authenticated using different currency\",\n \"code\": \"unfulfilled_condition\",\n \"details\": {\n \"messages\": []\n }\n }\n}"},{"id":"be993892-bb91-4b97-9e83-f9fc8bf5e270","name":"create direct with credit card","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.00\",\n \"currency\": \"AUD\",\n \"customer\": {\n \"payment_source\": {\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_name\": \"First_Name Last_Name\",\n \"card_number\": \"4242424242424242\",\n \"expire_month\": \"09\",\n \"expire_year\": \"21\",\n \"card_ccv\": \"123\"\n }\n }\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 08:14:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"937"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"3a9-RHeI/9QgoGN4LUXmHI5DTg\""},{"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\": \"charge\",\n \"data\": {\n \"external_id\": \"ch_0Gkn48jQKtR4Rpd2u3MoHoVU\",\n \"_id\": \"5ec4e6d8b12c99579e46e86e\",\n \"created_at\": \"2020-05-20T08:14:16.285Z\",\n \"updated_at\": \"2020-05-20T08:14:16.980Z\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"__v\": 0,\n \"transactions\": [\n {\n \"created_at\": \"2020-05-20T08:14:16.282Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ec4e6d8b12c99579e46e86f\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"status\": \"complete\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"payment_source\": {\n \"card_name\": \"First_Name Last_Name\",\n \"card_number_last4\": \"4242\",\n \"expire_month\": 9,\n \"expire_year\": 21,\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_scheme\": \"visa\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_type\": \"Stripe\"\n }\n },\n \"capture\": true,\n \"status\": \"complete\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n }\n}"},{"id":"e142d38e-ef28-4f3e-9d45-87a3f7fbe309","name":"create wih pre-auth with different amount or currency than pre auth","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\": \"1.00\",\n \"currency\": \"AUD\",\n \"_3ds\": {\n \"charge_id\": \"5eda4ee7b97da4248e766f09\"\n }\n}"},"url":"{{url}}/v1/charges"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 05 Jun 2020 13:59:02 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"148"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"94-97DpWGx2lvTe81CZsnjIXQ\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"Charge authorized using different amount\",\n \"code\": \"UnfulfilledCondition\"\n },\n \"resource\": {\n \"type\": \"charge\",\n \"data\": null\n }\n}"},{"id":"ef496daa-9e4d-4290-b261-ed881234a094","name":"one-time token with fraud in active mode. Success","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":"\"amount\": \"101\",\n\t\"currency\": \"AUD\",\n\t\"token\": \"d397b06c-2525-4d4f-9d3b-3328f3156a34\",\n\n\t\"fraud\": {\n\t\t\"token\": \"eyJpdGVtcyI6W3sicHJvdmlkZXIiOiJBY2NlcnRpZnkiLCJ2YWx1ZSI6IlZJUlRVQUwiLCJ2ZXJzaW9uIjoibGF0ZXN0In1dfQ==\",\n\t\t\"service_id\": \"5f19e2756f48941648a490d9\",\n\t\t\"mode\": \"active\",\n\t\t\"data\": {\n\t\t\t\"billing\": {\n\t\t\t\t\"shippingFirstName\": \"First_Name\",\n\t\t\t\t\"shippingLastName\": \"Last_Name\",\n\t\t\t\t\"shippingAddress1\": \"Collins Street\",\n\t\t\t\t\"shippingAddress2\": \"\",\n\t\t\t\t\"shippingCity\": \"Melbourne\",\n\t\t\t\t\"shippingState\": \"VIC\",\n\t\t\t\t\"shippingPostcode\": \"3000\",\n\t\t\t\t\"shippingCountry\": \"AU\",\n\t\t\t\t\"shippingPhone\": \"231231\",\n\t\t\t\t\"shippingMethod\": \"N\",\n\t\t\t\t\"shippingEmail\": \"abc@efg.com\"\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"{{url}}/v1/charges"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"\"status\": 201,\r\n \"error\": null,\r\n \"resource\": {\r\n \"type\": \"charge\",\r\n \"data\": {\r\n \"status\": \"complete\",\r\n \"external_id\": \"470b3a66-63bc-4568-a8d6-c22c99bb671b:9c20adc0-d10c-489e-b92b-21ab0a86f004\",\r\n \"_id\": \"5f1eb002435632337dab1849\",\r\n \"created_at\": \"2020-07-27T10:44:18.697Z\",\r\n \"updated_at\": \"2020-07-27T10:44:19.790Z\",\r\n \"user_id\": \"5de656818ebed20cee14ff85\",\r\n \"company_id\": \"5de656818ebed20cee14ff86\",\r\n \"amount\": 101,\r\n \"currency\": \"AUD\",\r\n \"__v\": 0,\r\n \"fraud\": {\r\n \"mode\": \"active\",\r\n \"service_id\": \"5f19e2756f48941648a490d9\"\r\n },\r\n \"transactions\": [\r\n {\r\n \"external_id\": \"470b3a66-63bc-4568-a8d6-c22c99bb671b:9c20adc0-d10c-489e-b92b-21ab0a86f004\",\r\n \"created_at\": \"2020-07-27T10:44:18.697Z\",\r\n \"currency\": \"AUD\",\r\n \"amount\": 101,\r\n \"_id\": \"5f1eb002435632337dab184a\",\r\n \"fraud\": {\r\n \"specific_code\": null,\r\n \"specific_message\": \"5237260000001540498:liquor_BIN Country Not Equal to US:500;5237260000001540577:liquor_Transaction Total Amount Greater Than 500:500;\",\r\n \"status\": \"approve\",\r\n \"score\": \"1000\"\r\n },\r\n \"status_code_description\": null,\r\n \"status_code\": null,\r\n \"error_code\": null,\r\n \"error_message\": null,\r\n \"gateway_specific_description\": null,\r\n \"gateway_specific_code\": null,\r\n \"_source_ip_address\": \"31.202.25.210\",\r\n \"status\": \"complete\",\r\n \"type\": \"sale\"\r\n }\r\n ],\r\n \"one_off\": true,\r\n \"archived\": false,\r\n \"customer\": {\r\n \"first_name\": \"First_Name\",\r\n \"last_name\": \"Last_Name\",\r\n \"email\": \"reject132@example.com\",\r\n \"payment_source\": {\r\n \"gateway_type\": \"MasterCard\",\r\n \"gateway_name\": \"MasterCardTest\",\r\n \"type\": \"card\",\r\n \"gateway_id\": \"5eeb7470c6f56c58107671ab\",\r\n \"card_name\": \"test test\",\r\n \"card_number_last4\": \"4242\",\r\n \"expire_month\": 12,\r\n \"expire_year\": 2020,\r\n \"card_scheme\": \"visa\",\r\n \"address_country\": \"AU\"\r\n }\r\n },\r\n \"capture\": true,\r\n \"items\": [],\r\n \"transfer\": {\r\n \"items\": []\r\n }\r\n }\r\n }\r\n}"},{"id":"ffebac26-5189-42f6-917f-a98eada6cf3d","name":"create with pre-auth success","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\": \"100.00\",\n \"currency\": \"AUD\",\n \"_3ds\": {\n \"charge_id\": \"5eda5031b97da4248e766f36\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/charges"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 05 Jun 2020 14:07:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"153"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"99-K3pdssv5GvA1//6kThdWuQ\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"error\": null,\n \"resource\": {\n \"type\": \"charge\",\n \"data\": {\n \"_id\": \"5ee0fa666c43c31b799780f6\",\n \"created_at\": \"2020-06-10T15:21:10.210Z\",\n \"updated_at\": \"2020-06-10T15:26:05.696Z\",\n \"company_id\": \"580f17b15cc3e4e3199ef9a6\",\n \"amount\": 100,\n \"currency\": \"AUD\",\n \"__v\": 1,\n \"external_id\": \"37b1ebc6-a746-4b5e-b55a-b352026e3cf3:b33d49ec-1689-478b-9bb3-90168cbcb003\",\n \"_3ds\": {\n \"token\": \"eyJjb250ZW50IjoiPGRpdiBpZD1cInJlZGlyZWN0VG8zZHMxQWNzU2ltcGxlXCIgeG1sbnM9XCJodHRwOi8vd3d3LnczLm9yZy8xOTk5L2h0bWxcIj4gPGlmcmFtZSBpZD1cInJlZGlyZWN0VG8zZHMxRnJhbWVcIiBuYW1lPVwicmVkaXJlY3RUbzNkczFGcmFtZVwiIGhlaWdodD1cIjEwMCVcIiB3aWR0aD1cIjEwMCVcIiA+IDwvaWZyYW1lPiA8Zm9ybSBpZCA9XCJyZWRpcmVjdFRvM2RzMUZvcm1cIiBtZXRob2Q9XCJQT1NUXCIgYWN0aW9uPVwiaHR0cHM6Ly9tdGYuZ2F0ZXdheS5tYXN0ZXJjYXJkLmNvbS9hY3MvTWFzdGVyY2FyZEFDUy9hNTc1YTI2My02ODdhLTQ1ZWItYjIxZi00MDYwMTE2YjA2YTdcIiB0YXJnZXQ9XCJyZWRpcmVjdFRvM2RzMUZyYW1lXCI+IDxpbnB1dCB0eXBlPVwiaGlkZGVuXCIgbmFtZT1cIlBhUmVxXCIgdmFsdWU9XCJlQUZWVVZ0cndqQVlmUmY4RDZYc2RVMVNpVlA1akhnYks5U2hUaG5zTGFTWkZ0cFUwMmE2Zjcra3RuUExVODVKem5jNUJ5YlhQUE8rcEM3VFFvMTlFbURmazBvVVNhb09ZMysvZTM0YytCUFc3Y0R1cUtWY3ZFbGh0R1N3a21YSkQ5SkxFNnZCN2xBeUdJYmt5V2V3bm03bG1VRlRrOW1TUVFpb2hWYXF4WkdyaWdFWDUxbjB5bWlQOWdnRzFFRElwWTRXTEk0Mm1BQzZBVkE4bHl4T3o2YlFNVmNKb0pvQVVSaFY2VytHZTMxQUxRQ2pNM2FzcWxNNVF1aHl1UVJacmN1c0xoQkZIbkNEQUxrL2dPNnpySTJicXJTclhkT0V6YU0rM1h5SzA5Yk16RHZaeCthRHg5L2IxUkl2b3pFZzl3TVNYa2tXNGhEalBzRWVvYU9RaklqZHMrYUI1MjR5TnQwdnZBZnJUNERkZmpjT1RxN1Y5QVpxN3dEOXBjQTZyRzBFN1ZZdEFuazlGVXJhcXJiTDd4M1FmZkw1aS9OVVZOWTlTdXRNYUhPR3p0MzZ3VlZKcldNaHdaWnNBQ0FuUlUxdzFwVTZYTXY4QzczYitRRkhMN09XXCIgLz4gPGlucHV0IHR5cGU9XCJoaWRkZW5cIiBuYW1lPVwiVGVybVVybFwiIHZhbHVlPVwiaHR0cHM6Ly9tdGYuZ2F0ZXdheS5tYXN0ZXJjYXJkLmNvbS9jYWxsYmFja0ludGVyZmFjZS9nYXRld2F5LzlmYzEyM2U0NWQ2OTNiMjU5YzExYjE5MjdlMGY4MTg2YjVkYTc1NDlkNmZiZDc2NGQ2YTdjNzU3NjFjMGZhZjBcIiAvPiA8aW5wdXQgdHlwZT1cImhpZGRlblwiIG5hbWU9XCJNRFwiIHZhbHVlPVwiXCIgLz4gPC9mb3JtPiA8c2NyaXB0IGlkPVwiYXV0aGVudGljYXRlLXBheWVyLXNjcmlwdFwiPiB2YXIgZT1kb2N1bWVudC5nZXRFbGVtZW50QnlJZChcInJlZGlyZWN0VG8zZHMxRm9ybVwiKTsgaWYgKGUpIHsgZS5zdWJtaXQoKTsgaWYgKGUucGFyZW50Tm9kZSAhPT0gbnVsbCkgeyBlLnBhcmVudE5vZGUucmVtb3ZlQ2hpbGQoZSk7IH0gfSA8L3NjcmlwdD4gPC9kaXY+IiwiZm9ybWF0IjoiaHRtbCIsImNoYXJnZV9pZCI6IjVlZTBmYTY2NmM0M2MzMWI3OTk3ODBmNiJ9\"\n },\n \"transactions\": [\n {\n \"external_id\": \"37b1ebc6-a746-4b5e-b55a-b352026e3cf3:b33d49ec-1689-478b-9bb3-90168cbcb003\",\n \"created_at\": \"2020-06-10T15:26:03.037Z\",\n \"currency\": \"AUD\",\n \"amount\": 100,\n \"_id\": \"5ee0fb8b6c43c31b799780f7\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"127.0.0.1\",\n \"status\": \"complete\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"payment_source\": {\n \"ref_token\": \"9212140974255241\",\n \"gateway_id\": \"5eda22bb37356514ddaabee7\",\n \"gateway_type\": \"MasterCard\",\n \"gateway_name\": \"MasterCard\",\n \"card_number_last4\": \"5559\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_scheme\": \"mastercard\"\n }\n },\n \"capture\": true,\n \"status\": \"complete\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n }\n}"}],"_postman_id":"e854658a-f25f-4ad2-9f61-b5ef1ee48a67"},{"name":"get","id":"5f903871-7712-4ec9-8fc4-43610f0ab7f0","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/charges/:id","description":"

Retrieves data on a charge with specified ID.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","charges",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5f084eb39c63b80a26e52b01","key":"id"}]}},"response":[{"id":"3d405f65-ad09-4773-b857-d019e2b5e7ad","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":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"18a0-ddATdsXBmeJKtEbC3eyquHtlSe4\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"charge\",\n \"data\": {\n \"_id\": \"5ec7b21cb12c99579e46f270\",\n \"created_at\": \"2020-05-22T11:06:04.900Z\",\n \"updated_at\": \"2020-05-22T11:06:06.000Z\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"amount\": 1,\n \"currency\": \"AUD\",\n \"subscription_id\": \"5ec7b20ab12c99579e46f26b\",\n \"_source_ip_address\": \"127.0.0.1\",\n \"transactions\": [\n {\n \"created_at\": \"2020-05-22T11:06:04.894Z\",\n \"amount\": 1,\n \"currency\": \"AUD\",\n \"_id\": \"5ec7b21cb12c99579e46f271\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"127.0.0.1\",\n \"service_logs\": [\n {\n \"req\": {\n \"format\": \"json\",\n \"body\": \"{\\\"body\\\":{\\\"amount\\\":1,\\\"customerId\\\":\\\"536537284\\\",\\\"type\\\":\\\"sale\\\"}}\"\n },\n \"response_body\": {\n \"format\": \"json\",\n \"body\": \"{\\\"transaction\\\":{\\\"id\\\":\\\"b7vyt6xm\\\",\\\"status\\\":\\\"authorized\\\",\\\"type\\\":\\\"sale\\\",\\\"currencyIsoCode\\\":\\\"USD\\\",\\\"amount\\\":\\\"1.00\\\",\\\"merchantAccountId\\\":\\\"4cptn45444ks9cw4\\\",\\\"subMerchantAccountId\\\":null,\\\"masterMerchantAccountId\\\":null,\\\"orderId\\\":null,\\\"createdAt\\\":\\\"2020-05-22T11:06:05Z\\\",\\\"updatedAt\\\":\\\"2020-05-22T11:06:05Z\\\",\\\"customer\\\":{\\\"id\\\":\\\"536537284\\\",\\\"firstName\\\":null,\\\"lastName\\\":null,\\\"company\\\":null,\\\"email\\\":\\\"test12345678@test.test\\\",\\\"website\\\":null,\\\"phone\\\":null,\\\"fax\\\":null,\\\"globalId\\\":\\\"Y3VzdG9tZXJfNTM2NTM3Mjg0\\\"},\\\"billing\\\":{\\\"id\\\":null,\\\"firstName\\\":null,\\\"lastName\\\":null,\\\"company\\\":null,\\\"streetAddress\\\":null,\\\"extendedAddress\\\":null,\\\"locality\\\":null,\\\"region\\\":null,\\\"postalCode\\\":null,\\\"countryName\\\":null,\\\"countryCodeAlpha2\\\":null,\\\"countryCodeAlpha3\\\":null,\\\"countryCodeNumeric\\\":null},\\\"refundId\\\":null,\\\"refundIds\\\":[],\\\"refundedTransactionId\\\":null,\\\"partialSettlementTransactionIds\\\":[],\\\"authorizedTransactionId\\\":null,\\\"settlementBatchId\\\":null,\\\"shipping\\\":{\\\"id\\\":null,\\\"firstName\\\":null,\\\"lastName\\\":null,\\\"company\\\":null,\\\"streetAddress\\\":null,\\\"extendedAddress\\\":null,\\\"locality\\\":null,\\\"region\\\":null,\\\"postalCode\\\":null,\\\"countryName\\\":null,\\\"countryCodeAlpha2\\\":null,\\\"countryCodeAlpha3\\\":null,\\\"countryCodeNumeric\\\":null},\\\"customFields\\\":\\\"\\\",\\\"avsErrorResponseCode\\\":null,\\\"avsPostalCodeResponseCode\\\":\\\"I\\\",\\\"avsStreetAddressResponseCode\\\":\\\"I\\\",\\\"cvvResponseCode\\\":\\\"I\\\",\\\"gatewayRejectionReason\\\":null,\\\"processorAuthorizationCode\\\":\\\"2783KW\\\",\\\"processorResponseCode\\\":\\\"1000\\\",\\\"processorResponseText\\\":\\\"Approved\\\",\\\"additionalProcessorResponse\\\":null,\\\"voiceReferralNumber\\\":null,\\\"purchaseOrderNumber\\\":null,\\\"taxAmount\\\":null,\\\"taxExempt\\\":false,\\\"creditCard\\\":{\\\"token\\\":\\\"8x6m7fg\\\",\\\"bin\\\":\\\"424242\\\",\\\"last4\\\":\\\"4242\\\",\\\"cardType\\\":\\\"Visa\\\",\\\"expirationMonth\\\":\\\"03\\\",\\\"expirationYear\\\":\\\"2020\\\",\\\"customerLocation\\\":\\\"US\\\",\\\"cardholderName\\\":\\\"test test\\\",\\\"imageUrl\\\":\\\"https://assets.braintreegateway.com/payment_method_logo/visa.png?environment=sandbox\\\",\\\"prepaid\\\":\\\"Unknown\\\",\\\"healthcare\\\":\\\"Unknown\\\",\\\"debit\\\":\\\"Unknown\\\",\\\"durbinRegulated\\\":\\\"Unknown\\\",\\\"commercial\\\":\\\"Unknown\\\",\\\"payroll\\\":\\\"Unknown\\\",\\\"issuingBank\\\":\\\"Unknown\\\",\\\"countryOfIssuance\\\":\\\"Unknown\\\",\\\"productId\\\":\\\"Unknown\\\",\\\"globalId\\\":\\\"cGF5bWVudG1ldGhvZF9jY184eDZtN2Zn\\\",\\\"accountType\\\":null,\\\"uniqueNumberIdentifier\\\":\\\"8a8e0755d14e2ee2a306f4788f4e480a\\\",\\\"venmoSdk\\\":false,\\\"maskedNumber\\\":\\\"424242******4242\\\",\\\"expirationDate\\\":\\\"03/2020\\\"},\\\"statusHistory\\\":[{\\\"timestamp\\\":\\\"2020-05-22T11:06:05Z\\\",\\\"status\\\":\\\"authorized\\\",\\\"amount\\\":\\\"1.00\\\",\\\"user\\\":\\\"juls\\\",\\\"transactionSource\\\":\\\"api\\\"}],\\\"planId\\\":null,\\\"subscriptionId\\\":null,\\\"subscription\\\":{\\\"billingPeriodEndDate\\\":null,\\\"billingPeriodStartDate\\\":null},\\\"addOns\\\":[],\\\"discounts\\\":[],\\\"descriptor\\\":{\\\"name\\\":null,\\\"phone\\\":null,\\\"url\\\":null},\\\"recurring\\\":false,\\\"channel\\\":null,\\\"serviceFeeAmount\\\":null,\\\"escrowStatus\\\":null,\\\"disbursementDetails\\\":{\\\"disbursementDate\\\":null,\\\"settlementAmount\\\":null,\\\"settlementCurrencyIsoCode\\\":null,\\\"settlementCurrencyExchangeRate\\\":null,\\\"fundsHeld\\\":null,\\\"success\\\":null},\\\"disputes\\\":[],\\\"authorizationAdjustments\\\":[],\\\"paymentInstrumentType\\\":\\\"credit_card\\\",\\\"processorSettlementResponseCode\\\":\\\"\\\",\\\"processorSettlementResponseText\\\":\\\"\\\",\\\"networkResponseCode\\\":\\\"XX\\\",\\\"networkResponseText\\\":\\\"sample network response text\\\",\\\"threeDSecureInfo\\\":null,\\\"shipsFromPostalCode\\\":null,\\\"shippingAmount\\\":null,\\\"discountAmount\\\":null,\\\"networkTransactionId\\\":\\\"020200522110605\\\",\\\"processorResponseType\\\":\\\"approved\\\",\\\"authorizationExpiresAt\\\":\\\"2020-05-29T11:06:05Z\\\",\\\"refundGlobalIds\\\":[],\\\"partialSettlementTransactionGlobalIds\\\":[],\\\"refundedTransactionGlobalId\\\":null,\\\"authorizedTransactionGlobalId\\\":null,\\\"globalId\\\":\\\"dHJhbnNhY3Rpb25fYjd2eXQ2eG0\\\",\\\"retryIds\\\":[],\\\"retriedTransactionId\\\":null,\\\"retrievalReferenceNumber\\\":\\\"1234567\\\",\\\"paypalAccount\\\":{},\\\"coinbaseAccount\\\":{},\\\"applePayCard\\\":{},\\\"androidPayCard\\\":{}},\\\"success\\\":true}\"\n }\n }\n ],\n \"status\": \"complete\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": false,\n \"archived\": false,\n \"customer\": {\n \"customer_id\": \"5ec7b209b12c99579e46f268\",\n \"email\": \"test12345678@test.test\",\n \"payment_source\": {\n \"type\": \"card\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"expire_month\": 3,\n \"expire_year\": 2020,\n \"address_country\": \"AU\",\n \"gateway_id\": \"5cffefaa18b6546015794998\"\n }\n },\n \"capture\": true,\n \"status\": \"complete\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n },\n \"__v\": 0,\n \"external_id\": \"b7vyt6xm\",\n \"subscription\": {\n \"created_at\": \"2020-05-22T11:05:46.160Z\",\n \"updated_at\": \"2020-05-22T11:06:06.039Z\",\n \"status\": \"active\",\n \"statistics\": {\n \"total_collected_amount\": 1,\n \"successful_transactions\": 1\n },\n \"schedule\": {\n \"interval\": \"day\",\n \"start_date\": \"2020-05-22T11:05:45.440Z\",\n \"end_transactions\": 2,\n \"next_assessment\": \"2020-05-23T11:05:45.440Z\",\n \"next_assessment_planned\": \"2020-05-23T11:05:45.440Z\",\n \"last_assessment_planned\": \"2020-05-22T11:05:45.440Z\",\n \"first_assessment\": \"2020-05-22T11:05:45.440Z\",\n \"last_assessment\": \"2020-05-22T11:06:06.025Z\",\n \"completed_count\": 1,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1,\n \"status\": \"complete\"\n }\n },\n \"current_subscription_details\": {\n \"status\": \"active\",\n \"schedule\": {\n \"interval\": \"day\",\n \"frequency\": 1,\n \"start_date\": \"2020-05-22T11:05:45.440Z\",\n \"end_transactions\": 2,\n \"next_assessment\": \"2020-05-23T11:05:45.440Z\",\n \"last_assessment\": \"2020-05-22T11:06:06.025Z\",\n \"next_assessment_planned\": \"2020-05-23T11:05:45.440Z\",\n \"last_assessment_planned\": \"2020-05-22T11:05:45.440Z\",\n \"first_assessment\": \"2020-05-22T11:05:45.440Z\",\n \"retry_count\": 0,\n \"status\": \"complete\"\n }\n }\n }\n }\n}"},{"id":"b3c7dc3e-02a8-4af0-8f93-096b4a5a932a","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/charges/:id","host":["{{url}}"],"path":["v1","charges",":id"],"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:36:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"5267"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"1493-189qrJovkcqiD7ZNoR1GCdbdxRI\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"charge\",\n \"data\": {\n \"_id\": \"5ec7b21cb12c99579e46f270\",\n \"created_at\": \"2020-05-22T11:06:04.900Z\",\n \"updated_at\": \"2020-05-22T11:06:06.000Z\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"amount\": 1,\n \"currency\": \"AUD\",\n \"subscription_id\": \"5ec7b20ab12c99579e46f26b\",\n \"_source_ip_address\": \"127.0.0.1\",\n \"transactions\": [\n {\n \"created_at\": \"2020-05-22T11:06:04.894Z\",\n \"amount\": 1,\n \"currency\": \"AUD\",\n \"_id\": \"5ec7b21cb12c99579e46f271\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"127.0.0.1\",\n \"service_logs\": [\n {\n \"req\": {\n \"format\": \"json\",\n \"body\": \"{\\\"body\\\":{\\\"amount\\\":1,\\\"customerId\\\":\\\"536537284\\\",\\\"type\\\":\\\"sale\\\"}}\"\n },\n \"response_body\": {\n \"format\": \"json\",\n \"body\": \"{\\\"transaction\\\":{\\\"id\\\":\\\"b7vyt6xm\\\",\\\"status\\\":\\\"authorized\\\",\\\"type\\\":\\\"sale\\\",\\\"currencyIsoCode\\\":\\\"USD\\\",\\\"amount\\\":\\\"1.00\\\",\\\"merchantAccountId\\\":\\\"4cptn45444ks9cw4\\\",\\\"subMerchantAccountId\\\":null,\\\"masterMerchantAccountId\\\":null,\\\"orderId\\\":null,\\\"createdAt\\\":\\\"2020-05-22T11:06:05Z\\\",\\\"updatedAt\\\":\\\"2020-05-22T11:06:05Z\\\",\\\"customer\\\":{\\\"id\\\":\\\"536537284\\\",\\\"firstName\\\":null,\\\"lastName\\\":null,\\\"company\\\":null,\\\"email\\\":\\\"test12345678@test.test\\\",\\\"website\\\":null,\\\"phone\\\":null,\\\"fax\\\":null,\\\"globalId\\\":\\\"Y3VzdG9tZXJfNTM2NTM3Mjg0\\\"},\\\"billing\\\":{\\\"id\\\":null,\\\"firstName\\\":null,\\\"lastName\\\":null,\\\"company\\\":null,\\\"streetAddress\\\":null,\\\"extendedAddress\\\":null,\\\"locality\\\":null,\\\"region\\\":null,\\\"postalCode\\\":null,\\\"countryName\\\":null,\\\"countryCodeAlpha2\\\":null,\\\"countryCodeAlpha3\\\":null,\\\"countryCodeNumeric\\\":null},\\\"refundId\\\":null,\\\"refundIds\\\":[],\\\"refundedTransactionId\\\":null,\\\"partialSettlementTransactionIds\\\":[],\\\"authorizedTransactionId\\\":null,\\\"settlementBatchId\\\":null,\\\"shipping\\\":{\\\"id\\\":null,\\\"firstName\\\":null,\\\"lastName\\\":null,\\\"company\\\":null,\\\"streetAddress\\\":null,\\\"extendedAddress\\\":null,\\\"locality\\\":null,\\\"region\\\":null,\\\"postalCode\\\":null,\\\"countryName\\\":null,\\\"countryCodeAlpha2\\\":null,\\\"countryCodeAlpha3\\\":null,\\\"countryCodeNumeric\\\":null},\\\"customFields\\\":\\\"\\\",\\\"avsErrorResponseCode\\\":null,\\\"avsPostalCodeResponseCode\\\":\\\"I\\\",\\\"avsStreetAddressResponseCode\\\":\\\"I\\\",\\\"cvvResponseCode\\\":\\\"I\\\",\\\"gatewayRejectionReason\\\":null,\\\"processorAuthorizationCode\\\":\\\"2783KW\\\",\\\"processorResponseCode\\\":\\\"1000\\\",\\\"processorResponseText\\\":\\\"Approved\\\",\\\"additionalProcessorResponse\\\":null,\\\"voiceReferralNumber\\\":null,\\\"purchaseOrderNumber\\\":null,\\\"taxAmount\\\":null,\\\"taxExempt\\\":false,\\\"creditCard\\\":{\\\"token\\\":\\\"8x6m7fg\\\",\\\"bin\\\":\\\"424242\\\",\\\"last4\\\":\\\"4242\\\",\\\"cardType\\\":\\\"Visa\\\",\\\"expirationMonth\\\":\\\"03\\\",\\\"expirationYear\\\":\\\"2020\\\",\\\"customerLocation\\\":\\\"US\\\",\\\"cardholderName\\\":\\\"test test\\\",\\\"imageUrl\\\":\\\"https://assets.braintreegateway.com/payment_method_logo/visa.png?environment=sandbox\\\",\\\"prepaid\\\":\\\"Unknown\\\",\\\"healthcare\\\":\\\"Unknown\\\",\\\"debit\\\":\\\"Unknown\\\",\\\"durbinRegulated\\\":\\\"Unknown\\\",\\\"commercial\\\":\\\"Unknown\\\",\\\"payroll\\\":\\\"Unknown\\\",\\\"issuingBank\\\":\\\"Unknown\\\",\\\"countryOfIssuance\\\":\\\"Unknown\\\",\\\"productId\\\":\\\"Unknown\\\",\\\"globalId\\\":\\\"cGF5bWVudG1ldGhvZF9jY184eDZtN2Zn\\\",\\\"accountType\\\":null,\\\"uniqueNumberIdentifier\\\":\\\"8a8e0755d14e2ee2a306f4788f4e480a\\\",\\\"venmoSdk\\\":false,\\\"maskedNumber\\\":\\\"424242******4242\\\",\\\"expirationDate\\\":\\\"03/2020\\\"},\\\"statusHistory\\\":[{\\\"timestamp\\\":\\\"2020-05-22T11:06:05Z\\\",\\\"status\\\":\\\"authorized\\\",\\\"amount\\\":\\\"1.00\\\",\\\"user\\\":\\\"juls\\\",\\\"transactionSource\\\":\\\"api\\\"}],\\\"planId\\\":null,\\\"subscriptionId\\\":null,\\\"subscription\\\":{\\\"billingPeriodEndDate\\\":null,\\\"billingPeriodStartDate\\\":null},\\\"addOns\\\":[],\\\"discounts\\\":[],\\\"descriptor\\\":{\\\"name\\\":null,\\\"phone\\\":null,\\\"url\\\":null},\\\"recurring\\\":false,\\\"channel\\\":null,\\\"serviceFeeAmount\\\":null,\\\"escrowStatus\\\":null,\\\"disbursementDetails\\\":{\\\"disbursementDate\\\":null,\\\"settlementAmount\\\":null,\\\"settlementCurrencyIsoCode\\\":null,\\\"settlementCurrencyExchangeRate\\\":null,\\\"fundsHeld\\\":null,\\\"success\\\":null},\\\"disputes\\\":[],\\\"authorizationAdjustments\\\":[],\\\"paymentInstrumentType\\\":\\\"credit_card\\\",\\\"processorSettlementResponseCode\\\":\\\"\\\",\\\"processorSettlementResponseText\\\":\\\"\\\",\\\"networkResponseCode\\\":\\\"XX\\\",\\\"networkResponseText\\\":\\\"sample network response text\\\",\\\"threeDSecureInfo\\\":null,\\\"shipsFromPostalCode\\\":null,\\\"shippingAmount\\\":null,\\\"discountAmount\\\":null,\\\"networkTransactionId\\\":\\\"020200522110605\\\",\\\"processorResponseType\\\":\\\"approved\\\",\\\"authorizationExpiresAt\\\":\\\"2020-05-29T11:06:05Z\\\",\\\"refundGlobalIds\\\":[],\\\"partialSettlementTransactionGlobalIds\\\":[],\\\"refundedTransactionGlobalId\\\":null,\\\"authorizedTransactionGlobalId\\\":null,\\\"globalId\\\":\\\"dHJhbnNhY3Rpb25fYjd2eXQ2eG0\\\",\\\"retryIds\\\":[],\\\"retriedTransactionId\\\":null,\\\"retrievalReferenceNumber\\\":\\\"1234567\\\",\\\"paypalAccount\\\":{},\\\"coinbaseAccount\\\":{},\\\"applePayCard\\\":{},\\\"androidPayCard\\\":{}},\\\"success\\\":true}\"\n }\n }\n ],\n \"status\": \"complete\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": false,\n \"archived\": false,\n \"customer\": {\n \"customer_id\": \"5ec7b209b12c99579e46f268\",\n \"email\": \"test12345678@test.test\",\n \"payment_source\": {\n \"type\": \"card\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"expire_month\": 3,\n \"expire_year\": 2020,\n \"address_country\": \"AU\",\n \"gateway_id\": \"5cffefaa18b6546015794998\"\n }\n },\n \"capture\": true,\n \"status\": \"complete\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n },\n \"__v\": 0,\n \"external_id\": \"b7vyt6xm\"\n }\n }\n}"}],"_postman_id":"5f903871-7712-4ec9-8fc4-43610f0ab7f0"},{"name":"capture","id":"3622884f-8af0-48e3-a91d-4e0f1ccc5bed","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":""},"url":"{{url}}/v1/charges/:id/capture","description":"

For capturing an authorised charge, make a POST call

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","charges",":id","capture"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5f084eb39c63b80a26e52b01","key":"id"}]}},"response":[{"id":"77c01e0e-f1db-49ea-9266-1395e00d211d","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":"PayDock "},{"key":"ETag","value":"W/\"447-W5NXxs3sQjK0T6SiJsD9Rg\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"Charge not in pending status\",\n \"code\": \"UnfulfilledCondition\",\n \"details\": {\n \"path\": \"status\"\n }\n },\n \"resource\": {\n \"type\": \"charge\",\n \"data\": {\n \"_id\": \"5f085abf9c63b80a26e52b45\",\n \"created_at\": \"2020-07-10T12:10:39.926Z\",\n \"updated_at\": \"2020-07-10T12:10:41.039Z\",\n \"company_id\": \"5de656818ebed20cee14ff86\",\n \"user_id\": \"5de656818ebed20cee14ff85\",\n \"amount\": 111,\n \"currency\": \"AUD\",\n \"__v\": 0,\n \"external_id\": \"d75545f3-e4f3-4546-8a9e-ecfb792becc9:9c7a9ac1-f263-4dc8-92f2-ba8fd17b5ca7\",\n \"transactions\": [\n {\n \"created_at\": \"2020-07-10T12:10:39.923Z\",\n \"amount\": 111,\n \"currency\": \"AUD\",\n \"_id\": \"5f085abf9c63b80a26e52b46\",\n \"external_id\": \"d75545f3-e4f3-4546-8a9e-ecfb792becc9:9c7a9ac1-f263-4dc8-92f2-ba8fd17b5ca7\",\n \"status_code_description\": null,\n \"status_code\": null,\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"31.202.25.210\",\n \"service_logs\": [],\n \"status\": \"complete\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"first_name\": \"First_Name\",\n \"last_name\": \"Last_Name\",\n \"payment_source\": {\n \"type\": \"card\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"expire_month\": 12,\n \"expire_year\": 21,\n \"address_country\": \"AU\",\n \"gateway_id\": \"5eeb7470c6f56c58107671ab\",\n \"card_scheme\": \"visa\",\n \"gateway_name\": \"MasterCardTest\",\n \"gateway_type\": \"MasterCard\"\n }\n },\n \"capture\": true,\n \"status\": \"complete\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n },\n \"error_summary\": {\n \"message\": \"Charge not in pending status\",\n \"code\": \"unfulfilled_condition\",\n \"details\": {\n \"path\": \"status\",\n \"messages\": []\n }\n }\n}"},{"id":"f3bd57e6-bba6-4d37-b947-786e3aaf68d8","name":"capture","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":"5ec6305eb12c99579e46edef"}]}},"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":"PayDock "},{"key":"ETag","value":"W/\"40f-h4iitGvjF+fKWxTqvLCoXg\""},{"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\": \"charge\",\n \"data\": {\n \"_id\": \"5ec6305eb12c99579e46edef\",\n \"created_at\": \"2020-05-21T07:40:14.179Z\",\n \"updated_at\": \"2020-05-22T15:02:05.580Z\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"__v\": 0,\n \"external_id\": \"ch_0Gl90kjQKtR4Rpd2KlGhQamr\",\n \"transactions\": [\n {\n \"created_at\": \"2020-05-21T07:40:14.177Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ec6305eb12c99579e46edf0\",\n \"pended_at\": \"2020-05-23T07:40:57.991Z\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"status\": \"complete\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"payment_source\": {\n \"card_name\": \"First_Name Last_Name\",\n \"card_number_last4\": \"4242\",\n \"expire_month\": 1,\n \"expire_year\": 21,\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_scheme\": \"visa\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_type\": \"Stripe\"\n }\n },\n \"capture\": true,\n \"status\": \"complete\",\n \"schedule\": {\n \"authorised_pended_at\": \"2020-05-22T09:40:57.324Z\"\n },\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n }\n}"}],"_postman_id":"3622884f-8af0-48e3-a91d-4e0f1ccc5bed"},{"name":"cancel authorised","id":"e7571922-c5d5-4e10-8e55-2563ae32d1da","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":""},"url":"{{url}}/v1/charges/:id/capture","description":"

For cancelling an authorised charge, make a DELETE call.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","charges",":id","capture"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5ec7b6b3b12c99579e46f27d","key":"id"}]}},"response":[{"id":"22dec709-40fa-4a1d-839e-29010982df43","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":"PayDock "},{"key":"ETag","value":"W/\"76-jkkeypCmJvq7I3bnF0oM/g\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"Charge not found or not in pending state\",\n \"code\": \"UnfulfilledCondition\"\n },\n \"resource\": {\n \"type\": \"charge\",\n \"data\": null\n },\n \"error_summary\": {\n \"message\": \"Charge not found or not in pending state\",\n \"code\": \"unfulfilled_condition\",\n \"details\": {\n \"messages\": []\n }\n }\n}"}],"_postman_id":"e7571922-c5d5-4e10-8e55-2563ae32d1da"},{"name":"archive","id":"dedb2a12-82f5-4516-84a0-64e5d456ea5f","protocolProfileBehavior":{"disableBodyPruning":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/charges/:id","description":"

Archive Charge to hide it it from charges list. You can still retrieve archived charges

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","charges",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5ec691dfb12c99579e46ee4e","key":"id"}]}},"response":[{"id":"982728d2-0c2e-4507-af60-f4cd40fe107d","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":"PayDock "},{"key":"ETag","value":"W/\"461-ZmW1jbhJNwakBf/S7e8VFw\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"charge\",\n \"data\": {\n \"_id\": \"5ec691dfb12c99579e46ee4e\",\n \"created_at\": \"2020-05-21T14:36:15.368Z\",\n \"updated_at\": \"2020-05-25T10:18:32.707Z\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"description\": \"First_Name Last_Name is charged\",\n \"__v\": 0,\n \"external_id\": \"ch_0GlFVLjQKtR4Rpd21QwOjU9U\",\n \"transactions\": [\n {\n \"created_at\": \"2020-05-21T14:36:15.366Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ec691dfb12c99579e46ee4f\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"service_logs\": [],\n \"status\": \"complete\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": true,\n \"archived\": true,\n \"customer\": {\n \"customer_id\": \"5e4bfbd86d244b438451fbd7\",\n \"first_name\": \"First\",\n \"last_name\": \"Last\",\n \"company_name\": \"COMP-NAME\",\n \"payment_source\": {\n \"source_id\": \"5e4bfbc96d244b438451fbd6\",\n \"type\": \"card\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"expire_month\": 12,\n \"expire_year\": 2020,\n \"address_country\": \"AU\",\n \"gateway_id\": \"5cbede1f151b842653e987be\"\n }\n },\n \"capture\": true,\n \"status\": \"complete\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n }\n}"}],"_postman_id":"dedb2a12-82f5-4516-84a0-64e5d456ea5f"},{"name":"refund","id":"777c6a27-50d7-4e39-bacd-10db592813ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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":"{{url}}/v1/charges/:id/refunds","description":"

refund request of specified transaction.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","charges",":id","refunds"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5ecd108a51eff9228f882b8b","key":"id"}]}},"response":[{"id":"8f8e5f76-cb14-4cc9-b9f3-332b0d819267","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":"PayDock "},{"key":"ETag","value":"W/\"8dc-0k7rwX+nxdWdF29cYaMIeg\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"Invalid Transaction Details\",\n \"code\": \"invalid_transaction_details\",\n \"details\": [\n {\n \"gateway_specific_code\": \"INVALID_REQUEST:INVALID:apiOperation\",\n \"gateway_specific_description\": \"The request contained a field with a value that did not pass validation.\",\n \"param_name\": null,\n \"description\": \"Invalid Transaction Details\"\n }\n ]\n },\n \"resource\": {\n \"type\": \"charge\",\n \"data\": {\n \"_id\": \"5f085a919c63b80a26e52b3d\",\n \"created_at\": \"2020-07-10T12:09:54.001Z\",\n \"updated_at\": \"2020-07-10T12:57:13.148Z\",\n \"company_id\": \"5de656818ebed20cee14ff86\",\n \"user_id\": \"5de656818ebed20cee14ff85\",\n \"amount\": 111,\n \"currency\": \"AUD\",\n \"__v\": 2,\n \"external_id\": \"c7016979-7ec2-49a0-89db-255f0409ad7d:68c534c0-991b-4040-a032-f3a7369a53ca\",\n \"_source_ip_address\": \"31.202.25.210\",\n \"transactions\": [\n {\n \"created_at\": \"2020-07-10T12:09:53.999Z\",\n \"amount\": 111,\n \"currency\": \"AUD\",\n \"_id\": \"5f085a929c63b80a26e52b3e\",\n \"external_id\": \"c7016979-7ec2-49a0-89db-255f0409ad7d:68c534c0-991b-4040-a032-f3a7369a53ca\",\n \"status_code_description\": null,\n \"status_code\": null,\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"31.202.25.210\",\n \"service_logs\": [],\n \"status\": \"complete\",\n \"type\": \"sale\"\n },\n {\n \"created_at\": \"2020-07-10T12:56:46.847Z\",\n \"amount\": 111,\n \"currency\": \"AUD\",\n \"_id\": \"5f08658e9c63b80a26e52d48\",\n \"external_id\": \"c7016979-7ec2-49a0-89db-255f0409ad7d:e2b11bcb-6861-4d8f-9333-cb6e7cb626ff\",\n \"status_code_description\": null,\n \"status_code\": null,\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"31.202.25.210\",\n \"service_logs\": [],\n \"status\": \"complete\",\n \"type\": \"refund\"\n },\n {\n \"created_at\": \"2020-07-10T12:57:12.210Z\",\n \"amount\": 111,\n \"currency\": \"AUD\",\n \"_id\": \"5f0865a89c63b80a26e52d49\",\n \"status_code_description\": null,\n \"status_code\": null,\n \"error_code\": \"invalid_transaction_details\",\n \"error_message\": \"Invalid Transaction Details\",\n \"gateway_specific_description\": \"The request contained a field with a value that did not pass validation.\",\n \"gateway_specific_code\": \"INVALID_REQUEST:INVALID:apiOperation\",\n \"_source_ip_address\": \"31.202.25.210\",\n \"service_logs\": [],\n \"status\": \"failed\",\n \"type\": \"refund\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"first_name\": \"First_Name\",\n \"last_name\": \"Last_Name\",\n \"payment_source\": {\n \"type\": \"card\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"expire_month\": 12,\n \"expire_year\": 21,\n \"address_country\": \"AU\",\n \"gateway_id\": \"5eeb7470c6f56c58107671ab\",\n \"card_scheme\": \"visa\",\n \"gateway_name\": \"MasterCardTest\",\n \"gateway_type\": \"MasterCard\"\n }\n },\n \"capture\": true,\n \"status\": \"refunded\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n },\n \"transaction\": {\n \"created_at\": \"2020-07-10T12:57:12.210Z\",\n \"amount\": 111,\n \"currency\": \"AUD\",\n \"_id\": \"5f0865a89c63b80a26e52d49\",\n \"status_code_description\": null,\n \"status_code\": null,\n \"error_code\": \"invalid_transaction_details\",\n \"error_message\": \"Invalid Transaction Details\",\n \"gateway_specific_description\": \"The request contained a field with a value that did not pass validation.\",\n \"gateway_specific_code\": \"INVALID_REQUEST:INVALID:apiOperation\",\n \"_source_ip_address\": \"31.202.25.210\",\n \"service_logs\": [],\n \"status\": \"failed\",\n \"type\": \"refund\"\n }\n }\n },\n \"error_summary\": {\n \"message\": \"Invalid Transaction Details\",\n \"code\": \"invalid_transaction_details\",\n \"details\": {\n \"gateway_specific_code\": \"INVALID_REQUEST:INVALID:apiOperation\",\n \"gateway_specific_description\": \"The request contained a field with a value that did not pass validation.\",\n \"messages\": [\n \"Invalid Transaction Details\"\n ]\n }\n }\n}"},{"id":"bafb50bf-49d9-48d7-8b39-0462c184df1f","name":"partial refund","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\": 5\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/charges/:id/refunds","host":["{{url}}"],"path":["v1","charges",":id","refunds"],"variable":[{"key":"id","value":"5ecd153551eff9228f882b98"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 26 May 2020 13:10:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1467"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"5bb-qmSt35IyUD+CBrVGwbgcJg\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"charge\",\n \"data\": {\n \"_id\": \"5ecd153551eff9228f882b98\",\n \"created_at\": \"2020-05-26T13:10:13.489Z\",\n \"updated_at\": \"2020-05-26T13:10:46.807Z\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"__v\": 1,\n \"external_id\": \"ch_0Gn2XpjQKtR4Rpd21n4wyxte\",\n \"transactions\": [\n {\n \"created_at\": \"2020-05-26T13:10:13.488Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ecd153551eff9228f882b99\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"service_logs\": [],\n \"status\": \"complete\",\n \"type\": \"sale\"\n },\n {\n \"pended_at\": \"2020-05-27T13:10:46.804Z\",\n \"created_at\": \"2020-05-26T13:10:46.241Z\",\n \"amount\": 5,\n \"currency\": \"AUD\",\n \"_id\": \"5ecd155651eff9228f882ba2\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"service_logs\": [],\n \"status\": \"requested\",\n \"type\": \"refund\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"customer_id\": \"5e4bfbd86d244b438451fbd7\",\n \"first_name\": \"First\",\n \"last_name\": \"Last\",\n \"company_name\": \"COMP-NAME\",\n \"payment_source\": {\n \"source_id\": \"5e4bfbc96d244b438451fbd6\",\n \"type\": \"card\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"expire_month\": 12,\n \"expire_year\": 2020,\n \"address_country\": \"AU\",\n \"gateway_id\": \"5cbede1f151b842653e987be\"\n }\n },\n \"capture\": true,\n \"status\": \"refund_requested\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n }\n}"},{"id":"d3436913-237d-46c9-aab2-bfdaee97433d","name":"refund success","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":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 26 May 2020 12:51:21 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1468"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"5bc-Iw38hRQ78sWevJgoux5jJw\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"charge\",\n \"data\": {\n \"_id\": \"5ecd108a51eff9228f882b8b\",\n \"created_at\": \"2020-05-26T12:50:18.586Z\",\n \"updated_at\": \"2020-05-26T12:51:21.921Z\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"__v\": 1,\n \"external_id\": \"ch_0Gn2EYjQKtR4Rpd2Z409qPmQ\",\n \"transactions\": [\n {\n \"created_at\": \"2020-05-26T12:50:18.579Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ecd108a51eff9228f882b8c\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"service_logs\": [],\n \"status\": \"complete\",\n \"type\": \"sale\"\n },\n {\n \"pended_at\": \"2020-05-27T12:51:21.917Z\",\n \"created_at\": \"2020-05-26T12:51:21.331Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ecd10c951eff9228f882b95\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"service_logs\": [],\n \"status\": \"requested\",\n \"type\": \"refund\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"customer_id\": \"5e4bfbd86d244b438451fbd7\",\n \"first_name\": \"First\",\n \"last_name\": \"Last\",\n \"company_name\": \"COMP-NAME\",\n \"payment_source\": {\n \"source_id\": \"5e4bfbc96d244b438451fbd6\",\n \"type\": \"card\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"expire_month\": 12,\n \"expire_year\": 2020,\n \"address_country\": \"AU\",\n \"gateway_id\": \"5cbede1f151b842653e987be\"\n }\n },\n \"capture\": true,\n \"status\": \"refund_requested\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n }\n}"}],"_postman_id":"777c6a27-50d7-4e39-bacd-10db592813ad"},{"name":"get with refund status","id":"a1b4a26a-0ecc-4af2-9a7d-5d12acf7d3f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","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/charges/:id/refunds","description":"

Manually request update the refund transaction status and get charge with actual refund info

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","charges",":id","refunds"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5ecd108a51eff9228f882b8b","key":"id"}]}},"response":[{"id":"247f569a-7285-418c-9d47-c9675bce6abe","name":"refund success","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":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 26 May 2020 12:51:21 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1468"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"5bc-Iw38hRQ78sWevJgoux5jJw\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"charge\",\n \"data\": {\n \"_id\": \"5ecd108a51eff9228f882b8b\",\n \"created_at\": \"2020-05-26T12:50:18.586Z\",\n \"updated_at\": \"2020-05-26T12:51:21.921Z\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"__v\": 1,\n \"external_id\": \"ch_0Gn2EYjQKtR4Rpd2Z409qPmQ\",\n \"transactions\": [\n {\n \"created_at\": \"2020-05-26T12:50:18.579Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ecd108a51eff9228f882b8c\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"service_logs\": [],\n \"status\": \"complete\",\n \"type\": \"sale\"\n },\n {\n \"pended_at\": \"2020-05-27T12:51:21.917Z\",\n \"created_at\": \"2020-05-26T12:51:21.331Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ecd10c951eff9228f882b95\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"service_logs\": [],\n \"status\": \"requested\",\n \"type\": \"refund\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"customer_id\": \"5e4bfbd86d244b438451fbd7\",\n \"first_name\": \"First\",\n \"last_name\": \"Last\",\n \"company_name\": \"COMP-NAME\",\n \"payment_source\": {\n \"source_id\": \"5e4bfbc96d244b438451fbd6\",\n \"type\": \"card\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"expire_month\": 12,\n \"expire_year\": 2020,\n \"address_country\": \"AU\",\n \"gateway_id\": \"5cbede1f151b842653e987be\"\n }\n },\n \"capture\": true,\n \"status\": \"refund_requested\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n }\n}"},{"id":"d4018f0e-43bd-47d3-8dcd-a4b925406557","name":"get with refund status","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/charges/:id/refunds","host":["{{url}}"],"path":["v1","charges",":id","refunds"],"variable":[{"key":"id","value":"5ecd108a51eff9228f882b8b"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 26 May 2020 13:09:34 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1758"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"6de-xXz5YgIzZfXv+POOXq3zdg\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"charge\",\n \"data\": {\n \"_id\": \"5ecd108a51eff9228f882b8b\",\n \"created_at\": \"2020-05-26T12:50:18.586Z\",\n \"updated_at\": \"2020-05-26T13:05:34.527Z\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"__v\": 2,\n \"external_id\": \"ch_0Gn2EYjQKtR4Rpd2Z409qPmQ\",\n \"transactions\": [\n {\n \"created_at\": \"2020-05-26T12:50:18.579Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ecd108a51eff9228f882b8c\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"service_logs\": [],\n \"status\": \"complete\",\n \"type\": \"sale\"\n },\n {\n \"created_at\": \"2020-05-26T12:51:21.331Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ecd10c951eff9228f882b95\",\n \"pended_at\": \"2020-05-27T12:51:21.917Z\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"service_logs\": [],\n \"status\": \"complete\",\n \"type\": \"refund\"\n },\n {\n \"created_at\": \"2020-05-26T13:01:58.145Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ecd134651eff9228f882b97\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"service_logs\": [],\n \"status\": \"failed\",\n \"type\": \"refund\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"customer_id\": \"5e4bfbd86d244b438451fbd7\",\n \"first_name\": \"First\",\n \"last_name\": \"Last\",\n \"company_name\": \"COMP-NAME\",\n \"payment_source\": {\n \"source_id\": \"5e4bfbc96d244b438451fbd6\",\n \"type\": \"card\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"expire_month\": 12,\n \"expire_year\": 2020,\n \"address_country\": \"AU\",\n \"gateway_id\": \"5cbede1f151b842653e987be\"\n }\n },\n \"capture\": true,\n \"status\": \"refunded\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n }\n}"},{"id":"d55076f3-3f59-4097-bd5e-5f6e2ed87915","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":"PayDock "},{"key":"ETag","value":"W/\"8dc-0k7rwX+nxdWdF29cYaMIeg\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"Invalid Transaction Details\",\n \"code\": \"invalid_transaction_details\",\n \"details\": [\n {\n \"gateway_specific_code\": \"INVALID_REQUEST:INVALID:apiOperation\",\n \"gateway_specific_description\": \"The request contained a field with a value that did not pass validation.\",\n \"param_name\": null,\n \"description\": \"Invalid Transaction Details\"\n }\n ]\n },\n \"resource\": {\n \"type\": \"charge\",\n \"data\": {\n \"_id\": \"5f085a919c63b80a26e52b3d\",\n \"created_at\": \"2020-07-10T12:09:54.001Z\",\n \"updated_at\": \"2020-07-10T12:57:13.148Z\",\n \"company_id\": \"5de656818ebed20cee14ff86\",\n \"user_id\": \"5de656818ebed20cee14ff85\",\n \"amount\": 111,\n \"currency\": \"AUD\",\n \"__v\": 2,\n \"external_id\": \"c7016979-7ec2-49a0-89db-255f0409ad7d:68c534c0-991b-4040-a032-f3a7369a53ca\",\n \"_source_ip_address\": \"31.202.25.210\",\n \"transactions\": [\n {\n \"created_at\": \"2020-07-10T12:09:53.999Z\",\n \"amount\": 111,\n \"currency\": \"AUD\",\n \"_id\": \"5f085a929c63b80a26e52b3e\",\n \"external_id\": \"c7016979-7ec2-49a0-89db-255f0409ad7d:68c534c0-991b-4040-a032-f3a7369a53ca\",\n \"status_code_description\": null,\n \"status_code\": null,\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"31.202.25.210\",\n \"service_logs\": [],\n \"status\": \"complete\",\n \"type\": \"sale\"\n },\n {\n \"created_at\": \"2020-07-10T12:56:46.847Z\",\n \"amount\": 111,\n \"currency\": \"AUD\",\n \"_id\": \"5f08658e9c63b80a26e52d48\",\n \"external_id\": \"c7016979-7ec2-49a0-89db-255f0409ad7d:e2b11bcb-6861-4d8f-9333-cb6e7cb626ff\",\n \"status_code_description\": null,\n \"status_code\": null,\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"31.202.25.210\",\n \"service_logs\": [],\n \"status\": \"complete\",\n \"type\": \"refund\"\n },\n {\n \"created_at\": \"2020-07-10T12:57:12.210Z\",\n \"amount\": 111,\n \"currency\": \"AUD\",\n \"_id\": \"5f0865a89c63b80a26e52d49\",\n \"status_code_description\": null,\n \"status_code\": null,\n \"error_code\": \"invalid_transaction_details\",\n \"error_message\": \"Invalid Transaction Details\",\n \"gateway_specific_description\": \"The request contained a field with a value that did not pass validation.\",\n \"gateway_specific_code\": \"INVALID_REQUEST:INVALID:apiOperation\",\n \"_source_ip_address\": \"31.202.25.210\",\n \"service_logs\": [],\n \"status\": \"failed\",\n \"type\": \"refund\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"first_name\": \"First_Name\",\n \"last_name\": \"Last_Name\",\n \"payment_source\": {\n \"type\": \"card\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"expire_month\": 12,\n \"expire_year\": 21,\n \"address_country\": \"AU\",\n \"gateway_id\": \"5eeb7470c6f56c58107671ab\",\n \"card_scheme\": \"visa\",\n \"gateway_name\": \"MasterCardTest\",\n \"gateway_type\": \"MasterCard\"\n }\n },\n \"capture\": true,\n \"status\": \"refunded\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n },\n \"transaction\": {\n \"created_at\": \"2020-07-10T12:57:12.210Z\",\n \"amount\": 111,\n \"currency\": \"AUD\",\n \"_id\": \"5f0865a89c63b80a26e52d49\",\n \"status_code_description\": null,\n \"status_code\": null,\n \"error_code\": \"invalid_transaction_details\",\n \"error_message\": \"Invalid Transaction Details\",\n \"gateway_specific_description\": \"The request contained a field with a value that did not pass validation.\",\n \"gateway_specific_code\": \"INVALID_REQUEST:INVALID:apiOperation\",\n \"_source_ip_address\": \"31.202.25.210\",\n \"service_logs\": [],\n \"status\": \"failed\",\n \"type\": \"refund\"\n }\n }\n },\n \"error_summary\": {\n \"message\": \"Invalid Transaction Details\",\n \"code\": \"invalid_transaction_details\",\n \"details\": {\n \"gateway_specific_code\": \"INVALID_REQUEST:INVALID:apiOperation\",\n \"gateway_specific_description\": \"The request contained a field with a value that did not pass validation.\",\n \"messages\": [\n \"Invalid Transaction Details\"\n ]\n }\n }\n}"}],"_postman_id":"a1b4a26a-0ecc-4af2-9a7d-5d12acf7d3f1"},{"name":"modify","id":"e672e6e8-99f9-4e27-8bcc-045208649fd1","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\t\"subscription_id\": \"5ec7b20ab12c99579e46f26b\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/charges/:id","description":"

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
subscription_id	-	string (24 byte hex)	You can assign a single charge to an existing subscription.

","urlObject":{"path":["v1","charges",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5ecd186b51eff9228f882bb0","key":"id"}]}},"response":[{"id":"a7aab775-8f07-4ad7-a89d-a817d6191ded","name":"assign to a subscription success","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\": \"5ecd192e51eff9228f882bba\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/charges/:id","host":["{{url}}"],"path":["v1","charges",":id"],"variable":[{"key":"id","value":"5ecd186b51eff9228f882bb0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 26 May 2020 13:27:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1165"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"48d-XmBcoXwkc/iObeCCi4drkw\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"charge\",\n \"data\": {\n \"subscription_id\": \"5ecd192e51eff9228f882bba\",\n \"_id\": \"5ecd186b51eff9228f882bb0\",\n \"created_at\": \"2020-05-26T13:23:55.150Z\",\n \"updated_at\": \"2020-05-26T13:27:57.412Z\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"__v\": 0,\n \"external_id\": \"ch_0Gn2l5jQKtR4Rpd2K635oA4f\",\n \"transactions\": [\n {\n \"created_at\": \"2020-05-26T13:23:55.148Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"_id\": \"5ecd186b51eff9228f882bb1\",\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"188.191.147.164\",\n \"service_logs\": [],\n \"status\": \"complete\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": false,\n \"archived\": false,\n \"customer\": {\n \"customer_id\": \"5e4bfbd86d244b438451fbd7\",\n \"first_name\": \"First\",\n \"last_name\": \"Last\",\n \"company_name\": \"COMP-NAME\",\n \"payment_source\": {\n \"source_id\": \"5e4bfbc96d244b438451fbd6\",\n \"type\": \"card\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"expire_month\": 12,\n \"expire_year\": 2020,\n \"address_country\": \"AU\",\n \"gateway_id\": \"5cbede1f151b842653e987be\"\n }\n },\n \"capture\": true,\n \"status\": \"complete\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n }\n}"},{"id":"d1a51e82-7e92-4aa5-97e7-b5799c5369b2","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":"PayDock "},{"key":"ETag","value":"W/\"a4-kw0lZzjOmFuwqFIFZzX9GQ\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"Charge has relations with subscription\",\n \"code\": \"UnfulfilledCondition\"\n },\n \"resource\": {\n \"type\": \"charge\",\n \"data\": {}\n },\n \"error_summary\": {\n \"message\": \"Charge has relations with subscription\",\n \"code\": \"unfulfilled_condition\",\n \"details\": {\n \"messages\": []\n }\n }\n}"}],"_postman_id":"e672e6e8-99f9-4e27-8bcc-045208649fd1"},{"name":"pre-auth","id":"44c885da-2431-4679-928e-1b8221c85587","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

This 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

Flow

API request
Client SDK

Request body

field	required[flow]	type	description
amount	+	float	Amount of payment
currency	+	string (iso4217 alpha-3)	Currency code
description	-	string	Manually defined description for payments in payment systems
reference	-	string	Manually defined reference for customer in payment systems
token	+	string(UUID)	One-time token with all the payment source information
_3ds	+	object	3ds options.
_3ds.redirect_url	-	string (url)	custom redirect url for canvas3ds
_3ds.browser_details	+1	object	3ds browser options. Client SDK automatically generates this object
_3ds.browser_details.name	+	string	Browser info https://developer.mozilla.org/en-US/docs/Web/API/Navigator
_3ds.browser_details.javaEnabled	+	string (bool)	Browser info https://developer.mozilla.org/en-US/docs/Web/API/Navigator
_3ds.browser_details.language	+	string (BCP 47)	Browser info https://developer.mozilla.org/en-US/docs/Web/API/Navigator
_3ds.browser_details.timeZone	+	string (numeric)	Browser info https://developer.mozilla.org/en-US/docs/Web/API/Navigator
_3ds.browser_details.screenHeight	+	string (numeric)	Browser info https://developer.mozilla.org/en-US/docs/Web/API/Screen
_3ds.browser_details.screenWidth	+	string (numeric)	Browser info https://developer.mozilla.org/en-US/docs/Web/API/Screen
_3ds.browser_details.colorDepth	+	string (numeric)	Browser info https://developer.mozilla.org/en-US/docs/Web/API/Screen

","urlObject":{"path":["v1","charges","3ds"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"52499da6-9de3-4814-b388-198c31703dac","name":"pre-auth success with public key","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 \"amount\": \"100\",\n \"currency\": \"AUD\",\n \"token\": \"82e05cde-4467-43ec-87f4-5be18bfaf06e\",\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"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 11 Sep 2020 13:12:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2027"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"7eb-bX+6jqdx8dIs1KL91cta0w\""},{"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\": \"charge\",\n \"data\": {\n \"_3ds\": {\n \"id\": \"4c925017-5676-4a7e-afa7-710a7374591e\",\n \"token\": \"eyJjb250ZW50IjoiPGRpdiBpZD1cInJlZGlyZWN0VG8zZHMxQWNzU2ltcGxlXCIgeG1sbnM9XCJodHRwOi8vd3d3LnczLm9yZy8xOTk5L2h0bWxcIj4gPGlmcmFtZSBpZD1cInJlZGlyZWN0VG8zZHMxRnJhbWVcIiBuYW1lPVwicmVkaXJlY3RUbzNkczFGcmFtZVwiIGhlaWdodD1cIjEwMCVcIiB3aWR0aD1cIjEwMCVcIiA+IDwvaWZyYW1lPiA8Zm9ybSBpZCA9XCJyZWRpcmVjdFRvM2RzMUZvcm1cIiBtZXRob2Q9XCJQT1NUXCIgYWN0aW9uPVwiaHR0cHM6Ly9tdGYuZ2F0ZXdheS5tYXN0ZXJjYXJkLmNvbS9hY3MvVmlzYUFDUy81Nzg5ZDc4Ni1kMDAxLTQ0ODYtOTIyYy1hZThmMTFiYWMzNGRcIiB0YXJnZXQ9XCJyZWRpcmVjdFRvM2RzMUZyYW1lXCI+IDxpbnB1dCB0eXBlPVwiaGlkZGVuXCIgbmFtZT1cIlBhUmVxXCIgdmFsdWU9XCJlQUZWVWRGdWdqQVVmVGZ4SHdqWjY3Z3Q0aWJtV3VPbTIwemNkRk0vb0NtTmtFRFJBdUwrZmkzQzNOcVhudE43VG0vUHhla2xTNTJ6MUVXU3E0bExQZUk2VW9rOFN0Umg0dTUzTC9jamQ4cjZQZHpGV3NyNVZvcEtTNGJ2c2lqNFFUcEpaRFRFcnVFb0hOSkg0akxjekw3a2lXSHJ5WXlsNXlOMDBFaTFpTGtxR1hKeGVscCtzQ0FNeU5CVXRCQXpxWmR6dGxwK0VvcHdCYWg0SnRrcU9WVzVYbkVWSVRRRWlyeFNwZjVtWlBDQTBBR3NkTXJpc2p3V1k0QzZycjIwMGFWRzU0azg4M2dGQ0xZRzRkYkxwckpkRmVacmx5UmkyL01RMXJ4YWhJdHlHOWVhSE1JMGVCM1Y2MFVxSmdpMkFpTmVTdVlUbjVDUVVvY094dFFmRHdoQ3d5UFBiR2RzdHA4N2R5WWZqNWlibHNPamZXcDJMV2l5US9oTG9VbFlteEYwditvUXlzc3hWOUs0bXF4K3p3aTN6cC9mYkthaU5Pa0Yvdjl0MDIwdXJFdGlFdk1wdmRwWWdHQ2wwQTdPcE5JTTF6RC9odDd2L1FDS2M3UENcIiAvPiA8aW5wdXQgdHlwZT1cImhpZGRlblwiIG5hbWU9XCJUZXJtVXJsXCIgdmFsdWU9XCJodHRwczovL210Zi5nYXRld2F5Lm1hc3RlcmNhcmQuY29tL2NhbGxiYWNrSW50ZXJmYWNlL2dhdGV3YXkvM2EzMDExMWQyYmM5MjM4NmIyNjU1NGU3OTNlZDE1Yzc3ZjJlNGQxYWExOTMwYjc1MTYxMDNkYzAyZDUzMWQ3Y1wiIC8+IDxpbnB1dCB0eXBlPVwiaGlkZGVuXCIgbmFtZT1cIk1EXCIgdmFsdWU9XCJcIiAvPiA8L2Zvcm0+IDxzY3JpcHQgaWQ9XCJhdXRoZW50aWNhdGUtcGF5ZXItc2NyaXB0XCI+IHZhciBlPWRvY3VtZW50LmdldEVsZW1lbnRCeUlkKFwicmVkaXJlY3RUbzNkczFGb3JtXCIpOyBpZiAoZSkgeyBlLnN1Ym1pdCgpOyBpZiAoZS5wYXJlbnROb2RlICE9PSBudWxsKSB7IGUucGFyZW50Tm9kZS5yZW1vdmVDaGlsZChlKTsgfSB9IDwvc2NyaXB0PiA8L2Rpdj4iLCJmb3JtYXQiOiJodG1sIiwiY2hhcmdlXzNkc19pZCI6IjRjOTI1MDE3LTU2NzYtNGE3ZS1hZmE3LTcxMGE3Mzc0NTkxZSJ9\"\n },\n \"status\": \"pre_authentication_pending\"\n }\n }\n}"},{"id":"aa61aaa6-e9b9-4a18-8b51-64fe4165c2ef","name":"pre-auth success with secret key","originalRequest":{"method":"POST","header":[{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"},{"key":"x-user-secret-key","value":"{{secretkey}}","type":"text"}],"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}","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":"PayDock "},{"key":"ETag","value":"W/\"bb7-NYGGyzfE8FSFL9zaSLfuJw\""},{"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\": \"charge\",\n \"data\": {\n \"external_id\": \"c191ac20-86e6-4a33-867c-05947e2741bb:500837ac-3f5a-4441-99cc-a7c9dcaf042e\",\n \"__v\": 0,\n \"created_at\": \"2020-09-11T13:16:41.004Z\",\n \"updated_at\": \"2020-09-11T13:16:53.870Z\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 100,\n \"currency\": \"AUD\",\n \"_id\": \"5f5b78b9c1d6113b904dadd6\",\n \"_3ds\": {\n \"token\": \"eyJjb250ZW50IjoiPGRpdiBpZD1cInJlZGlyZWN0VG8zZHMxQWNzU2ltcGxlXCIgeG1sbnM9XCJodHRwOi8vd3d3LnczLm9yZy8xOTk5L2h0bWxcIj4gPGlmcmFtZSBpZD1cInJlZGlyZWN0VG8zZHMxRnJhbWVcIiBuYW1lPVwicmVkaXJlY3RUbzNkczFGcmFtZVwiIGhlaWdodD1cIjEwMCVcIiB3aWR0aD1cIjEwMCVcIiA+IDwvaWZyYW1lPiA8Zm9ybSBpZCA9XCJyZWRpcmVjdFRvM2RzMUZvcm1cIiBtZXRob2Q9XCJQT1NUXCIgYWN0aW9uPVwiaHR0cHM6Ly9tdGYuZ2F0ZXdheS5tYXN0ZXJjYXJkLmNvbS9hY3MvVmlzYUFDUy8yZTFiNDg0OS00OGY5LTQ1MWYtYWFmNi00MDRjMmYwYzllMDRcIiB0YXJnZXQ9XCJyZWRpcmVjdFRvM2RzMUZyYW1lXCI+IDxpbnB1dCB0eXBlPVwiaGlkZGVuXCIgbmFtZT1cIlBhUmVxXCIgdmFsdWU9XCJlQUZWVWNGdWdrQVF2WnY0RDRUMFduWVgwYWdaMTFCdFV4TTAyRW9QdlZIWUNna3Nza0MxZjk5WmtMYXlGOTdiZVc5bjNzRHlrbWZHbDFCVldzaUZ5U3hxR2tKR1Jaeks0OElNRGsvM1UzUEpod000SkVxSTlhdUlHaVU0YkVWVmhVZGhwREZxcVA3RzA1bE5iV1p5OE4wWFVYSzRlbkswdEd3Z1BVU3BpcEpRMWh6Q3FIelk3TGd6YytnWUs2NFFjcUUyYSs1dDlwUUI2UURJTUJmY1M4dW1VRjRvWXlBdEFWSFJ5RnA5Y3pxYUFPa0JOQ3JqU1YyZnFqa2g1L1BaeWxwZGhqb3JLbklyYkFnUVhRUGtyeGUvMFYxVk9Ob2xqYm0zMi92VDVEMVpmUVp2dVNzK0FwK1ZHK0Z0bStSeEFVUlhRQnpXZ3VQRWxNNFlNOWhvemlaekI2ZG9lUWh6M1JsM2c3VnhoL2xZbE9KOEhRY24vWlRiZ1RZN0lQOHB3SVFWcnFDZnFrY2dMcWRDQ25URlYzNy9nZngxdm5yV21VWTFwdWZZdDBlbjIxNW9seFFUc3hucmJEUUFvcVhrdWpoTXBWMHVNamRMSHc1K0FLSUJzK0U9XCIgLz4gPGlucHV0IHR5cGU9XCJoaWRkZW5cIiBuYW1lPVwiVGVybVVybFwiIHZhbHVlPVwiaHR0cHM6Ly9tdGYuZ2F0ZXdheS5tYXN0ZXJjYXJkLmNvbS9jYWxsYmFja0ludGVyZmFjZS9nYXRld2F5LzQzMjgwZjY4YzQ4ODA2NWIzOGY3MjVkOWY0M2I2YWY5YTQ2ZTcwMDY3ZDllOTgxMTgyZWRiNDVmN2JhMWMyZjZcIiAvPiA8aW5wdXQgdHlwZT1cImhpZGRlblwiIG5hbWU9XCJNRFwiIHZhbHVlPVwiXCIgLz4gPC9mb3JtPiA8c2NyaXB0IGlkPVwiYXV0aGVudGljYXRlLXBheWVyLXNjcmlwdFwiPiB2YXIgZT1kb2N1bWVudC5nZXRFbGVtZW50QnlJZChcInJlZGlyZWN0VG8zZHMxRm9ybVwiKTsgaWYgKGUpIHsgZS5zdWJtaXQoKTsgaWYgKGUucGFyZW50Tm9kZSAhPT0gbnVsbCkgeyBlLnBhcmVudE5vZGUucmVtb3ZlQ2hpbGQoZSk7IH0gfSA8L3NjcmlwdD4gPC9kaXY+IiwiZm9ybWF0IjoiaHRtbCIsImNoYXJnZV8zZHNfaWQiOiJhYzBmMzVjMy0yYzI0LTQwNWItYjQ1OC0zZmNlZDcxYWMzNzgifQ==\",\n \"id\": \"ac0f35c3-2c24-405b-b458-3fced71ac378\"\n },\n \"transactions\": [],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"last_name\": \"LastName\",\n \"first_name\": \"FirstName\",\n \"email\": \"{{test_email}}\",\n \"phone\": \"+12345678910\",\n \"payment_source\": {\n \"vault_token\": \"6d288634-3adc-4081-9926-ea8e15d5a9f4\",\n \"ref_token\": \"9653202562100530\",\n \"address_line1\": \"Suite 660\",\n \"address_line2\": \"822 Ruiz Square\",\n \"address_city\": \"Lake Edward\",\n \"address_postcode\": \"1234\",\n \"address_state\": \"TAS\",\n \"address_country\": \"AU\",\n \"gateway_id\": \"5ef6167d2e4a1b140f640167\",\n \"gateway_type\": \"MasterCard\",\n \"gateway_name\": \"TESTMasterCard\",\n \"card_number_last4\": \"4242\",\n \"card_name\": \"Test Test\",\n \"expire_month\": 12,\n \"expire_year\": 2021,\n \"card_scheme\": \"visa\"\n }\n },\n \"capture\": true,\n \"status\": \"pre_authentication_pending\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n }\n}"},{"id":"e0ab7ad4-2549-4438-b07e-7944b81f8feb","name":"pre-auth not_supported","originalRequest":{"method":"POST","header":[{"description":"This is your PayDock API Public Key","key":"x-user-public-key","value":"{{publickey}}"},{"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\": \"100\",\n \"currency\": \"AUD\",\n \"token\": \"6999d477-1640-4f94-9d0d-d94558b78487\",\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"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 05 Jun 2020 13:51:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"649"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"289-PlRkm4s/KvJqIBK5xFCyRQ\""},{"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\": \"charge\",\n \"data\": {\n \"external_id\": null,\n \"__v\": 0,\n \"created_at\": \"2020-06-05T13:51:05.820Z\",\n \"updated_at\": \"2020-06-05T13:51:10.693Z\",\n \"company_id\": \"580f17b15cc3e4e3199ef9a6\",\n \"amount\": 100,\n \"currency\": \"AUD\",\n \"_id\": \"5eda4dc96a8f17256bd3f7d4\",\n \"_3ds\": {\n \"token\": \"eyJjaGFyZ2VfaWQiOiI1ZWRhNGRjOTZhOGYxNzI1NmJkM2Y3ZDQifQ==\"\n },\n \"transactions\": [],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"payment_source\": {\n \"ref_token\": \"9680477382167375\",\n \"gateway_id\": \"5eda22bb37356514ddaabee7\",\n \"gateway_type\": \"MasterCard\",\n \"gateway_name\": \"MasterCard\"\n }\n },\n \"capture\": true,\n \"status\": \"authorization_not_supported\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n }\n}"}],"_postman_id":"44c885da-2431-4679-928e-1b8221c85587"},{"name":"process charge with 3DS","id":"00d032cd-9f75-4ac1-8a86-0d7d98aff207","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-user-secret-key","type":"text","value":"{{secret_key}}"}],"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 \"fraud\": {\n\t\t\"token\": \"eyJpdGVtcyI6W3sicHJvdmlkZXIiOiJBY2NlcnRpZnkiLCJ2YWx1ZSI6IlZJUlRVQUwiLCJ2ZXJzaW9uIjoibGF0ZXN0In1dfQ==\",\n\t\t\"mode\": \"active\",\n\t\t\"data\": {\n\t\t\t\"transaction\": {\n\t\t\t\t\"billing\": {\n\t\t\t\t\t\"customerEmailAddress\": \"alex.mail.perry76@gmail.com\"\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"billing\": {\n\t\t\t\t\"shippingFirstName\": \"FirstName\",\n\t\t\t\t\"shippingLastName\": \"LastName\",\n\t\t\t\t\"shippingAddress1\": \"Collins Street\",\n\t\t\t\t\"shippingAddress2\": \"\",\n\t\t\t\t\"shippingCity\": \"Melbourne\",\n\t\t\t\t\"shippingState\": \"VIC\",\n\t\t\t\t\"shippingPostcode\": \"3000\",\n\t\t\t\t\"shippingCountry\": \"AU\",\n\t\t\t\t\"shippingPhone\": \"231231\",\n\t\t\t\t\"shippingMethod\": \"N\",\n\t\t\t\t\"shippingEmail\": \"paydock@paydock.com\"\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"{{url}}/v1/charges","urlObject":{"path":["v1","charges"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f69c99be-9d89-413a-b26d-008874c53cec","name":"process charge with 3DS success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-user-secret-key","type":"text","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 \"fraud\": {\n\t\t\"token\": \"eyJpdGVtcyI6W3sicHJvdmlkZXIiOiJBY2NlcnRpZnkiLCJ2YWx1ZSI6IlZJUlRVQUwiLCJ2ZXJzaW9uIjoibGF0ZXN0In1dfQ==\",\n\t\t\"mode\": \"active\",\n\t\t\"data\": {\n\t\t\t\"transaction\": {\n\t\t\t\t\"billing\": {\n\t\t\t\t\t\"customerEmailAddress\": \"alex.mail.perry76@gmail.com\"\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"billing\": {\n\t\t\t\t\"shippingFirstName\": \"FirstName\",\n\t\t\t\t\"shippingLastName\": \"LastName\",\n\t\t\t\t\"shippingAddress1\": \"Collins Street\",\n\t\t\t\t\"shippingAddress2\": \"\",\n\t\t\t\t\"shippingCity\": \"Melbourne\",\n\t\t\t\t\"shippingState\": \"VIC\",\n\t\t\t\t\"shippingPostcode\": \"3000\",\n\t\t\t\t\"shippingCountry\": \"AU\",\n\t\t\t\t\"shippingPhone\": \"231231\",\n\t\t\t\t\"shippingMethod\": \"N\",\n\t\t\t\t\"shippingEmail\": \"paydock@paydock.com\"\n\t\t\t}\n\t\t}\n\t}\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":"PayDock "},{"key":"ETag","value":"W/\"f1d-lSwVVVr+so106ygSqz62Jw\""},{"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\": \"charge\",\n \"data\": {\n \"description\": \"some_description\",\n \"reference\": \"some_reference\",\n \"_id\": \"5f5b7d3d5d374c3c7970c19c\",\n \"created_at\": \"2020-09-11T13:35:57.911Z\",\n \"updated_at\": \"2020-09-11T13:37:49.252Z\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"__v\": 1,\n \"external_id\": \"b9631d4a-1928-4868-99ca-bb181ec86543:aa4c40d4-8cda-4806-961e-beec4b08e292\",\n \"fraud\": {\n \"mode\": \"active\",\n \"service_id\": \"5f58ed3b1f3a4238e1d73082\"\n },\n \"_3ds\": {\n \"id\": \"9d6147d9-30f5-488b-88d9-0cf47420f230\",\n \"token\": \"eyJjb250ZW50IjoiPGRpdiBpZD1cInJlZGlyZWN0VG8zZHMxQWNzU2ltcGxlXCIgeG1sbnM9XCJodHRwOi8vd3d3LnczLm9yZy8xOTk5L2h0bWxcIj4gPGlmcmFtZSBpZD1cInJlZGlyZWN0VG8zZHMxRnJhbWVcIiBuYW1lPVwicmVkaXJlY3RUbzNkczFGcmFtZVwiIGhlaWdodD1cIjEwMCVcIiB3aWR0aD1cIjEwMCVcIiA+IDwvaWZyYW1lPiA8Zm9ybSBpZCA9XCJyZWRpcmVjdFRvM2RzMUZvcm1cIiBtZXRob2Q9XCJQT1NUXCIgYWN0aW9uPVwiaHR0cHM6Ly9tdGYuZ2F0ZXdheS5tYXN0ZXJjYXJkLmNvbS9hY3MvVmlzYUFDUy80NDEzOGZhZS0xZjMyLTQwMWYtODRhMy01ZGIyN2RkODc5ZjNcIiB0YXJnZXQ9XCJyZWRpcmVjdFRvM2RzMUZyYW1lXCI+IDxpbnB1dCB0eXBlPVwiaGlkZGVuXCIgbmFtZT1cIlBhUmVxXCIgdmFsdWU9XCJlQUZWVWRGdWdqQVVmVGZ4SHdqWjY3Z3RpaE56clhFelpqbzFidFBzbVpSR3lhQm9vZFB0NjllQ3pFbGZPS2Yzbk41N0xvN09XZXA4Q1ZVa3VSeTYxQ091SXlUUDQwVHVodTUyTTczdnV5UFdidUZtcjRTWXZBdXVsV0M0RkVVUjdZU1R4RVpEN0JlRWZmOGg3TGtNMStNM2NXUjQ4V1RHMHZNUkdtaWtpdThqV1RLTStQRnh0bUxkc0VzQ1UzR0JtQWsxbTdERjdKVlFoQnFnakRMQkZzbFI1Mm9SeVJpaElwRG5XcGJxbTVGT0Q2RUJxRlhLOW1WNUtBWUFwOVBKU3l0ZGFuUWV6ek12MG9CZ2F4Q3V2YXkxN2Fvd281MlRtQ1dmaEU4MVRQMTBuc0lINzcwc3owVFA4OVZQMkI4aTJBcU1vMUl3bi9pRWhKUTZ0RFBvQklNZ1JLaDRqRExiR1J0dko4NGRKUjRoWnJ5YXdvTjlhVndER3gzQ2Z3Wk52c29zb0ptcFFTak9oMXdLNDJtUyt2dEh1UGI5OUd3VDVhWEpydXZmSHB0dGRXRmRFcE9YVDJsdFl3R0NsY0psYlNhVGFyV0d1Vmw1dS9VTE10YXpPQT09XCIgLz4gPGlucHV0IHR5cGU9XCJoaWRkZW5cIiBuYW1lPVwiVGVybVVybFwiIHZhbHVlPVwiaHR0cHM6Ly9tdGYuZ2F0ZXdheS5tYXN0ZXJjYXJkLmNvbS9jYWxsYmFja0ludGVyZmFjZS9nYXRld2F5LzBjMGE0ZmI3ZWRiZTk0ZTYwNWNjZjBiMWY2MzM0NWE1OThlNmNkNTQ5MzRmMDFmOWM5MTAzN2NiMmRjNzczOWFcIiAvPiA8aW5wdXQgdHlwZT1cImhpZGRlblwiIG5hbWU9XCJNRFwiIHZhbHVlPVwiXCIgLz4gPC9mb3JtPiA8c2NyaXB0IGlkPVwiYXV0aGVudGljYXRlLXBheWVyLXNjcmlwdFwiPiB2YXIgZT1kb2N1bWVudC5nZXRFbGVtZW50QnlJZChcInJlZGlyZWN0VG8zZHMxRm9ybVwiKTsgaWYgKGUpIHsgZS5zdWJtaXQoKTsgaWYgKGUucGFyZW50Tm9kZSAhPT0gbnVsbCkgeyBlLnBhcmVudE5vZGUucmVtb3ZlQ2hpbGQoZSk7IH0gfSA8L3NjcmlwdD4gPC9kaXY+IiwiZm9ybWF0IjoiaHRtbCIsImNoYXJnZV8zZHNfaWQiOiI5ZDYxNDdkOS0zMGY1LTQ4OGItODhkOS0wY2Y0NzQyMGYyMzAifQ==\"\n },\n \"transactions\": [\n {\n \"external_id\": \"b9631d4a-1928-4868-99ca-bb181ec86543:aa4c40d4-8cda-4806-961e-beec4b08e292\",\n \"created_at\": \"2020-09-11T13:37:45.802Z\",\n \"currency\": \"AUD\",\n \"amount\": 10,\n \"_id\": \"5f5b7da95d374c3c7970c19d\",\n \"fraud\": {\n \"score\": \"1\",\n \"specific_message\": \"5237260000001540608:liquor_More Than 1 Transaction With Same Card Number In 1 Hour:1;5237260000001540498:liquor_BIN Country Not Equal to AU:10;5237260000001540578:liquor_Transaction Total Amount Less Than 50:-10;5237260000001540899:liquor_Device Browser Service Rule - Test:0;\",\n \"specific_code\": null,\n \"status\": \"approve\"\n },\n \"status_code_description\": null,\n \"status_code\": null,\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_specific_description\": null,\n \"gateway_specific_code\": null,\n \"_source_ip_address\": \"127.0.0.1\",\n \"status\": \"complete\",\n \"type\": \"sale\"\n }\n ],\n \"one_off\": true,\n \"archived\": false,\n \"customer\": {\n \"last_name\": \"LastName\",\n \"first_name\": \"FirstName\",\n \"email\": \"test.email.sam.parry77@gmail.com\",\n \"phone\": \"+12345678910\",\n \"payment_source\": {\n \"vault_token\": \"e5e68ae1-200c-4868-8de4-dd724d190c9e\",\n \"address_line1\": \"Suite 660\",\n \"address_line2\": \"822 Ruiz Square\",\n \"address_city\": \"Lake Edward\",\n \"address_postcode\": \"1234\",\n \"address_state\": \"TAS\",\n \"address_country\": \"AU\",\n \"gateway_id\": \"5ef6167d2e4a1b140f640167\",\n \"gateway_type\": \"MasterCard\",\n \"gateway_name\": \"TESTMasterCard\",\n \"card_number_last4\": \"4242\",\n \"card_name\": \"Test Test\",\n \"expire_month\": 12,\n \"expire_year\": 2021,\n \"card_scheme\": \"visa\"\n }\n },\n \"capture\": true,\n \"status\": \"complete\",\n \"items\": [],\n \"transfer\": {\n \"items\": []\n }\n }\n }\n}"}],"_postman_id":"00d032cd-9f75-4ac1-8a86-0d7d98aff207"}],"id":"17d50475-4ff6-48f0-8e0c-69b642d83ea7","description":"

A Charge is a one-time payment that can be requested against any connected processing service.

Charges can be created through 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.

A One-Time-Token (returned as part of a checkout flow)
\n
A Customer (Customer's default Payment Source will be used)
\n
A Payment Source (Belonging to a Customer)
\n
A Transfer (When used as part of Paydock's Transfer/remittance API).
\n
A Vault Token (Directly charging a payment instrument stored in the Paydock Vault independent of any Customer)
\n

Charge Resource

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required[flow]	type	description
amount	+	float	Amount of payment
currency	+	string (iso4217 alpha-3)	Currency code
description	-	string	Manually defined description for payments in payment systems
reference	-	string	Manually defined reference for customer in payment systems
_id	+	string (24 byte hex)	Charge Id for any future requests
external_id	+	string	External id of transaction
created_at	+	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Charge creation date
updated_at	+	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Date of last charge update
user_id	-	string (24 byte hex)	id of an initiator of the request if the request was by the personal token (from the dashboard)
status	+	string	Actual charge status. See the status table
capture	+	bool	Automatically capture or only authorize
one_off	+	bool	For manual charges always true for subscription always false
archived	+	bool	For new created charges always false, true after manual archiving
_source_ip_address	+	string	Client ip address, for subscription by default 127.0.0.1
subscription_id	+4	string (24 byte hex)	Subscription ID
customer	+	object	Object with the customer’s information.
customer.customer_id	+3	string (24 byte hex)	Customer ID
customer.first_name	-	string	Customer first name
customer.last_name	-	string	Customer last name
customer.email	-	string	Customer email
customer.phone	-	string(E.164)	Customer phone in E.164 international notation (Example: +12345678901)
customer.payment_source	+	object	Object with payment information
customer.payment_source.source_id	+3, -4	string (24 byte hex)	Payment source ID
customer.payment_source.gateway_id	+	string (24 byte hex)	Gateway id
customer.payment_source.gateway_type	+	string	Type of gateway
customer.payment_source.gateway_name	+	string	Custom name of of gateway
customer.payment_source.type	+	string	Type of payment. card for payment with credit card, bank_account for direct debit payments
customer.payment_source.card_name	+1	string	Cardholder name (as on card)
customer.payment_source.card_number_last4	+1	string(numeric)	Card number last 4
customer.payment_source.card_scheme	+1	string	Cardholder scheme (i.g. visa, mastercard etc...)
customer.payment_source.expire_month	+1	string(mm)	Card expiration month mm
customer.payment_source.expire_year	+1	string(yyyy)	Card expiration year
customer.payment_source.account_name	+2	string	Customer account name.
customer.payment_source.account_number	+2	string	Number of Customer account.
customer.payment_source.account_bsb	-2	string	Customer bank state branch number.
customer.payment_source.account_routing	-2	string(numeric)	Number of Customer account. BSB/Routing/SWIFT/IBAN Number.
customer.payment_source.account_holder_type	-2	string	account type (personal or business)
customer.payment_source.account_bank_name	-2	string	Name of account bank
customer.payment_source.address_line1	-	string	Customer Address, line 1
customer.payment_source.address_line2	-	string	Customer Address, line 2
customer.payment_source.address_state	-	string	Customer Address, State
customer.payment_source.address_country	-	string	Customer Address, Country Code
customer.payment_source.address_city	-	string	Customer Address, City
customer.payment_source.address_postcode	-	string(numeric)	Customer Address, Postcade
transactions	+	array	all transactions within the within the one charge
transactions[]._id	+	string (24 byte hex)	inernal id of transaction
transactions[].amount	+	float	Amount of transaction
transactions[].currency	+	string (iso4217 alpha-3)	Currency code
transactions[].type	+	string	type of transaction: Look at transaction types table
transactions[].status	+	string	status of transaction: Look at transaction status table
transactions[].created_at	+	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Transaction creation date
transactions[].gateway_specific_code	+6	string	Error code on gateway side
transactions[].gateway_specific_description	+6	string	Internal or external error message
transactions[].error_message	+6, +9	string	Internal error message
transactions[].error_code	+6, +9	string	internal error code
transactions[].fraud	+9	object, optional	Fraud payload
transactions[].fraud.status	+9	string	Status after fraud verification: Look at Fraud status table
transactions[].fraud.specific_code	+9	string	Fraud specific code
transactions[].fraud.specific_message	+9	string	Fraud specific message
transactions[].fraud.score	+9	string	Fraud score
meta	-	object	Optional object with specific fields for different gateways
meta.stripe_direct_account_id	-	string	ID of an existing, connected stripe account. Use to create Stripe connect Direct Charges
meta.stripe_application_fee	-	string	A fee in cents that will be applied to the charge and transferred to the application owner’s Stripe account
meta.stripe_destination_account_id	-	string	ID of an existing, connected stripe account. Use to create Stripe connect Destination Charges
meta.stripe_destination_amount	-	string	The amount to transfer to the destination account without creating an Application Fee
meta.securepay_fraud_guard	-	bool	applies only for Secure Pay, enables SecurePay fraud guard for this transaction
meta.ip_address	-	string	applies only for Secure Pay, pass through the client IP for fraud validation
meta.customer_storage_number	-	string	Bambora gateway only. This value dictates which account the card details will be stored against
meta.tokenise_algorithm	-	number	Bambora alorithm Id for creating charges. (Default - 8, if not specified.)
transfer	-5	object	Object, optional
transfer.stripe_transfer_group	-	string	transfer group Id (specific field for Stripe)
transfer.items	+	array	items
transfer.items[].amount	+	float	Amount of a transfer
transfer.items[].currency	+	string (iso4217 alpha-3)	Currency of a transfer
transfer.items[].destination	+	string	transfer destination (e.g. stripe destination account Id)
_3ds	+7, +8	object	3ds payload
_3ds.token	+	string	token for client-sdk(Canvas3ds)
fraud	+9	Object	Fraud payload
fraud.service_id	+9	string (24 byte hex)	id of fraud service
fraud.mode	+9	string	fraud service mode: look at Fraud mode table

Status

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status	description
complete	success
pending	The charge wait for capture or cancel
requested	A change was requested, but the gateway did not return the actual status (it is usually relevant for bank account transactions). The status will be updated later automatically by schedule task
failed	The charge was failed (see details of an error)
refund_requested	A refund was requested, but the gateway did not return the actual status (it is usually need some time). The status will be updated later automatically by schedule task or by manual by the specific endpoint
void_requested	A void was requested, but the connected service did not return the actual status. The status will be monitored by Paydock until a result is returned. Can also be manually checked.
refund_void_requested	A refund void was requested, but the connected service did not return the actual status. The status will be monitored by Paydock until a result is returned. Can also be manually checked.
refunded	success refund
inprogress	Intermediate status short-lived
held	Type of charges created by subscriptions with status held
archived	Charge is archived
not_authenticated	Pre-auth (3ds) not supported for such card
pre_authenticated	Pre-auth (3ds) created successfully and accepted by user
pre_authentication_pending	Pre-auth (3ds) created successfully and waiting for accepting by user
inreview	Fraud service requested review and fraud mode is active
declined	Charge was declined after inreview status
cancelled	Charge was cancelled

Transaction types

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

type	description
sale	Payment transaction
refund	Refund transaction
transfer	Transfer transaction

Transaction status

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status	description
complete	complete direct or captured transaction
failed	failed transaction or refund
inprogress	system state of a transaction while its sending request to a payment gateway
pending	authorized, but not captured transaction
requested	refund pending status. After an automatic scheduled transaction check, it might go to a complete of failed.
cancelled	cancelled transaction
declined	declined auth transaction
approved	approved following optional fraud workflow
review	review following optional fraud workflow
rejected	rejected following optional fraud workflow

Fraud status

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status	description
approve	Fraud service approve transaction
failed	Fraud service verification failed
review	Fraud service need additional verification
reject	Fraud service reject transaction

Fraud mode

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

mode	description
active	Paydock will block charges based on fraud service responses
passive	Paydock will not affect Charge processing. Charge may be rejected for other reasons however the fraud service will not interfere directly

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"93f63951-7056-44b1-aca2-4b6bd69179e6"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"01ae78c4-eb1c-4c76-bf7c-67394105cd73"}}],"_postman_id":"17d50475-4ff6-48f0-8e0c-69b642d83ea7"},{"name":"customers","item":[{"name":"create","id":"5e599ece-63aa-496f-be6b-52bf97f19008","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\": \"Samantha\",\n \"payment_source\": {\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_name\": \"Samantha Washington\",\n \"card_number\": \"4242424242424242\",\n \"expire_month\": \"09\",\n \"expire_year\": \"21\",\n \"card_ccv\": \"123\"\n }\n}"},"url":"{{url}}/v1/customers","description":"

Flow

You can create a customer using:

Created with credit card payment source
Created with the bank account payment source
Create with one-time token
Create with vault token

Request body

field	required[flow]	type	description
token	+3	string(UIID)	One-time token with all the payment source information
reference	-	string	Manually defined reference for customer in payment systems
description	-	string	Customer description. This is customer internal description
company_name	-	string	Customer company name
first_name	-	string	Customer first name
last_name	-	string	Customer last name
email	-	string	Customer email
phone	-	string(E.164)	Customer phone in E.164 international notation (Example: +12345678901)
default_source	+	string (24 byte hex)	Payment source used by default
payment_source	+	object	Object with payment information
payment_source.gateway_id	+	string (24 byte hex)	Gateway id
payment_source.vault_token	+4	string (UIID)	Vault token
payment_source.type	+2	string	Type of payment. card for payment with credit card, bank_account for direct debit payments
payment_source.card_name	+1	string	Cardholder name (as on card)
payment_source.card_number	+1	string(numeric)	Card number
payment_source.expire_month	+1	string(mm)	Card expiration month mm
payment_source.expire_year	+1	string(yyyy)	Card expiration year
payment_source.card_ccv	-1	string(numeric)	Card CCV number
payment_source.account_name	+2	string	Customer account name.
payment_source.account_number	+2	string	Number of Customer account.
payment_source.account_bsb	-2	string	Customer bank state branch number.
payment_source.account_routing	-2	string(numeric)	Number of Customer account. BSB/Routing/SWIFT/IBAN Number.
payment_source.account_holder_type	-2	string	account type (personal or business)
payment_source.account_bank_name	-2	string	Name of account bank
payment_source.address_line1	-	string	Customer Address, line 1
payment_source.address_line2	-	string	Customer Address, line 2
payment_source.address_state	-	string	Customer Address, State
payment_source.address_country	-	string	Customer Address, Country Code
payment_source.address_city	-	string	Customer Address, City
payment_source.address_postcode	-	string(numeric)	Customer Address, Postcade
payment_source.meta.customer_storage_number	-	string	Identification of a customer on a gateway side for future payments binding (used by Bambora gateway)
payment_source.meta.tokenise_algorithm	-	number	Bambora alorithm Id for creating customers. (Default -2, if not specified.)
meta.user_id	-	string	existing user on payment system side (used by Assembly payments). Paydock matches customer on Assembly payments by this id, and adds new payment source
payment_destination	-	object	@TODO

","urlObject":{"path":["v1","customers"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"2dc71569-f04f-4681-a244-31e298aa24a5","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":"PayDock "},{"key":"ETag","value":"W/\"82-p6MwaBpbSc0MNJlpay9Khw\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"Token Not found\",\n \"details\": [\n \"No Tokens found with provided id\"\n ]\n },\n \"resource\": {\n \"type\": \"customer\"\n },\n \"error_summary\": {\n \"message\": \"Token Not found\",\n \"code\": \"unspecified_error\",\n \"details\": {\n \"messages\": [\n \"No Tokens found with provided id\"\n ]\n }\n }\n}"},{"id":"385f1c2d-b829-4b43-ba8e-24a9b33cb622","name":"create with one-time 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\t\"token\": \"d11ed1d6-f22f-4035-a61f-a576a83e1d88\"\n}"},"url":"{{url}}/v1/customers"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 May 2020 12:11:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"800"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"320-2kYSX4ZwCGzVaw3tAOO+fw\""},{"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\": \"customer\",\n \"data\": {\n \"__v\": 0,\n \"created_at\": \"2020-05-27T12:11:13.634Z\",\n \"updated_at\": \"2020-05-27T12:11:13.634Z\",\n \"default_source\": \"5ece58d4aab8f8579dc10ddc\",\n \"_id\": \"5ece58e1aab8f8579dc10ddd\",\n \"payment_destinations\": [],\n \"payment_sources\": [\n {\n \"_id\": \"5ece58d4aab8f8579dc10ddc\",\n \"updated_at\": \"2020-05-27T12:11:13.633Z\",\n \"vault_token\": \"c7704378-2092-49b3-b362-9e4a8fa4c249\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_name\": \"First_Name Last_Name\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"cus_HM6IU9TqcV9qTm\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-27T12:11:00.643Z\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"type\": \"card\"\n }\n ],\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n },\n \"_service\": {\n \"default_gateway_id\": \"5cbede1f151b842653e987be\"\n }\n }\n }\n}"},{"id":"92bec877-3819-4187-aa2e-f322952b5241","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 \"payment_source\": {\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"vault_token\": \"0fd20631-509e-45c7-a8f0-f1f36d6ad298\"\n }\n}"},"url":"{{url}}/v1/customers"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 May 2020 12:15:25 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"818"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"332-od/QT8c4C0zMMoaTqzx6GA\""},{"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\": \"customer\",\n \"data\": {\n \"__v\": 0,\n \"created_at\": \"2020-05-27T12:15:25.738Z\",\n \"updated_at\": \"2020-05-27T12:15:25.738Z\",\n \"status\": \"active\",\n \"default_source\": \"5ece59dd9c49c657d60630ee\",\n \"_id\": \"5ece59dc9c49c657d60630ed\",\n \"payment_destinations\": [],\n \"payment_sources\": [\n {\n \"updated_at\": \"2020-05-27T12:15:25.737Z\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"vault_token\": \"0fd20631-509e-45c7-a8f0-f1f36d6ad298\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"cus_HM6N4T0hv9klsg\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-27T12:15:25.728Z\",\n \"_id\": \"5ece59dd9c49c657d60630ee\",\n \"type\": \"card\"\n }\n ],\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n },\n \"_service\": {\n \"default_gateway_id\": \"5cbede1f151b842653e987be\"\n }\n }\n }\n}"},{"id":"b93132a2-cbf6-4a50-b142-7911f1d4be19","name":"create with bank account","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 \"first_name\": \"First_Name\",\n \"payment_source\": {\n \"gateway_id\": \"5d1df20be205944082f778b8\",\n \"type\": \"bank_account\",\n \"account_name\": \"test test\",\n \"account_number\": \"064000\",\n \"account_routing\": \"064000\"\n }\n}"},"url":"{{url}}/v1/customers"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 May 2020 12:05:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"842"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"34a-AGQRzaQ/P4M4Vr1jsyYVYw\""},{"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\": \"customer\",\n \"data\": {\n \"__v\": 0,\n \"created_at\": \"2020-05-27T12:05:08.157Z\",\n \"updated_at\": \"2020-05-27T12:05:08.157Z\",\n \"status\": \"active\",\n \"default_source\": \"5ece57740654e0578ddf9c37\",\n \"first_name\": \"Samantha\",\n \"_id\": \"5ece57720654e0578ddf9c36\",\n \"payment_destinations\": [],\n \"payment_sources\": [\n {\n \"updated_at\": \"2020-05-27T12:05:08.157Z\",\n \"vault_token\": \"a065da69-0018-40d5-857a-9ddd65b26a66\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"cus_HM6C9I0rgswgTg\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-27T12:05:08.100Z\",\n \"_id\": \"5ece57740654e0578ddf9c37\",\n \"type\": \"card\"\n }\n ],\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n },\n \"_service\": {\n \"default_gateway_id\": \"5cbede1f151b842653e987be\"\n }\n }\n }\n}"},{"id":"d784c218-6968-48ed-aa3c-2a1165884ad0","name":"create with gateway 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 \"card_name\": \"First_Name Last_Name\",\n \"card_number\": \"4242424242424241\",\n \"expire_month\": \"09\",\n \"expire_year\": \"21\",\n \"card_ccv\": \"123\"\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:24:25 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"464"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"1d0-TsaoXPJr6bjWkr1PELbRGQ\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"body validation failed\",\n \"code\": \"ValidationError\",\n \"details\": {\n \"path\": \"first_name\",\n \"messages\": [\n \"first_name should not be empty\",\n \"first_name must be a string\"\n ]\n }\n },\n \"resource\": {\n \"type\": \"customer\",\n \"data\": {\n \"_id\": \"5f0c0f879c63b80a26e5eca8\",\n \"payment_destinations\": [],\n \"payment_sources\": [],\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n }\n }\n },\n \"error_summary\": {\n \"message\": \"body validation failed\",\n \"code\": \"validation_error\",\n \"details\": {\n \"path\": \"first_name\",\n \"messages\": [\n \"first_name should not be empty\",\n \"first_name must be a string\"\n ]\n }\n }\n}"},{"id":"d9333548-3001-402c-a1ff-9c8264c2c477","name":"create with credit card","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 \"first_name\": \"First_Name\",\n \"payment_source\": {\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_name\": \"First_Name Last_Name\",\n \"card_number\": \"4242424242424242\",\n \"expire_month\": \"09\",\n \"expire_year\": \"21\",\n \"card_ccv\": \"123\"\n }\n}"},"url":"{{url}}/v1/customers"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 May 2020 12:05:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"842"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"34a-AGQRzaQ/P4M4Vr1jsyYVYw\""},{"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\": \"customer\",\n \"data\": {\n \"__v\": 0,\n \"created_at\": \"2020-05-27T12:05:08.157Z\",\n \"updated_at\": \"2020-05-27T12:05:08.157Z\",\n \"status\": \"active\",\n \"default_source\": \"5ece57740654e0578ddf9c37\",\n \"first_name\": \"Samantha\",\n \"_id\": \"5ece57720654e0578ddf9c36\",\n \"payment_destinations\": [],\n \"payment_sources\": [\n {\n \"updated_at\": \"2020-05-27T12:05:08.157Z\",\n \"vault_token\": \"a065da69-0018-40d5-857a-9ddd65b26a66\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"cus_HM6C9I0rgswgTg\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-27T12:05:08.100Z\",\n \"_id\": \"5ece57740654e0578ddf9c37\",\n \"type\": \"card\"\n }\n ],\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n },\n \"_service\": {\n \"default_gateway_id\": \"5cbede1f151b842653e987be\"\n }\n }\n }\n}"}],"_postman_id":"5e599ece-63aa-496f-be6b-52bf97f19008"},{"name":"search","id":"95b95127-dfe3-4407-8c75-2712fb9e47d0","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/customers","description":"

Returns all charges for the account

Request query params

Pagination

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required[flow]	type	description
skip	-	number	Pagination parameter to skip first n customers from list, default = 0
limit	-	number	Pagination parameter to limit output to n , default = 100 , maximum value = 1000
sortkey	-	string	Sorting key parameter i.e. created_at
sortdirection	-	string	Sorting order direction parameter ASC or DESC (DESC by default)

filters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
gateway_id	-	string (24 byte hex)	ID of a gateway with which charges were created
payment_source_id	-	string (24 byte hex)	ID of a stored customers payment_source
status	-	string	See Status table
archived	-	bool	Set to true to show all the archived charges. Default: false
reference	-	string	reference
company_name	-	string	Company name
id	-	string (24 byte hex)	ID of particular customer

Other

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
search	-	string	Word of phrase Customer want to search in created charges (search works by fields: first_name, last_name, email, company_name)

","urlObject":{"path":["v1","customers"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"2e38b443-3f1a-4cff-a938-5e1d0d4554a7","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":"PayDock "},{"key":"ETag","value":"W/\"781-ukF9G4wqKD5tCgG8baOUAA\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"customers\",\n \"data\": [\n {\n \"_id\": \"5ece59dc9c49c657d60630ed\",\n \"created_at\": \"2020-05-27T12:15:25.738Z\",\n \"updated_at\": \"2020-05-27T12:15:25.738Z\",\n \"status\": \"active\",\n \"default_source\": \"5ece59dd9c49c657d60630ee\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"payment_destinations\": [],\n \"payment_sources\": [\n {\n \"updated_at\": \"2020-05-27T12:15:25.737Z\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"vault_token\": \"0fd20631-509e-45c7-a8f0-f1f36d6ad298\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"cus_HM6N4T0hv9klsg\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-27T12:15:25.728Z\",\n \"_id\": \"5ece59dd9c49c657d60630ee\",\n \"type\": \"card\"\n }\n ],\n \"archived\": false,\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n }\n },\n {\n \"_id\": \"5ece58e1aab8f8579dc10ddd\",\n \"created_at\": \"2020-05-27T12:11:13.634Z\",\n \"updated_at\": \"2020-05-27T12:11:13.634Z\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"default_source\": \"5ece58d4aab8f8579dc10ddc\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"payment_destinations\": [],\n \"payment_sources\": [\n {\n \"_id\": \"5ece58d4aab8f8579dc10ddc\",\n \"updated_at\": \"2020-05-27T12:11:13.633Z\",\n \"vault_token\": \"c7704378-2092-49b3-b362-9e4a8fa4c249\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_name\": \"First_Name Last_Name\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"cus_HM6IU9TqcV9qTm\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-27T12:11:00.643Z\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"type\": \"card\"\n }\n ],\n \"archived\": false,\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n }\n }\n ],\n \"query_token\": \"{{vault:json-web-token}}\",\n \"count\": 5,\n \"limit\": 100,\n \"skip\": 0\n }\n}"},{"id":"83d24030-a62a-4138-aa71-e54859299f2e","name":"search by phrase","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?search=Samantha","host":["{{url}}"],"path":["v1","customers"],"query":[{"key":"search","value":"Samantha"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 May 2020 12:26:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1119"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"45f-pAL3IEthGavTs+3AYEHTdQ\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"customers\",\n \"data\": [\n {\n \"_id\": \"5ece57720654e0578ddf9c36\",\n \"created_at\": \"2020-05-27T12:05:08.157Z\",\n \"updated_at\": \"2020-05-27T12:05:08.157Z\",\n \"status\": \"active\",\n \"default_source\": \"5ece57740654e0578ddf9c37\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"first_name\": \"First_Name\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"payment_destinations\": [],\n \"payment_sources\": [\n {\n \"updated_at\": \"2020-05-27T12:05:08.157Z\",\n \"vault_token\": \"a065da69-0018-40d5-857a-9ddd65b26a66\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"cus_HM6C9I0rgswgTg\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-27T12:05:08.100Z\",\n \"_id\": \"5ece57740654e0578ddf9c37\",\n \"type\": \"card\"\n }\n ],\n \"archived\": false,\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n }\n }\n ],\n \"query_token\": \"{{vault:json-web-token}}\",\n \"count\": 1,\n \"limit\": 100,\n \"skip\": 0\n }\n}"},{"id":"a9233458-d98d-436e-a271-105fffd102ae","name":"search with pagination and sort","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?limit=2&skip=1&sortkey=updated_at&sortdirection=DESC","host":["{{url}}"],"path":["v1","customers"],"query":[{"key":"limit","value":"2"},{"key":"skip","value":"1"},{"key":"sortkey","value":"updated_at"},{"key":"sortdirection","value":"DESC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 May 2020 12:27:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1951"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"79f-mquUoR+VOrWHWJj9NXtgSg\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"customers\",\n \"data\": [\n {\n \"_id\": \"5ece58e1aab8f8579dc10ddd\",\n \"created_at\": \"2020-05-27T12:11:13.634Z\",\n \"updated_at\": \"2020-05-27T12:11:13.634Z\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"default_source\": \"5ece58d4aab8f8579dc10ddc\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"payment_destinations\": [],\n \"payment_sources\": [\n {\n \"_id\": \"5ece58d4aab8f8579dc10ddc\",\n \"updated_at\": \"2020-05-27T12:11:13.633Z\",\n \"vault_token\": \"c7704378-2092-49b3-b362-9e4a8fa4c249\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_name\": \"First_Name Last_Name\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"cus_HM6IU9TqcV9qTm\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-27T12:11:00.643Z\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"type\": \"card\"\n }\n ],\n \"archived\": false,\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n }\n },\n {\n \"_id\": \"5ece57720654e0578ddf9c36\",\n \"created_at\": \"2020-05-27T12:05:08.157Z\",\n \"updated_at\": \"2020-05-27T12:05:08.157Z\",\n \"status\": \"active\",\n \"default_source\": \"5ece57740654e0578ddf9c37\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"first_name\": \"First_Name\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"payment_destinations\": [],\n \"payment_sources\": [\n {\n \"updated_at\": \"2020-05-27T12:05:08.157Z\",\n \"vault_token\": \"a065da69-0018-40d5-857a-9ddd65b26a66\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"cus_HM6C9I0rgswgTg\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-27T12:05:08.100Z\",\n \"_id\": \"5ece57740654e0578ddf9c37\",\n \"type\": \"card\"\n }\n ],\n \"archived\": false,\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n }\n }\n ],\n \"query_token\": \"{{vault:json-web-token}}\",\n \"count\": 7,\n \"limit\": 2,\n \"skip\": 1\n }\n}"}],"_postman_id":"95b95127-dfe3-4407-8c75-2712fb9e47d0"},{"name":"get","id":"6d0d8e49-be79-496e-aa98-85dd8b81e31a","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/customers/:id","description":"

Retrieves data on the customer with specified ID.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

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\"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.

Flow

You can:

Add a new payment source with credit card
Add a new payment source with bank account
Add a new payment source with one-time token
Add a new payment source with vault token
Set default source. By default default source always equal a new added payment source

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required[flow]	type	description
token	+3	string(UIID)	One-time token with all the payment source information
reference	-	string	Manually defined reference for customer in payment systems
description	-	string	Customer description. This is customer internal description
company_name	-	string	Customer company name
first_name	-	string	Customer first name
last_name	-	string	Customer last name
email	-	string	Customer email
phone	-	string(E.164)	Customer phone in E.164 international notation (Example: +12345678901)
default_source	+6	string (24 byte hex)	Payment source used by default
payment_source	+2, +3, +4	object	See create customer
payment_destination	-	object	@TODO

","urlObject":{"path":["v1","customers",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5ece59dc9c49c657d60630ed","key":"id"}]}},"response":[{"id":"860dec8f-d027-4048-902a-a46449264b99","name":"modify success","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\"first_name\": \"test\"\n}"},"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:35:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"838"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"346-IlIOatbgUVoOHpBTZFeF8w\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"customer\",\n \"data\": {\n \"first_name\": \"test\",\n \"_id\": \"5ece59dc9c49c657d60630ed\",\n \"created_at\": \"2020-05-27T12:15:25.738Z\",\n \"updated_at\": \"2020-05-27T12:35:18.111Z\",\n \"status\": \"active\",\n \"default_source\": \"5ece59dd9c49c657d60630ee\",\n \"__v\": 0,\n \"payment_destinations\": [],\n \"payment_sources\": [\n {\n \"updated_at\": \"2020-05-27T12:35:18.110Z\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"vault_token\": \"0fd20631-509e-45c7-a8f0-f1f36d6ad298\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"cus_HM6N4T0hv9klsg\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-27T12:15:25.728Z\",\n \"_id\": \"5ece59dd9c49c657d60630ee\",\n \"type\": \"card\"\n }\n ],\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n },\n \"_service\": {\n \"default_gateway_id\": \"5cbede1f151b842653e987be\"\n }\n }\n }\n}"},{"id":"a21d3176-4d5f-4690-9f12-fa3ccf012e39","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}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"payment_source\": {\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_name\": \"First_Name Last_Name\",\n \"card_number\": \"4242424242424242\",\n \"expire_month\": \"09\",\n \"expire_year\": \"21\",\n \"card_ccv\": \"123\"\n }\n}"},"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":"PayDock "},{"key":"ETag","value":"W/\"4cd-JsNMONXrrFinS0URBSRQ3Q\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"customer\",\n \"data\": {\n \"_id\": \"5ece59dc9c49c657d60630ed\",\n \"created_at\": \"2020-05-27T12:15:25.738Z\",\n \"updated_at\": \"2020-05-27T12:36:34.714Z\",\n \"status\": \"active\",\n \"default_source\": \"5ece5ed2bf87e8587723dd46\",\n \"__v\": 1,\n \"first_name\": \"test\",\n \"payment_destinations\": [],\n \"payment_sources\": [\n {\n \"updated_at\": \"2020-05-27T12:36:34.714Z\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"vault_token\": \"0fd20631-509e-45c7-a8f0-f1f36d6ad298\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"cus_HM6N4T0hv9klsg\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-27T12:15:25.728Z\",\n \"_id\": \"5ece59dd9c49c657d60630ee\",\n \"type\": \"card\"\n },\n {\n \"updated_at\": \"2020-05-27T12:36:34.714Z\",\n \"vault_token\": \"eb94cf5a-a2b0-46a5-b433-ffa5e736b6a7\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"cus_HM6ipTRBOq6TE4\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-27T12:36:34.653Z\",\n \"_id\": \"5ece5ed2bf87e8587723dd46\",\n \"type\": \"card\"\n }\n ],\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n },\n \"_service\": {\n \"default_gateway_id\": \"5cbede1f151b842653e987be\"\n }\n }\n }\n}"},{"id":"f31a7252-8c03-48d9-9e0b-478a3a6b7ea2","name":"add a new payment source and keep old one by default","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\"default_source\": \"5ece5ed2bf87e8587723dd46\",\n\t\"payment_source\": {\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_name\": \"First_Name Last_Name\",\n \"card_number\": \"4242424242424242\",\n \"expire_month\": \"09\",\n \"expire_year\": \"21\",\n \"card_ccv\": \"123\"\n }\n}"},"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:39:25 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1620"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"654-h/zVhrT1VzzzO0KMkvLuoQ\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"customer\",\n \"data\": {\n \"_id\": \"5ece59dc9c49c657d60630ed\",\n \"created_at\": \"2020-05-27T12:15:25.738Z\",\n \"updated_at\": \"2020-05-27T12:39:25.763Z\",\n \"status\": \"active\",\n \"default_source\": \"5ece5ed2bf87e8587723dd46\",\n \"__v\": 2,\n \"first_name\": \"test\",\n \"payment_destinations\": [],\n \"payment_sources\": [\n {\n \"updated_at\": \"2020-05-27T12:39:25.763Z\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"vault_token\": \"0fd20631-509e-45c7-a8f0-f1f36d6ad298\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"cus_HM6N4T0hv9klsg\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-27T12:15:25.728Z\",\n \"_id\": \"5ece59dd9c49c657d60630ee\",\n \"type\": \"card\"\n },\n {\n \"updated_at\": \"2020-05-27T12:39:25.763Z\",\n \"vault_token\": \"eb94cf5a-a2b0-46a5-b433-ffa5e736b6a7\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"cus_HM6ipTRBOq6TE4\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-27T12:36:34.653Z\",\n \"_id\": \"5ece5ed2bf87e8587723dd46\",\n \"type\": \"card\"\n },\n {\n \"updated_at\": \"2020-05-27T12:39:25.763Z\",\n \"vault_token\": \"8549cac2-c4bb-432a-b4db-63e6614ac46c\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"cus_HM6l3Ump2rDgcs\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-27T12:39:25.731Z\",\n \"_id\": \"5ece5f7dbf87e8587723dd49\",\n \"type\": \"card\"\n }\n ],\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n },\n \"_service\": {\n \"default_gateway_id\": \"5cbede1f151b842653e987be\"\n }\n }\n }\n}"}],"_postman_id":"cf4fc503-36c7-457a-8dff-505a6c52e7b8"},{"name":"archive","id":"615fe40d-7f4c-4765-97c2-b12da57c5f22","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":""},"url":"{{url}}/v1/customers/:id","description":"

Customer with specified id will be archived. You can retrieve archived customers using

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","customers",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5ece6a89ce7ad559e487cec0","key":"id"}]}},"response":[{"id":"a38164ea-ab2c-476c-9cd1-391247cdaa5c","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":"PayDock "},{"key":"ETag","value":"W/\"34a-p68U6cHJfTte/8Aul8SnJg\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"customer\",\n \"data\": {\n \"_id\": \"5ece6a89ce7ad559e487cec0\",\n \"created_at\": \"2020-05-27T13:26:34.738Z\",\n \"updated_at\": \"2020-05-27T13:27:18.357Z\",\n \"status\": \"active\",\n \"default_source\": \"5ece6a8ace7ad559e487cec1\",\n \"first_name\": \"First_Name\",\n \"__v\": 0,\n \"payment_destinations\": [],\n \"payment_sources\": [\n {\n \"updated_at\": \"2020-05-27T13:27:18.357Z\",\n \"vault_token\": \"6628fc11-5140-473c-9850-9ae9682e8ecc\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"cus_HM7W8zjx0qkAMh\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-27T13:26:34.707Z\",\n \"_id\": \"5ece6a8ace7ad559e487cec1\",\n \"type\": \"card\"\n }\n ],\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n },\n \"_service\": {\n \"default_gateway_id\": \"5cbede1f151b842653e987be\"\n }\n }\n }\n}"},{"id":"ba828548-dc19-4178-b44c-704bcc33c273","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":"PayDock "},{"key":"ETag","value":"W/\"781-ukF9G4wqKD5tCgG8baOUAA\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"customers\",\n \"data\": [\n {\n \"_id\": \"5ece59dc9c49c657d60630ed\",\n \"created_at\": \"2020-05-27T12:15:25.738Z\",\n \"updated_at\": \"2020-05-27T12:15:25.738Z\",\n \"status\": \"active\",\n \"default_source\": \"5ece59dd9c49c657d60630ee\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"payment_destinations\": [],\n \"payment_sources\": [\n {\n \"updated_at\": \"2020-05-27T12:15:25.737Z\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"vault_token\": \"0fd20631-509e-45c7-a8f0-f1f36d6ad298\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"cus_HM6N4T0hv9klsg\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-27T12:15:25.728Z\",\n \"_id\": \"5ece59dd9c49c657d60630ee\",\n \"type\": \"card\"\n }\n ],\n \"archived\": false,\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n }\n },\n {\n \"_id\": \"5ece58e1aab8f8579dc10ddd\",\n \"created_at\": \"2020-05-27T12:11:13.634Z\",\n \"updated_at\": \"2020-05-27T12:11:13.634Z\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"default_source\": \"5ece58d4aab8f8579dc10ddc\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"payment_destinations\": [],\n \"payment_sources\": [\n {\n \"_id\": \"5ece58d4aab8f8579dc10ddc\",\n \"updated_at\": \"2020-05-27T12:11:13.633Z\",\n \"vault_token\": \"c7704378-2092-49b3-b362-9e4a8fa4c249\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_name\": \"First_Name Last_Name\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"cus_HM6IU9TqcV9qTm\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-27T12:11:00.643Z\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"type\": \"card\"\n }\n ],\n \"archived\": false,\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n }\n }\n ],\n \"query_token\": \"{{vault:json-web-token}}\",\n \"count\": 5,\n \"limit\": 2,\n \"skip\": 0\n }\n}"}],"_postman_id":"615fe40d-7f4c-4765-97c2-b12da57c5f22"},{"name":"get payment sources","id":"5fc6fbf8-ddb6-4e5c-8d4b-7b03601c7bae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

This 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?query_token={{vault:json-web-token}}","description":"

Get payment sources of customers by query_token generated from seach with params endpoint

Request query

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
query_token	+	string (JWT token)	query_token received at the search stage

Response body

Collection of payment sources (see payment_sources[])

\n","urlObject":{"path":["v1","customers"],"host":["{{url}}"],"query":[{"key":"query_token","value":"{{vault:json-web-token}}"}],"variable":[]}},"response":[{"id":"3b1eb4ac-e137-467a-91d2-2236ad01c93d","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={{vault:json-web-token}}","host":["{{url}}"],"path":["v1","customers","payment_sources"],"query":[{"key":"query_token","value":"{{vault:json-web-token}}"}]}},"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":"PayDock "},{"key":"ETag","value":"W/\"2ae-Zl0VMeMHW+X7lZZC0TeubA\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"payment_sources\",\n \"data\": [\n {\n \"_id\": \"5ece59dd9c49c657d60630ee\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"type\": \"card\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"customer_id\": \"5ece59dc9c49c657d60630ed\",\n \"primary\": false\n },\n {\n \"_id\": \"5ece5ed2bf87e8587723dd46\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"type\": \"card\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"customer_id\": \"5ece59dc9c49c657d60630ed\",\n \"primary\": true\n },\n {\n \"_id\": \"5ece5f7dbf87e8587723dd49\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"type\": \"card\",\n \"gateway_id\": \"5cbede1f151b842653e987be\",\n \"customer_id\": \"5ece59dc9c49c657d60630ed\",\n \"primary\": false\n }\n ],\n \"count\": 3,\n \"limit\": 100,\n \"skip\": 0\n }\n}"}],"_postman_id":"5fc6fbf8-ddb6-4e5c-8d4b-7b03601c7bae"}],"id":"4e7b2c99-289c-4d61-96f7-5c024748cd3c","description":"

A 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.

Conditions

The response is different depends on such conditions:

Created with credit card payment source
Created with the bank account payment source

Charge resource

field	required[flow]	type	description
reference	-	string	Manually defined reference for customer in payment systems
description	-	string	Customer description. This is customer internal description
company_name	-	string	Customer company name
_id	+	string (24 byte hex)	Charge Id for any future requests
user_id	-	string (24 byte hex)	id of an initiator of the request if the request was by the personal token (from the dashboard)
created_at	+	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Charge creation date
updated_at	+	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Date of last charge update
status	+	string	Actual charge status. See the status table
archived	+	bool	For new created charges always false, true after manual archiving
first_name	-	string	Customer first name
last_name	-	string	Customer last name
email	-	string	Customer email
phone	-	string(E.164)	Customer phone in E.164 international notation (Example: +12345678901)
default_source	+	string (24 byte hex)	Payment source used by default
payment_sources	+	Array	Collection with payment information
payment_sources[].gateway_id	+	string (24 byte hex)	Gateway id
payment_sources[].gateway_type	+	string	Type of gateway
payment_sources[].gateway_name	+	string	Custom name of of gateway
payment_sources[].type	+	string	Type of payment. card for payment with credit card, bank_account for direct debit payments
payment_sources[].card_name	+1	string	Cardholder name (as on card)
payment_sources[].card_number_last4	+1	string(numeric)	Card number last 4
payment_sources[].card_scheme	+1	string	Cardholder scheme (i.g. visa, mastercard etc...)
payment_sources[].expire_month	+1	string(mm)	Card expiration month mm
payment_sources[].expire_year	+1	string(yyyy)	Card expiration year
payment_sources[].account_name	+2	string	Customer account name.
payment_sources[].account_number	+2	string	Number of Customer account.
payment_sources[].account_bsb	-2	string	Customer bank state branch number.
payment_sources[].account_routing	-2	string(numeric)	Number of Customer account. BSB/Routing/SWIFT/IBAN Number.
payment_sources[].account_holder_type	-2	string	account type (personal or business)
payment_sources[].account_bank_name	-2	string	Name of account bank
payment_sources[].address_line1	-	string	Customer Address, line 1
payment_sources[].address_line2	-	string	Customer Address, line 2
payment_sources[].address_state	-	string	Customer Address, State
payment_sources[].address_country	-	string	Customer Address, Country Code
payment_sources[].address_city	-	string	Customer Address, City
payment_sources[].address_postcode	-	string(numeric)	Customer Address, Postcade
payment_sources[].meta.customer_storage_number	-	string	Identification of a customer on a gateway side for future payments binding (used by Bambora gateway)
payment_sources[].meta.tokenise_algorithm	-	number	Bambora alorithm Id for creating customers. (Default -2, if not specified.)
statistics	-	object	statistics of using customer
statistics.total_collected_amount	+	number	Total collected amount
statistics.successful_transactions	+	number	Successful transactions
payment_destination	-	object	@TODO

Status

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status	description
active	active customer
archived	Charge is archived

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"64f322b8-b0bf-4dea-9435-ce6d291049c5"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"69c74a9e-ab71-4611-901a-775ebb10c3d8"}}],"_postman_id":"4e7b2c99-289c-4d61-96f7-5c024748cd3c"},{"name":"subscriptions","item":[{"name":"search","id":"5a5ff166-ed45-4dd0-922f-5d611e4bad0a","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

Request query params

Pagination

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required[flow]	type	description
skip	-	number	Pagination parameter to skip first n subscriptions from list, default = 0
limit	-	number	Pagination parameter to limit output to n , default = 100 , maximum value = 1000
sortkey	-	string	Sorting key parameter i.e. created_at
sortdirection	-	string	Sorting order direction parameter ASC or DESC (DESC by default)

filters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required[flow]	type	description
gateway_id	-	string (24 byte hex)	ID of a gateway with which subscription were created
customer_id	-	string (24 byte hex)	ID of a customer with which subscription were created
status	-	string	See Status table

Other

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required[flow]	type	description
search	-	string	Word of phrase Customer want to search in created subscriptions (search works by fields: First Name, Last Name and Email)

","urlObject":{"path":["v1","subscriptions"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"79f91074-3e26-4b77-a241-138a9899eaff","name":"search by customerId","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?customer_id=5ef05cc53dcfec0ac5e0620f","host":["{{url}}"],"path":["v1","subscriptions"],"query":[{"key":"customer_id","value":"5ef05cc53dcfec0ac5e0620f"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 02 Sep 2020 15:25:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1377"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"561-ddik1ywdGBMFsTNScbGV0g\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"subscriptions\",\n \"data\": [\n {\n \"_id\": \"5ef05cc63dcfec0ac5e06212\",\n \"created_at\": \"2020-06-22T07:24:54.785Z\",\n \"updated_at\": \"2020-07-22T07:24:59.527Z\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 12,\n \"status\": \"expired\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"latest_charge_id\": \"5f17e9cab264e75b488d0708\",\n \"expired_at\": \"2020-07-22T07:24:59.497Z\",\n \"expired_reason\": \"end_date\",\n \"last_change_by\": \"automatic\",\n \"archived\": false,\n \"_source_ip_address\": \"178.137.184.131\",\n \"customer\": {\n \"customer_id\": \"5ef05cc53dcfec0ac5e0620f\",\n \"first_name\": \"Eduard\",\n \"last_name\": \"Nakon\",\n \"email\": \"ikneblis@gmail.com\",\n \"phone\": \"+380995222655\",\n \"reference\": \"Test\",\n \"company_name\": \"Test\"\n },\n \"statistics\": {\n \"total_collected_amount\": 24,\n \"successful_transactions\": 2\n },\n \"schedule\": {\n \"interval\": \"month\",\n \"start_date\": \"2020-06-22T07:24:53.705Z\",\n \"end_date\": \"2020-08-11T21:00:00.000Z\",\n \"next_assessment\": \"2020-07-22T07:24:53.705Z\",\n \"next_assessment_planned\": \"2020-07-22T07:24:53.705Z\",\n \"first_assessment\": \"2020-06-22T07:24:53.705Z\",\n \"status\": \"complete\",\n \"processing_pended_at\": \"2020-07-22T07:25:47.940Z\",\n \"last_assessment_planned\": \"2020-06-22T07:24:53.705Z\",\n \"last_assessment\": \"2020-07-22T07:24:59.508Z\",\n \"locked\": false,\n \"completed_count\": 2,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n }\n ],\n \"count\": 1,\n \"limit\": 100,\n \"skip\": 0\n }\n}"},{"id":"9b230bfc-8b52-441d-b116-00b833faa440","name":"search with pagination and sorting","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?limit=2&skip=1&sortkey=updated_at&sortdirection=DESC","host":["{{url}}"],"path":["v1","subscriptions"],"query":[{"key":"limit","value":"2"},{"key":"skip","value":"1"},{"key":"sortkey","value":"updated_at"},{"key":"sortdirection","value":"DESC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 02 Sep 2020 15:15:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2533"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"9e5-1c76ZRRAx85xJELpS8gYqA\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"subscriptions\",\n \"data\": [\n {\n \"_id\": \"5ef073483dcfec0ac5e062b6\",\n \"created_at\": \"2020-06-22T09:00:56.072Z\",\n \"updated_at\": \"2020-08-24T09:01:49.241Z\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 12,\n \"status\": \"failed\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"latest_charge_id\": \"5f4381fd3679530fc4236b1c\",\n \"last_change_by\": \"automatic\",\n \"archived\": false,\n \"_source_ip_address\": \"178.137.184.131\",\n \"customer\": {\n \"customer_id\": \"5ef073473dcfec0ac5e062b3\",\n \"first_name\": \"Eduard\",\n \"last_name\": \"Nakon\",\n \"email\": \"eduard.n@houstonapps.co\",\n \"phone\": \"+380995222655\",\n \"company_name\": \"Ed\"\n },\n \"statistics\": {\n \"total_collected_amount\": 708,\n \"successful_transactions\": 59\n },\n \"schedule\": {\n \"interval\": \"day\",\n \"start_date\": \"2020-06-22T09:00:55.068Z\",\n \"next_assessment\": \"2020-08-24T09:01:46.899Z\",\n \"next_assessment_planned\": \"2020-08-20T09:00:55.068Z\",\n \"first_assessment\": \"2020-06-22T09:00:55.068Z\",\n \"status\": \"failed\",\n \"processing_pended_at\": \"2020-08-24T09:02:39.100Z\",\n \"last_assessment_planned\": \"2020-08-20T09:00:55.068Z\",\n \"last_assessment\": \"2020-08-24T09:01:49.220Z\",\n \"locked\": false,\n \"completed_count\": 59,\n \"held_count\": 0,\n \"retry_count\": 5,\n \"frequency\": 1\n },\n \"currency\": \"AUD\",\n \"gateway_type\": \"CyberSource\",\n \"gateway_name\": \"CyberSource\",\n \"gateway_mode\": \"test\"\n },\n {\n \"_id\": \"5ef05cc63dcfec0ac5e06212\",\n \"created_at\": \"2020-06-22T07:24:54.785Z\",\n \"updated_at\": \"2020-07-22T07:24:59.527Z\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 12,\n \"status\": \"expired\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"latest_charge_id\": \"5f17e9cab264e75b488d0708\",\n \"expired_at\": \"2020-07-22T07:24:59.497Z\",\n \"expired_reason\": \"end_date\",\n \"last_change_by\": \"automatic\",\n \"archived\": false,\n \"_source_ip_address\": \"178.137.184.131\",\n \"customer\": {\n \"customer_id\": \"5ef05cc53dcfec0ac5e0620f\",\n \"first_name\": \"Eduard\",\n \"last_name\": \"Nakon\",\n \"email\": \"ikneblis@gmail.com\",\n \"phone\": \"+380995222655\",\n \"reference\": \"Test\",\n \"company_name\": \"Test\"\n },\n \"statistics\": {\n \"total_collected_amount\": 24,\n \"successful_transactions\": 2\n },\n \"schedule\": {\n \"interval\": \"month\",\n \"start_date\": \"2020-06-22T07:24:53.705Z\",\n \"end_date\": \"2020-08-11T21:00:00.000Z\",\n \"next_assessment\": \"2020-07-22T07:24:53.705Z\",\n \"next_assessment_planned\": \"2020-07-22T07:24:53.705Z\",\n \"first_assessment\": \"2020-06-22T07:24:53.705Z\",\n \"status\": \"complete\",\n \"processing_pended_at\": \"2020-07-22T07:25:47.940Z\",\n \"last_assessment_planned\": \"2020-06-22T07:24:53.705Z\",\n \"last_assessment\": \"2020-07-22T07:24:59.508Z\",\n \"locked\": false,\n \"completed_count\": 2,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n }\n ],\n \"count\": 7,\n \"limit\": 2,\n \"skip\": 1\n }\n}"},{"id":"9fa08a67-98b4-4baf-9bff-868e7369b68a","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":"PayDock "},{"key":"ETag","value":"W/\"1de1-jzqyGXnO8rTDWle7RQX/Kw\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"subscriptions\",\n \"data\": [\n {\n \"_id\": \"5f311e5ebc5c891bd59ad435\",\n \"created_at\": \"2020-08-10T10:15:58.616Z\",\n \"updated_at\": \"2020-09-02T11:30:36.514Z\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 111,\n \"status\": \"held\",\n \"held_at\": \"2020-08-10T10:16:21.169Z\",\n \"last_change_by\": \"manual\",\n \"latest_charge_id\": \"5f4f825ce582476241b3432f\",\n \"archived\": false,\n \"_source_ip_address\": \"::1\",\n \"customer\": {\n \"customer_id\": \"5f311e5bbc5c891bd59ad432\",\n \"first_name\": \"Eduard\",\n \"last_name\": \"Nakon\",\n \"email\": \"eduard.n@houstonapps.co\",\n \"phone\": \"+380995222655\",\n \"company_name\": \"Ed\"\n },\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n },\n \"schedule\": {\n \"interval\": \"day\",\n \"start_date\": \"2020-08-10T11:30:00.000Z\",\n \"end_amount_after\": 0,\n \"end_amount_before\": 0,\n \"end_amount_total\": 0,\n \"next_assessment\": \"2020-09-03T11:30:00.000Z\",\n \"next_assessment_planned\": \"2020-09-03T11:30:00.000Z\",\n \"first_assessment\": \"2020-08-10T11:30:00.000Z\",\n \"status\": \"held\",\n \"processing_pended_at\": \"2020-09-02T12:10:36.425Z\",\n \"last_assessment_planned\": \"2020-09-02T11:30:00.000Z\",\n \"last_assessment\": \"2020-09-02T11:30:36.504Z\",\n \"locked\": false,\n \"completed_count\": 0,\n \"held_count\": 24,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n },\n {\n \"_id\": \"5ef071bc3dcfec0ac5e062a8\",\n \"created_at\": \"2020-06-22T08:54:20.306Z\",\n \"updated_at\": \"2020-06-23T08:54:40.448Z\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 20,\n \"status\": \"expired\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"latest_charge_id\": \"5ef1c34feec804212963d632\",\n \"expired_at\": \"2020-06-23T08:54:40.358Z\",\n \"expired_reason\": \"end_date\",\n \"last_change_by\": \"automatic\",\n \"archived\": false,\n \"_source_ip_address\": \"178.137.184.131\",\n \"customer\": {\n \"customer_id\": \"5ef071bb3dcfec0ac5e062a5\",\n \"first_name\": \"Eduard\",\n \"last_name\": \"Nakon\",\n \"email\": \"eduard.n@houstonapps.co\",\n \"phone\": \"+380995222655\",\n \"company_name\": \"Ed\"\n },\n \"statistics\": {\n \"total_collected_amount\": 40,\n \"successful_transactions\": 2\n },\n \"schedule\": {\n \"interval\": \"day\",\n \"start_date\": \"2020-06-22T08:54:19.235Z\",\n \"end_date\": \"2020-06-24T00:00:00.000Z\",\n \"next_assessment\": \"2020-06-23T08:54:19.235Z\",\n \"next_assessment_planned\": \"2020-06-23T08:54:19.235Z\",\n \"first_assessment\": \"2020-06-22T08:54:19.235Z\",\n \"status\": \"complete\",\n \"processing_pended_at\": \"2020-06-23T08:55:28.279Z\",\n \"last_assessment_planned\": \"2020-06-22T08:54:19.235Z\",\n \"last_assessment\": \"2020-06-23T08:54:40.365Z\",\n \"locked\": false,\n \"completed_count\": 2,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n },\n {\n \"_id\": \"5ef070ef3dcfec0ac5e0629c\",\n \"created_at\": \"2020-06-22T08:50:55.244Z\",\n \"updated_at\": \"2020-06-24T11:49:05.939Z\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 11,\n \"status\": \"expired\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"latest_charge_id\": \"5ef33db0b1a51f4dfc89e34a\",\n \"expired_at\": \"2020-06-24T11:49:05.839Z\",\n \"expired_reason\": \"end_date\",\n \"last_change_by\": \"automatic\",\n \"archived\": false,\n \"_source_ip_address\": \"178.137.184.131\",\n \"customer\": {\n \"customer_id\": \"5ef070ee3dcfec0ac5e06299\",\n \"first_name\": \"Eduard\",\n \"last_name\": \"Nakon\",\n \"email\": \"eduard.n@houstonapps.co\",\n \"phone\": \"+380995222655\",\n \"company_name\": \"Ed\"\n },\n \"statistics\": {\n \"total_collected_amount\": 33,\n \"successful_transactions\": 3\n },\n \"schedule\": {\n \"interval\": \"day\",\n \"start_date\": \"2020-06-22T11:49:00.000Z\",\n \"end_date\": \"2020-06-25T00:00:00.000Z\",\n \"next_assessment\": \"2020-06-24T11:49:00.000Z\",\n \"next_assessment_planned\": \"2020-06-24T11:49:00.000Z\",\n \"first_assessment\": \"2020-06-22T11:49:00.000Z\",\n \"status\": \"complete\",\n \"processing_pended_at\": \"2020-06-24T11:49:52.112Z\",\n \"last_assessment_planned\": \"2020-06-23T11:49:00.000Z\",\n \"last_assessment\": \"2020-06-24T11:49:05.846Z\",\n \"locked\": false,\n \"completed_count\": 3,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n },\n {\n \"_id\": \"5ef064763dcfec0ac5e0622e\",\n \"created_at\": \"2020-06-22T07:57:42.963Z\",\n \"updated_at\": \"2020-06-29T07:58:15.049Z\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 12,\n \"status\": \"expired\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"latest_charge_id\": \"5ef99f168bbc123baf1507f4\",\n \"expired_at\": \"2020-06-29T07:58:15.019Z\",\n \"expired_reason\": \"end_date\",\n \"last_change_by\": \"automatic\",\n \"archived\": false,\n \"_source_ip_address\": \"178.137.184.131\",\n \"customer\": {\n \"customer_id\": \"5ef064763dcfec0ac5e0622b\",\n \"first_name\": \"Eduard\",\n \"last_name\": \"Nakon\",\n \"email\": \"eduard.n@houstonapps.co\",\n \"phone\": \"+380995222655\",\n \"company_name\": \"Ed\"\n },\n \"statistics\": {\n \"total_collected_amount\": 96,\n \"successful_transactions\": 8\n },\n \"schedule\": {\n \"interval\": \"day\",\n \"start_date\": \"2020-06-22T07:57:42.066Z\",\n \"end_date\": \"2020-06-29T21:00:00.000Z\",\n \"next_assessment\": \"2020-06-29T07:57:42.066Z\",\n \"next_assessment_planned\": \"2020-06-29T07:57:42.066Z\",\n \"first_assessment\": \"2020-06-22T07:57:42.066Z\",\n \"status\": \"complete\",\n \"processing_pended_at\": \"2020-06-29T07:59:02.065Z\",\n \"last_assessment_planned\": \"2020-06-28T07:57:42.066Z\",\n \"last_assessment\": \"2020-06-29T07:58:15.025Z\",\n \"locked\": false,\n \"completed_count\": 8,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n },\n {\n \"_id\": \"5ef05eb03dcfec0ac5e06220\",\n \"created_at\": \"2020-06-22T07:33:04.827Z\",\n \"updated_at\": \"2020-06-29T07:33:15.602Z\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 22,\n \"status\": \"expired\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"latest_charge_id\": \"5ef9993a8bbc123baf1507e7\",\n \"expired_at\": \"2020-06-29T07:33:15.581Z\",\n \"expired_reason\": \"end_date\",\n \"last_change_by\": \"automatic\",\n \"archived\": false,\n \"_source_ip_address\": \"178.137.184.131\",\n \"customer\": {\n \"customer_id\": \"5ef05eaf3dcfec0ac5e0621d\",\n \"first_name\": \"Eduard\",\n \"last_name\": \"Nakon\",\n \"email\": \"eduard.n@houstonapps.co\",\n \"phone\": \"+380995222655\",\n \"reference\": \"Ed\",\n \"company_name\": \"Ed\"\n },\n \"statistics\": {\n \"total_collected_amount\": 176,\n \"successful_transactions\": 8\n },\n \"schedule\": {\n \"interval\": \"day\",\n \"start_date\": \"2020-06-22T07:33:03.848Z\",\n \"end_date\": \"2020-06-29T21:00:00.000Z\",\n \"next_assessment\": \"2020-06-29T07:33:03.848Z\",\n \"next_assessment_planned\": \"2020-06-29T07:33:03.848Z\",\n \"first_assessment\": \"2020-06-22T07:33:03.848Z\",\n \"status\": \"complete\",\n \"processing_pended_at\": \"2020-06-29T07:34:02.012Z\",\n \"last_assessment_planned\": \"2020-06-28T07:33:03.848Z\",\n \"last_assessment\": \"2020-06-29T07:33:15.587Z\",\n \"locked\": false,\n \"completed_count\": 8,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n },\n {\n \"_id\": \"5ef05cc63dcfec0ac5e06212\",\n \"created_at\": \"2020-06-22T07:24:54.785Z\",\n \"updated_at\": \"2020-07-22T07:24:59.527Z\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 12,\n \"status\": \"expired\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"latest_charge_id\": \"5f17e9cab264e75b488d0708\",\n \"expired_at\": \"2020-07-22T07:24:59.497Z\",\n \"expired_reason\": \"end_date\",\n \"last_change_by\": \"automatic\",\n \"archived\": false,\n \"_source_ip_address\": \"178.137.184.131\",\n \"customer\": {\n \"customer_id\": \"5ef05cc53dcfec0ac5e0620f\",\n \"first_name\": \"Eduard\",\n \"last_name\": \"Nakon\",\n \"email\": \"ikneblis@gmail.com\",\n \"phone\": \"+380995222655\",\n \"reference\": \"Test\",\n \"company_name\": \"Test\"\n },\n \"statistics\": {\n \"total_collected_amount\": 24,\n \"successful_transactions\": 2\n },\n \"schedule\": {\n \"interval\": \"month\",\n \"start_date\": \"2020-06-22T07:24:53.705Z\",\n \"end_date\": \"2020-08-11T21:00:00.000Z\",\n \"next_assessment\": \"2020-07-22T07:24:53.705Z\",\n \"next_assessment_planned\": \"2020-07-22T07:24:53.705Z\",\n \"first_assessment\": \"2020-06-22T07:24:53.705Z\",\n \"status\": \"complete\",\n \"processing_pended_at\": \"2020-07-22T07:25:47.940Z\",\n \"last_assessment_planned\": \"2020-06-22T07:24:53.705Z\",\n \"last_assessment\": \"2020-07-22T07:24:59.508Z\",\n \"locked\": false,\n \"completed_count\": 2,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n }\n ],\n \"count\": 6,\n \"limit\": 100,\n \"skip\": 0\n }\n}"},{"id":"da58abbd-182a-4a41-9b34-52f93264e6f3","name":"search by status","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?status=expired","host":["{{url}}"],"path":["v1","subscriptions"],"query":[{"key":"status","value":"expired"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 02 Sep 2020 15:28:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"6419"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"1913-RQ5Jfjmj6nELj5La7CWJsg\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"subscriptions\",\n \"data\": [\n {\n \"_id\": \"5ef071bc3dcfec0ac5e062a8\",\n \"created_at\": \"2020-06-22T08:54:20.306Z\",\n \"updated_at\": \"2020-06-23T08:54:40.448Z\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 20,\n \"status\": \"expired\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"latest_charge_id\": \"5ef1c34feec804212963d632\",\n \"expired_at\": \"2020-06-23T08:54:40.358Z\",\n \"expired_reason\": \"end_date\",\n \"last_change_by\": \"automatic\",\n \"archived\": false,\n \"_source_ip_address\": \"178.137.184.131\",\n \"customer\": {\n \"customer_id\": \"5ef071bb3dcfec0ac5e062a5\",\n \"first_name\": \"Eduard\",\n \"last_name\": \"Nakon\",\n \"email\": \"eduard.n@houstonapps.co\",\n \"phone\": \"+380995222655\",\n \"company_name\": \"Ed\"\n },\n \"statistics\": {\n \"total_collected_amount\": 40,\n \"successful_transactions\": 2\n },\n \"schedule\": {\n \"interval\": \"day\",\n \"start_date\": \"2020-06-22T08:54:19.235Z\",\n \"end_date\": \"2020-06-24T00:00:00.000Z\",\n \"next_assessment\": \"2020-06-23T08:54:19.235Z\",\n \"next_assessment_planned\": \"2020-06-23T08:54:19.235Z\",\n \"first_assessment\": \"2020-06-22T08:54:19.235Z\",\n \"status\": \"complete\",\n \"processing_pended_at\": \"2020-06-23T08:55:28.279Z\",\n \"last_assessment_planned\": \"2020-06-22T08:54:19.235Z\",\n \"last_assessment\": \"2020-06-23T08:54:40.365Z\",\n \"locked\": false,\n \"completed_count\": 2,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n },\n {\n \"_id\": \"5ef070ef3dcfec0ac5e0629c\",\n \"created_at\": \"2020-06-22T08:50:55.244Z\",\n \"updated_at\": \"2020-06-24T11:49:05.939Z\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 11,\n \"status\": \"expired\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"latest_charge_id\": \"5ef33db0b1a51f4dfc89e34a\",\n \"expired_at\": \"2020-06-24T11:49:05.839Z\",\n \"expired_reason\": \"end_date\",\n \"last_change_by\": \"automatic\",\n \"archived\": false,\n \"_source_ip_address\": \"178.137.184.131\",\n \"customer\": {\n \"customer_id\": \"5ef070ee3dcfec0ac5e06299\",\n \"first_name\": \"Eduard\",\n \"last_name\": \"Nakon\",\n \"email\": \"eduard.n@houstonapps.co\",\n \"phone\": \"+380995222655\",\n \"company_name\": \"Ed\"\n },\n \"statistics\": {\n \"total_collected_amount\": 33,\n \"successful_transactions\": 3\n },\n \"schedule\": {\n \"interval\": \"day\",\n \"start_date\": \"2020-06-22T11:49:00.000Z\",\n \"end_date\": \"2020-06-25T00:00:00.000Z\",\n \"next_assessment\": \"2020-06-24T11:49:00.000Z\",\n \"next_assessment_planned\": \"2020-06-24T11:49:00.000Z\",\n \"first_assessment\": \"2020-06-22T11:49:00.000Z\",\n \"status\": \"complete\",\n \"processing_pended_at\": \"2020-06-24T11:49:52.112Z\",\n \"last_assessment_planned\": \"2020-06-23T11:49:00.000Z\",\n \"last_assessment\": \"2020-06-24T11:49:05.846Z\",\n \"locked\": false,\n \"completed_count\": 3,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n },\n {\n \"_id\": \"5ef064763dcfec0ac5e0622e\",\n \"created_at\": \"2020-06-22T07:57:42.963Z\",\n \"updated_at\": \"2020-06-29T07:58:15.049Z\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 12,\n \"status\": \"expired\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"latest_charge_id\": \"5ef99f168bbc123baf1507f4\",\n \"expired_at\": \"2020-06-29T07:58:15.019Z\",\n \"expired_reason\": \"end_date\",\n \"last_change_by\": \"automatic\",\n \"archived\": false,\n \"_source_ip_address\": \"178.137.184.131\",\n \"customer\": {\n \"customer_id\": \"5ef064763dcfec0ac5e0622b\",\n \"first_name\": \"Eduard\",\n \"last_name\": \"Nakon\",\n \"email\": \"eduard.n@houstonapps.co\",\n \"phone\": \"+380995222655\",\n \"company_name\": \"Ed\"\n },\n \"statistics\": {\n \"total_collected_amount\": 96,\n \"successful_transactions\": 8\n },\n \"schedule\": {\n \"interval\": \"day\",\n \"start_date\": \"2020-06-22T07:57:42.066Z\",\n \"end_date\": \"2020-06-29T21:00:00.000Z\",\n \"next_assessment\": \"2020-06-29T07:57:42.066Z\",\n \"next_assessment_planned\": \"2020-06-29T07:57:42.066Z\",\n \"first_assessment\": \"2020-06-22T07:57:42.066Z\",\n \"status\": \"complete\",\n \"processing_pended_at\": \"2020-06-29T07:59:02.065Z\",\n \"last_assessment_planned\": \"2020-06-28T07:57:42.066Z\",\n \"last_assessment\": \"2020-06-29T07:58:15.025Z\",\n \"locked\": false,\n \"completed_count\": 8,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n },\n {\n \"_id\": \"5ef05eb03dcfec0ac5e06220\",\n \"created_at\": \"2020-06-22T07:33:04.827Z\",\n \"updated_at\": \"2020-06-29T07:33:15.602Z\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 22,\n \"status\": \"expired\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"latest_charge_id\": \"5ef9993a8bbc123baf1507e7\",\n \"expired_at\": \"2020-06-29T07:33:15.581Z\",\n \"expired_reason\": \"end_date\",\n \"last_change_by\": \"automatic\",\n \"archived\": false,\n \"_source_ip_address\": \"178.137.184.131\",\n \"customer\": {\n \"customer_id\": \"5ef05eaf3dcfec0ac5e0621d\",\n \"first_name\": \"Eduard\",\n \"last_name\": \"Nakon\",\n \"email\": \"eduard.n@houstonapps.co\",\n \"phone\": \"+380995222655\",\n \"reference\": \"Ed\",\n \"company_name\": \"Ed\"\n },\n \"statistics\": {\n \"total_collected_amount\": 176,\n \"successful_transactions\": 8\n },\n \"schedule\": {\n \"interval\": \"day\",\n \"start_date\": \"2020-06-22T07:33:03.848Z\",\n \"end_date\": \"2020-06-29T21:00:00.000Z\",\n \"next_assessment\": \"2020-06-29T07:33:03.848Z\",\n \"next_assessment_planned\": \"2020-06-29T07:33:03.848Z\",\n \"first_assessment\": \"2020-06-22T07:33:03.848Z\",\n \"status\": \"complete\",\n \"processing_pended_at\": \"2020-06-29T07:34:02.012Z\",\n \"last_assessment_planned\": \"2020-06-28T07:33:03.848Z\",\n \"last_assessment\": \"2020-06-29T07:33:15.587Z\",\n \"locked\": false,\n \"completed_count\": 8,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n },\n {\n \"_id\": \"5ef05cc63dcfec0ac5e06212\",\n \"created_at\": \"2020-06-22T07:24:54.785Z\",\n \"updated_at\": \"2020-07-22T07:24:59.527Z\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 12,\n \"status\": \"expired\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"latest_charge_id\": \"5f17e9cab264e75b488d0708\",\n \"expired_at\": \"2020-07-22T07:24:59.497Z\",\n \"expired_reason\": \"end_date\",\n \"last_change_by\": \"automatic\",\n \"archived\": false,\n \"_source_ip_address\": \"178.137.184.131\",\n \"customer\": {\n \"customer_id\": \"5ef05cc53dcfec0ac5e0620f\",\n \"first_name\": \"Eduard\",\n \"last_name\": \"Nakon\",\n \"email\": \"ikneblis@gmail.com\",\n \"phone\": \"+380995222655\",\n \"reference\": \"Test\",\n \"company_name\": \"Test\"\n },\n \"statistics\": {\n \"total_collected_amount\": 24,\n \"successful_transactions\": 2\n },\n \"schedule\": {\n \"interval\": \"month\",\n \"start_date\": \"2020-06-22T07:24:53.705Z\",\n \"end_date\": \"2020-08-11T21:00:00.000Z\",\n \"next_assessment\": \"2020-07-22T07:24:53.705Z\",\n \"next_assessment_planned\": \"2020-07-22T07:24:53.705Z\",\n \"first_assessment\": \"2020-06-22T07:24:53.705Z\",\n \"status\": \"complete\",\n \"processing_pended_at\": \"2020-07-22T07:25:47.940Z\",\n \"last_assessment_planned\": \"2020-06-22T07:24:53.705Z\",\n \"last_assessment\": \"2020-07-22T07:24:59.508Z\",\n \"locked\": false,\n \"completed_count\": 2,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n }\n ],\n \"count\": 5,\n \"limit\": 100,\n \"skip\": 0\n }\n}"},{"id":"ef1f6f49-17ac-4128-bfef-51a6ab671bd1","name":"search by phrase","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?search=@gmail.com","host":["{{url}}"],"path":["v1","subscriptions"],"query":[{"key":"search","value":"@gmail.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 02 Sep 2020 15:23:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1377"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"561-ddik1ywdGBMFsTNScbGV0g\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"subscriptions\",\n \"data\": [\n {\n \"_id\": \"5ef05cc63dcfec0ac5e06212\",\n \"created_at\": \"2020-06-22T07:24:54.785Z\",\n \"updated_at\": \"2020-07-22T07:24:59.527Z\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 12,\n \"status\": \"expired\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"latest_charge_id\": \"5f17e9cab264e75b488d0708\",\n \"expired_at\": \"2020-07-22T07:24:59.497Z\",\n \"expired_reason\": \"end_date\",\n \"last_change_by\": \"automatic\",\n \"archived\": false,\n \"_source_ip_address\": \"178.137.184.131\",\n \"customer\": {\n \"customer_id\": \"5ef05cc53dcfec0ac5e0620f\",\n \"first_name\": \"Eduard\",\n \"last_name\": \"Nakon\",\n \"email\": \"ikneblis@gmail.com\",\n \"phone\": \"+380995222655\",\n \"reference\": \"Test\",\n \"company_name\": \"Test\"\n },\n \"statistics\": {\n \"total_collected_amount\": 24,\n \"successful_transactions\": 2\n },\n \"schedule\": {\n \"interval\": \"month\",\n \"start_date\": \"2020-06-22T07:24:53.705Z\",\n \"end_date\": \"2020-08-11T21:00:00.000Z\",\n \"next_assessment\": \"2020-07-22T07:24:53.705Z\",\n \"next_assessment_planned\": \"2020-07-22T07:24:53.705Z\",\n \"first_assessment\": \"2020-06-22T07:24:53.705Z\",\n \"status\": \"complete\",\n \"processing_pended_at\": \"2020-07-22T07:25:47.940Z\",\n \"last_assessment_planned\": \"2020-06-22T07:24:53.705Z\",\n \"last_assessment\": \"2020-07-22T07:24:59.508Z\",\n \"locked\": false,\n \"completed_count\": 2,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n }\n ],\n \"count\": 1,\n \"limit\": 100,\n \"skip\": 0\n }\n}"}],"_postman_id":"5a5ff166-ed45-4dd0-922f-5d611e4bad0a"},{"name":"get","id":"ef647910-51f4-498f-bd5a-35a9f150ec74","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/:id","description":"

Retrieves data on a subscription with a specified ID.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","subscriptions",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5ef064763dcfec0ac5e0622e","key":"id"}]}},"response":[{"id":"406b83bf-9d20-4d5b-a214-0ee87434e671","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":"PayDock "},{"key":"ETag","value":"W/\"761-06IxEuhqTj6iLo4XAT2slA\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"subscription\",\n \"data\": {\n \"_id\": \"5ef064763dcfec0ac5e0622e\",\n \"created_at\": \"2020-06-22T07:57:42.963Z\",\n \"updated_at\": \"2020-06-29T07:58:15.049Z\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 12,\n \"status\": \"expired\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"latest_charge_id\": \"5ef99f168bbc123baf1507f4\",\n \"expired_at\": \"2020-06-29T07:58:15.019Z\",\n \"expired_reason\": \"end_date\",\n \"last_change_by\": \"automatic\",\n \"archived\": false,\n \"_source_ip_address\": \"178.137.184.131\",\n \"customer\": {\n \"customer_id\": \"5ef064763dcfec0ac5e0622b\",\n \"first_name\": \"Eduard\",\n \"last_name\": \"Nakon\",\n \"email\": \"eduard.n@houstonapps.co\",\n \"phone\": \"+380995222655\",\n \"company_name\": \"Ed\",\n \"payment_source\": {\n \"gateway_name\": \"Stripe 1\",\n \"gateway_type\": \"Stripe\",\n \"gateway_mode\": \"test\",\n \"updated_at\": \"2020-06-22T07:57:42.957Z\",\n \"vault_token\": \"bd9d6ed0-7c6c-4ee7-84f6-b774cd2a88ed\",\n \"gateway_id\": \"5dde1f3799cfea21ed2fc942\",\n \"expire_year\": 2021,\n \"expire_month\": 1,\n \"address_country\": \"UA\",\n \"address_line1\": \"Derevanco, De, asdas\",\n \"address_line2\": \"asdas\",\n \"address_city\": \"Kharkiv\",\n \"address_state\": \"Kharkiv Oblast\",\n \"address_postcode\": \"61103\",\n \"card_name\": \"Test\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"cus_HVm5S8sw1hGryF\",\n \"status\": \"active\",\n \"created_at\": \"2020-06-22T07:57:42.906Z\",\n \"_id\": \"5ef064763dcfec0ac5e0622c\",\n \"type\": \"card\"\n }\n },\n \"statistics\": {\n \"total_collected_amount\": 96,\n \"successful_transactions\": 8\n },\n \"schedule\": {\n \"interval\": \"day\",\n \"start_date\": \"2020-06-22T07:57:42.066Z\",\n \"end_date\": \"2020-06-29T21:00:00.000Z\",\n \"next_assessment\": \"2020-06-29T07:57:42.066Z\",\n \"next_assessment_planned\": \"2020-06-29T07:57:42.066Z\",\n \"first_assessment\": \"2020-06-22T07:57:42.066Z\",\n \"status\": \"complete\",\n \"processing_pended_at\": \"2020-06-29T07:59:02.065Z\",\n \"last_assessment_planned\": \"2020-06-28T07:57:42.066Z\",\n \"last_assessment\": \"2020-06-29T07:58:15.025Z\",\n \"locked\": false,\n \"completed_count\": 8,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\"\n }\n }\n}"}],"_postman_id":"ef647910-51f4-498f-bd5a-35a9f150ec74"},{"name":"create","id":"707ceeab-928d-4a21-baab-ab1ea069a1a3","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.00\",\n \"currency\": \"AUD\",\n \"reference\": \"Fuga consequuntur sint ab magnam\",\n \"description\": \"Vitae commodi provident assumenda\",\n \"customer\": {\n \"first_name\": \"Samantha\",\n \"last_name\": \"Washington\",\n \"email\": \"samwashington@gmail.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\": \"First_Name Last_Name\",\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

You can create a subscription using:

One-time token (customer will be created automatically before creating a subscription)
An existing customer (with default or non-default payment source)
Direct with credit card (customer will be created automatically before creating a subscription)
Direct with bank account (customer will be created automatically before creating a subscription)
Using vault-token (customer will be created automatically before creating a subscription)

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.

Subscriptions can also be configured to end after:

a certain number of transactions
an amount (eg end before reaching $1000 or end after reaching $1000)
a date

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.

Request body

field	required[flow]	type	description
amount	+	float	Amount of payment
currency	+	string (iso4217 alpha-3)	Currency code
description	-	string	Manually defined description for payments in payment systems
reference	-	string	Manually defined reference for customer in payment systems
token	+1	string(UUID)	One-time token with all the payment source information
customer_id	+2	string (24 byte hex)	Existing customer ID
customer	+3, +4, +5	object	Object with the customer’s information.
customer.first_name	-	string	Customer first name
customer.last_name	-	string	Customer last name
customer.email	-	string	Customer email
customer.phone	-	string(E.164)	Customer phone in E.164 international notation (Example: +12345678901)
customer.reference	-	string	Manually defined reference for customer in payment systems
customer.payment_source	+	object	Object with payment information
customer.payment_source.gateway_id	+	string (24 byte hex)	Gateway id
customer.payment_source.type	+4	string	Type of payment. By default card. Use card for payment with credit card. Use bank_account for using direct debit payments
customer.payment_source.card_name	+3	string	Cardholder name (as on card)
customer.payment_source.card_number	+3	string(numeric)	Card number
customer.payment_source.expire_month	+3	string(mm)	Card expiration month mm
customer.payment_source.expire_year	+3	string(yyyy)	Card expiration year
customer.payment_source.card_ccv	-3	string(numeric)	Card CCV number
customer.payment_source.account_name	+4	string	Customer account name.
customer.payment_source.account_number	+4	string	Number of Customer account.
customer.payment_source.account_bsb	-4	string	Customer bank state branch number.
customer.payment_source.account_routing	-4	string(numeric)	Number of Customer account. BSB/Routing/SWIFT/IBAN Number.
customer.payment_source.account_holder_type	-4	string	account type (personal or business)
customer.payment_source.account_bank_name	-4	string	Name of account bank
customer.payment_source.address_line1	-	string	Customer Address, line 1
customer.payment_source.address_line2	-	string	Customer Address, line 2
customer.payment_source.address_state	-	string	Customer Address, State
customer.payment_source.address_country	-	string	Customer Address, Country Code
customer.payment_source.address_city	-	string	Customer Address, City
customer.payment_source.address_postcode	-	string(numeric)	Customer Address, Postcade
customer.payment_source.vault_token	+5	string(UUID)	Vault token
schedule	+	object	Object with subscription schedule information
schedule.interval	+	string	Assessment interval one-off, week, month, year, day
schedule.frequency	+	string(numeric)	Assessment frequency, 1 by default (i.e. “3” = “Every 3 weeks”)
schedule.start_date	-	string(Date)	Start date, ISO 8601 format (yyyy-mm-ddThh:mm:ss.sssZ) or short type of date (yyyy-mm-dd) or specify time offsets from UTC (yyyy-mm-ddThh:mm:ss+hh:mm)
schedule.end_date	-	string(Date)	End date, ISO 8601 format (yyyy-mm-ddThh:mm:ss.sssZ) or short type of date (yyyy-mm-dd) or specify time offsets from UTC (yyyy-mm-ddThh:mm:ss+hh:mm)
schedule.end_amount_after	-	float	Total amount of all successful transactions (equals or exceeds)
schedule.end_amount_before	-	float	Total amount of all successful transactions (not to exceed)
schedule.end_amount_total	-	float	Total amount to be paid with subscription (equals). NOTE: If last payment of subscription schedule will be less then $ 1.00, some gateways may respond with error and subscription status will become ‘failed’.
schedule.end_transactions	-	integer	Total count of all successful transactions
meta	-	object	Optional object with specific fields for different gateways
meta.account_id	-	string	ID of an existing, connected stripe account. Use to create Stripe connect Direct Charges

","urlObject":{"path":["v1","subscriptions"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0e48ee95-9723-4e34-90e4-a7b9e13e2c43","name":"create with one-time 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 \"token\": \"9a922988-7889-4a7c-9eba-9fc589d5b22b\",\n \"schedule\": {\n \"frequency\": \"1\",\n \"interval\": \"day\",\n \"start_date\": \"2020-08-23\",\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:52:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1038"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"40e-S5kQ3wEuFh8FKd7+QmVVgA\""},{"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\": \"subscription\",\n \"data\": {\n \"__v\": 0,\n \"created_at\": \"2020-09-03T09:52:45.361Z\",\n \"updated_at\": \"2020-09-03T09:52:45.361Z\",\n \"amount\": 10,\n \"description\": \"Vitae commodi provident assumenda\",\n \"reference\": \"Fuga consequuntur sint ab magnam\",\n \"status\": \"active\",\n \"_id\": \"5f50bced80c950150a60364c\",\n \"archived\": false,\n \"_service\": {\n \"customer_default_gateway_id\": \"5ef6167d2e4a1b140f640167\",\n \"tags\": \"undefined undefined test@paydock.com\"\n },\n \"customer\": {\n \"customer_id\": \"5f50bced80c950150a60364a\",\n \"email\": \"test@paydock.com\"\n },\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n },\n \"schedule\": {\n \"interval\": \"day\",\n \"start_date\": \"2020-09-03T11:30:00.000Z\",\n \"end_date\": \"2020-09-25T19:05:11.000Z\",\n \"end_amount_after\": 0,\n \"end_amount_before\": 0,\n \"end_amount_total\": 0,\n \"next_assessment\": \"2020-09-03T11:30:00.000Z\",\n \"next_assessment_planned\": \"2020-09-03T11:30:00.000Z\",\n \"first_assessment\": \"2020-09-03T11:30:00.000Z\",\n \"status\": \"inprogress\",\n \"locked\": false,\n \"completed_count\": 0,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\"\n }\n }\n}"},{"id":"1d8ad469-0526-444b-97ab-df56b8c0fde3","name":"create with credit card and customer details","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 \"first_name\": \"Samantha\",\n \"last_name\": \"Washington\",\n \"email\": \"samwashington@gmail.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\": \"First_Name Last_Name\",\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 \"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 10:20:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1133"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"46d-lciHomszwEaGWGd0qe9Xxg\""},{"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\": \"subscription\",\n \"data\": {\n \"__v\": 0,\n \"created_at\": \"2020-09-03T10:20:18.115Z\",\n \"updated_at\": \"2020-09-03T10:20:18.115Z\",\n \"amount\": 10,\n \"description\": \"Vitae commodi provident assumenda\",\n \"reference\": \"Fuga consequuntur sint ab magnam\",\n \"status\": \"active\",\n \"_id\": \"5f50c36280c950150a603650\",\n \"archived\": false,\n \"_service\": {\n \"customer_default_gateway_id\": \"5dde1f3799cfea21ed2fc942\",\n \"tags\": \"samantha washington samwashington@gmail.com\"\n },\n \"customer\": {\n \"customer_id\": \"5f50c36080c950150a60364d\",\n \"first_name\": \"Samantha\",\n \"last_name\": \"Washington\",\n \"email\": \"samwashington@gmail.com\",\n \"reference\": \"CustomReference\"\n },\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n },\n \"schedule\": {\n \"interval\": \"month\",\n \"start_date\": \"2020-09-03T11:30:00.000Z\",\n \"end_date\": \"2020-09-25T19:05:11.000Z\",\n \"end_amount_after\": 0,\n \"end_amount_before\": 0,\n \"end_amount_total\": 0,\n \"next_assessment\": \"2020-09-03T11:30:00.000Z\",\n \"next_assessment_planned\": \"2020-09-03T11:30:00.000Z\",\n \"first_assessment\": \"2020-09-03T11:30:00.000Z\",\n \"status\": \"inprogress\",\n \"locked\": false,\n \"completed_count\": 0,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\"\n }\n }\n}"},{"id":"5ae30a4c-f7ee-451a-995a-0a15e5d9d99b","name":"create with customer and non-default payment source","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_id\": \"5f50b04e80c950150a603632\",\n \"payment_source_id\": \"5f50b04f80c950150a603633\",\n \"schedule\": {\n \"frequency\": \"1\",\n \"interval\": \"day\",\n \"start_date\": \"2020-08-23\",\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:15:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1193"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"4a9-Gg0TEPieAQE4NiEvxlUfqg\""},{"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\": \"subscription\",\n \"data\": {\n \"__v\": 0,\n \"created_at\": \"2020-09-03T09:15:13.783Z\",\n \"updated_at\": \"2020-09-03T09:15:13.783Z\",\n \"amount\": 10,\n \"description\": \"Vitae commodi provident assumenda\",\n \"reference\": \"Fuga consequuntur sint ab magnam\",\n \"status\": \"active\",\n \"payment_source_id\": \"5f50b04f80c950150a603633\",\n \"_id\": \"5f50b42180c950150a60363d\",\n \"archived\": false,\n \"_service\": {\n \"customer_default_gateway_id\": \"5dde1f3799cfea21ed2fc942\",\n \"tags\": \"matt perry m.perry@gmail.com\"\n },\n \"customer\": {\n \"customer_id\": \"5f50b04e80c950150a603632\",\n \"first_name\": \"Matt\",\n \"last_name\": \"Perry\",\n \"email\": \"m.perry@gmail.com\",\n \"phone\": \"+1234567890\",\n \"reference\": \"Some refference\",\n \"company_name\": \"gmail\"\n },\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n },\n \"schedule\": {\n \"interval\": \"day\",\n \"start_date\": \"2020-09-03T11:30:00.000Z\",\n \"end_date\": \"2020-09-25T19:05:11.000Z\",\n \"end_amount_after\": 0,\n \"end_amount_before\": 0,\n \"end_amount_total\": 0,\n \"next_assessment\": \"2020-09-03T11:30:00.000Z\",\n \"next_assessment_planned\": \"2020-09-03T11:30:00.000Z\",\n \"first_assessment\": \"2020-09-03T11:30:00.000Z\",\n \"status\": \"inprogress\",\n \"locked\": false,\n \"completed_count\": 0,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\"\n }\n }\n}"},{"id":"669fb5c8-3677-4a49-9b9e-ef9c0f9a0496","name":"create with customer","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_id\": \"5f50b04e80c950150a603632\",\n \"schedule\": {\n \"frequency\": \"1\",\n \"interval\": \"day\",\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 08:59:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1146"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"47a-yj3jFfWM0+qlU++Skj3osg\""},{"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\": \"subscription\",\n \"data\": {\n \"__v\": 0,\n \"created_at\": \"2020-09-03T08:59:07.752Z\",\n \"updated_at\": \"2020-09-03T08:59:07.752Z\",\n \"amount\": 10,\n \"description\": \"Vitae commodi provident assumenda\",\n \"reference\": \"Fuga consequuntur sint ab magnam\",\n \"status\": \"active\",\n \"_id\": \"5f50b05b80c950150a603635\",\n \"archived\": false,\n \"_service\": {\n \"customer_default_gateway_id\": \"5dde1f3799cfea21ed2fc942\",\n \"tags\": \"matt perry m.perry@gmail.com\"\n },\n \"customer\": {\n \"customer_id\": \"5f50b04e80c950150a603632\",\n \"first_name\": \"Matt\",\n \"last_name\": \"Perry\",\n \"email\": \"m.perry@gmail.com\",\n \"phone\": \"+1234567890\",\n \"reference\": \"Some refference\",\n \"company_name\": \"gmail\"\n },\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n },\n \"schedule\": {\n \"interval\": \"day\",\n \"start_date\": \"2020-09-03T11:30:00.000Z\",\n \"end_date\": \"2020-09-25T19:05:11.000Z\",\n \"end_amount_after\": 0,\n \"end_amount_before\": 0,\n \"end_amount_total\": 0,\n \"next_assessment\": \"2020-09-03T11:30:00.000Z\",\n \"next_assessment_planned\": \"2020-09-03T11:30:00.000Z\",\n \"first_assessment\": \"2020-09-03T11:30:00.000Z\",\n \"status\": \"inprogress\",\n \"locked\": false,\n \"completed_count\": 0,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\"\n }\n }\n}"},{"id":"78fe7a2c-7880-4f82-8b2f-aeedb0b88fd3","name":"create with credit card","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 \"card_name\": \"First_Name Last_Name\",\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 \"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:11:40 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":"PayDock "},{"key":"ETag","value":"W/\"3ee-+KhKhc8YSPmZNyNRrokEyA\""},{"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\": \"subscription\",\n \"data\": {\n \"__v\": 0,\n \"created_at\": \"2020-09-03T09:11:40.733Z\",\n \"updated_at\": \"2020-09-03T09:11:40.733Z\",\n \"amount\": 10,\n \"description\": \"Vitae commodi provident assumenda\",\n \"reference\": \"Fuga consequuntur sint ab magnam\",\n \"status\": \"active\",\n \"_id\": \"5f50b34c80c950150a603639\",\n \"archived\": false,\n \"_service\": {\n \"customer_default_gateway_id\": \"5dde1f3799cfea21ed2fc942\",\n \"tags\": \"undefined undefined undefined\"\n },\n \"customer\": {\n \"customer_id\": \"5f50b34b80c950150a603636\"\n },\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n },\n \"schedule\": {\n \"interval\": \"month\",\n \"start_date\": \"2020-09-03T11:30:00.000Z\",\n \"end_date\": \"2020-09-25T19:05:11.000Z\",\n \"end_amount_after\": 0,\n \"end_amount_before\": 0,\n \"end_amount_total\": 0,\n \"next_assessment\": \"2020-09-03T11:30:00.000Z\",\n \"next_assessment_planned\": \"2020-09-03T11:30:00.000Z\",\n \"first_assessment\": \"2020-09-03T11:30:00.000Z\",\n \"status\": \"inprogress\",\n \"locked\": false,\n \"completed_count\": 0,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\"\n }\n }\n}"},{"id":"808bf0af-1dd5-4785-9632-b19be07e69b6","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":"PayDock "},{"key":"ETag","value":"W/\"3ee-XqVcGUfFi5ejwblVXGiMfg\""},{"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\": \"subscription\",\n \"data\": {\n \"__v\": 0,\n \"created_at\": \"2020-09-03T09:50:26.022Z\",\n \"updated_at\": \"2020-09-03T09:50:26.022Z\",\n \"amount\": 10,\n \"description\": \"Vitae commodi provident assumenda\",\n \"reference\": \"Fuga consequuntur sint ab magnam\",\n \"status\": \"active\",\n \"_id\": \"5f50bc6280c950150a603648\",\n \"archived\": false,\n \"_service\": {\n \"customer_default_gateway_id\": \"5dde1f3799cfea21ed2fc942\",\n \"tags\": \"undefined undefined undefined\"\n },\n \"customer\": {\n \"customer_id\": \"5f50bc6080c950150a603646\"\n },\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n },\n \"schedule\": {\n \"interval\": \"month\",\n \"start_date\": \"2020-09-03T11:30:00.000Z\",\n \"end_date\": \"2020-09-25T19:05:11.000Z\",\n \"end_amount_after\": 0,\n \"end_amount_before\": 0,\n \"end_amount_total\": 0,\n \"next_assessment\": \"2020-09-03T11:30:00.000Z\",\n \"next_assessment_planned\": \"2020-09-03T11:30:00.000Z\",\n \"first_assessment\": \"2020-09-03T11:30:00.000Z\",\n \"status\": \"inprogress\",\n \"locked\": false,\n \"completed_count\": 0,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\"\n }\n }\n}"},{"id":"94aac3e9-934f-4075-975d-aa7b04e46394","name":"create direct with bank-account","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\": \"5e259f7881910626190d0433\",\n \"type\": \"bank_account\",\n \"account_name\": \"test test\", \n \"account_number\": \"064000\",\n \"account_routing\": \"064000\"\n }\n },\n \"schedule\": {\n \"frequency\": \"1\",\n \"interval\": \"day\",\n \"start_date\": \"2020-08-23\",\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:27:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1004"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"3ec-NTIv2cAX4Qn9O4obTPjS7A\""},{"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\": \"subscription\",\n \"data\": {\n \"__v\": 0,\n \"created_at\": \"2020-09-03T09:27:58.427Z\",\n \"updated_at\": \"2020-09-03T09:27:58.427Z\",\n \"amount\": 10,\n \"description\": \"Vitae commodi provident assumenda\",\n \"reference\": \"Fuga consequuntur sint ab magnam\",\n \"status\": \"active\",\n \"_id\": \"5f50b71e80c950150a603644\",\n \"archived\": false,\n \"_service\": {\n \"customer_default_gateway_id\": \"5e259f7881910626190d0433\",\n \"tags\": \"undefined undefined undefined\"\n },\n \"customer\": {\n \"customer_id\": \"5f50b71580c950150a603641\"\n },\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n },\n \"schedule\": {\n \"interval\": \"day\",\n \"start_date\": \"2020-09-03T11:30:00.000Z\",\n \"end_date\": \"2020-09-25T19:05:11.000Z\",\n \"end_amount_after\": 0,\n \"end_amount_before\": 0,\n \"end_amount_total\": 0,\n \"next_assessment\": \"2020-09-03T11:30:00.000Z\",\n \"next_assessment_planned\": \"2020-09-03T11:30:00.000Z\",\n \"first_assessment\": \"2020-09-03T11:30:00.000Z\",\n \"status\": \"inprogress\",\n \"locked\": false,\n \"completed_count\": 0,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\"\n }\n }\n}"}],"_postman_id":"707ceeab-928d-4a21-baab-ab1ea069a1a3"},{"name":"delete","id":"d8fb752b-d259-49d1-bdc1-de40d284d00d","protocolProfileBehavior":{"disableBodyPruning":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/subscriptions/:id","description":"

Delete Subscription to change subsscription status to \"deleted\". You can still retrieve subscriptions with \"deleted\" status.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","subscriptions",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5ef064763dcfec0ac5e0622e","key":"id"}]}},"response":[{"id":"77462d07-96d7-4b8d-a198-ab43dfb8f656","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":"PayDock "},{"key":"ETag","value":"W/\"46e-iPQ+do6Cnmj+5B3eVPeyqQ\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"subscription\",\n \"data\": {\n \"_id\": \"5ef064763dcfec0ac5e0622e\",\n \"created_at\": \"2020-06-22T07:57:42.963Z\",\n \"updated_at\": \"2020-09-03T07:47:59.749Z\",\n \"amount\": 12,\n \"status\": \"deleted\",\n \"latest_charge_id\": \"5ef99f168bbc123baf1507f4\",\n \"expired_at\": \"2020-06-29T07:58:15.019Z\",\n \"expired_reason\": \"end_date\",\n \"last_change_by\": \"manual\",\n \"archived\": false,\n \"customer\": {\n \"customer_id\": \"5ef064763dcfec0ac5e0622b\",\n \"first_name\": \"Eduard\",\n \"last_name\": \"Nakon\",\n \"email\": \"eduard.n@houstonapps.co\",\n \"phone\": \"+380995222655\",\n \"company_name\": \"Ed\"\n },\n \"statistics\": {\n \"total_collected_amount\": 96,\n \"successful_transactions\": 8\n },\n \"schedule\": {\n \"interval\": \"day\",\n \"start_date\": \"2020-06-22T07:57:42.066Z\",\n \"end_date\": \"2020-06-29T21:00:00.000Z\",\n \"next_assessment\": \"2020-06-29T07:57:42.066Z\",\n \"next_assessment_planned\": \"2020-06-29T07:57:42.066Z\",\n \"first_assessment\": \"2020-06-22T07:57:42.066Z\",\n \"status\": \"complete\",\n \"processing_pended_at\": \"2020-06-29T07:59:02.065Z\",\n \"last_assessment_planned\": \"2020-06-28T07:57:42.066Z\",\n \"last_assessment\": \"2020-06-29T07:58:15.025Z\",\n \"locked\": false,\n \"completed_count\": 8,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\"\n }\n }\n}"}],"_postman_id":"d8fb752b-d259-49d1-bdc1-de40d284d00d"},{"name":"modify","id":"cd745a14-1af0-4848-8582-0fe020799dc7","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\t\"status\": \"active\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/subscriptions/:id","description":"

Flow

Change status from expired to active(schedule.start_date field is required).
Change status from deleted to active(schedule.start_date field is required).
Modify for a subscription with deleted status is forbidden.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

Request body

field	required[flow]	type	description
amount	-	float	Amount of payment
currency	-	string (iso4217 alpha-3)	Currency code
description	-	string	Manually defined description for payments in payment systems
reference	-	string	Manually defined reference for customer in payment systems
payment_source_id	-	string(24 byte hex)	The payment source to be used to pay for the subscription, generally use a payment source retrieved from a customer
status	-	string	Set “active” to reactivate failed subscription
schedule	-	object	Object with subscription schedule information
schedule.interval	+	string	Assessment interval one-off, week, month, year, day
schedule.frequency	+	string(numeric)	Assessment frequency, 1 by default (i.e. “3” = “Every 3 weeks”)
schedule.start_date	+	string(Date)	Start date, ISO 8601 format (yyyy-mm-ddThh:mm:ss.sssZ) or short type of date (yyyy-mm-dd) or specify time offsets from UTC (yyyy-mm-ddThh:mm:ss+hh:mm)
schedule.end_date	-	string(Date)	End date, ISO 8601 format (yyyy-mm-ddThh:mm:ss.sssZ) or short type of date (yyyy-mm-dd) or specify time offsets from UTC (yyyy-mm-ddThh:mm:ss+hh:mm)
schedule.end_amount_after	-	float	Total amount of all successful transactions (equals or exceeds)
schedule.end_amount_before	-	float	Total amount of all successful transactions (not to exceed)
schedule.end_amount_total	-	float	Total amount to be paid with subscription (equals). NOTE: If last payment of subscription schedule will be less then $ 1.00, some gateways may respond with error and subscription status will become ‘failed’.
schedule.end_transactions	-	integer	Total count of all successful transactions

","urlObject":{"path":["v1","subscriptions",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5f50f59580c950150a6038a9","key":"id"}]}},"response":[{"id":"256c9bd1-9393-4b2d-98c9-45d1e7566418","name":"modify change status from 'deleted' to 'active'","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\": \"active\",\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":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Sun, 13 Sep 2020 19:28:20 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1379"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"563-3T0ztHBtjXw38sPBgcnGMA\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"subscription\",\n \"data\": {\n \"_id\": \"5f5e1eb189201b0866d045f5\",\n \"created_at\": \"2020-09-13T13:29:21.404Z\",\n \"updated_at\": \"2020-09-13T19:28:20.201Z\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 12,\n \"description\": \"desc\",\n \"reference\": \"ref\",\n \"status\": \"active\",\n \"held_at\": \"2020-09-13T17:18:33.126Z\",\n \"last_change_by\": \"manual\",\n \"payment_source_id\": \"5f5e1eb189201b0866d045f3\",\n \"retry\": {\n \"fail_status\": \"faild\",\n \"limit\": 2,\n \"frequency\": 1,\n \"interval\": \"day\"\n },\n \"archived\": false,\n \"_source_ip_address\": \"77.122.20.89\",\n \"customer\": {\n \"customer_id\": \"5f5e1eb089201b0866d045f2\",\n \"first_name\": \"Alex\",\n \"last_name\": \"Voloshyn\",\n \"email\": \"alex545456v@gmail.com\",\n \"phone\": \"+1234567890\",\n \"reference\": \"Ololo PTY Ltd\",\n \"company_name\": \"Ololo PTY Ltd\"\n },\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n },\n \"schedule\": {\n \"interval\": \"month\",\n \"start_date\": \"2020-09-14T21:00:00.000Z\",\n \"end_amount_after\": 0,\n \"end_amount_before\": 0,\n \"end_amount_total\": 0,\n \"next_assessment\": \"2020-09-14T21:00:00.000Z\",\n \"next_assessment_planned\": \"2020-09-14T21:00:00.000Z\",\n \"first_assessment\": \"2020-09-14T21:00:00.000Z\",\n \"status\": \"inprogress\",\n \"end_date\": \"2020-09-19T11:30:00.000Z\",\n \"end_transactions\": null,\n \"locked\": false,\n \"completed_count\": 0,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n }\n }\n}"},{"id":"443df484-ab52-4204-93aa-ce8f846ea3f0","name":"modify status to \"held\"","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\": \"held\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/subscriptions/:id","host":["{{url}}"],"path":["v1","subscriptions",":id"],"variable":[{"key":"id","value":"5f50f59580c950150a6038a9"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 03 Sep 2020 14:19:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1463"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"5b7-msl9aRzaUzBaAZN9M1Xz3Q\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"subscription\",\n \"data\": {\n \"held_at\": \"2020-09-03T14:19:39.840Z\",\n \"last_change_by\": \"manual\",\n \"_id\": \"5f50f59580c950150a6038a9\",\n \"created_at\": \"2020-09-03T13:54:29.655Z\",\n \"updated_at\": \"2020-09-03T14:19:39.842Z\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 10,\n \"description\": \"Vitae commodi provident assumenda\",\n \"reference\": \"Fuga consequuntur sint ab magnam\",\n \"status\": \"held\",\n \"latest_charge_id\": \"5f50f5a980c950150a6038ad\",\n \"payment_source_id\": \"5f50f59580c950150a6038a7\",\n \"retry\": null,\n \"archived\": false,\n \"_source_ip_address\": \"77.122.20.89\",\n \"customer\": {\n \"customer_id\": \"5f50f59480c950150a6038a6\",\n \"first_name\": \"Samantha\",\n \"last_name\": \"Washington\",\n \"email\": \"samwashington@gmail.com\",\n \"reference\": \"CustomReference\"\n },\n \"statistics\": {\n \"total_collected_amount\": 10,\n \"successful_transactions\": 1\n },\n \"schedule\": {\n \"interval\": \"month\",\n \"start_date\": \"2020-09-03T11:30:00.000Z\",\n \"end_amount_after\": 0,\n \"end_amount_before\": 0,\n \"end_amount_total\": 0,\n \"next_assessment\": \"2020-10-03T11:30:00.000Z\",\n \"next_assessment_planned\": \"2020-10-03T11:30:00.000Z\",\n \"first_assessment\": \"2020-09-03T11:30:00.000Z\",\n \"status\": \"complete\",\n \"processing_pended_at\": \"2020-09-03T14:34:49.406Z\",\n \"last_assessment_planned\": \"2020-09-03T11:30:00.000Z\",\n \"last_assessment\": \"2020-09-03T13:54:50.435Z\",\n \"locked\": false,\n \"completed_count\": 1,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"UAH\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n }\n }\n}"},{"id":"56b09f0c-d060-4521-ab37-3903e36fa5ac","name":"modify status to \"active\"","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\": \"active\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/subscriptions/:id","host":["{{url}}"],"path":["v1","subscriptions",":id"],"variable":[{"key":"id","value":"5f50f59580c950150a6038a9"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 03 Sep 2020 14:20:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1465"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"5b9-0OaqJaJ6rWXyaE0OozmHrw\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"subscription\",\n \"data\": {\n \"_id\": \"5f50f59580c950150a6038a9\",\n \"created_at\": \"2020-09-03T13:54:29.655Z\",\n \"updated_at\": \"2020-09-03T14:20:17.658Z\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 10,\n \"description\": \"Vitae commodi provident assumenda\",\n \"reference\": \"Fuga consequuntur sint ab magnam\",\n \"status\": \"active\",\n \"latest_charge_id\": \"5f50f5a980c950150a6038ad\",\n \"payment_source_id\": \"5f50f59580c950150a6038a7\",\n \"held_at\": \"2020-09-03T14:19:39.840Z\",\n \"last_change_by\": \"manual\",\n \"retry\": null,\n \"archived\": false,\n \"_source_ip_address\": \"77.122.20.89\",\n \"customer\": {\n \"customer_id\": \"5f50f59480c950150a6038a6\",\n \"first_name\": \"Samantha\",\n \"last_name\": \"Washington\",\n \"email\": \"samwashington@gmail.com\",\n \"reference\": \"CustomReference\"\n },\n \"statistics\": {\n \"total_collected_amount\": 10,\n \"successful_transactions\": 1\n },\n \"schedule\": {\n \"interval\": \"month\",\n \"start_date\": \"2020-09-03T11:30:00.000Z\",\n \"end_amount_after\": 0,\n \"end_amount_before\": 0,\n \"end_amount_total\": 0,\n \"next_assessment\": \"2020-10-03T11:30:00.000Z\",\n \"next_assessment_planned\": \"2020-10-03T11:30:00.000Z\",\n \"first_assessment\": \"2020-09-03T11:30:00.000Z\",\n \"status\": \"complete\",\n \"processing_pended_at\": \"2020-09-03T14:34:49.406Z\",\n \"last_assessment_planned\": \"2020-09-03T11:30:00.000Z\",\n \"last_assessment\": \"2020-09-03T13:54:50.435Z\",\n \"locked\": false,\n \"completed_count\": 1,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"UAH\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n }\n }\n}"},{"id":"5bc0edd7-d052-42a3-920d-9772bed2de53","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":"PayDock "},{"key":"ETag","value":"W/\"19d-SV0FC0Z0y1PkpAUqP45m0w\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"Validation error\",\n \"code\": \"ValidationError\",\n \"details\": [\n \"Subscription Cancelled. Please provide new status when updating cancelled subscription\"\n ]\n },\n \"resource\": {\n \"type\": \"subscription\",\n \"data\": null\n },\n \"error_summary\": {\n \"message\": \"Validation error\",\n \"code\": \"validation_error\",\n \"details\": {\n \"messages\": [\n \"Subscription Cancelled. Please provide new status when updating cancelled subscription\"\n ]\n }\n }\n}"},{"id":"5c163469-c2dd-4718-be91-7622e59324a8","name":"assign to another payment source","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\"payment_source_id\": \"5f50f59580c950150a6038a7\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/subscriptions/:id","host":["{{url}}"],"path":["v1","subscriptions",":id"],"variable":[{"key":"id","value":"5f50f59580c950150a6038a9"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 03 Sep 2020 14:18:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1402"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"57a-ucncohGWpeIc8qkODo1gQA\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"subscription\",\n \"data\": {\n \"payment_source_id\": \"5f50f59580c950150a6038a7\",\n \"_id\": \"5f50f59580c950150a6038a9\",\n \"created_at\": \"2020-09-03T13:54:29.655Z\",\n \"updated_at\": \"2020-09-03T14:18:42.037Z\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 10,\n \"description\": \"Vitae commodi provident assumenda\",\n \"reference\": \"Fuga consequuntur sint ab magnam\",\n \"status\": \"active\",\n \"latest_charge_id\": \"5f50f5a980c950150a6038ad\",\n \"retry\": null,\n \"archived\": false,\n \"_source_ip_address\": \"77.122.20.89\",\n \"customer\": {\n \"customer_id\": \"5f50f59480c950150a6038a6\",\n \"first_name\": \"Samantha\",\n \"last_name\": \"Washington\",\n \"email\": \"samwashington@gmail.com\",\n \"reference\": \"CustomReference\"\n },\n \"statistics\": {\n \"total_collected_amount\": 10,\n \"successful_transactions\": 1\n },\n \"schedule\": {\n \"interval\": \"month\",\n \"start_date\": \"2020-09-03T11:30:00.000Z\",\n \"end_amount_after\": 0,\n \"end_amount_before\": 0,\n \"end_amount_total\": 0,\n \"next_assessment\": \"2020-10-03T11:30:00.000Z\",\n \"next_assessment_planned\": \"2020-10-03T11:30:00.000Z\",\n \"first_assessment\": \"2020-09-03T11:30:00.000Z\",\n \"status\": \"complete\",\n \"processing_pended_at\": \"2020-09-03T14:34:49.406Z\",\n \"last_assessment_planned\": \"2020-09-03T11:30:00.000Z\",\n \"last_assessment\": \"2020-09-03T13:54:50.435Z\",\n \"locked\": false,\n \"completed_count\": 1,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"UAH\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n }\n }\n}"},{"id":"c9a0c467-3199-4cc9-a496-4a431982f9c8","name":"modify change status from 'expired' to 'active'","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\": \"active\",\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":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Sun, 13 Sep 2020 19:24:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1379"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"563-JXXJ+OVE6HgcaUAbfapKTA\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"subscription\",\n \"data\": {\n \"_id\": \"5f5e1eb189201b0866d045f5\",\n \"created_at\": \"2020-09-13T13:29:21.404Z\",\n \"updated_at\": \"2020-09-13T19:24:22.242Z\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 12,\n \"description\": \"desc\",\n \"reference\": \"ref\",\n \"status\": \"active\",\n \"held_at\": \"2020-09-13T17:18:33.126Z\",\n \"last_change_by\": \"manual\",\n \"payment_source_id\": \"5f5e1eb189201b0866d045f3\",\n \"retry\": {\n \"fail_status\": \"faild\",\n \"limit\": 2,\n \"frequency\": 1,\n \"interval\": \"day\"\n },\n \"archived\": false,\n \"_source_ip_address\": \"77.122.20.89\",\n \"customer\": {\n \"customer_id\": \"5f5e1eb089201b0866d045f2\",\n \"first_name\": \"Alex\",\n \"last_name\": \"Voloshyn\",\n \"email\": \"alex545456v@gmail.com\",\n \"phone\": \"+1234567890\",\n \"reference\": \"Ololo PTY Ltd\",\n \"company_name\": \"Ololo PTY Ltd\"\n },\n \"statistics\": {\n \"total_collected_amount\": 0,\n \"successful_transactions\": 0\n },\n \"schedule\": {\n \"interval\": \"month\",\n \"start_date\": \"2020-09-14T21:00:00.000Z\",\n \"end_amount_after\": 0,\n \"end_amount_before\": 0,\n \"end_amount_total\": 0,\n \"next_assessment\": \"2020-09-14T21:00:00.000Z\",\n \"next_assessment_planned\": \"2020-09-14T21:00:00.000Z\",\n \"first_assessment\": \"2020-09-14T21:00:00.000Z\",\n \"status\": \"inprogress\",\n \"end_date\": \"2020-09-19T11:30:00.000Z\",\n \"end_transactions\": null,\n \"locked\": false,\n \"completed_count\": 0,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"AUD\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n }\n }\n}"},{"id":"e6ed7d29-5dd9-40fb-9801-e3b97859685d","name":"modify currency","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\"currency\": \"UAH\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/subscriptions/:id","host":["{{url}}"],"path":["v1","subscriptions",":id"],"variable":[{"key":"id","value":"5f50f59580c950150a6038a9"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 03 Sep 2020 14:05:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1355"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"54b-WzGqyD5QpgWWisxpu/4gvA\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"subscription\",\n \"data\": {\n \"_id\": \"5f50f59580c950150a6038a9\",\n \"created_at\": \"2020-09-03T13:54:29.655Z\",\n \"updated_at\": \"2020-09-03T14:05:41.640Z\",\n \"user_id\": \"5d305bfbfac31b4448c738d6\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"amount\": 10,\n \"description\": \"Vitae commodi provident assumenda\",\n \"reference\": \"Fuga consequuntur sint ab magnam\",\n \"status\": \"active\",\n \"latest_charge_id\": \"5f50f5a980c950150a6038ad\",\n \"retry\": null,\n \"archived\": false,\n \"_source_ip_address\": \"77.122.20.89\",\n \"customer\": {\n \"customer_id\": \"5f50f59480c950150a6038a6\",\n \"first_name\": \"Samantha\",\n \"last_name\": \"Washington\",\n \"email\": \"samwashington@gmail.com\",\n \"reference\": \"CustomReference\"\n },\n \"statistics\": {\n \"total_collected_amount\": 10,\n \"successful_transactions\": 1\n },\n \"schedule\": {\n \"interval\": \"month\",\n \"start_date\": \"2020-09-03T11:30:00.000Z\",\n \"end_amount_after\": 0,\n \"end_amount_before\": 0,\n \"end_amount_total\": 0,\n \"next_assessment\": \"2020-10-03T11:30:00.000Z\",\n \"next_assessment_planned\": \"2020-10-03T11:30:00.000Z\",\n \"first_assessment\": \"2020-09-03T11:30:00.000Z\",\n \"status\": \"complete\",\n \"processing_pended_at\": \"2020-09-03T14:34:49.406Z\",\n \"last_assessment_planned\": \"2020-09-03T11:30:00.000Z\",\n \"last_assessment\": \"2020-09-03T13:54:50.435Z\",\n \"locked\": false,\n \"completed_count\": 1,\n \"held_count\": 0,\n \"retry_count\": 0,\n \"frequency\": 1\n },\n \"currency\": \"UAH\",\n \"gateway_type\": \"Stripe\",\n \"gateway_name\": \"Stripe 1\",\n \"gateway_mode\": \"test\"\n }\n }\n}"}],"_postman_id":"cd745a14-1af0-4848-8582-0fe020799dc7"}],"id":"9b0a675f-b24e-4335-927f-d7d2f08590b7","description":"

Subscriptions are recurring billing events. These can be set up to take scheduled payments from a customer without having to re-enter the billing details.

Conditions

The response is different depends on such conditions:

Created with credit card payment source
\n
Created with the bank account payment source
\n
Created with an existed customer
\n
Created with one-time token
\n

Subscription resource

field	required[flow]	type	description
amount	+	float	Amount of payment
currency	+	string (iso4217 alpha-3)	Currency code
description	-	string	Manually defined description for payments in payment systems
reference	-	string	Manually defined reference for customer in payment systems
_id	+	string (24 byte hex)	Charge Id for any future requests
created_at	+	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Charge creation date
updated_at	+	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Date of last charge update
status	+	string	Actual charge status. See the status table
held_at	+	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Charge held start time
expired_at	+	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Charge expiration time
expired_reason	+	string	Actual expiration reason. See the Expire reason table
last_change_by	+	string	Carge was last time changed by. Values: manual or automatic
latest_charge_id	+	string (24 byte hex)	Latest charge id of subscription
archived	+	bool	For new created charges always false, true after manual archiving
customer	+	object	Object with the customer’s information.
customer.customer_id	+3	string (24 byte hex)	Customer ID
customer.first_name	-	string	Customer first name
customer.last_name	-	string	Customer last name
customer.email	-	string	Customer email
customer.phone	-	string(E.164)	Customer phone in E.164 international notation (Example: +12345678901)
customer.payment_source	+	object	Object with payment information
customer.payment_source.source_id	+3, -4	string (24 byte hex)	Payment source ID
customer.payment_source.gateway_id	+	string (24 byte hex)	Gateway id
customer.payment_source.gateway_type	+	string	Type of gateway
customer.payment_source.gateway_name	+	string	Custom name of of gateway
customer.payment_source.type	+	string	Type of payment. card for payment with credit card, bank_account for direct debit payments
customer.payment_source.card_name	+1	string	Cardholder name (as on card)
customer.payment_source.card_number_last4	+1	string(numeric)	Card number last 4
customer.payment_source.card_scheme	+1	string	Cardholder scheme (i.g. visa, mastercard etc...)
customer.payment_source.expire_month	+1	string(mm)	Card expiration month mm
customer.payment_source.expire_year	+1	string(yyyy)	Card expiration year
customer.payment_source.account_name	+2	string	Customer account name.
customer.payment_source.account_number	+2	string	Number of Customer account.
customer.payment_source.account_bsb	-2	string	Customer bank state branch number.
customer.payment_source.account_routing	-2	string(numeric)	Number of Customer account. BSB/Routing/SWIFT/IBAN Number.
customer.payment_source.account_holder_type	-2	string	account type (personal or business)
customer.payment_source.account_bank_name	-2	string	Name of account bank
customer.payment_source.address_line1	-	string	Customer Address, line 1
customer.payment_source.address_line2	-	string	Customer Address, line 2
customer.payment_source.address_state	-	string	Customer Address, State
customer.payment_source.address_country	-	string	Customer Address, Country Code
customer.payment_source.address_city	-	string	Customer Address, City
customer.payment_source.address_postcode	-	string(numeric)	Customer Address, Postcade
schedule	+	object	Object with subscription schedule information
schedule.interval	+	string	Assessment interval one-off, week, month, year, day
schedule.next_assessment	+	string(Date)	Date of next subscription assesssment
schedule.first_assessment	+	string(Date)	Date of first subscription assesssment
schedule.status	+	string	Status of schedule. Look at the Schedule status table
schedule.locked	+	boolean	Locked state of schedule
schedule.completed_count	+	integer	Count of successful transactions
schedule.retry_count	+	integer	Count of unsuccessful transactions
schedule.frequency	+	string(numeric)	Assessment frequency, 1 by default (i.e. “3” = “Every 3 weeks”)
schedule.start_date	-	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Start date, ISO 8601 format (yyyy-mm-ddThh:mm:ss.sssZ) or short type of date (yyyy-mm-dd)
schedule.end_date	-	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	End date, ISO 8601 format (yyyy-mm-ddThh:mm:ss.sssZ) or short type of date (yyyy-mm-dd)
schedule.end_amount_after	-	float	Total amount of all successful transactions (equals or exceeds)
schedule.end_amount_before	-	float	Total amount of all successful transactions (not to exceed)
schedule.end_amount_total	-	float	Total amount to be paid with subscription (equals). NOTE: If last payment of subscription schedule will be less then $ 1.00, some gateways may respond with error and subscription status will become ‘failed’.
schedule.end_transactions	-	integer	Total count of all successful transactions
statistics	+	object	Object with statistic info by charge
statistics.successful_transactions	+	number	Number of succesfull transactions
statistics.total_collected_amount	+	number	Total amount by subscription
meta	-	object	Optional object with specific fields for different gateways
meta.account_id	-	string	ID of an existing, connected stripe account. Use to create Stripe connect Direct Charges
retry	-	object	Optional object with specific fields for retry settings
retry.limit	-	integer	Custom retry limit settings for current subscription
retry.frequency	-	integer	Custom retry frequency settings for current subscription
retry.interval	-	string	Custom retry interval settings for current subscription
retry.fail_status	-	string	Custom retry fail_status settings for current subscription. Values: active, held, failed, deleted

Status

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status	description
active	A subscription that is active and has more payments to be collected
complete	A subscription that is complete, where all payments have been collected
deleted	A subscription has been removed
failed	This typically occurs when the number of failed payments has been exceeded (see details of an error)
expired	A subscription that is complete, where end date parameter becomes
held	A subscription was manually held

Expire reason

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status	description
manual	A subscription was expired manualy
end_date	A subscription was expired by end date settings
end_amount_total	A subscription was expired by total amount settings
end_amount_before	A subscription was expired by before ampout settings
end_amount_after	A subscription was expired by after amount settings
end_transactions	A subscription was expired by count of transaction settings

Schedule status

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status	description
complete	Last schedule processing finished successfully
failed	Last schedule processing finished unsuccessfully
inprogress	Schedule is processing at the moment
held	A schedule that is complete, where subscription on the held status

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"99806734-032e-42cf-90b2-755c66e472d5"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"70598407-a094-4070-9665-2f417fbd17ff"}}],"_postman_id":"9b0a675f-b24e-4335-927f-d7d2f08590b7"},{"name":"transfers","item":[{"name":"search","id":"09f27334-6007-4a5d-a861-603ddc6a1a1e","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

Request query params

Pagination

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required[flow]	type	description
skip	-	number	Pagination parameter to skip first n subscriptions from list, default = 0
limit	-	number	Pagination parameter to limit output to n , default = 100 , maximum value = 1000

filters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required[flow]	type	description
archived	-	bool	true or false

","urlObject":{"path":["v1","transfers"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"203dd3e8-5254-4f0a-b9b7-215bca8dfb35","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":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-info-limit","value":"100"},{"key":"x-info-skip","value":"0"},{"key":"x-info-sort-key","value":"created_at"},{"key":"x-info-sort-direction","value":"DESC"},{"key":"x-info-count","value":"1"},{"key":"etag","value":"W/\"19a-GjAvkZPFe7qwpgk38CGnDlko4vI\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"transfers\",\n \"data\": [\n {\n \"_id\": \"5e1874032139a47666c372f4\",\n \"created_at\": \"2020-01-10T12:54:27.532Z\",\n \"updated_at\": \"2020-01-10T12:54:27.532Z\",\n \"description\": \"sdfdfsdf\",\n \"reference\": \"sdfsdfsdfsdsdf\",\n \"gateway_id\": \"5df1e8a28dfcf018377928fd\",\n \"status\": \"pending\",\n \"__v\": 0,\n \"payouts\": [],\n \"capture\": false\n }\n ],\n \"skip\": 0,\n \"limit\": 100,\n \"sortkey\": \"created_at\",\n \"sortdirection\": \"DESC\",\n \"count\": 1\n }\n}"},{"id":"9f31fa3f-ed0c-4d98-b694-4f2d26b4618b","name":"search with pagination","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?skip=2&limit=1","host":["{{url}}"],"path":["v1","transfers"],"query":[{"key":"skip","value":"2"},{"key":"limit","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 07 Sep 2020 11:22:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"501"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-info-limit","value":"1"},{"key":"x-info-skip","value":"2"},{"key":"x-info-sort-key","value":"created_at"},{"key":"x-info-sort-direction","value":"DESC"},{"key":"x-info-count","value":"8"},{"key":"etag","value":"W/\"1f5-/3NGkj395yTtYgpRJQpRr3zgRMM\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"transfers\",\n \"data\": [\n {\n \"_id\": \"5e18669d2139a47666c372e4\",\n \"created_at\": \"2020-01-10T11:57:17.779Z\",\n \"updated_at\": \"2020-01-10T11:57:20.524Z\",\n \"description\": \"aaaaaaaa\",\n \"reference\": \"aaaaaaaa\",\n \"gateway_id\": \"5df1e8a28dfcf018377928fd\",\n \"status\": \"requested\",\n \"__v\": 0,\n \"external_id\": \"PB.2k8z\",\n \"payouts\": [],\n \"capture\": false,\n \"schedule\": {\n \"status_pended_at\": \"2020-01-10T10:02:38.128Z\",\n \"locked\": true\n }\n }\n ],\n \"skip\": 2,\n \"limit\": 1,\n \"sortkey\": \"created_at\",\n \"sortdirection\": \"DESC\",\n \"count\": 8\n }\n}"}],"_postman_id":"09f27334-6007-4a5d-a861-603ddc6a1a1e"},{"name":"get","id":"ddd4656c-c8b5-4edc-9af6-a9021fa40457","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/:id","description":"

Retrieves data on a transfer with specified ID.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","transfers",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5e1874032139a47666c372f4","key":"id"}]}},"response":[{"id":"bc3c17ce-c4a4-4371-89d5-d4359d0a8d1e","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":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"999-SXWbrSK/+ITu3ZPtcwPUbBJALPI\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"transfer\",\n \"data\": {\n \"_id\": \"5e1874032139a47666c372f4\",\n \"created_at\": \"2020-01-10T12:54:27.532Z\",\n \"updated_at\": \"2020-09-07T11:27:41.848Z\",\n \"description\": \"sdfdfsdf\",\n \"reference\": \"sdfsdfsdfsdsdf\",\n \"gateway_id\": \"5df1e8a28dfcf018377928fd\",\n \"status\": \"pending\",\n \"__v\": 0,\n \"payouts\": [\n {\n \"_id\": \"5e1874032139a47666c372f5\",\n \"created_at\": \"2020-01-10T12:54:27.539Z\",\n \"updated_at\": \"2020-01-10T12:55:04.194Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"customer_id\": \"5df399bd9327e850a73e97c5\",\n \"payment_destination_id\": \"5df399bd9327e850a73e97c6\",\n \"transfer_id\": \"5e1874032139a47666c372f4\",\n \"status\": \"pending\",\n \"__v\": 2,\n \"transactions\": [\n {\n \"created_at\": \"2020-01-10T12:54:29.829Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"type\": \"transfer\",\n \"status\": \"pending\",\n \"_id\": \"5e1874052139a47666c372f8\",\n \"service_logs\": [],\n \"_source_ip_address\": \"127.0.0.1\"\n },\n {\n \"created_at\": \"2020-01-10T12:55:04.194Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"type\": \"transfer\",\n \"status\": \"pending\",\n \"_id\": \"5e1874282139a47666c372fe\",\n \"service_logs\": [],\n \"_source_ip_address\": \"127.0.0.1\"\n }\n ]\n },\n {\n \"_id\": \"5e1874032139a47666c372f6\",\n \"created_at\": \"2020-01-10T12:54:27.544Z\",\n \"updated_at\": \"2020-01-10T12:55:04.216Z\",\n \"amount\": 15,\n \"currency\": \"GBP\",\n \"customer_id\": \"5df399bd9327e850a73e97c5\",\n \"payment_destination_id\": \"5df399bd9327e850a73e97c6\",\n \"transfer_id\": \"5e1874032139a47666c372f4\",\n \"status\": \"pending\",\n \"__v\": 2,\n \"transactions\": [\n {\n \"created_at\": \"2020-01-10T12:54:29.841Z\",\n \"amount\": 15,\n \"currency\": \"GBP\",\n \"type\": \"transfer\",\n \"status\": \"pending\",\n \"_id\": \"5e1874052139a47666c372f9\",\n \"service_logs\": [],\n \"_source_ip_address\": \"127.0.0.1\"\n },\n {\n \"created_at\": \"2020-01-10T12:55:04.216Z\",\n \"amount\": 15,\n \"currency\": \"GBP\",\n \"type\": \"transfer\",\n \"status\": \"pending\",\n \"_id\": \"5e1874282139a47666c372ff\",\n \"service_logs\": [],\n \"_source_ip_address\": \"127.0.0.1\"\n }\n ]\n },\n {\n \"_id\": \"5e1874032139a47666c372f7\",\n \"created_at\": \"2020-01-10T12:54:27.548Z\",\n \"updated_at\": \"2020-01-10T12:55:04.233Z\",\n \"amount\": 20,\n \"currency\": \"USD\",\n \"customer_id\": \"5df399bd9327e850a73e97c5\",\n \"payment_destination_id\": \"5df399bd9327e850a73e97c6\",\n \"transfer_id\": \"5e1874032139a47666c372f4\",\n \"status\": \"pending\",\n \"__v\": 2,\n \"transactions\": [\n {\n \"created_at\": \"2020-01-10T12:54:29.849Z\",\n \"amount\": 20,\n \"currency\": \"USD\",\n \"type\": \"transfer\",\n \"status\": \"pending\",\n \"_id\": \"5e1874052139a47666c372fa\",\n \"service_logs\": [],\n \"_source_ip_address\": \"127.0.0.1\"\n },\n {\n \"created_at\": \"2020-01-10T12:55:04.233Z\",\n \"amount\": 20,\n \"currency\": \"USD\",\n \"type\": \"transfer\",\n \"status\": \"pending\",\n \"_id\": \"5e1874282139a47666c37300\",\n \"service_logs\": [],\n \"_source_ip_address\": \"127.0.0.1\"\n }\n ]\n }\n ],\n \"capture\": false,\n \"logs\": []\n }\n }\n}"}],"_postman_id":"ddd4656c-c8b5-4edc-9af6-a9021fa40457"},{"name":"create","id":"19d9de50-2807-4b2d-896c-4ba6d08512b0","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 \"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.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required[flow]	type	description
description	-	string	Manually defined description for payments in payment systems
reference	-	string	Manually defined reference for customer in payment systems
gateway_id	+	string (24 byte hex)	Existing gateway ID(should be the same as gateway_id from customer entity which set to payouts array)
payouts	+	array	Array with the payout's information
payouts.amount	+	float	Amount of payment
payouts.currency	+	string (iso4217 alpha-3)	Currency code
payouts.customer_id	+	string (24 byte hex)	Existing customer ID after payment destination creating

","urlObject":{"path":["v1","transfers"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"e46d5f68-adc0-47fe-acb7-cb9df07a0d09","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":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"2b7-Gqy3jL5Hhfmj0wvS6qO9TOvQ0vc\""},{"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\": \"transfer\",\n \"data\": {\n \"_id\": \"5f562c3fbb8a75181d42c1ca\",\n \"created_at\": \"2020-09-07T12:49:03.459Z\",\n \"updated_at\": \"2020-09-07T12:49:03.459Z\",\n \"description\": \"Vitae commodi provident assumenda\",\n \"reference\": \"Fuga consequuntur sint ab magnam\",\n \"gateway_id\": \"5df1e8a28dfcf018377928fd\",\n \"status\": \"pending\",\n \"__v\": 0,\n \"payouts\": [\n {\n \"_id\": \"5f562c3fbb8a75181d42c1cb\",\n \"created_at\": \"2020-09-07T12:49:03.464Z\",\n \"updated_at\": \"2020-09-07T12:49:03.464Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"customer_id\": \"5f50f59480c950150a6038a6\",\n \"payment_destination_id\": \"5f561f6bbb8a75181d42c196\",\n \"transfer_id\": \"5f562c3fbb8a75181d42c1ca\",\n \"status\": \"pending\",\n \"__v\": 0,\n \"transactions\": []\n }\n ],\n \"capture\": false\n }\n }\n}"}],"_postman_id":"19d9de50-2807-4b2d-896c-4ba6d08512b0"},{"name":"delete","id":"f58e895b-4e15-4d1e-85b4-d6c3b630689b","protocolProfileBehavior":{"disableBodyPruning":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/transfers/:id","description":"

Archive Transfer to hide it it from transfers list. You can still retrieve archived transfers.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","transfers",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5e1874032139a47666c372f4","key":"id"}]}},"response":[{"id":"11502a7d-78b3-40cd-b47a-afa42f2e6bcd","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":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"999-SXWbrSK/+ITu3ZPtcwPUbBJALPI\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"transfer\",\n \"data\": {\n \"_id\": \"5e1874032139a47666c372f4\",\n \"created_at\": \"2020-01-10T12:54:27.532Z\",\n \"updated_at\": \"2020-09-07T11:27:41.848Z\",\n \"description\": \"sdfdfsdf\",\n \"reference\": \"sdfsdfsdfsdsdf\",\n \"gateway_id\": \"5df1e8a28dfcf018377928fd\",\n \"status\": \"pending\",\n \"__v\": 0,\n \"payouts\": [\n {\n \"_id\": \"5e1874032139a47666c372f5\",\n \"created_at\": \"2020-01-10T12:54:27.539Z\",\n \"updated_at\": \"2020-01-10T12:55:04.194Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"customer_id\": \"5df399bd9327e850a73e97c5\",\n \"payment_destination_id\": \"5df399bd9327e850a73e97c6\",\n \"transfer_id\": \"5e1874032139a47666c372f4\",\n \"status\": \"pending\",\n \"__v\": 2,\n \"transactions\": [\n {\n \"created_at\": \"2020-01-10T12:54:29.829Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"type\": \"transfer\",\n \"status\": \"pending\",\n \"_id\": \"5e1874052139a47666c372f8\",\n \"service_logs\": [],\n \"_source_ip_address\": \"127.0.0.1\"\n },\n {\n \"created_at\": \"2020-01-10T12:55:04.194Z\",\n \"amount\": 10,\n \"currency\": \"AUD\",\n \"type\": \"transfer\",\n \"status\": \"pending\",\n \"_id\": \"5e1874282139a47666c372fe\",\n \"service_logs\": [],\n \"_source_ip_address\": \"127.0.0.1\"\n }\n ]\n },\n {\n \"_id\": \"5e1874032139a47666c372f6\",\n \"created_at\": \"2020-01-10T12:54:27.544Z\",\n \"updated_at\": \"2020-01-10T12:55:04.216Z\",\n \"amount\": 15,\n \"currency\": \"GBP\",\n \"customer_id\": \"5df399bd9327e850a73e97c5\",\n \"payment_destination_id\": \"5df399bd9327e850a73e97c6\",\n \"transfer_id\": \"5e1874032139a47666c372f4\",\n \"status\": \"pending\",\n \"__v\": 2,\n \"transactions\": [\n {\n \"created_at\": \"2020-01-10T12:54:29.841Z\",\n \"amount\": 15,\n \"currency\": \"GBP\",\n \"type\": \"transfer\",\n \"status\": \"pending\",\n \"_id\": \"5e1874052139a47666c372f9\",\n \"service_logs\": [],\n \"_source_ip_address\": \"127.0.0.1\"\n },\n {\n \"created_at\": \"2020-01-10T12:55:04.216Z\",\n \"amount\": 15,\n \"currency\": \"GBP\",\n \"type\": \"transfer\",\n \"status\": \"pending\",\n \"_id\": \"5e1874282139a47666c372ff\",\n \"service_logs\": [],\n \"_source_ip_address\": \"127.0.0.1\"\n }\n ]\n },\n {\n \"_id\": \"5e1874032139a47666c372f7\",\n \"created_at\": \"2020-01-10T12:54:27.548Z\",\n \"updated_at\": \"2020-01-10T12:55:04.233Z\",\n \"amount\": 20,\n \"currency\": \"USD\",\n \"customer_id\": \"5df399bd9327e850a73e97c5\",\n \"payment_destination_id\": \"5df399bd9327e850a73e97c6\",\n \"transfer_id\": \"5e1874032139a47666c372f4\",\n \"status\": \"pending\",\n \"__v\": 2,\n \"transactions\": [\n {\n \"created_at\": \"2020-01-10T12:54:29.849Z\",\n \"amount\": 20,\n \"currency\": \"USD\",\n \"type\": \"transfer\",\n \"status\": \"pending\",\n \"_id\": \"5e1874052139a47666c372fa\",\n \"service_logs\": [],\n \"_source_ip_address\": \"127.0.0.1\"\n },\n {\n \"created_at\": \"2020-01-10T12:55:04.233Z\",\n \"amount\": 20,\n \"currency\": \"USD\",\n \"type\": \"transfer\",\n \"status\": \"pending\",\n \"_id\": \"5e1874282139a47666c37300\",\n \"service_logs\": [],\n \"_source_ip_address\": \"127.0.0.1\"\n }\n ]\n }\n ],\n \"capture\": false,\n \"logs\": []\n }\n }\n}"}],"_postman_id":"f58e895b-4e15-4d1e-85b4-d6c3b630689b"},{"name":"capture","id":"787b31df-c83c-4784-97c6-f1e2c32a7204","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":""},"url":"{{url}}/v1/transfers/:id/capture","description":"

For capturing a transfer, make a POST call

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","transfers",":id","capture"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5f561fa9bb8a75181d42c1a0","key":"id"}]}},"response":[{"id":"194d2150-9966-4b1a-98d2-ed7680dbcd3b","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":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"59-7oZBI2FX/jnHZcP6FS/hXH8ZqmE\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"error\": {\n \"message\": \"Transfer ready for capturing not found\"\n },\n \"resource\": {},\n \"error_summary\": {\n \"message\": \"Transfer ready for capturing not found\",\n \"code\": \"unspecified_error\",\n \"details\": {\n \"messages\": []\n }\n }\n}"},{"id":"4131b1b0-e523-48b9-8244-a575272ff169","name":"capture fail customer not exist","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":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 07 Sep 2020 11:51:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"281"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"8f-mCc8QzeGDFKsSWxHR76M6qiM3i8\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"Customer not exist\",\n \"code\": \"UnfulfilledCondition\",\n \"details\": {\n \"path\": \"payouts[0].customer_id\"\n }\n },\n \"resource\": {},\n \"error_summary\": {\n \"message\": \"Customer not exist\",\n \"code\": \"unfulfilled_condition\",\n \"details\": {\n \"path\": \"payouts[0].customer_id\",\n \"messages\": []\n }\n }\n}"},{"id":"cee64bf1-fc78-4b2c-ab1e-98e1520ab378","name":"capture success","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":"5f561fa9bb8a75181d42c1a0"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 07 Sep 2020 11:55:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"935"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"3a7-m0Bp7PCkJ5ga5SYFqP6JTQJdDY0\""},{"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\": \"transfer\",\n \"data\": {\n \"_id\": \"5f561fa9bb8a75181d42c1a0\",\n \"created_at\": \"2020-09-07T11:55:21.966Z\",\n \"updated_at\": \"2020-09-07T11:55:50.883Z\",\n \"description\": \"Transfer Description\",\n \"reference\": \"Transfer reference\",\n \"gateway_id\": \"5df1e8a28dfcf018377928fd\",\n \"status\": \"requested\",\n \"__v\": 0,\n \"external_id\": \"PB.2p76\",\n \"payouts\": [\n {\n \"_id\": \"5f561fa9bb8a75181d42c1a1\",\n \"created_at\": \"2020-09-07T11:55:21.973Z\",\n \"updated_at\": \"2020-09-07T11:55:50.900Z\",\n \"amount\": 15,\n \"currency\": \"AUD\",\n \"customer_id\": \"5f50f59480c950150a6038a6\",\n \"payment_destination_id\": \"5f561f6bbb8a75181d42c196\",\n \"transfer_id\": \"5f561fa9bb8a75181d42c1a0\",\n \"status\": \"requested\",\n \"__v\": 1,\n \"external_id\": \"D.2pq1\",\n \"transactions\": [\n {\n \"created_at\": \"2020-09-07T11:55:50.576Z\",\n \"amount\": 15,\n \"currency\": \"AUD\",\n \"type\": \"transfer\",\n \"status\": \"requested\",\n \"_id\": \"5f561fc6bb8a75181d42c1a2\",\n \"external_id\": \"D.2pq1\",\n \"service_logs\": [],\n \"_source_ip_address\": \"127.0.0.1\"\n }\n ]\n }\n ],\n \"capture\": false\n }\n }\n}"}],"_postman_id":"787b31df-c83c-4784-97c6-f1e2c32a7204"}],"id":"2e0206e6-d288-41cb-9548-133e55cf10ef","description":"

Transfers help sending money from a connected payment services to a bank account and retrieve transfers details.

Transfer resource

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required[flow]	type	description
amount	+	float	Amount of payment
currency	+	string (iso4217 alpha-3)	Currency code
description	-	string	Manually defined description for a transfer in payment services
reference	-	string	Manually defined reference for a transfer
_id	+	string (24 byte hex)	Charge Id for any future requests
gateway_id	+	string (24 byte hex)	Gateway ID
created_at	+	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Charge creation date
updated_at	+	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Date of last charge update
status	+	string	Actual transfer status. See the status table
capture	+	bool	Automatically capturing or just authorize
archived	+	bool	For new created transfers always false, true after manual archiving
payouts	+	array	Array of destinations with amount and currency information

Status

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status	description
requested	All payouts are in pending state
partially_approved	Some of the payouts were approved, the others are in requested state
partially_declined	Some of the payouts were declined, the others are in requested or approved state
declined	All payouts are in declined state
approved	All payouts are in approved state

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"fcde347e-af9a-43ee-b504-2d178a774248"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"c986d3a7-4b32-4476-ae4f-4b8a371bbed3"}}],"_postman_id":"2e0206e6-d288-41cb-9548-133e55cf10ef"},{"name":"services","item":[{"name":"search","id":"51cf49d7-4343-4cae-875f-c1f7cec9cf33","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.

Request query params

Pagination

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
skip	-	number	Pagination parameter to skip first n subscriptions from list, default = 0
limit	-	number	Pagination parameter to limit output to n , default = 100 , maximum value = 1000
sortkey	-	string	Sorting key parameter i.e. created_at
sortdirection	-	string	Sorting order direction parameter ASC or DESC (DESC by default)

Filters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
archived	-	bool	true or false

Other

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
search	-	string	Search by service name

","urlObject":{"path":["v1","services"],"host":["{{url}}"],"query":[{"key":"archived","value":"true"}],"variable":[]}},"response":[{"id":"52ed0098-f546-402c-9706-e2ffcfb43ce6","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":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-info-limit","value":"100"},{"key":"x-info-skip","value":"0"},{"key":"x-info-sort-key","value":"created_at"},{"key":"x-info-sort-direction","value":"DESC"},{"key":"x-info-count","value":"3"},{"key":"etag","value":"W/\"3d5-lOUeIt5r7NkWJ9x6D955qN1D4Ag\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"services\",\n \"data\": [\n {\n \"_id\": \"5f575ad7bb8a75181d42c23c\",\n \"name\": \"First service\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": true,\n \"mode\": \"passive\"\n },\n \"archived\": true,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-09-08T10:20:07.626Z\",\n \"updated_at\": \"2020-09-08T10:32:25.075Z\"\n },\n {\n \"_id\": \"5f1e9ec5fcbb091d88a19008\",\n \"name\": \"sdfs\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"live\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"active\"\n },\n \"archived\": true,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-27T09:30:45.371Z\",\n \"updated_at\": \"2020-07-27T10:20:58.225Z\"\n },\n {\n \"_id\": \"5f1958a6be3959422c8b9dba\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"active\"\n },\n \"archived\": true,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-22T09:37:15.003Z\",\n \"updated_at\": \"2020-07-22T09:37:16.894Z\"\n }\n ],\n \"skip\": 0,\n \"limit\": 100,\n \"sortkey\": \"created_at\",\n \"sortdirection\": \"DESC\",\n \"count\": 3\n }\n}"},{"id":"bc2d455a-528e-4e56-b5b3-cc2e89a76e12","name":"search with pagination","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?skip=3&limit=1","host":["{{url}}"],"path":["v1","services"],"query":[{"key":"skip","value":"3"},{"key":"limit","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 08 Sep 2020 10:15:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"428"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-info-limit","value":"1"},{"key":"x-info-skip","value":"3"},{"key":"x-info-sort-key","value":"created_at"},{"key":"x-info-sort-direction","value":"DESC"},{"key":"x-info-count","value":"76"},{"key":"etag","value":"W/\"1ac-oCxiju96c6177WsUmlplWIQ90f4\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"services\",\n \"data\": [\n {\n \"_id\": \"5f57541cbb8a75181d42c223\",\n \"name\": \"Service Name\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-09-08T09:51:24.845Z\",\n \"updated_at\": \"2020-09-08T09:51:24.845Z\"\n }\n ],\n \"skip\": 3,\n \"limit\": 1,\n \"sortkey\": \"created_at\",\n \"sortdirection\": \"DESC\",\n \"count\": 76\n }\n}"},{"id":"c097a373-7fb6-44f2-9841-caee1b82da3d","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/services"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 08 Sep 2020 10:12:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"21580"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-info-limit","value":"100"},{"key":"x-info-skip","value":"0"},{"key":"x-info-sort-key","value":"created_at"},{"key":"x-info-sort-direction","value":"DESC"},{"key":"x-info-count","value":"76"},{"key":"etag","value":"W/\"544c-F1CT5tts9rK3z1oifSMGDKO0qDk\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"services\",\n \"data\": [\n {\n \"_id\": \"5f57571fbb8a75181d42c231\",\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-08T10:04:15.366Z\",\n \"updated_at\": \"2020-09-08T10:04:16.531Z\"\n },\n {\n \"_id\": \"5f5755b8bb8a75181d42c225\",\n \"name\": \"Service Name\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-09-08T09:58:16.725Z\",\n \"updated_at\": \"2020-09-08T09:58:17.896Z\"\n },\n {\n \"_id\": \"5f575421bb8a75181d42c224\",\n \"name\": \"Service Name\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": false,\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-08T10:04:16.514Z\"\n },\n {\n \"_id\": \"5f57541cbb8a75181d42c223\",\n \"name\": \"Service Name\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-09-08T09:51:24.845Z\",\n \"updated_at\": \"2020-09-08T09:51:24.845Z\"\n },\n {\n \"_id\": \"5f5753e8bb8a75181d42c222\",\n \"name\": \"Service Name\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-09-08T09:50:32.607Z\",\n \"updated_at\": \"2020-09-08T09:50:32.607Z\"\n },\n {\n \"_id\": \"5f3e5d0ee03ac13bdfc60e21\",\n \"name\": \"Test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"active\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-08-20T11:22:54.964Z\",\n \"updated_at\": \"2020-08-20T11:22:54.964Z\"\n },\n {\n \"_id\": \"5f3d2409a53f387e1b7df214\",\n \"name\": \"pagination\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-08-19T13:07:21.781Z\",\n \"updated_at\": \"2020-09-08T09:51:30.759Z\"\n },\n {\n \"_id\": \"5f3d23dda53f387e1b7df211\",\n \"name\": \"pagination\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-08-19T13:06:37.413Z\",\n \"updated_at\": \"2020-08-19T13:07:23.363Z\"\n },\n {\n \"_id\": \"5f3d23d6a53f387e1b7df210\",\n \"name\": \"pagination\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-08-19T13:06:30.803Z\",\n \"updated_at\": \"2020-08-19T13:06:39.014Z\"\n },\n {\n \"_id\": \"5f3d23cca53f387e1b7df20f\",\n \"name\": \"pagination\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-08-19T13:06:20.832Z\",\n \"updated_at\": \"2020-08-19T13:06:32.351Z\"\n },\n {\n \"_id\": \"5f3d23c5a53f387e1b7df20e\",\n \"name\": \"pagination\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-08-19T13:06:13.719Z\",\n \"updated_at\": \"2020-08-19T13:06:22.352Z\"\n },\n {\n \"_id\": \"5f3d23baa53f387e1b7df20d\",\n \"name\": \"pagination\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-08-19T13:06:02.323Z\",\n \"updated_at\": \"2020-08-19T13:06:15.517Z\"\n },\n {\n \"_id\": \"5f1ef1e69ecdac558b0bd39b\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-27T15:25:26.807Z\",\n \"updated_at\": \"2020-08-19T13:06:03.915Z\"\n },\n {\n \"_id\": \"5f1ef190a12cf3542d292f0f\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-27T15:24:00.590Z\",\n \"updated_at\": \"2020-07-27T15:25:29.204Z\"\n },\n {\n \"_id\": \"5f1ef033d91f85501a729a2b\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"mode\": \"passive\",\n \"default\": false,\n \"_id\": \"5f1ef033d91f85501a729a2c\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-27T15:18:11.700Z\",\n \"updated_at\": \"2020-07-27T15:19:01.667Z\"\n },\n {\n \"_id\": \"5f1eede2aa61344767efae6e\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"active\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-27T15:08:18.647Z\",\n \"updated_at\": \"2020-07-27T15:08:18.647Z\"\n },\n {\n \"_id\": \"5f1eec7bf5de89410150026e\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"active\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-27T15:02:19.532Z\",\n \"updated_at\": \"2020-07-27T15:02:19.532Z\"\n },\n {\n \"_id\": \"5f1eebe4dcb3763fee030842\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"active\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-27T14:59:48.552Z\",\n \"updated_at\": \"2020-07-27T14:59:48.552Z\"\n },\n {\n \"_id\": \"5f1eeafaf5e6493cf5f0c131\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"active\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-27T14:55:54.111Z\",\n \"updated_at\": \"2020-07-27T14:55:56.492Z\"\n },\n {\n \"_id\": \"5f1eea29195b0d37882e774c\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"active\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-27T14:52:25.501Z\",\n \"updated_at\": \"2020-07-27T14:52:26.261Z\"\n },\n {\n \"_id\": \"5f1ee096ae85e1120847b32d\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-27T14:11:34.632Z\",\n \"updated_at\": \"2020-07-27T14:23:55.088Z\"\n },\n {\n \"_id\": \"5f1edfbe54c6280f48a28734\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-27T14:07:58.514Z\",\n \"updated_at\": \"2020-07-27T14:23:55.082Z\"\n },\n {\n \"_id\": \"5f1eb5a9957b0b4ca50bac32\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-27T11:08:25.815Z\",\n \"updated_at\": \"2020-07-27T14:52:27.728Z\"\n },\n {\n \"_id\": \"5f1eb585957b0b4ca50bac31\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"active\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-27T11:07:49.037Z\",\n \"updated_at\": \"2020-07-27T11:19:30.035Z\"\n },\n {\n \"_id\": \"5f1eb533e6f95a4950ea7113\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"active\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-27T11:06:27.783Z\",\n \"updated_at\": \"2020-07-27T11:06:27.783Z\"\n },\n {\n \"_id\": \"5f1eb4f2e6f95a4950ea7112\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"active\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-27T11:05:22.025Z\",\n \"updated_at\": \"2020-07-27T11:05:22.025Z\"\n },\n {\n \"_id\": \"5f1ea0fefcbb091d88a19009\",\n \"name\": \"777\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"live\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"active\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-27T09:40:14.645Z\",\n \"updated_at\": \"2020-07-27T10:51:02.869Z\"\n },\n {\n \"_id\": \"5f1e9bf8fcbb091d88a19007\",\n \"name\": \"sdfs\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"live\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"active\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-27T09:18:48.485Z\",\n \"updated_at\": \"2020-07-27T09:18:48.485Z\"\n },\n {\n \"_id\": \"5f1e94f0fcbb091d88a19006\",\n \"name\": \"Acert1\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"active\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-27T08:48:48.005Z\",\n \"updated_at\": \"2020-07-27T08:48:48.005Z\"\n },\n {\n \"_id\": \"5f1e947b82d7b7300c061cd9\",\n \"name\": \"Acert1\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"active\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-27T08:46:51.158Z\",\n \"updated_at\": \"2020-07-27T08:46:51.158Z\"\n },\n {\n \"_id\": \"5f1e946c82d7b7300c061cd8\",\n \"name\": \"Acert1\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"live\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"active\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-27T08:46:36.500Z\",\n \"updated_at\": \"2020-07-27T08:46:36.500Z\"\n },\n {\n \"_id\": \"5f1e93bd1255f157d8effbc3\",\n \"name\": \"Acert1\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"live\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"active\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-27T08:43:41.703Z\",\n \"updated_at\": \"2020-07-27T10:51:01.370Z\"\n },\n {\n \"_id\": \"5f1e7bc3782a271f58369406\",\n \"name\": \"sdfsdf\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-27T07:01:23.518Z\",\n \"updated_at\": \"2020-07-27T10:51:01.369Z\"\n },\n {\n \"_id\": \"5f1e7b90782a271f58369405\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-27T07:00:32.692Z\",\n \"updated_at\": \"2020-07-27T07:01:25.896Z\"\n },\n {\n \"_id\": \"5f1e7b81782a271f58369404\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-27T07:00:17.331Z\",\n \"updated_at\": \"2020-07-27T10:51:01.362Z\"\n },\n {\n \"_id\": \"5f1a034e27e81f2b84dd8610\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T21:38:22.302Z\",\n \"updated_at\": \"2020-07-27T07:00:19.142Z\"\n },\n {\n \"_id\": \"5f1a030527e81f2b84dd860f\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-23T21:37:09.570Z\",\n \"updated_at\": \"2020-07-23T21:38:24.500Z\"\n },\n {\n \"_id\": \"5f1a02dc27e81f2b84dd860e\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T21:36:28.427Z\",\n \"updated_at\": \"2020-07-23T21:37:11.059Z\"\n },\n {\n \"_id\": \"5f1a012c27e81f2b84dd860d\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T21:29:16.652Z\",\n \"updated_at\": \"2020-07-23T21:36:30.943Z\"\n },\n {\n \"_id\": \"5f19ffbd27e81f2b84dd860c\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-23T21:23:09.715Z\",\n \"updated_at\": \"2020-07-23T21:29:18.698Z\"\n },\n {\n \"_id\": \"5f19fcd3b096061fdc169c2e\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T21:10:43.296Z\",\n \"updated_at\": \"2020-07-23T21:23:10.924Z\"\n },\n {\n \"_id\": \"5f19f694d85d8a7fd705fe4e\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T20:44:05.005Z\",\n \"updated_at\": \"2020-07-23T21:10:45.251Z\"\n },\n {\n \"_id\": \"5f19f63989894c7e2b028aa8\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T20:42:33.516Z\",\n \"updated_at\": \"2020-07-27T10:57:53.468Z\"\n },\n {\n \"_id\": \"5f19f45969314a77d323b738\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T20:34:33.624Z\",\n \"updated_at\": \"2020-07-23T20:34:35.603Z\"\n },\n {\n \"_id\": \"5f19f3e556df966feb246341\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T20:32:37.133Z\",\n \"updated_at\": \"2020-07-27T11:04:13.285Z\"\n },\n {\n \"_id\": \"5f19f30d56df966feb246340\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T20:29:01.366Z\",\n \"updated_at\": \"2020-07-23T20:29:03.126Z\"\n },\n {\n \"_id\": \"5f19f2f956df966feb24633f\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T20:28:41.243Z\",\n \"updated_at\": \"2020-07-23T20:28:42.005Z\"\n },\n {\n \"_id\": \"5f19f2e456df966feb24633e\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T20:28:20.438Z\",\n \"updated_at\": \"2020-07-23T20:28:21.285Z\"\n },\n {\n \"_id\": \"5f19f2b656df966feb24633d\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T20:27:34.345Z\",\n \"updated_at\": \"2020-07-23T20:27:36.371Z\"\n },\n {\n \"_id\": \"5f19f2355b09b56e639d7b31\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T20:25:25.057Z\",\n \"updated_at\": \"2020-07-23T20:25:28.879Z\"\n },\n {\n \"_id\": \"5f19ee800340765f9e3b6e05\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T20:09:36.490Z\",\n \"updated_at\": \"2020-07-23T20:29:03.124Z\"\n },\n {\n \"_id\": \"5f19ee760340765f9e3b6e04\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T20:09:27.005Z\",\n \"updated_at\": \"2020-07-23T20:25:27.060Z\"\n },\n {\n \"_id\": \"5f19ed357d89a235c7407e69\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T20:04:05.418Z\",\n \"updated_at\": \"2020-07-23T20:04:06.199Z\"\n },\n {\n \"_id\": \"5f19e3287d89a235c7407e68\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"live\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T19:21:12.393Z\",\n \"updated_at\": \"2020-07-23T19:21:13.369Z\"\n },\n {\n \"_id\": \"5f19e2a87bb6043378e619fa\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T19:19:04.418Z\",\n \"updated_at\": \"2020-07-23T19:19:05.183Z\"\n },\n {\n \"_id\": \"5f19e2947bb6043378e619f9\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-23T19:18:44.324Z\",\n \"updated_at\": \"2020-07-23T19:18:44.324Z\"\n },\n {\n \"_id\": \"5f19e27d7bb6043378e619f8\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T19:18:21.435Z\",\n \"updated_at\": \"2020-07-23T19:18:22.164Z\"\n },\n {\n \"_id\": \"5f19d1933129676f28008819\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T18:06:11.447Z\",\n \"updated_at\": \"2020-07-23T18:06:14.424Z\"\n },\n {\n \"_id\": \"5f19d157151e106e4b12929d\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T18:05:11.235Z\",\n \"updated_at\": \"2020-07-23T18:05:14.605Z\"\n },\n {\n \"_id\": \"5f19d07048bc436b1cc3542a\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-23T18:01:20.639Z\",\n \"updated_at\": \"2020-07-23T18:01:20.639Z\"\n },\n {\n \"_id\": \"5f19d02e2f37ba69d5ac8702\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-23T18:00:14.079Z\",\n \"updated_at\": \"2020-07-23T18:00:14.079Z\"\n },\n {\n \"_id\": \"5f19cf94d59a2567feee5425\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-23T17:57:40.540Z\",\n \"updated_at\": \"2020-07-23T17:57:40.540Z\"\n },\n {\n \"_id\": \"5f19cf4793568867223f9fcf\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-23T17:56:23.611Z\",\n \"updated_at\": \"2020-07-23T17:56:23.611Z\"\n },\n {\n \"_id\": \"5f19cee9cfe773658d8593eb\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-23T17:54:49.887Z\",\n \"updated_at\": \"2020-07-23T17:54:49.887Z\"\n },\n {\n \"_id\": \"5f19ce30b34b4863c74e46e4\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T17:51:44.858Z\",\n \"updated_at\": \"2020-07-23T17:51:49.533Z\"\n },\n {\n \"_id\": \"5f19cde299df8461cde3b17e\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T17:50:26.026Z\",\n \"updated_at\": \"2020-07-23T17:50:27.063Z\"\n },\n {\n \"_id\": \"5f19cc096d22905cad5fbc21\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T17:42:33.110Z\",\n \"updated_at\": \"2020-07-23T17:42:34.084Z\"\n },\n {\n \"_id\": \"5f19ca96655c79576e7d8e6d\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T17:36:22.828Z\",\n \"updated_at\": \"2020-07-23T17:36:23.824Z\"\n },\n {\n \"_id\": \"5f19ca61017e1c55001fabf8\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T17:35:29.388Z\",\n \"updated_at\": \"2020-07-23T17:35:30.136Z\"\n },\n {\n \"_id\": \"5f19c5382ca5f14034bd8c2b\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T17:13:28.761Z\",\n \"updated_at\": \"2020-07-23T17:13:29.529Z\"\n },\n {\n \"_id\": \"5f19c5052ca5f14034bd8c2a\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"virtual\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T17:12:37.751Z\",\n \"updated_at\": \"2020-07-23T17:12:38.455Z\"\n },\n {\n \"_id\": \"5f19c4e62ca5f14034bd8c29\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-23T17:12:06.917Z\",\n \"updated_at\": \"2020-07-23T17:12:07.745Z\"\n },\n {\n \"_id\": \"5f19c44fb5c6423de6778fe4\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-23T17:09:35.388Z\",\n \"updated_at\": \"2020-07-23T17:09:35.388Z\"\n },\n {\n \"_id\": \"5f19c40991bc073cfffb23a3\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-23T17:08:25.093Z\",\n \"updated_at\": \"2020-07-23T17:08:25.093Z\"\n },\n {\n \"_id\": \"5f19c3cef4ebd53c2a254c52\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-23T17:07:26.255Z\",\n \"updated_at\": \"2020-07-23T17:07:26.255Z\"\n },\n {\n \"_id\": \"5f19c398c71ce930eb09b68c\",\n \"name\": \"test\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": false,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-07-23T17:06:32.350Z\",\n \"updated_at\": \"2020-07-23T17:06:32.350Z\"\n }\n ],\n \"skip\": 0,\n \"limit\": 100,\n \"sortkey\": \"created_at\",\n \"sortdirection\": \"DESC\",\n \"count\": 76\n }\n}"},{"id":"d8ee3c99-f361-4f48-8d30-7ce4c6359f5a","name":"search with search param","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?search=first","host":["{{url}}"],"path":["v1","services"],"query":[{"key":"search","value":"first"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 08 Sep 2020 10:20:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"429"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-info-limit","value":"100"},{"key":"x-info-skip","value":"0"},{"key":"x-info-sort-key","value":"created_at"},{"key":"x-info-sort-direction","value":"DESC"},{"key":"x-info-count","value":"1"},{"key":"etag","value":"W/\"1ad-Miphul8nAHXDXQkJpm4uL2MuT2M\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"services\",\n \"data\": [\n {\n \"_id\": \"5f575ad7bb8a75181d42c23c\",\n \"name\": \"First service\",\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-08T10:20:07.626Z\",\n \"updated_at\": \"2020-09-08T10:20:08.610Z\"\n }\n ],\n \"skip\": 0,\n \"limit\": 100,\n \"sortkey\": \"created_at\",\n \"sortdirection\": \"DESC\",\n \"count\": 1\n }\n}"}],"_postman_id":"51cf49d7-4343-4cae-875f-c1f7cec9cf33"},{"name":"get","id":"5b28465e-5dbc-4446-b0b6-04cc69ab23d7","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/:id","description":"

Retrieves data on a service with specified ID.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","services",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5f57571fbb8a75181d42c231","key":"id"}]}},"response":[{"id":"0aaf38e4-ad22-4dd8-b4fe-0a2c80274c35","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/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":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"304-UXHfdggw454jaM3ldapb8gIFa5s\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"services\",\n \"data\": {\n \"_id\": \"5f57571fbb8a75181d42c231\",\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-08T10:04:15.366Z\",\n \"updated_at\": \"2020-09-08T10:04:16.531Z\",\n \"logs\": [\n {\n \"_id\": \"5f57572067330f183c22354c\",\n \"created_at\": \"2020-09-08T10:04:16.493Z\",\n \"updated_at\": \"2020-09-08T10:04:16.493Z\",\n \"tcp_status\": null,\n \"status\": \"500\",\n \"action\": \"verification_service\",\n \"relation_entity\": \"service\",\n \"relation_id\": \"5f57571fbb8a75181d42c231\",\n \"url\": \"https://icnow01.accertify.net/icNowImport/merchant\",\n \"__v\": 0,\n \"response\": {\n \"format\": \"xml\",\n \"body\": null\n },\n \"request\": {\n \"format\": \"json\",\n \"body\": \"{\\\"transaction\\\":{}}\"\n }\n }\n ]\n }\n }\n}"}],"_postman_id":"5b28465e-5dbc-4446-b0b6-04cc69ab23d7"},{"name":"create","id":"220bdcc5-586b-4a18-a886-e04977e1927d","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 \"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 service account more than once, by using a different name each time.

Each of the different services requires a different set of parameters to add them, see the detailed list below.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
type	+	string	value : ‘Accertify’
name	+	string	Name which will be presented service
credentials	+	object	Credentials object to connect service
credentials.username	+	string	API Key
credentials.password	+	string	Password for gateway
credentials.merchant	-	string	Merchant for gateway
mode	+	string	Must be test for testing mode, live for production mode, virtual for testing purposes
group	+	string	Group of service. At that moment only fraud service available
fraud_options	+	object	Options, specific for the fraud group of services
fraud_options.mode	+	string	active or passive fraud mode
fraud_options.default	-	bool	Flag to use as default fraud service

","urlObject":{"path":["v1","services"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"17bc37b7-3537-4fb4-a938-ee3a6da820b0","name":"create","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 \"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}"},"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":"x-powered-by","value":"Express"},{"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}"}],"_postman_id":"220bdcc5-586b-4a18-a886-e04977e1927d"},{"name":"delete","id":"0d5f0228-46ea-49e0-9590-340446999455","protocolProfileBehavior":{"disableBodyPruning":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":"

Archive Service to hide it it from service list. You can still retrieve archived service.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","services",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5f575ad7bb8a75181d42c23c","key":"id"}]}},"response":[{"id":"a5f10049-4b27-4fad-bd9a-3dc99dae4567","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/services/:id","host":["{{url}}"],"path":["v1","services",":id"],"variable":[{"key":"id","value":"5f575ad7bb8a75181d42c23c"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 08 Sep 2020 10:32:25 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"349"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"15d-4FnjSSJH39yZuKsn0wpQxcat5NI\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"services\",\n \"data\": {\n \"_id\": \"5f575ad7bb8a75181d42c23c\",\n \"name\": \"First service\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": true,\n \"mode\": \"passive\"\n },\n \"archived\": true,\n \"verification_status\": \"failed\",\n \"created_at\": \"2020-09-08T10:20:07.626Z\",\n \"updated_at\": \"2020-09-08T10:32:25.075Z\"\n }\n }\n}"}],"_postman_id":"0d5f0228-46ea-49e0-9590-340446999455"},{"name":"modify configuration","id":"3a8aa748-99c0-4d3c-9443-04dc62080408","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\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.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required[flow]	type	description
name	-	string	Name which will be presented service
fraud_options	-	object	Options, specific for the fraud group of services
fraud_options.mode	-	string	active or passive fraud mode
fraud_options.default	-	string	Flag to use as default fraud service

","urlObject":{"path":["v1","services",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5f1958a6be3959422c8b9dba","key":"id"}]}},"response":[{"id":"46a2860c-f4ad-4887-b95e-4f5185a994d2","name":"modify fraud name","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\"name\": \"Name Fraud\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/services/:id","host":["{{url}}"],"path":["v1","services",":id"],"variable":[{"key":"id","value":"5f1958a6be3959422c8b9dba"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 08 Sep 2020 13:51:59 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":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"15d-/22JOqBKrTB6DweCREjInyNRlfE\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"services\",\n \"data\": {\n \"_id\": \"5f1958a6be3959422c8b9dba\",\n \"name\": \"Name Fraud\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": true,\n \"mode\": \"passive\"\n },\n \"archived\": true,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-22T09:37:15.003Z\",\n \"updated_at\": \"2020-09-08T13:51:59.707Z\"\n }\n }\n}"},{"id":"80ad583a-eb5b-41a8-a3e5-59c11d972c55","name":"modify fraud set as default","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\"fraud_options\": {\n\t\t\"default\": true\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/services/:id","host":["{{url}}"],"path":["v1","services",":id"],"variable":[{"key":"id","value":"5f1958a6be3959422c8b9dba"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 08 Sep 2020 13:51:02 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"343"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"157-7tqhJ0SiMYn0OiyhLlo/WTAD1+w\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"services\",\n \"data\": {\n \"_id\": \"5f1958a6be3959422c8b9dba\",\n \"name\": \"Name\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": true,\n \"mode\": \"passive\"\n },\n \"archived\": true,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-22T09:37:15.003Z\",\n \"updated_at\": \"2020-09-08T13:51:02.658Z\"\n }\n }\n}"},{"id":"88e258ff-ce56-41b3-aeb7-f4249f3e7e1f","name":"modify fraud mode to 'active'","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\"fraud_options\": {\n\t\t\"mode\": \"active\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/services/:id","host":["{{url}}"],"path":["v1","services",":id"],"variable":[{"key":"id","value":"5f1958a6be3959422c8b9dba"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 08 Sep 2020 13:49:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"343"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"157-QyeDJGi8Ky5lFgg11XRZYx2xfUY\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"services\",\n \"data\": {\n \"_id\": \"5f1958a6be3959422c8b9dba\",\n \"name\": \"Name\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"active\"\n },\n \"archived\": true,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-22T09:37:15.003Z\",\n \"updated_at\": \"2020-09-08T13:49:46.008Z\"\n }\n }\n}"},{"id":"9337b14f-9b95-459e-91df-9d84a76a0060","name":"modify fraud mode to 'passive'","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\"fraud_options\": {\n\t\t\"mode\": \"passive\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/services/:id","host":["{{url}}"],"path":["v1","services",":id"],"variable":[{"key":"id","value":"5f1958a6be3959422c8b9dba"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 08 Sep 2020 13:50:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"344"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"158-dkEpjqDjq5jN9Esd/k9Vuv2xaRE\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"services\",\n \"data\": {\n \"_id\": \"5f1958a6be3959422c8b9dba\",\n \"name\": \"Name\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": true,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-22T09:37:15.003Z\",\n \"updated_at\": \"2020-09-08T13:50:30.495Z\"\n }\n }\n}"},{"id":"a6ef1487-dfb8-418f-a1c7-30198739927e","name":"modify configuration success","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\"name\": \"Name\",\n\t\"fraud_options\": {\n\t\t\"mode\": \"active\",\n\t\t\"default\": false\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/services/:id","host":["{{url}}"],"path":["v1","services",":id"],"variable":[{"key":"id","value":"5f1958a6be3959422c8b9dba"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 08 Sep 2020 13:48:20 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"344"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"158-UL0/9qjL3UN0pISGq/R5zo0aIJk\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"services\",\n \"data\": {\n \"_id\": \"5f1958a6be3959422c8b9dba\",\n \"name\": \"Name\",\n \"group\": \"fraud\",\n \"type\": \"Accertify\",\n \"mode\": \"test\",\n \"fraud_options\": {\n \"default\": false,\n \"mode\": \"passive\"\n },\n \"archived\": true,\n \"verification_status\": \"completed\",\n \"created_at\": \"2020-07-22T09:37:15.003Z\",\n \"updated_at\": \"2020-09-08T13:48:20.357Z\"\n }\n }\n}"}],"_postman_id":"3a8aa748-99c0-4d3c-9443-04dc62080408"}],"id":"3387843b-33bf-45e8-8f5f-a8206a9746a0","description":"

PayDock enables you to connect different services (fraud etc) to a single PayDock account.

Services can be added through the API or via the PayDock Dashboard.

Before connecting to a company, there should be an account registered with the required service in their system, where specific data can be found (service username, merchant ID, API key, etc.).

Service resource

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
name	+	string	Name which will be presented service
group	+	string	Group of service. At that moment only ‘fraud’ service available
type	+	string	Type of service. Value : ‘Accertify’
mode	+	string	Defaults to ‘test’, must be ‘live’ for production mode, ‘virtual’ for testing purposes
_id	+	string (24 byte hex)	Service Id for any future requests
created_at	+	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Charge creation date
updated_at	+	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Date of last charge update
verification_status	+	string	Actual service verification status. See the status table
archived	+	bool	For new created services always false, true after manual archiving
fraud_options	+	object	Options, specific for the fraud group of services
fraud_options.mode	-	string	active or passive fraud mode
fraud_options.default	-	bool	Flag to use as default fraud service

Status

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

verification_status	description
completed	Verification complete successfully
failed	Verification complete unsuccessfully

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"08b88b2c-2fbc-4705-893f-078682156c6d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"106078c8-942e-4075-b5ab-830b364dab65"}}],"_postman_id":"3387843b-33bf-45e8-8f5f-a8206a9746a0"},{"name":"tokens","item":[{"name":"create","id":"f52450f7-e4e6-4905-b145-c29dbc22ba62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

This 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 \"gateway_id\": \"5eda22bb37356514ddaabee7\",\n \"card_name\": \"First_Name Last_Name\",\n \"card_number\": \"5123450000000008\",\n \"expire_month\": \"09\",\n \"expire_year\": \"21\",\n \"card_ccv\": \"123\"\n}"},"url":"{{url}}/v1/payment_sources/tokens","description":"

Create one-time token

Tokens can also be created using client-sdk

This endpoint is available both with a secret and public token

Flow

You can create a one time token using:

credit card
bank account

Request body

field	required[flow]	type	description
first_name	-	string	Customer first name
last_name	-	string	Customer last name
email	-	string	Customer email
phone	-	string(E.164)	Customer phone in E.164 international notation (Example: +12345678901)
gateway_id	+	string (24 byte hex)	Gateway id
type	+2	string	Type of payment. By default card. Use card for payment with credit card. Use bank_account for using direct debit payments
card_name	+1	string	Cardholder name (as on card)
card_number	+1	string(numeric)	Card number
expire_month	+1	string(mm)	Card expiration month mm
expire_year	+1	string(yyyy)	Card expiration year
card_ccv	-1	string(numeric)	Card CCV number
account_name	+2	string	Customer account name.
account_number	+2	string	Number of Customer account.
account_bsb	-2	string	Customer bank state branch number.
account_routing	-2	string(numeric)	Number of Customer account. BSB/Routing/SWIFT/IBAN Number.
account_holder_type	-2	string	account type (personal or business)
account_bank_name	-2	string	Name of account bank
address_line1	-	string	Customer Address, line 1
address_line2	-	string	Customer Address, line 2
address_state	-	string	Customer Address, State
address_country	-	string	Customer Address, Country Code
address_city	-	string	Customer Address, City
address_postcode	-	string(numeric)	Customer Address, Postcade
meta.customer_storage_number	-	string	Identification of a customer on a gateway side for future payments binding (used by Bambora gateway)
meta.tokenise_algorithm	-	number	Bambora alorithm Id for creating customers. (Default -2, if not specified.)

","urlObject":{"path":["v1","payment_sources","tokens"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"5f81e0c4-a5b3-44fa-856d-4160b315481f","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\": \"First_Name Last_Name\",\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":"PayDock "},{"key":"ETag","value":"W/\"65-Yuk9xBrbQUsOVFK9PBnATQ\""},{"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\": \"token\",\n \"data\": \"f6301700-dcfe-4640-aabf-eff4ee3d96a6\"\n }\n}"},{"id":"833dfb07-5e5c-43cf-bde7-1ae5b16cb058","name":"create with bank account","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\": \"5d1df20be205944082f778b8\",\n \"type\": \"bank_account\",\n \"account_name\": \"test test\",\n \"account_number\": \"064000\",\n \"account_routing\": \"064000\"\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:57:57 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":"PayDock "},{"key":"ETag","value":"W/\"65-50a+C7PSC7sG0XzK/SgViQ\""},{"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\": \"token\",\n \"data\": \"8f9f601b-808d-485f-bf5f-e430784c4458\"\n }\n}"}],"_postman_id":"f52450f7-e4e6-4905-b145-c29dbc22ba62"}],"id":"59bfbe5d-2848-4e5a-838c-2e854a38234c","description":"

One-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":"59bfbe5d-2848-4e5a-838c-2e854a38234c"},{"name":"gateways","item":[{"name":"create","id":"953658d3-111c-4e9b-8114-931f39a323be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","type":"text","description":"

This 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\": \"secret_key\"\n}"},"url":"{{url}}/v1/gateways","description":"

You can add a gateway account more than once, by using a different name each time.

Each of the different gateways require a different set of parameters to add them, see the detailed list below.

Gateway types

Name	Type
Afterpay	Afterpay
Authorize Net	Authorize
Bpoint	Bpoint
Brain Tree	Brain
Eway	Eway
Ezidebit	Ezidebit
Ezidebit 3.5	Ezidebit35
Fat Zebra	FatZebra
Flo 2 Cash	Flo2Cash
Forte	Forte
Bambora	IpPayments
MasterCard	MasterCard
Merchantwarrior	Merchantwarrior
NAB	Nab
Paperless	Paperless
Payment Express	Paymentexpress
PayPal	Paypal
PayPal Classic	PaypalClassic
Pay Way	PaywayRest
Pin	Pin
Assembly	PromisePay
Secure Pay	Securepay
Split Payments	SplitPayments
Sqid	Sqid
Stripe	Stripe
World Pay	Worldpay
Zip Money	Zipmoney
Payeezy	Payeezy

Request body

gateway	field	required[flow]	type	description
	type	+	type	Type of gateway. See Types table
	name	+	string	Manually defined name
	default	-	bool	Use such gateway by default (e.g. Default gateway for client sdk widget). Default value is false
	mode	-	string	Defaults to test, must be live for production mode
Brain Tree
Brain Tree	merchant	+	string	The merchant account ID
Brain Tree	username	+	string	Public key
Brain Tree	password	+	string	Private key
Eway
Eway	username	+	string	Public key
Eway	password	+	string	Password
Paperless
Paperless	username	+	string	Terminal ID
Paperless	password	+	string	Terminal Key
Ezidebit
Ezidebit	username	+	string	Public key
Ezidebit	password	+	string	Digital key
Ezidebit 35
Ezidebit 35	username	+	string	Public key
Ezidebit 35	password	+	string	Digital key
PayPal
PayPal	username	+	string	Client ID
PayPal	password	+	string	Secret key
Pin
Pin	username	+	string	Secret key
Stripe
Stripe	username	+	string	Secret key
Pay Way
Pay Way	merchant	+	string	Merchant (required for credit card payments)
Pay Way	username	+	string	Publishable key
Pay Way	password	+	string	Secret key
Authorize Net
Authorize Net	username	+	string	API login ID
Authorize Net	password	+	string	Transaction key
Secure Pay
Secure Pay	username	+	string	Merchant
Secure Pay	password	+	string	Password
Payment Express
Payment Express	username	+	string	Username
Payment Express	password	+	string	Password
World Pay
World Pay	username	+	string	Client API key
World Pay	password	+	string	Service API key
Nab
Nab	username	+	string	Username
Nab	password	+	string	Password
Merchantwarrior
Merchantwarrior	merchant	+	string	Merchant UUID
Merchantwarrior	username	+	string	API Key
Merchantwarrior	password	+	string	Passphrase
Sqid
Sqid	merchant	+	string	Merchant Code
Sqid	username	+	string	API Key
Sqid	password	+	string	Passphrase
Assembly
Assembly	username	+	string	Username
Assembly	password	+	string	API Key
PayPal Classic
PayPal Classic	username	+	string	Client ID
PayPal Classic	password	+	string	Secret key
PayPal Classic	signature	+	string	Signature
Forte
Forte	merchant	+	string	Merchant
Forte	username	+	string	Username
Forte	password	+	string	Password
Forte	signature	+	string	Signature
Afterpay
Afterpay	username	+	string	Username
Afterpay	password	+	string	Password
Bambora
Bambora	merchant	+	string	Merchant
Bambora	username	+	string	Username
Bambora	password	+	string	Password
Zip Money
Zip Money	username	+	string	Username
Payeezy
Payeezy	username	+	string	API key
Payeezy	password	+	string	Token
Payeezy	signature	+	string	Security key
Fat Zebra
Fat Zebra	username	+	string	Username
Fat Zebra	password	+	string	Token
Flo 2 Cash
Flo 2 Cash	merchant	+	string	Merchant
Flo 2 Cash	username	+	string	Username
Flo 2 Cash	password	+	string	Password
Flo 2 Cash	signature	+	string	Sub account
Split Payments
Split Payments	password	+	string	Personal access token. Can be found in “Your applications” on a gateway side
Bpoint
Bpoint	merchant	+	string	API Merchant
Bpoint	username	+	string	API Username
Bpoint	password	+	string	API Password
MasterCard
MasterCard	username	+	string	Merchant
MasterCard	password	+	string	Password

","urlObject":{"path":["v1","gateways"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"41bd3f1c-51e0-45e1-9706-93d9366e4cfc","name":"create","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\": \"secret_key\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/gateways"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 25 May 2020 13:17:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"271"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"10f-H2KF9cNBkFvbCa69DyNfjw\""},{"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\": \"gateway\",\n \"data\": {\n \"created_at\": \"2020-05-25T13:17:59.890Z\",\n \"updated_at\": \"2020-05-25T13:17:59.890Z\",\n \"type\": \"Stripe\",\n \"name\": \"first strip gateway\",\n \"_id\": \"5ecbc587b12c99579e47002d\",\n \"default\": false,\n \"archived\": false,\n \"mode\": \"test\"\n }\n }\n}"},{"id":"45db0710-a4b7-4823-afbc-7fda87f692f4","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":"PayDock "},{"key":"ETag","value":"W/\"61-gXaeKQ0QJaHePXbp/BCLog\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"Invalid Secret Key\"\n },\n \"resource\": {\n \"type\": \"gateway\",\n \"data\": null\n }\n}"},{"id":"b0f25580-e1d3-4a5d-8f4d-de616ff72bde","name":"create with validation 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 \"type\": \"Unknown\",\n \"name\": \"first unknown 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:12:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"99"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"63-PKi5t0Gb4cZS+Fu3/0CpJw\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"Unknown gateway type\",\n \"code\": \"ValidationError\"\n },\n \"resource\": {\n \"type\": \"gateway\",\n \"data\": null\n },\n \"error_summary\": {\n \"message\": \"Unknown gateway type\",\n \"code\": \"validation_error\",\n \"details\": {\n \"messages\": []\n }\n }\n}"}],"_postman_id":"953658d3-111c-4e9b-8114-931f39a323be"},{"name":"get","id":"4f7f6085-b788-4515-9b95-eee227f690e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","type":"text","description":"

This 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

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

This 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

Request query params

Pagination

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
skip	-	number	Pagination parameter to skip first n transactions from list, default = 0
limit	-	number	Pagination parameter to limit output to n , default = 100 , maximum value = 1000
sortkey	-	string	Sorting key parameter i.e. created_at
sortdirection	-	string	Sorting order direction parameter ASC or DESC (DESC by default)

Other

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
search	-	string	Word of phrase

","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":"5f263345-9b77-42fc-9b3b-87be35f6c540","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":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-info-limit","value":"1"},{"key":"x-info-skip","value":"1"},{"key":"x-info-sort-key","value":"created_at"},{"key":"x-info-sort-direction","value":"DESC"},{"key":"x-info-count","value":"5"},{"key":"etag","value":"W/\"18b-TzvQtpfu1jO+sxQju8Su8Ba29J0\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"gateways\",\n \"data\": [\n {\n \"created_at\": \"2020-05-25T13:55:40.161Z\",\n \"updated_at\": \"2020-05-25T13:55:41.383Z\",\n \"type\": \"Stripe\",\n \"name\": \"first strip gateway\",\n \"_id\": \"5ecbce5cb12c99579e470096\",\n \"default\": false,\n \"archived\": false,\n \"mode\": \"test\"\n }\n ],\n \"skip\": 0,\n \"limit\": 100,\n \"sortkey\": \"created_at\",\n \"sortdirection\": \"DESC\",\n \"count\": 1\n }\n}"},{"id":"eac52bb4-5f96-486d-b8a1-895deb0ef6ef","name":"search with pagination and sort","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?limit=1&skip=1&sort_key=created_at&sort_direction=DESC","host":["{{url}}"],"path":["v1","gateways"],"query":[{"key":"limit","value":"1"},{"key":"skip","value":"1"},{"key":"sort_key","value":"created_at"},{"key":"sort_direction","value":"DESC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 25 May 2020 14:07:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"427"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-info-limit","value":"1"},{"key":"x-info-skip","value":"1"},{"key":"x-info-sort-key","value":"created_at"},{"key":"x-info-sort-direction","value":"DESC"},{"key":"x-info-count","value":"240"},{"key":"etag","value":"W/\"1ab-q/R0uOOPYVtaDO8vZtm7DyIViDU\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"gateways\",\n \"data\": [\n {\n\t \"created_at\": \"2020-05-25T13:24:56.662Z\",\n\t \"updated_at\": \"2020-05-25T13:55:41.383Z\",\n\t \"type\": \"Stripe\",\n\t \"name\": \"first strip gateway\",\n\t \"_id\": \"5ecbc728b12c99579e47002e\",\n\t \"default\": false,\n\t \"archived\": false,\n\t \"mode\": \"test\"\n \t}\n ],\n \"skip\": 1,\n \"limit\": 1,\n \"sortkey\": \"created_at\",\n \"sortdirection\": \"DESC\",\n \"count\": 240\n }\n}"}],"_postman_id":"812ae54e-bebf-48f9-8e5c-e2b73782fd80"},{"name":"update","id":"31beb136-eb1b-4b18-8ab1-d92753ca8ad6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","type":"text","description":"

This 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 ‘actions=check’ to check gateway credentials before updating.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

Request query

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
actions	-	string	Use value check to check gateway credentials before updating. @TODO need check

","urlObject":{"path":["v1","gateways",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5ecbc728b12c99579e47002e","key":"id"}]}},"response":[{"id":"3a3b4a84-a21f-4e59-bef3-f562aed09725","name":"update success","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\": \"first updated strip gateway\"\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:14:02 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"279"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"117-7150q2+1c1kOxOQQQAufnQ\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"gateway\",\n \"data\": {\n \"created_at\": \"2020-05-25T13:24:56.662Z\",\n \"updated_at\": \"2020-05-25T14:14:02.059Z\",\n \"type\": \"Stripe\",\n \"name\": \"first updated strip gateway\",\n \"_id\": \"5ecbc728b12c99579e47002e\",\n \"default\": false,\n \"archived\": false,\n \"mode\": \"test\"\n }\n }\n}"},{"id":"b51eb3a0-26ee-4e49-924d-c15d36fa6f59","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":"PayDock "},{"key":"ETag","value":"W/\"5a-9thnWzDEj7MCyjo8Ipzyqw\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"Bad request\"\n },\n \"resource\": {\n \"type\": \"gateway\",\n \"data\": null\n },\n \"error_summary\": {\n \"message\": \"Bad request\",\n \"code\": \"unspecified_error\",\n \"details\": {\n \"messages\": []\n }\n }\n}"}],"_postman_id":"31beb136-eb1b-4b18-8ab1-d92753ca8ad6"},{"name":"archive","id":"2d266f35-7b02-440c-8471-b939b17a428f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-user-secret-key","value":"{{secretkey}}","type":"text","description":"

This 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.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

PayDock enables multiple gateways to be connected to a single PayDock account, see our list of Supported Gateways

Gateways can be added through the API where the third-party gateway supports it or through the PayDock Admin Portal.

Before 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.).

Gateway types (@TODO)

\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type
eWay	EWay

Gateway resource

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required[flow]	type	description
type	+	type	Type of gateway. See Types table
name	+	string	Manually defined name
_id	+	string (24 byte hex)	Charge Id for any future requests
created_at	+	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Creation date
updated_at	+	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Date of last update
archived	+	bool	For new created charges always false, true after manual archiving
default	-	bool	Use susch gateway by default (e.g. Default gateway for client sdk widget). Default value is false
mode	-	string	Defaults to test, must be live for production mode

","_postman_id":"aca37d42-8d15-4ccb-953c-e4cf3a8c04f2"},{"name":"vaults","item":[{"name":"create","id":"d3f41fbb-effc-4b3c-89ed-da6146271b11","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 \"card_name\": \"First_Name Last_Name\",\n \"card_number\": \"4242424242424242\",\n \"expire_month\": \"09\",\n \"expire_year\": \"21\",\n \"card_ccv\": \"123\"\n}"},"url":"{{url}}/v1/vault/payment_sources","description":"

Create a new vault payment token representing user’s payment information.

Flow

You can create a vault using:

credit card
bank account
one-time token

Request body

field	required[flow]	type	description
token	+3	string(UIID)	One-time token with all the payment source information
first_name	-	string	Customer first name
last_name	-	string	Customer last name
email	-	string	Customer email
phone	-	string(E.164)	Customer phone in E.164 international notation (Example: +12345678901)
type	+	string	Type of source. card for source with credit card, bank_account for direct debit source
card_name	+1	string	Cardholder name (as on card)
card_number_last4	+1	string(numeric)	Card number last 4
card_scheme	+1	string	Cardholder scheme (i.g. visa, mastercard etc...)
expire_month	+1	string(mm)	Card expiration month mm
expire_year	+1	string(yyyy)	Card expiration year
card_ccv	-1	string(numeric)	Card CCV number
account_name	+2	string	Customer account name.
account_number	+2	string	Number of Customer account.
account_bsb	-2	string	Customer bank state branch number.
account_routing	-2	string(numeric)	Number of Customer account. BSB/Routing/SWIFT/IBAN Number.
account_holder_type	-2	string	account type (personal or business)
account_bank_name	-2	string	Name of account bank
address_line1	-	string	Customer Address, line 1
address_line2	-	string	Customer Address, line 2
address_state	-	string	Customer Address, State
address_country	-	string	Customer Address, Country Code
address_city	-	string	Customer Address, City
address_postcode	-	string(numeric)	Customer Address, Postcade

","urlObject":{"path":["v1","vault","payment_sources"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"fab7c98e-51b0-4611-90a5-c2396cb4871f","name":"create with bank account","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 \"type\": \"bank_account\",\n \"account_name\": \"test test\",\n \"account_number\": \"064000\",\n \"account_routing\": \"064000\"\n}"},"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:10:38 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"465"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"1d1-OlHLaDF24tFmKWe+r+RX/A\""},{"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\": \"payment_source\",\n \"data\": {\n \"account_bsb\": \"064000\",\n \"updated_at\": \"2020-05-26T15:10:38.241Z\",\n \"vault_token\": \"1797e611-150e-46ec-83c8-50be73f3bcfc\",\n \"account_name\": \"test test\",\n \"account_number\": \"064000\",\n \"account_routing\": \"064000\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-26T15:10:38.201Z\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"type\": \"bank_account\"\n }\n }\n}"},{"id":"ff839c97-b24f-4aed-ac05-beed30f8f7fb","name":"create with credit card","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 \"card_name\": \"First_Name Last_Name\",\n \"card_number\": \"4242424242424242\",\n \"expire_month\": \"09\",\n \"expire_year\": \"21\",\n \"card_ccv\": \"123\"\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":"PayDock "},{"key":"ETag","value":"W/\"1d8-HFBdItB79D+n1bz4HudGjQ\""},{"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\": \"payment_source\",\n \"data\": {\n \"updated_at\": \"2020-05-26T15:05:50.731Z\",\n \"vault_token\": \"e9adab9c-68f4-443a-b64f-faabb2750ab6\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-26T15:05:50.713Z\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"type\": \"card\"\n }\n }\n}"}],"_postman_id":"d3f41fbb-effc-4b3c-89ed-da6146271b11"},{"name":"modify","id":"3cb1d2cf-1fc8-41bf-bb47-ff5996ba3deb","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 \"expire_month\": \"01\",\n \"expire_year\": \"22\"\n}"},"url":"{{url}}/v1/vault-tokens/:vault_token","description":"

Update a payment information

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
vault_token	+	string (UIID)	vault_token received at the creation stage

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
expire_month	+1	string(mm)	Card expiration month mm
expire_year	+1	string(yyyy)	Card expiration year

Respose body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
vault_id	+	string (24 byte hex)	Vault Id

","urlObject":{"path":["v1","vault-tokens",":vault_token"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"bfd538f5-e4e5-43bd-871d-3ffa6db7f59a","key":"vault_token"}]}},"response":[{"id":"799a38b3-2195-4e5b-8346-ce1b47fa9bc6","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":"PayDock "},{"key":"ETag","value":"W/\"6c-DbeU7GHTqVwg0/65t4JWIg\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"vault-token\",\n \"data\": {\n \"vault_id\": \"5ecd322551eff9228f882bd1\"\n }\n }\n}"}],"_postman_id":"3cb1d2cf-1fc8-41bf-bb47-ff5996ba3deb"},{"name":"search","id":"479dd69e-6c95-48aa-a783-0a407ed75e4d","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/vault/payment_sources?limit=2&skip=1&sortkey=updated_at&sortdirection=DESC","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":"3a145485-e2de-44d6-97ff-bdb95c5fe2f9","name":"search by phrase","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/vault/payment_sources?search=Samantha","host":["{{url}}"],"path":["v1","vault","payment_sources"],"query":[{"key":"search","value":"Samantha"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 May 2020 12:00:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"903"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"387-+OIt1xtusyclt8E0VBnUCA\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"payment_sources\",\n \"data\": [\n {\n \"updated_at\": \"2020-05-26T15:13:41.105Z\",\n \"vault_token\": \"bfd538f5-e4e5-43bd-871d-3ffa6db7f59a\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 1,\n \"expire_year\": 22,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-26T15:13:41.085Z\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"type\": \"card\"\n },\n {\n \"updated_at\": \"2020-05-26T15:05:50.731Z\",\n \"vault_token\": \"e9adab9c-68f4-443a-b64f-faabb2750ab6\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-26T15:05:50.713Z\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"type\": \"card\"\n }\n ],\n \"count\": 2,\n \"limit\": 100,\n \"skip\": 0\n }\n}"},{"id":"68df0231-8979-44fe-bc76-f5c8d107da86","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/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":"PayDock "},{"key":"ETag","value":"W/\"3d1-+2hTwPXeXx6KZUlzSRimBQ\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"payment_sources\",\n \"data\": [\n {\n \"updated_at\": \"2020-05-26T15:05:50.731Z\",\n \"vault_token\": \"e9adab9c-68f4-443a-b64f-faabb2750ab6\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-26T15:05:50.713Z\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"type\": \"card\"\n },\n {\n \"updated_at\": \"2020-05-22T11:05:46.137Z\",\n \"vault_token\": \"a9120c0b-be21-49d7-8706-ecb3cffbf1c2\",\n \"expire_year\": 2020,\n \"expire_month\": 3,\n \"address_country\": \"AU\",\n \"card_name\": \"test test\",\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"ref_token\": \"536537284\",\n \"email\": \"test12345678@test.test\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-22T11:05:45.968Z\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"type\": \"card\"\n }\n ],\n \"count\": 2,\n \"limit\": 100,\n \"skip\": 0\n }\n}"},{"id":"cd134132-a8d2-4b41-b1f3-9d7bb46e8489","name":"search with pagination and sort","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/vault/payment_sources?limit=2&skip=1&sortkey=updated_at&sortdirection=DESC","host":["{{url}}"],"path":["v1","vault","payment_sources"],"query":[{"key":"limit","value":"2"},{"key":"skip","value":"1"},{"key":"sortkey","value":"updated_at"},{"key":"sortdirection","value":"DESC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 May 2020 11:07:21 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"900"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"384-ulJL2h379QpmLT/KDPuPfQ\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"payment_sources\",\n \"data\": [\n {\n \"account_bsb\": \"064000\",\n \"updated_at\": \"2020-05-26T15:10:38.241Z\",\n \"vault_token\": \"1797e611-150e-46ec-83c8-50be73f3bcfc\",\n \"account_name\": \"test test\",\n \"account_number\": \"064000\",\n \"account_routing\": \"064000\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-26T15:10:38.201Z\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"type\": \"bank_account\"\n },\n {\n \"updated_at\": \"2020-05-26T15:05:50.731Z\",\n \"vault_token\": \"e9adab9c-68f4-443a-b64f-faabb2750ab6\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 9,\n \"expire_year\": 2021,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-26T15:05:50.713Z\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"type\": \"card\"\n }\n ],\n \"count\": 162,\n \"limit\": 2,\n \"skip\": 1\n }\n}"}],"_postman_id":"479dd69e-6c95-48aa-a783-0a407ed75e4d"},{"name":"get","id":"4acd1cf3-7f05-4862-b81a-0831107da2bf","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

Returns payment source information associated with a vault token.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
vault_token	+	string (UIID)	vault_token received at the creation stage

","urlObject":{"path":["v1","vault-tokens",":vault_token"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"bfd538f5-e4e5-43bd-871d-3ffa6db7f59a","key":"vault_token"}]}},"response":[{"id":"0617f3e0-c33b-4d03-a5b8-9f82c7745b19","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/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 11:04:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"470"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"1d6-GIUv4ZRgmZcMEhLZe+btWg\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"payment_source\",\n \"data\": {\n \"updated_at\": \"2020-05-26T15:13:41.105Z\",\n \"vault_token\": \"bfd538f5-e4e5-43bd-871d-3ffa6db7f59a\",\n \"card_name\": \"First_Name Last_Name\",\n \"expire_month\": 1,\n \"expire_year\": 22,\n \"card_number_last4\": \"4242\",\n \"card_scheme\": \"visa\",\n \"status\": \"active\",\n \"created_at\": \"2020-05-26T15:13:41.085Z\",\n \"user_id\": \"5cbeda664fdfb25772b5547e\",\n \"company_id\": \"5cbeda664fdfb25772b5547f\",\n \"_source_ip_address\": \"188.191.147.164\",\n \"type\": \"card\"\n }\n }\n}"}],"_postman_id":"4acd1cf3-7f05-4862-b81a-0831107da2bf"},{"name":"archive","id":"797bcbdb-5150-4d4d-a7d3-a1b6f4f9d182","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":""},"url":"{{url}}/v1/vault-tokens/:vault_token","description":"

Archive a vault token

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
vault_token	+	string (UIID)	vault_token received at the creation stage

Response body

absent

\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":"ba3e36e3-193c-4666-bdc5-0347eba65f2c","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":"PayDock "},{"key":"ETag","value":"W/\"3d-1gQorHmwozsZv9i3tVGFKw\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"vault-token\"\n }\n}"}],"_postman_id":"797bcbdb-5150-4d4d-a7d3-a1b6f4f9d182"},{"name":"remove all","id":"bb0903b3-4933-471c-bbda-01ff8c727410","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":""},"url":"{{url}}/v1/vault-tokens","description":"

Remove all vaults in your company

Response body

void

\n","urlObject":{"path":["v1","vault-tokens"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"00f1294b-6165-4210-81e5-846ab4034f07","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":"PayDock "},{"key":"ETag","value":"W/\"6a-WkWkH9yxuF15B1O7gh3fNA\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"payment_sources\",\n \"data\": [],\n \"count\": 162,\n \"limit\": 0,\n \"skip\": 0\n }\n}"}],"_postman_id":"bb0903b3-4933-471c-bbda-01ff8c727410"}],"id":"6d94fa3d-9d87-4efd-adae-5b34076bc7d6","description":"

PayDock also has a PCI compliant vault that lets you access and store customer payment details from all of your payment gateways. Our vault gives you the power to prefill customer card details and help your customers transact faster - regardless of payment gateway you process transactions with.

The vault is built on PayDock infrastructure so you do not wear any liability or data risk.

Conditions

The response is different depends on such conditions:

credit card
\n
with the bank
\n

Vault resource

field	required[flow]	type	description
vault_token	+	string(UIID)	Vault token
created_at	+	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Charge creation date
updated_at	+	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Date of last charge update
archived	+	bool	For new created vaults always false, true after manual archiving
user_id	-	string (24 byte hex)	id of an initiator of the request if the request was by the personal token (from the dashboard)
status	+	string	Actual vault status. See the status table
_source_ip_address	+	string	Client ip address
first_name	-	string	Customer first name
last_name	-	string	Customer last name
email	-	string	Customer email
phone	-	string(E.164)	Customer phone in E.164 international notation (Example: +12345678901)
type	+	string	Type of source. card for source with credit card, bank_account for direct debit source
card_name	+1	string	Cardholder name (as on card)
card_number_last4	+1	string(numeric)	Card number last 4
card_scheme	+1	string	Cardholder scheme (i.g. visa, mastercard etc...)
expire_month	+1	string(mm)	Card expiration month mm
expire_year	+1	string(yyyy)	Card expiration year
account_name	+2	string	Customer account name.
account_number	+2	string	Number of Customer account.
account_bsb	-2	string	Customer bank state branch number.
account_routing	-2	string(numeric)	Number of Customer account. BSB/Routing/SWIFT/IBAN Number.
account_holder_type	-2	string	account type (personal or business)
account_bank_name	-2	string	Name of account bank
address_line1	-	string	Customer Address, line 1
address_line2	-	string	Customer Address, line 2
address_state	-	string	Customer Address, State
address_country	-	string	Customer Address, Country Code
address_city	-	string	Customer Address, City
address_postcode	-	string(numeric)	Customer Address, Postcade

Status

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

status	description
active	default status after creating
archived	manual archived

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"6f63b106-b504-4f3f-a78e-f4e823b59904"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"8cb9a00a-2aa4-493f-b6dc-454f4b687b39"}}],"_postman_id":"6d94fa3d-9d87-4efd-adae-5b34076bc7d6"},{"name":"notifications","item":[{"name":"logs","item":[{"name":"search logs","id":"301aa4cf-bd18-4009-8d75-5bbc39278823","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.

Request query params

Pagination

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
skip	-	number	Pagination parameter to skip first n subscriptions from list, default = 0
limit	-	number	Pagination parameter to limit output to n , default = 100 , maximum value = 1000
sortkey	-	string	Sorting key parameter i.e. created_at
sortdirection	-	string	Sorting order direction parameter ASC or DESC (DESC by default)

Filters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
archived	-	bool	Set to true to show all the archived notification logs. Default: false
success	-	bool	Parameter to filter success or failed notifications. Values: true/false
event	-	string	Parameter to filter notification events. Values: transaction_success, transaction_failure, subscription_transaction, subscription_transaction_failure, subscription_creation_success , subscription_creation_failure, subscription_updated, subscription_finished, subscription_failed, refund_requested, refund_successful, refund_failure, card_expiration_warning, transfer_pending, transfer_requested, transfer_partially_approved, transfer_partially_declined, transfer_declined, transfer_approved
parent_id	-	string (24 byte hex)	Used to search for notifications that have been resent, represents the id of the failed notification
destination	-	string	Shows email address or webhook URL.
type	-	string	Parameter to filter notification by type. Values: email, webhook
relation_id	-	string (24 byte hex)	Related Subscription/Charge/Transaction ID

Other

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required[flow]	type	description
created_at.from	-	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Parameter to filter notifications date range. Format: ISO 8601 (yyyy-mm-ddThh:mm:ss.sssZ) or short type of date (yyyy-mm-dd) or specify time offsets from UTC (yyyy-mm-ddThh:mm:ss+hh:mm)
created_at.to	-	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Parameter to filter notifications date range. Format: ISO 8601 (yyyy-mm-ddThh:mm:ss.sssZ) or short type of date (yyyy-mm-dd) or specify time offsets from UTC (yyyy-mm-ddThh:mm:ss+hh:mm)

","urlObject":{"path":["v1","notifications","logs"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"20986168-10d9-4026-a735-5a99fe2c217e","name":"search logs by parent Id","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?parent_id=5f5789d2ca97750b32ecdd54","host":["{{url}}"],"path":["v1","notifications","logs"],"query":[{"key":"parent_id","value":"5f5789d2ca97750b32ecdd54"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 11:30:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"507"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"1fb-6d6qv0z1nP64vu5BUR8G2g\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"notification_logs\",\n \"data\": [\n {\n \"_id\": \"5f5789d5e2f9bf184bcd2062\",\n \"parent_root_id\": \"5f5789d2ca97750b32ecdd54\",\n \"created_at\": \"2020-09-08T13:40:37.604Z\",\n \"parent_id\": \"5f5789d2ca97750b32ecdd54\",\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5789cbca97750b32ecdd52\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"success\": true,\n \"archived\": false\n }\n ],\n \"count\": 1,\n \"limit\": 100,\n \"skip\": 0\n }\n}"},{"id":"318e72f5-4e6b-4453-aa15-3b4df0786810","name":"search logs by relation Id","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?relation_id=5f57966d207335153de3e9de","host":["{{url}}"],"path":["v1","notifications","logs"],"query":[{"key":"relation_id","value":"5f57966d207335153de3e9de"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 11:28:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"839"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"347-pxLEeOVhQ3f96d3gkq0mgQ\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"notification_logs\",\n \"data\": [\n {\n \"_id\": \"5f579671207335153de3e9e1\",\n \"created_at\": \"2020-09-08T14:34:25.628Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f57966d207335153de3e9de\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f579671207335153de3e9e0\",\n \"created_at\": \"2020-09-08T14:34:25.265Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f57966d207335153de3e9de\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n }\n ],\n \"count\": 2,\n \"limit\": 100,\n \"skip\": 0\n }\n}"},{"id":"36982f38-30b1-476d-84f1-7167b49c0227","name":"search logs","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/logs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 10:58:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"36967"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"9067-Qm7YuhzXNn77ZsuD9xawJg\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"notification_logs\",\n \"data\": [\n {\n \"_id\": \"5f58a2e184fcc97544c4d23b\",\n \"created_at\": \"2020-09-09T09:39:45.448Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f58a2dc84fcc97544c4d238\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f58a2e084fcc97544c4d23a\",\n \"created_at\": \"2020-09-09T09:39:44.944Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f58a2dc84fcc97544c4d238\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5796ca207335153de3e9e3\",\n \"created_at\": \"2020-09-08T14:35:54.278Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f579661207335153de3e9da\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5796c7207335153de3e9e2\",\n \"created_at\": \"2020-09-08T14:35:51.295Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f579661207335153de3e9da\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f579671207335153de3e9e1\",\n \"created_at\": \"2020-09-08T14:34:25.628Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f57966d207335153de3e9de\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f579671207335153de3e9e0\",\n \"created_at\": \"2020-09-08T14:34:25.265Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f57966d207335153de3e9de\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f579667207335153de3e9dd\",\n \"created_at\": \"2020-09-08T14:34:15.018Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f579661207335153de3e9da\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f579666207335153de3e9dc\",\n \"created_at\": \"2020-09-08T14:34:14.625Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f579661207335153de3e9da\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5793ac207335153de3e9d9\",\n \"created_at\": \"2020-09-08T14:22:36.984Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f5793a1207335153de3e9d6\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5793aa207335153de3e9d8\",\n \"created_at\": \"2020-09-08T14:22:34.472Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5793a1207335153de3e9d6\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f579062207335153de3e9d5\",\n \"created_at\": \"2020-09-08T14:08:34.298Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f579049207335153de3e9d0\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f579061207335153de3e9d4\",\n \"created_at\": \"2020-09-08T14:08:33.557Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f579049207335153de3e9d0\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f57904f207335153de3e9d3\",\n \"created_at\": \"2020-09-08T14:08:15.720Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f579049207335153de3e9d0\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f57904f207335153de3e9d2\",\n \"created_at\": \"2020-09-08T14:08:15.321Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f579049207335153de3e9d0\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f578fb44bd59014732b5a4d\",\n \"created_at\": \"2020-09-08T14:05:40.822Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f578f9f4bd59014732b5a48\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f578fb44bd59014732b5a4c\",\n \"created_at\": \"2020-09-08T14:05:40.282Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f578f9f4bd59014732b5a48\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f578fa34bd59014732b5a4b\",\n \"created_at\": \"2020-09-08T14:05:23.638Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f578f9f4bd59014732b5a48\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f578fa34bd59014732b5a4a\",\n \"created_at\": \"2020-09-08T14:05:23.288Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f578f9f4bd59014732b5a48\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f578f8b4bd59014732b5a47\",\n \"created_at\": \"2020-09-08T14:04:59.701Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f578f874bd59014732b5a44\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f578f8b4bd59014732b5a46\",\n \"created_at\": \"2020-09-08T14:04:59.273Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f578f874bd59014732b5a44\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f578a51a70b0e0be83253ba\",\n \"created_at\": \"2020-09-08T13:42:41.698Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f578a4ca70b0e0be83253b7\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f578a51a70b0e0be83253b9\",\n \"created_at\": \"2020-09-08T13:42:41.171Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f578a4ca70b0e0be83253b7\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f578a2958ebac0bb4298034\",\n \"created_at\": \"2020-09-08T13:42:01.270Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f578a2458ebac0bb4298031\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f578a2858ebac0bb4298033\",\n \"created_at\": \"2020-09-08T13:42:00.690Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f578a2458ebac0bb4298031\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5789fc733b420b67ccc069\",\n \"created_at\": \"2020-09-08T13:41:16.452Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f5789f7733b420b67ccc066\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5789fb733b420b67ccc068\",\n \"created_at\": \"2020-09-08T13:41:15.638Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5789f7733b420b67ccc066\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5789ea733b420b67ccc065\",\n \"created_at\": \"2020-09-08T13:40:58.528Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f5789e5733b420b67ccc062\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5789ea733b420b67ccc064\",\n \"created_at\": \"2020-09-08T13:40:58.023Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5789e5733b420b67ccc062\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5789d5e2f9bf184bcd2062\",\n \"parent_root_id\": \"5f5789d2ca97750b32ecdd54\",\n \"created_at\": \"2020-09-08T13:40:37.604Z\",\n \"parent_id\": \"5f5789d2ca97750b32ecdd54\",\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5789cbca97750b32ecdd52\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"success\": true,\n \"archived\": false\n },\n {\n \"_id\": \"5f5789d3ca97750b32ecdd55\",\n \"created_at\": \"2020-09-08T13:40:35.463Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f5789cbca97750b32ecdd52\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5789d2ca97750b32ecdd54\",\n \"created_at\": \"2020-09-08T13:40:34.796Z\",\n \"success\": false,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5789cbca97750b32ecdd52\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"400\",\n \"status\": \"complete\",\n \"schedule\": {\n \"processing_pended_at\": \"2020-09-08T21:40:38.482Z\",\n \"locked\": false,\n \"retry_count\": 1\n },\n \"archived\": false\n },\n {\n \"_id\": \"5f57891f091a150979874cdf\",\n \"created_at\": \"2020-09-08T13:37:35.872Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f578918091a150979874cdc\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f57891e091a150979874cde\",\n \"created_at\": \"2020-09-08T13:37:34.984Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f578918091a150979874cdc\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f578891091a150979874cdb\",\n \"created_at\": \"2020-09-08T13:35:13.508Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f57887b091a150979874cd6\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f578891091a150979874cda\",\n \"created_at\": \"2020-09-08T13:35:13.104Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f57887b091a150979874cd6\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f578882091a150979874cd9\",\n \"created_at\": \"2020-09-08T13:34:58.182Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f57887b091a150979874cd6\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f578881091a150979874cd8\",\n \"created_at\": \"2020-09-08T13:34:57.531Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f57887b091a150979874cd6\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f578849f721850914aa6abe\",\n \"created_at\": \"2020-09-08T13:34:01.161Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f57882af721850914aa6ab9\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f578849f721850914aa6abd\",\n \"created_at\": \"2020-09-08T13:34:01.096Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f57882af721850914aa6ab9\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f57882ff721850914aa6abc\",\n \"created_at\": \"2020-09-08T13:33:35.137Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f57882af721850914aa6ab9\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f57882ef721850914aa6abb\",\n \"created_at\": \"2020-09-08T13:33:34.750Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f57882af721850914aa6ab9\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f57880af220a608d0e6dea8\",\n \"created_at\": \"2020-09-08T13:32:58.467Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f5787f7f220a608d0e6dea3\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f57880af220a608d0e6dea7\",\n \"created_at\": \"2020-09-08T13:32:58.100Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5787f7f220a608d0e6dea3\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5787fcf220a608d0e6dea6\",\n \"created_at\": \"2020-09-08T13:32:44.908Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f5787f7f220a608d0e6dea3\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5787fcf220a608d0e6dea5\",\n \"created_at\": \"2020-09-08T13:32:44.607Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5787f7f220a608d0e6dea3\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5787ac041faa0812dee80f\",\n \"created_at\": \"2020-09-08T13:31:24.589Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f578790041faa0812dee80a\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5787ab041faa0812dee80e\",\n \"created_at\": \"2020-09-08T13:31:23.629Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f578790041faa0812dee80a\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f578794041faa0812dee80d\",\n \"created_at\": \"2020-09-08T13:31:00.968Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f578790041faa0812dee80a\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f578794041faa0812dee80c\",\n \"created_at\": \"2020-09-08T13:31:00.505Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f578790041faa0812dee80a\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5786758e4a430326388471\",\n \"created_at\": \"2020-09-08T13:26:13.806Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f5786298e4a43032638846c\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5786748e4a430326388470\",\n \"created_at\": \"2020-09-08T13:26:12.793Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5786298e4a43032638846c\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f57862d8e4a43032638846f\",\n \"created_at\": \"2020-09-08T13:25:01.997Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f5786298e4a43032638846c\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f57862d8e4a43032638846e\",\n \"created_at\": \"2020-09-08T13:25:01.388Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5786298e4a43032638846c\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5785118e4a43032638846b\",\n \"created_at\": \"2020-09-08T13:20:17.499Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f5784d88e4a430326388466\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5785108e4a43032638846a\",\n \"created_at\": \"2020-09-08T13:20:16.914Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5784d88e4a430326388466\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5784df8e4a430326388469\",\n \"created_at\": \"2020-09-08T13:19:27.767Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f5784d88e4a430326388466\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5784de8e4a430326388468\",\n \"created_at\": \"2020-09-08T13:19:26.919Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5784d88e4a430326388466\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5783985748e47d8becde05\",\n \"created_at\": \"2020-09-08T13:14:00.090Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f5783915748e47d8becde02\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5783975748e47d8becde04\",\n \"created_at\": \"2020-09-08T13:13:59.680Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5783915748e47d8becde02\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5783625748e47d8becde01\",\n \"created_at\": \"2020-09-08T13:13:06.444Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f57835d5748e47d8becddfe\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5783625748e47d8becde00\",\n \"created_at\": \"2020-09-08T13:13:06.056Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f57835d5748e47d8becddfe\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5783405748e47d8becddfd\",\n \"created_at\": \"2020-09-08T13:12:32.242Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f5783395748e47d8becddfa\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f57833f5748e47d8becddfc\",\n \"created_at\": \"2020-09-08T13:12:31.498Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5783395748e47d8becddfa\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5783205748e47d8becddf9\",\n \"created_at\": \"2020-09-08T13:12:00.744Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f57831a5748e47d8becddf6\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f57831f5748e47d8becddf8\",\n \"created_at\": \"2020-09-08T13:11:59.623Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f57831a5748e47d8becddf6\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5782c45748e47d8becddf5\",\n \"created_at\": \"2020-09-08T13:10:28.420Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f5782bf5748e47d8becddf2\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5782c35748e47d8becddf4\",\n \"created_at\": \"2020-09-08T13:10:27.999Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5782bf5748e47d8becddf2\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5782645748e47d8becddef\",\n \"created_at\": \"2020-09-08T13:08:52.109Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f57825e5748e47d8becddec\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5782635748e47d8becddee\",\n \"created_at\": \"2020-09-08T13:08:51.692Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f57825e5748e47d8becddec\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5781cd5748e47d8becddeb\",\n \"created_at\": \"2020-09-08T13:06:21.980Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f5781c55748e47d8becdde8\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5781cd5748e47d8becddea\",\n \"created_at\": \"2020-09-08T13:06:21.483Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5781c55748e47d8becdde8\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f57813422077a7cee629664\",\n \"created_at\": \"2020-09-08T13:03:48.739Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f57812e22077a7cee629661\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f57813422077a7cee629663\",\n \"created_at\": \"2020-09-08T13:03:48.058Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f57812e22077a7cee629661\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f577ff7bbb2e37a53d43bc1\",\n \"created_at\": \"2020-09-08T12:58:31.222Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f577fe5bbb2e37a53d43bbc\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f577ff6bbb2e37a53d43bc0\",\n \"created_at\": \"2020-09-08T12:58:30.964Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f577fe5bbb2e37a53d43bbc\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f577feabbb2e37a53d43bbf\",\n \"created_at\": \"2020-09-08T12:58:18.248Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f577fe5bbb2e37a53d43bbc\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f577fe9bbb2e37a53d43bbe\",\n \"created_at\": \"2020-09-08T12:58:17.994Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f577fe5bbb2e37a53d43bbc\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f577ef0bbb2e37a53d43bbb\",\n \"created_at\": \"2020-09-08T12:54:08.931Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f577eebbbb2e37a53d43bb8\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f577ef0bbb2e37a53d43bba\",\n \"created_at\": \"2020-09-08T12:54:08.426Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f577eebbbb2e37a53d43bb8\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f577d813d83c5540d5b3b50\",\n \"created_at\": \"2020-09-08T12:48:01.750Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f577d7c3d83c5540d5b3b4d\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f577d803d83c5540d5b3b4f\",\n \"created_at\": \"2020-09-08T12:48:00.689Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f577d7c3d83c5540d5b3b4d\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f577cb33d83c5540d5b3b4c\",\n \"created_at\": \"2020-09-08T12:44:35.272Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f577cad3d83c5540d5b3b49\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f577cb23d83c5540d5b3b4b\",\n \"created_at\": \"2020-09-08T12:44:34.846Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f577cad3d83c5540d5b3b49\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f577b823d83c5540d5b3b48\",\n \"created_at\": \"2020-09-08T12:39:30.713Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f577b7d3d83c5540d5b3b45\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f577b823d83c5540d5b3b47\",\n \"created_at\": \"2020-09-08T12:39:30.001Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f577b7d3d83c5540d5b3b45\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f577ac63d83c5540d5b3b44\",\n \"created_at\": \"2020-09-08T12:36:22.731Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f577ac03d83c5540d5b3b41\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f577ac53d83c5540d5b3b43\",\n \"created_at\": \"2020-09-08T12:36:21.167Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f577ac03d83c5540d5b3b41\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5779993d83c5540d5b3b40\",\n \"created_at\": \"2020-09-08T12:31:21.797Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f5779943d83c5540d5b3b3d\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5779993d83c5540d5b3b3f\",\n \"created_at\": \"2020-09-08T12:31:21.118Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5779943d83c5540d5b3b3d\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5771d23d83c5540d5b3b3c\",\n \"created_at\": \"2020-09-08T11:58:10.397Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f5771cd3d83c5540d5b3b39\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5771d13d83c5540d5b3b3b\",\n \"created_at\": \"2020-09-08T11:58:09.549Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5771cd3d83c5540d5b3b39\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f576c003d83c5540d5b3b38\",\n \"created_at\": \"2020-09-08T11:33:20.943Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f576bfb3d83c5540d5b3b35\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f576c003d83c5540d5b3b37\",\n \"created_at\": \"2020-09-08T11:33:20.627Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f576bfb3d83c5540d5b3b35\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f576b4c48a72e181744a8d2\",\n \"created_at\": \"2020-09-08T11:30:20.187Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f576b4a48a72e181744a8c8\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f576b4b48a72e181744a8d1\",\n \"created_at\": \"2020-09-08T11:30:19.968Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f576b4a48a72e181744a8c8\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f576b4b48a72e181744a8cb\",\n \"created_at\": \"2020-09-08T11:30:19.131Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f576b4848a72e181744a8bb\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n },\n {\n \"_id\": \"5f576b4a48a72e181744a8ca\",\n \"created_at\": \"2020-09-08T11:30:18.891Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f576b4848a72e181744a8bb\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f576b4ae2f9bf184bcd204e\",\n \"parent_root_id\": \"5f576b4848a72e181744a8be\",\n \"created_at\": \"2020-09-08T11:30:18.339Z\",\n \"parent_id\": \"5f576b4848a72e181744a8be\",\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f576b4548a72e181744a8b3\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"success\": true,\n \"archived\": false\n },\n {\n \"_id\": \"5f576b4848a72e181744a8be\",\n \"created_at\": \"2020-09-08T11:30:16.819Z\",\n \"success\": false,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f576b4548a72e181744a8b3\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"400\",\n \"status\": \"complete\",\n \"schedule\": {\n \"processing_pended_at\": \"2020-09-08T19:30:19.197Z\",\n \"locked\": false,\n \"retry_count\": 1\n },\n \"archived\": false\n },\n {\n \"_id\": \"5f576b4848a72e181744a8bd\",\n \"created_at\": \"2020-09-08T11:30:16.620Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f576b4548a72e181744a8b3\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n }\n ],\n \"count\": 160,\n \"limit\": 100,\n \"skip\": 0\n }\n}"},{"id":"46777dea-4098-48da-b476-f4e417812160","name":"search logs with pagination","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?skip=2&limit=2","host":["{{url}}"],"path":["v1","notifications","logs"],"query":[{"key":"skip","value":"2"},{"key":"limit","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 11:11:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"839"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"347-H7qmAvM3S/vEpn6Dq14hbw\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"notification_logs\",\n \"data\": [\n {\n \"_id\": \"5f5796ca207335153de3e9e3\",\n \"created_at\": \"2020-09-08T14:35:54.278Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f579661207335153de3e9da\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f5796c7207335153de3e9e2\",\n \"created_at\": \"2020-09-08T14:35:51.295Z\",\n \"success\": true,\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f579661207335153de3e9da\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"status\": \"complete\",\n \"archived\": false\n }\n ],\n \"count\": 160,\n \"limit\": 2,\n \"skip\": 2\n }\n}"},{"id":"a699ba77-8dfd-4cff-a6d0-3c779c650204","name":"search logs by 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/notifications/logs?success=false","host":["{{url}}"],"path":["v1","notifications","logs"],"query":[{"key":"success","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 11:26:41 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":"PayDock "},{"key":"ETag","value":"W/\"35e-N+SbtlEZay8sxi/AUhrLvQ\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"notification_logs\",\n \"data\": [\n {\n \"_id\": \"5f58a2e184fcc97544c4d23b\",\n \"created_at\": \"2020-09-09T09:39:45.448Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f58a2dc84fcc97544c4d238\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f579671207335153de3e9e1\",\n \"created_at\": \"2020-09-08T14:34:25.628Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f57966d207335153de3e9de\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n }\n ],\n \"count\": 81,\n \"limit\": 2,\n \"skip\": 0\n }\n}"},{"id":"b0aefc85-36c0-4a27-8a17-b5bfb8c20bce","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":"PayDock "},{"key":"ETag","value":"W/\"35e-h8UxC6yhVgK5wHEl5N+sdg\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"notification_logs\",\n \"data\": [\n {\n \"_id\": \"5f58a2e184fcc97544c4d23b\",\n \"created_at\": \"2020-09-09T09:39:45.448Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f58a2dc84fcc97544c4d238\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n },\n {\n \"_id\": \"5f579671207335153de3e9e1\",\n \"created_at\": \"2020-09-08T14:34:25.628Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f57966d207335153de3e9de\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": false\n }\n ],\n \"count\": 77,\n \"limit\": 2,\n \"skip\": 0\n }\n}"},{"id":"f7c45f00-099a-4b92-b13a-350d3279d022","name":"search logs 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/notifications/logs?archived=true","host":["{{url}}"],"path":["v1","notifications","logs"],"query":[{"key":"archived","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 11:12:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"484"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"1e4-73MK0/LEmFuTqt29YX3t0A\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"notification_logs\",\n \"data\": [\n {\n \"_id\": \"5f5796ca207335153de3e9e3\",\n \"created_at\": \"2020-09-08T14:35:54.278Z\",\n \"success\": false,\n \"type\": \"email\",\n \"destination\": \"eduard.n@paydock.com\",\n \"_object_id\": \"5f579661207335153de3e9da\",\n \"notification_id\": \"5ebe7c9e2da56d524c66edf9\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"parent_id\": null,\n \"event\": \"transaction_success\",\n \"response_status\": null,\n \"status\": \"processing\",\n \"archived\": true\n }\n ],\n \"count\": 1,\n \"limit\": 100,\n \"skip\": 0\n }\n}"}],"_postman_id":"301aa4cf-bd18-4009-8d75-5bbc39278823"},{"name":"get log","id":"7fef354a-1d7c-4537-b00b-d9bab77ba3c6","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?_id=5f5789d5e2f9bf184bcd2062","description":"

Get specific notification log by log id.

Request query params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
_id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","notifications","logs"],"host":["{{url}}"],"query":[{"key":"_id","value":"5f5789d5e2f9bf184bcd2062"}],"variable":[]}},"response":[{"id":"6c2049e5-5f92-4ba4-b620-eaf24747a978","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":"PayDock "},{"key":"ETag","value":"W/\"1d9-AuXZfYlgB5tmAWrD9zOetw\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"notification_log\",\n \"data\": {\n \"_id\": \"5f5789d5e2f9bf184bcd2062\",\n \"parent_root_id\": \"5f5789d2ca97750b32ecdd54\",\n \"created_at\": \"2020-09-08T13:40:37.604Z\",\n \"parent_id\": \"5f5789d2ca97750b32ecdd54\",\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5789cbca97750b32ecdd52\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"event\": \"transaction_success\",\n \"response_status\": \"200\",\n \"success\": true,\n \"archived\": false\n }\n }\n}"}],"_postman_id":"7fef354a-1d7c-4537-b00b-d9bab77ba3c6"},{"name":"archive log","id":"b69cfac3-e6b4-446e-a26d-8ff06a6799c7","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/logs/:id","description":"

Archive a notification log.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","notifications","logs",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5f5789d5e2f9bf184bcd2062","key":"id"}]}},"response":[{"id":"8b37045a-4831-4e45-9817-98ee4114ebc4","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":"PayDock "},{"key":"ETag","value":"W/\"1fe-dxG/MldOgCcdVMUtbYf0bA\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"charge\",\n \"data\": {\n \"_id\": \"5f5789d5e2f9bf184bcd2062\",\n \"parent_root_id\": \"5f5789d2ca97750b32ecdd54\",\n \"created_at\": \"2020-09-08T13:40:37.604Z\",\n \"parent_id\": \"5f5789d2ca97750b32ecdd54\",\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"type\": \"webhook\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"_object_id\": \"5f5789cbca97750b32ecdd52\",\n \"notification_id\": \"5e4b915bcd34da6dde6d1615\",\n \"event\": \"transaction_success\",\n \"__v\": 0,\n \"response_status\": \"200\",\n \"success\": true,\n \"archived\": true\n }\n }\n}"}],"_postman_id":"b69cfac3-e6b4-446e-a26d-8ff06a6799c7"}],"id":"05c33a63-261c-4e50-bee7-941ef9f003ba","description":"

Logs generating automatically after sending notification.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"68de5521-b802-423e-8a82-9eb7fe2c2d6c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"89dc8693-19c2-4667-a4c9-bab002b0379f"}}],"_postman_id":"05c33a63-261c-4e50-bee7-941ef9f003ba"},{"name":"templates","item":[{"name":"create template","id":"74d140c7-a5c6-49aa-b3a9-dfca9cffd6c9","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 \"label\": \"Sms first template\",\n \"notification_event\": \"transaction_success\",\n \"body\": \"Charge {{CHARGE_ID}} with {{AMOUNT}} {{CURRENCY}} created.\",\n \"destination\": \"{{{PHONE}}}\",\n \"type\": \"sms\"\n}"},"url":"{{url}}/v1/notifications/templates","description":"

Create a notification template (available only in email and SMS type of notifications).

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
body	+	string	Use custom text or/and predefined variables, in which PayDock automatically pulls values from customer, charge or subscription data objects.
label	+	string	Name of current template to identify it further
html	-	bool	Body could be in html or plain text format. Allowed values true, false, default is false
notification_event	+	string	Event to trigger notification. Look at the Event table

","urlObject":{"path":["v1","notifications","templates"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"367bebbf-ed3c-487e-a2d1-d0228e990083","name":"create template","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 \"label\": \"Sms first template\",\n \"notification_event\": \"transaction_success\",\n \"body\": \"Charge {{CHARGE_ID}} with {{AMOUNT}} {{CURRENCY}} created.\",\n \"destination\": \"{{{PHONE}}}\",\n \"type\": \"sms\"\n}"},"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":"PayDock "},{"key":"ETag","value":"W/\"148-DtFNeIzjuQmpdWP7T/H0Tg\""},{"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\": \"template\",\n \"data\": {\n \"__v\": 0,\n \"created_at\": \"2020-09-09T13:54:17.944Z\",\n \"updated_at\": \"2020-09-09T13:54:17.944Z\",\n \"label\": \"Sms first template\",\n \"notification_event\": \"transaction_success\",\n \"body\": \"Charge {{CHARGE_ID}} with {{AMOUNT}} {{CURRENCY}} created.\",\n \"_id\": \"5f58de89fb861d6300bdfdff\"\n }\n }\n}"}],"_postman_id":"74d140c7-a5c6-49aa-b3a9-dfca9cffd6c9"},{"name":"search templates","id":"c3f1fcd4-d605-47ab-b6ef-e289671cfb84","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","description":"

Returns notification templates limited to 100.

Request query params

Pagination

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
skip	-	number	Pagination parameter to skip first n subscriptions from list, default = 0
limit	-	number	Pagination parameter to limit output to n , default = 100 , maximum value = 1000
sortkey	-	string	Sorting key parameter i.e. created_at
sortdirection	-	string	Sorting order direction parameter ASC or DESC (DESC by default)

Filters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
html	-	bool	true or false
notification_event	-	string	Event name

Other

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required[flow]	type	description
created_at.from	-	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Parameter to filter notifications date range. Format: ISO 8601 (yyyy-mm-ddThh:mm:ss.sssZ) or short type of date (yyyy-mm-dd) or specify time offsets from UTC (yyyy-mm-ddThh:mm:ss+hh:mm)
created_at.to	-	string(ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ)	Parameter to filter notifications date range. Format: ISO 8601 (yyyy-mm-ddThh:mm:ss.sssZ) or short type of date (yyyy-mm-dd) or specify time offsets from UTC (yyyy-mm-ddThh:mm:ss+hh:mm)

","urlObject":{"path":["v1","notifications","templates"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"5d1c1ba6-57c3-4df7-83ec-ece2c208feb8","name":"search templates","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"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 10:50:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"6125"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"17ed-XhgwzEoRJVYiDfWH3m6UWA\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"templates\",\n \"data\": [\n {\n \"_id\": \"5f588d954d9f505928aca283\",\n \"created_at\": \"2020-09-09T08:08:53.962Z\",\n \"updated_at\": \"2020-09-09T08:08:53.962Z\",\n \"html\": false,\n \"notification_event\": \"subscription_failed\",\n \"body\": \"O)lol {{EMAIL}} {{AMOUNT}}{{CUSTOMER_REFERENCE}}\",\n \"label\": \"Sms template\"\n },\n {\n \"_id\": \"5ebe7c762da56d524c66edf8\",\n \"created_at\": \"2020-05-15T11:26:46.180Z\",\n \"updated_at\": \"2020-05-15T11:26:46.180Z\",\n \"html\": true,\n \"notification_event\": \"transaction_success\",\n \"body\": \"test {{ brand }}\",\n \"label\": \"Test brand\"\n },\n {\n \"_id\": \"5eb3f746cf13724d2da45bf2\",\n \"created_at\": \"2020-05-07T11:55:50.361Z\",\n \"updated_at\": \"2020-05-07T11:55:50.361Z\",\n \"html\": true,\n \"notification_event\": \"transaction_success\",\n \"body\": \"\\n\\n\\n\\t\\n\\t\\n\\t\\n\\t\\n\\n\\t\\n\\t\\n\\n\\n\\n\\n\\n\\n\\n\\n\\t\\n\\n\\t\\t\\n\\t\\n

\\n\\n\\n\\t\\t\\t\\n\\t\\t\\t\\n\\n\\t\\t\\t\\t\\n\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t

\\n\\t\\t\\t\\t\\t\\t\\n\\n\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t \\n\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t\\t\\n\\n\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\n\\n\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\n\\n\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\n\\n\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\n\\n\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t

\\n\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t\\n\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t\\t $\\\"\\\"$ \\n\\t\\t\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t \\n\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t \\n\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t

\\n\\t\\t

\\n\\n\\n\",\n \"label\": \"Test\"\n }\n ],\n \"count\": 3,\n \"limit\": 100,\n \"skip\": 0\n }\n}"},{"id":"788ca09f-1735-4d9c-889f-87171bb11775","name":"search templates by html","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/templates?html=false","host":["{{url}}"],"path":["v1","notifications","templates"],"query":[{"key":"html","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","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 "},{"key":"ETag","value":"W/\"15f-FuSvCU0/O+A9JhGMA+5oAg\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"templates\",\n \"data\": [\n {\n \"_id\": \"5f588d954d9f505928aca283\",\n \"created_at\": \"2020-09-09T08:08:53.962Z\",\n \"updated_at\": \"2020-09-09T08:08:53.962Z\",\n \"html\": false,\n \"notification_event\": \"subscription_failed\",\n \"body\": \"O)lol {{EMAIL}} {{AMOUNT}}{{CUSTOMER_REFERENCE}}\",\n \"label\": \"Sms template\"\n }\n ],\n \"count\": 1,\n \"limit\": 100,\n \"skip\": 0\n }\n}"},{"id":"8d8e22e0-6229-44fc-91a1-760db7ed9df0","name":"search templates by notification event","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/templates?notification_event=transaction_success","host":["{{url}}"],"path":["v1","notifications","templates"],"query":[{"key":"notification_event","value":"transaction_success"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 10:56:55 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"5873"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"16f1-nYaScLHSaSImIZ+H7cr5ug\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"templates\",\n \"data\": [\n {\n \"_id\": \"5ebe7c762da56d524c66edf8\",\n \"created_at\": \"2020-05-15T11:26:46.180Z\",\n \"updated_at\": \"2020-05-15T11:26:46.180Z\",\n \"html\": true,\n \"notification_event\": \"transaction_success\",\n \"body\": \"test {{ brand }}\",\n \"label\": \"Test brand\"\n },\n {\n \"_id\": \"5eb3f746cf13724d2da45bf2\",\n \"created_at\": \"2020-05-07T11:55:50.361Z\",\n \"updated_at\": \"2020-05-07T11:55:50.361Z\",\n \"html\": true,\n \"notification_event\": \"transaction_success\",\n \"body\": \"\\n\\n\\n\\t\\n\\t\\n\\t\\n\\t\\n\\n\\t\\n\\t\\n\\n\\n\\n\\n\\n\\n\\n\\n\\t\\n\\n\\t\\t\\n\\t\\n

\\n\\n\\n\\t\\t\\t\\n\\t\\t\\t\\n\\n\\t\\t\\t\\t\\n\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t

\\n\\t\\t\\t\\t\\t\\t\\n\\n\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t \\n\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t

\\n\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t\\n\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t\\t $\\\"\\\"$ \\n\\t\\t\\t\\t\\t\\t\\t\\t\\t\\n\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t \\n\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t \\n\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t\\t\\t\\t

\\n\\t\\t\\t\\t\\t

\\n\\t\\t

\\n\\n\\n\",\n \"label\": \"Test\"\n }\n ],\n \"count\": 2,\n \"limit\": 100,\n \"skip\": 0\n }\n}"},{"id":"b75e2ac4-a3c7-4afb-a4b2-9709321495e1","name":"search templates with pagination","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/templates?skip=1&limit=1","host":["{{url}}"],"path":["v1","notifications","templates"],"query":[{"key":"skip","value":"1"},{"key":"limit","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 09 Sep 2020 10:55:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"314"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PayDock "},{"key":"ETag","value":"W/\"13a-gZnrkDmOzxfHJlndE9S+7A\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"templates\",\n \"data\": [\n {\n \"_id\": \"5ebe7c762da56d524c66edf8\",\n \"created_at\": \"2020-05-15T11:26:46.180Z\",\n \"updated_at\": \"2020-05-15T11:26:46.180Z\",\n \"html\": true,\n \"notification_event\": \"transaction_success\",\n \"body\": \"test {{ brand }}\",\n \"label\": \"Test brand\"\n }\n ],\n \"count\": 3,\n \"limit\": 1,\n \"skip\": 1\n }\n}"}],"_postman_id":"c3f1fcd4-d605-47ab-b6ef-e289671cfb84"},{"name":"get template","id":"22a3a933-266b-45dc-b6da-310547cf22bd","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/:id","description":"

Get specific notification template by template id.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","notifications","templates",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5ebe7c762da56d524c66edf8","key":"id"}]}},"response":[{"id":"1c08b887-f46e-4fa9-82e4-f17fc49d3f9c","name":"get template","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/templates/:id","host":["{{url}}"],"path":["v1","notifications","templates",":id"],"variable":[{"key":"id","value":"5ebe7c762da56d524c66edf8"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","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":"PayDock "},{"key":"ETag","value":"W/\"11a-OdZp4hUmT0meEQTeyFa8pA\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"template\",\n \"data\": {\n \"_id\": \"5ebe7c762da56d524c66edf8\",\n \"created_at\": \"2020-05-15T11:26:46.180Z\",\n \"updated_at\": \"2020-05-15T11:26:46.180Z\",\n \"html\": true,\n \"notification_event\": \"transaction_success\",\n \"body\": \"test {{ brand }}\",\n \"label\": \"Test brand\"\n }\n }\n}"}],"_postman_id":"22a3a933-266b-45dc-b6da-310547cf22bd"},{"name":"modify template","id":"bdaa4117-093f-420f-ad1d-97c7c2c921e5","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\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":"{{url}}/v1/notifications/templates/:id","description":"

Update a notification template (available only in email and SMS type of notifications).

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
body	+	string	Use custom text or/and predefined variables, in which PayDock automatically pulls values from customer, charge or subscription data objects.
label	+	string	Name of current template to identify it further
html	-	bool	Body could be in html or plain text format. Allowed values true, false, default is false
notification_event	+	string	Event to trigger notification: transaction_success, transaction_failure, subscription_transaction, subscription_transaction_failure, subscription_creation_success , subscription_creation_failure, subscription_updated, subscription_finished, subscription_failed, refund_requested, refund_successful, refund_failure, card_expiration_warning, transfer_pending, transfer_requested, transfer_partially_approved, transfer_partially_declined, transfer_declined, transfer_approved

","urlObject":{"path":["v1","notifications","templates",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5f58de89fb861d6300bdfdff","key":"id"}]}},"response":[{"id":"b6c142b0-4d74-453b-9c23-89590626ad72","name":"modify template","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\"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":"5f58de89fb861d6300bdfdff"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","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":"PayDock "},{"key":"ETag","value":"W/\"13e-U9UP3beJ2+Ju2wOYzCpNPg\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"template\",\n \"data\": {\n \"_id\": \"5f58de89fb861d6300bdfdff\",\n \"created_at\": \"2020-09-09T13:54:17.944Z\",\n \"updated_at\": \"2020-09-09T14:02:50.659Z\",\n \"label\": \"Sms first template\",\n \"notification_event\": \"transaction_failure\",\n \"body\": \"Charge {{CHARGE_ID}} with {{AMOUNT}} {{CURRENCY}} edited\"\n }\n }\n}"}],"_postman_id":"bdaa4117-093f-420f-ad1d-97c7c2c921e5"},{"name":"delete template","id":"c8d01671-7368-46b7-8676-319575561768","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.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","notifications","templates",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5f58de89fb861d6300bdfdff","key":"id"}]}},"response":[{"id":"8755bfd6-149d-4194-b141-6eacfc622a55","name":"delete template","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/templates/:id","host":["{{url}}"],"path":["v1","notifications","templates",":id"],"variable":[{"key":"id","value":"5f58de89fb861d6300bdfdff"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","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":"PayDock "},{"key":"ETag","value":"W/\"13e-IQJpRvlLk0f4Y7GmLSLBXA\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"template\",\n \"data\": {\n \"_id\": \"5f58de89fb861d6300bdfdff\",\n \"created_at\": \"2020-09-09T13:54:17.944Z\",\n \"updated_at\": \"2020-09-09T19:30:39.267Z\",\n \"label\": \"Sms first template\",\n \"notification_event\": \"transaction_failure\",\n \"body\": \"Charge {{CHARGE_ID}} with {{AMOUNT}} {{CURRENCY}} edited\"\n }\n }\n}"}],"_postman_id":"c8d01671-7368-46b7-8676-319575561768"},{"name":"get template variables","id":"7eb7731d-893a-451b-8483-0a62ae1fe66b","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":"d6007702-863a-4d8d-a1de-3dfe43614226","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":"PayDock "},{"key":"ETag","value":"W/\"de2-kfWIB0VjYcBd224uWkew7g\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"variables\",\n \"data\": [\n {\n \"event\": \"transaction_success\",\n \"variables\": [\n \"CHARGE_ID\",\n \"EMAIL\",\n \"FIRST_NAME\",\n \"LAST_NAME\",\n \"PHONE\",\n \"AMOUNT\",\n \"CURRENCY\",\n \"CUSTOMER_REFERENCE\",\n \"CHARGE_REFERENCE\",\n \"CHARGE_DESCRIPTION\",\n \"CREATED_AT\",\n \"UPDATED_AT\"\n ]\n },\n {\n \"event\": \"transaction_failure\",\n \"variables\": [\n \"CHARGE_ID\",\n \"EMAIL\",\n \"FIRST_NAME\",\n \"LAST_NAME\",\n \"PHONE\",\n \"AMOUNT\",\n \"CURRENCY\",\n \"CUSTOMER_REFERENCE\",\n \"CHARGE_REFERENCE\",\n \"CHARGE_DESCRIPTION\",\n \"CREATED_AT\",\n \"UPDATED_AT\"\n ]\n },\n {\n \"event\": \"subscription_transaction\",\n \"variables\": [\n \"CHARGE_ID\",\n \"EMAIL\",\n \"FIRST_NAME\",\n \"LAST_NAME\",\n \"PHONE\",\n \"AMOUNT\",\n \"CURRENCY\",\n \"CUSTOMER_REFERENCE\",\n \"CHARGE_REFERENCE\",\n \"CHARGE_DESCRIPTION\",\n \"CREATED_AT\",\n \"UPDATED_AT\"\n ]\n },\n {\n \"event\": \"subscription_transaction_failure\",\n \"variables\": [\n \"CHARGE_ID\",\n \"EMAIL\",\n \"FIRST_NAME\",\n \"LAST_NAME\",\n \"PHONE\",\n \"AMOUNT\",\n \"CURRENCY\",\n \"CUSTOMER_REFERENCE\",\n \"CHARGE_REFERENCE\",\n \"CHARGE_DESCRIPTION\",\n \"CREATED_AT\",\n \"UPDATED_AT\"\n ]\n },\n {\n \"event\": \"subscription_creation_success\",\n \"variables\": [\n \"SUBSCRIPTION_ID\",\n \"EMAIL\",\n \"FIRST_NAME\",\n \"LAST_NAME\",\n \"PHONE\",\n \"AMOUNT\",\n \"CURRENCY\",\n \"CUSTOMER_REFERENCE\",\n \"CHARGE_REFERENCE\",\n \"CHARGE_DESCRIPTION\",\n \"CREATED_AT\",\n \"UPDATED_AT\"\n ]\n },\n {\n \"event\": \"subscription_creation_failure\",\n \"variables\": [\n \"EMAIL\",\n \"FIRST_NAME\",\n \"LAST_NAME\",\n \"PHONE\",\n \"AMOUNT\",\n \"CURRENCY\",\n \"CUSTOMER_REFERENCE\",\n \"CHARGE_REFERENCE\",\n \"CHARGE_DESCRIPTION\",\n \"CREATED_AT\",\n \"UPDATED_AT\"\n ]\n },\n {\n \"event\": \"subscription_failed\",\n \"variables\": [\n \"EMAIL\",\n \"FIRST_NAME\",\n \"LAST_NAME\",\n \"PHONE\",\n \"AMOUNT\",\n \"CURRENCY\",\n \"CUSTOMER_REFERENCE\",\n \"CHARGE_REFERENCE\",\n \"CHARGE_DESCRIPTION\",\n \"CREATED_AT\",\n \"UPDATED_AT\"\n ]\n },\n {\n \"event\": \"subscription_updated\",\n \"variables\": [\n \"SUBSCRIPTION_ID\",\n \"EMAIL\",\n \"FIRST_NAME\",\n \"LAST_NAME\",\n \"PHONE\",\n \"AMOUNT\",\n \"CURRENCY\",\n \"CUSTOMER_REFERENCE\",\n \"CHARGE_REFERENCE\",\n \"CHARGE_DESCRIPTION\",\n \"CREATED_AT\",\n \"UPDATED_AT\"\n ]\n },\n {\n \"event\": \"subscription_finished\",\n \"variables\": [\n \"SUBSCRIPTION_ID\",\n \"EMAIL\",\n \"FIRST_NAME\",\n \"LAST_NAME\",\n \"PHONE\",\n \"AMOUNT\",\n \"CURRENCY\",\n \"CUSTOMER_REFERENCE\",\n \"REFERENCE\",\n \"DESCRIPTION\",\n \"CREATED_AT\",\n \"UPDATED_AT\",\n \"STATUS\",\n \"COMPLETED_COUNT\"\n ]\n },\n {\n \"event\": \"refund_requested\",\n \"variables\": [\n \"CHARGE_ID\",\n \"EMAIL\",\n \"FIRST_NAME\",\n \"LAST_NAME\",\n \"PHONE\",\n \"AMOUNT\",\n \"CURRENCY\",\n \"CUSTOMER_REFERENCE\",\n \"CHARGE_REFERENCE\",\n \"CHARGE_DESCRIPTION\",\n \"CREATED_AT\",\n \"UPDATED_AT\"\n ]\n },\n {\n \"event\": \"refund_success\",\n \"variables\": [\n \"CHARGE_ID\",\n \"EMAIL\",\n \"FIRST_NAME\",\n \"LAST_NAME\",\n \"PHONE\",\n \"AMOUNT\",\n \"REFUND_AMOUNT\",\n \"CURRENCY\",\n \"CUSTOMER_REFERENCE\",\n \"CHARGE_REFERENCE\",\n \"CHARGE_DESCRIPTION\",\n \"CREATED_AT\",\n \"UPDATED_AT\"\n ]\n },\n {\n \"event\": \"refund_failure\",\n \"variables\": [\n \"CHARGE_ID\",\n \"EMAIL\",\n \"FIRST_NAME\",\n \"LAST_NAME\",\n \"PHONE\",\n \"AMOUNT\",\n \"REFUND_AMOUNT\",\n \"CURRENCY\",\n \"CUSTOMER_REFERENCE\",\n \"CHARGE_REFERENCE\",\n \"CHARGE_DESCRIPTION\",\n \"CREATED_AT\",\n \"UPDATED_AT\"\n ]\n },\n {\n \"event\": \"card_expiration_warning\",\n \"variables\": [\n \"EXPIRE_MONTH\",\n \"EXPIRE_YEAR\",\n \"CARD_NUMBER_LAST4\",\n \"CARD_SCHEME\",\n \"EMAIL\",\n \"FIRST_NAME\",\n \"LAST_NAME\",\n \"PHONE\",\n \"CUSTOMER_REFERENCE\",\n \"CREATED_AT\",\n \"UPDATED_AT\"\n ]\n },\n {\n \"event\": \"transfer_pending\",\n \"variables\": [\n \"TRANSFER_ID\",\n \"DESCRIPTION\",\n \"REFERENCE\",\n \"CURRENCY\",\n \"CREATED_AT\",\n \"UPDATED_AT\"\n ]\n },\n {\n \"event\": \"transfer_requested\",\n \"variables\": [\n \"TRANSFER_ID\",\n \"DESCRIPTION\",\n \"REFERENCE\",\n \"CURRENCY\",\n \"CREATED_AT\",\n \"UPDATED_AT\"\n ]\n },\n {\n \"event\": \"transfer_partially_approved\",\n \"variables\": [\n \"TRANSFER_ID\",\n \"DESCRIPTION\",\n \"REFERENCE\",\n \"CURRENCY\",\n \"CREATED_AT\",\n \"UPDATED_AT\"\n ]\n },\n {\n \"event\": \"transfer_partially_declined\",\n \"variables\": [\n \"TRANSFER_ID\",\n \"DESCRIPTION\",\n \"REFERENCE\",\n \"CURRENCY\",\n \"CREATED_AT\",\n \"UPDATED_AT\"\n ]\n },\n {\n \"event\": \"transfer_declined\",\n \"variables\": [\n \"TRANSFER_ID\",\n \"DESCRIPTION\",\n \"REFERENCE\",\n \"CURRENCY\",\n \"CREATED_AT\",\n \"UPDATED_AT\"\n ]\n },\n {\n \"event\": \"transfer_approved\",\n \"variables\": [\n \"TRANSFER_ID\",\n \"DESCRIPTION\",\n \"REFERENCE\",\n \"CURRENCY\",\n \"CREATED_AT\",\n \"UPDATED_AT\"\n ]\n }\n ]\n }\n}"}],"_postman_id":"7eb7731d-893a-451b-8483-0a62ae1fe66b"}],"id":"c81653f8-f7c2-4f2d-884d-9db1311e6e70","description":"

Templates are used for creating email and sms notifications.

Templates resource

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
body	+	string	Use custom text or/and predefined variables, in which PayDock automatically pulls values from customer, charge or subscription data objects.
label	+	string	Name of current template to identify it further
html	+	bool	Body could be in html or plain text format. Allowed values true, false
notification_event	+	string	Event to trigger notification. Look at the Event table

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"49e2bd7d-fc34-4a47-af20-811dc75a377f"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"55e71758-14eb-4ec9-a70f-4d4b10dce3d6"}}],"_postman_id":"c81653f8-f7c2-4f2d-884d-9db1311e6e70"},{"name":"create","id":"ad75a0bf-77f0-404d-976d-8f2322ba2f32","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://webhooks.com/\",\n \"type\": \"webhook\"\n}"},"url":"{{url}}/v1/notifications","description":"

Created 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).

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
type	+	string	type of notification: webhook, email, sms
destination	+	string	Where to send notification (URL for webhook, email address for email ({{EMAIL}} for current customer), phone number in international E.164 format ({{PHONE}} for current customer))
template_id	+email, +sms	string	Custom template, which can be used with email or sms notifications
event	+	string	Event to trigger notification. Look at the Event table

","urlObject":{"path":["v1","notifications"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d6b8cc68-d041-4219-945f-916ae7ce77f3","name":"create notification webhook","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 \"event\": \"transaction_success\",\n \"destination\": \"http://webhooks.com/\",\n \"type\": \"webhook\"\n}"},"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":"PayDock "},{"key":"ETag","value":"W/\"bc-YDX0W9mGxj4rD5YMpCROFw\""},{"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\": \"notification\",\n \"data\": {\n \"event\": \"transaction_success\",\n \"destination\": \"http://webhooks.com/\",\n \"type\": \"webhook\",\n \"_id\": \"5f58aadf4d9f505928aca28a\"\n }\n }\n}"}],"_postman_id":"ad75a0bf-77f0-404d-976d-8f2322ba2f32"},{"name":"search","id":"8436c7c2-1044-414a-b3f0-8c84aa9f540f","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","description":"

Returns all notification triggers for the account, limited to 100 records.

\n","urlObject":{"path":["v1","notifications"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"6f8cd630-ee6b-4d77-8e77-68bff728c272","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":"PayDock "},{"key":"ETag","value":"W/\"2d4-vqQnca5vrMgh6dYptzXtgg\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"notifications\",\n \"data\": [\n {\n \"type\": \"webhook\",\n \"event\": \"transaction_success\",\n \"destination\": \"https://enr10dgiqawe.x.pipedream.net/\",\n \"from\": \"\",\n \"_id\": \"5e4b915bcd34da6dde6d1615\"\n },\n {\n \"type\": \"email\",\n \"event\": \"transaction_success\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"destination\": \"eduard.n@paydock.com\",\n \"from\": \"testtest@test.test\",\n \"subject\": \"Test\",\n \"_id\": \"5ebe7c9e2da56d524c66edf9\"\n },\n {\n \"type\": \"sms\",\n \"event\": \"subscription_failed\",\n \"template_id\": \"5f588d954d9f505928aca283\",\n \"destination\": \"{{PHONE}}\",\n \"from\": \"\",\n \"_id\": \"5f588db64d9f505928aca284\"\n },\n {\n \"event\": \"transaction_success\",\n \"destination\": \"http://webhooks.com/\",\n \"type\": \"webhook\",\n \"_id\": \"5f58aadf4d9f505928aca28a\"\n }\n ],\n \"count\": 4,\n \"limit\": 0,\n \"skip\": 0\n }\n}"}],"_postman_id":"8436c7c2-1044-414a-b3f0-8c84aa9f540f"},{"name":"get","id":"91ef71dd-64e5-4c49-9eb4-5626376bf945","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/:id","description":"

Retrive details on a specific notification.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","notifications",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5ebe7c9e2da56d524c66edf9","key":"id"}]}},"response":[{"id":"e03537e8-6218-4ba5-81c7-bb9f7f1582a6","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":"PayDock "},{"key":"ETag","value":"W/\"110-AJGPG+PXnQ3dcPF/ydaFVw\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"notification\",\n \"data\": {\n \"type\": \"email\",\n \"event\": \"transaction_success\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"destination\": \"eduard.n@paydock.com\",\n \"from\": \"testtest@test.test\",\n \"subject\": \"Test\",\n \"_id\": \"5ebe7c9e2da56d524c66edf9\"\n }\n }\n}"}],"_postman_id":"91ef71dd-64e5-4c49-9eb4-5626376bf945"},{"name":"resend webhook notification","id":"830e05cf-3230-40da-aeb6-35b2660b64e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","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/logs/:id","description":"

Resend webhook notification.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
destination	-	string	Where to send notification (URL)

","urlObject":{"path":["v1","notifications","logs",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5f58eb6d61d0d5314e1089dc","key":"id"}]}},"response":[{"id":"a05f3613-5ab6-4d80-9f76-4aa5919ea471","name":"resend webhook notification","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":"{}","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":"X-Powered-By","value":"PayDock "},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"486"},{"key":"ETag","value":"W/\"1e6-fRLxe42W/5i3II+IS87YqQ\""},{"key":"Date","value":"Wed, 09 Sep 2020 19:49:37 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"notification_log\",\n \"data\": {\n \"__v\": 0,\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"created_at\": \"2020-09-09T19:49:37.249Z\",\n \"success\": false,\n \"type\": \"webhook\",\n \"destination\": \"https://www.google.com/\",\n \"_object_id\": \"5f58eb0061d0d5314e1089da\",\n \"notification_id\": \"5f58eb6d61d0d5314e1089dc\",\n \"parent_id\": \"5f58eb6d61d0d5314e1089dc\",\n \"event\": \"transaction_success\",\n \"response_status\": \"405\",\n \"status\": \"processing\",\n \"_id\": \"5f5931d163abd512e47c7753\",\n \"archived\": false\n }\n }\n}"},{"id":"b86312c9-0379-4a97-8d04-d0d106944bb2","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\": \"https://www.google.com/\"\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":"PayDock "},{"key":"ETag","value":"W/\"1e6-e04AGBr5wT0dws7piCTtSA\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"notification_log\",\n \"data\": {\n \"__v\": 0,\n \"company_id\": \"5d305bfbfac31b4448c738d7\",\n \"created_at\": \"2020-09-11T09:59:09.140Z\",\n \"success\": false,\n \"type\": \"webhook\",\n \"destination\": \"https://www.google.com/\",\n \"_object_id\": \"5f58eb0061d0d5314e1089da\",\n \"notification_id\": \"5f58eb6d61d0d5314e1089dc\",\n \"parent_id\": \"5f58eb6d61d0d5314e1089dc\",\n \"event\": \"transaction_success\",\n \"response_status\": \"405\",\n \"status\": \"processing\",\n \"_id\": \"5f5b4a6dbcff3a3646e6fdfd\",\n \"archived\": false\n }\n }\n}"}],"_postman_id":"830e05cf-3230-40da-aeb6-35b2660b64e6"},{"name":"delete","id":"f6a73d00-bb92-493c-9cdc-1d9a9f1fa16e","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/:id","description":"

Delete a notification.

Request params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
id	+	string (24 byte hex)	_id received at the creation stage

","urlObject":{"path":["v1","notifications",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5ebe7c9e2da56d524c66edf9","key":"id"}]}},"response":[{"id":"896f8ec6-9077-4cea-b503-b2d7fe578118","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":"PayDock "},{"key":"ETag","value":"W/\"110-AJGPG+PXnQ3dcPF/ydaFVw\""},{"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\": 200,\n \"error\": null,\n \"resource\": {\n \"type\": \"notification\",\n \"data\": {\n \"type\": \"email\",\n \"event\": \"transaction_success\",\n \"template_id\": \"5ebe7c762da56d524c66edf8\",\n \"destination\": \"eduard.n@paydock.com\",\n \"from\": \"testtest@test.test\",\n \"subject\": \"Test\",\n \"_id\": \"5ebe7c9e2da56d524c66edf9\"\n }\n }\n}"}],"_postman_id":"f6a73d00-bb92-493c-9cdc-1d9a9f1fa16e"}],"id":"f905cbd9-d314-495c-b385-0d355ac5fb3c","description":"

Notifications are automated messages that are triggered in response to events within the system.

Within PayDock, notification triggers are set up to fire on different events. Notification triggers can have have different types (i.e. Webhook, Email, Sms) and events (i.e. Transaction Success).

Notifications for email and SMS require templates for the notification.

Notification resource

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	required	type	description
type	+	string	type of notification: webhook, email, sms
destination	+	string	Where to send notification (URL for webhook, email address for email ({{EMAIL}} for current customer), phone number in international E.164 format ({{PHONE}} for current customer))
template_id	+email, +sms	string	Custom template, which can be used with email or sms notifications
event	+	string	Event to trigger notification. Look at the Event table

Event

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	description
transaction_success	Transaction processed successfully
transaction_failure	Transaction processed unsuccessfully
subscription_transaction	Transaction processed by subscription
subscription_transaction_failure	Transaction processed by subscription unsuccessfully
subscription_creation_success	Subscription created successfully
subscription_creation_failure	Subscription created unsuccessfully
subscription_updated	Subscription was updated
subscription_finished	Subscription was finished
subscription_failed	Subscription failed
refund_requested	Refund was requested
refund_successful	Refund processed successfully
refund_failure	Refund processed unsuccessfully
card_expiration_warning	Card will be expired soon
transfer_pending	Transfer on a pending status
transfer_requested	Transfer requested
transfer_partially_approved	Transfer is partially approved
transfer_partially_declined	Transfer is partially declined
transfer_declined	Transfer declined
transfer_approved	Transfer approved

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"4b92833b-f1b7-4331-83f8-56500dd612be"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"8a234a11-70fe-48e0-bc53-3e4b6a4fdcf7"}}],"_postman_id":"f905cbd9-d314-495c-b385-0d355ac5fb3c"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2c4c5b87-7130-4b15-ab66-8ecf425c69b5"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"f87d2e11-3527-48d3-8f26-2cf4db31f0c3"}}]}