{"__v":1,"_id":"55b0b0bbe7abe62300f9a8bb","category":{"__v":13,"_id":"55a64fe680c8a30d00b325e0","pages":["55a652b680c8a30d00b325ec","55a65a4251457325000e4d40","55a6705b80c8a30d00b32686","55a772393efe0c2f0074c8fe","55a7ae383efe0c2f0074caaf","55ae2ba22723e51900898fa0","55ae32628576b92300291cb3","55b0b0bbe7abe62300f9a8bb","55b0c6def202b12100cda2e7","55bf80af19dd820d0008a006","55c06be7344dc40d00f55859","55c06ccb37298d0d00088c72","561d098a09e6540d002ff602"],"project":"54ad7b1d9219922100751796","version":"5505581f728deb23005ec0f4","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-07-15T12:19:50.489Z","from_sync":false,"order":1,"slug":"rest-api-coming-soon","title":"REST API"},"project":"54ad7b1d9219922100751796","user":"55a38410912a6e2300882b88","version":{"__v":4,"_id":"5505581f728deb23005ec0f4","forked_from":"54ad7b1d9219922100751799","project":"54ad7b1d9219922100751796","createdAt":"2015-03-15T09:59:59.748Z","releaseDate":"2015-03-15T09:59:59.748Z","categories":["55055820728deb23005ec0f5","55055820728deb23005ec0f6","554213dacbc48d0d001544ef","55421a598aeff51700a20db6","55a64fe680c8a30d00b325e0"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-07-23T09:15:39.795Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"shell","code":"curl -H \"Authorization: Token 2a5bb3c446bdd71076202dcce4dcff57\" https://api2.vcita.com/v2/payments","name":""},{"code":"require 'net/http'\nrequire 'json'\n\nuri = URI('https://api2.vcita.com/v2/payments')\n\nres = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|\n  request = Net::HTTP::Get.new uri\n  request[\"Authorization\"] = \"Token 2a5bb3c446bdd71076202dcce4dcff57\"\n  http.request(request)\nend\n\nparsed_body = JSON.parse(res.body)","language":"ruby"},{"code":"import urllib\nimport urllib2\nimport json\n\nurl = 'https://api2.vcita.com/v2/payments'\nheaders = { 'Authorization' : 'Token 2a5bb3c446bdd71076202dcce4dcff57' }\nrequest = urllib2.Request(url, None, headers)\nresponse = urllib2.urlopen(request)\n\nparsed_data = json.loads(response.read())","language":"python"}]},"results":{"codes":[{"name":"","code":"[\n  {\n    \"uid\": \"a6f87f5c5877fe88\",\n    \"amount\": 1600,\n    \"amount_h\": \"$1600 USD\",\n    \"currency\": \"USD\",\n    \"type\": \"direct\",\n    \"paid\": true,\n    \"created_at\": \"2014-11-17T16:35:26.000+02:00\",\n    \"created_at_h\": \"Nov 17, 2014\",\n    \"payment_subject\": {\n      \"type\": \"payment_request\",\n      \"value\": {\n        \"uid\": \"aa25525253a8e2c8\",\n        \"title\": \"Payment For Helping with Excels\",\n        \"status_title\": \"Payment For Helping with Excels\",\n        \"paid_for\": \"Helping with Excels\",\n        \"paid_at\": \"2014-11-17T16:36:56.000+02:00\",\n        \"paid_at_h\": \"Nov 17, 2014\",\n        \"created_at\": \"2014-11-17T16:35:26.000+02:00\",\n        \"created_at_h\": \"Nov 17, 2014\",\n        \"conversation_uid\": \"3jziigf2sl1becb0\",\n        \"state\": \"completed\",\n        \"state_h\": \"Received\",\n        \"archived\": false,\n        \"description\": \"Received on Nov 17, 2014\",\n        \"amount\": \"1600.0\",\n        \"amount_h\": \"$1600 USD\",\n        \"notes\": \"You are amazing\",\n        \"payment_provider\": \"PayPal\",\n        \"client\": {\n          \"uid\": \"brc6d8osuqar0xfx\",\n          \"full_name\": \"Test Client\",\n          \"photo_path\": null\n        },\n        \"staff\": {\n          \"uid\": \"64beac3369e6d068\",\n          \"full_name\": \"Beverlyf\",\n          \"display_name\": \"Beverlyf\",\n          \"email\": \"test_client:::at:::vcita.com\",\n          \"photo_path\": null\n        }\n      }\n    },\n    \"client\": {\n      \"uid\": \"brc6d8osuqar0xfx\",\n      \"full_name\": \"Test Client\",\n      \"photo_path\": null\n    },\n    \"staff\": {\n      \"uid\": \"64beac3369e6d068\",\n      \"full_name\": \"Beverlyf\",\n      \"display_name\": \"Beverlyf\",\n      \"email\": \"test_client@vcita.com\",\n      \"photo_path\": null\n    }\n  }\n]","language":"json","status":200},{"name":"","code":"{\n  \"status\"=>\"failure\", \n  \"message\"=>\"401 Unauthorized\"\n}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":"/v2/payments"},"isReference":false,"order":8,"body":"","excerpt":"/v2/payments is an endpoint that returns a list of all payments. The response is in JSON format.","slug":"v2payments","type":"get","title":"/v2/payments"}

get/v2/payments

/v2/payments is an endpoint that returns a list of all payments. The response is in JSON format.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}