{"_id":"5609409b6d8c440d000c7a73","user":"55f8467359eace0d0087db7e","parentDoc":null,"version":{"_id":"55de36ec9067202b00de0015","__v":33,"project":"55dd0853d2d97337001800e2","createdAt":"2015-08-26T22:00:12.384Z","releaseDate":"2015-08-26T22:00:12.383Z","categories":["55de36ed9067202b00de0016","55de36ed9067202b00de0017","55de36ed9067202b00de0018","55df7dcd437b3f0d004ba204","55e4e014177b6e0d00333141","55e4e01fe252ac0d00303a99","55e4e05240cda60d003bad67","55e4e070177b6e0d00333142","55e4e0753325e60d007fbee6","55e4e0803325e60d007fbee7","55e4e086177b6e0d00333143","55e4e0a1177b6e0d00333144","55e4e0aa3325e60d007fbee8","55e4e0b140cda60d003bad6b","55e4e0bae252ac0d00303a9d","55e4e0c5177b6e0d00333145","55e4e0ee3325e60d007fbeea","55e4e0fae252ac0d00303a9e","55e4e100177b6e0d00333147","55f85c8ba3271b0d00498d55","56092e1ac5cff70d007d0131","564b64a3ee12850d0095866e","564b64b5791099170071e9ea","565cd0bfd18ae50d007183d8","565f5f5d6bafd40d0030a063","565f790d6bafd40d0030a09f","56611c464851190d003f9f5d","56637d5b7988ab0d00d0522e","56637d687988ab0d00d0522f","567835df6928b40d009dd650","56e59c043c29b117008dae5b","5704013559c5190e000ab646","572be252de40590e00026934","58af1bf6ebd7370f0078ba09","5cdad81d912ece0039e9a939"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3.0"},"githubsync":"","category":{"_id":"55e4e0aa3325e60d007fbee8","pages":["55e5f1059416190d00dc3a49","55e9fe81c584fb2300291dcf","55e9feaab44f7b1700e4527b","55e9fef4c584fb2300291dd1","56093fe48aedf50d0004d01e","5609409b6d8c440d000c7a73","5609411a8aedf50d0004d020","5641517d25f31f0d00ae7997","565d2cc52206890d00ba0578","56e889c6ce05a20e0010f7f7"],"version":"55de36ec9067202b00de0015","__v":10,"project":"55dd0853d2d97337001800e2","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-08-31T23:18:02.019Z","from_sync":false,"order":11,"slug":"payments","title":"Payments"},"project":"55dd0853d2d97337001800e2","__v":16,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-28T13:28:59.997Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"5693eae65f1c951900644c21","examples":{"codes":[]},"method":"put","results":{"codes":[{"language":"text","code":""}]},"auth":"required","params":[],"url":"/payments/:id"},"isReference":true,"order":4,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Payment details such as \\\"amount\\\", \\\"currency\\\", \\\"billingAddress\\\", and the payment source fund cannot be altered once the payment has been created.\",\n  \"title\": \"Payment details\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"description\",\n    \"0-1\": \"Optional\",\n    \"1-0\": \"meta\",\n    \"1-1\": \"Optional\",\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Required\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n\\t\\\"Accept\\\": \\\"application/json\\\",\\n  \\\"Content-Type\\\": \\\"application/json\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Headers\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"description\\\": \\\"Card payment update\\\",\\n  \\\"meta\\\": {\\n    \\\"clientPaymentId\\\": \\\"604648a0152646a1bd79c4\\\",\\n    \\\"note\\\": \\\"Payment has been updated\\\"\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Request\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"object\\\":\\\"payment\\\",\\n  \\\"id\\\":\\\"h3qo5rine8itrr43wfen2356\\\",\\n  \\\"amount\\\": \\\"20.37\\\",\\n  \\\"currency\\\": \\\"USD\\\",\\n  \\\"description\\\": \\\"Card payment update\\\",\\n  \\\"meta\\\": {\\n    \\\"clientPaymentId\\\": \\\"604648a0152646a1bd79c4\\\",\\n    \\\"note\\\": \\\"Payment has been updated\\\"\\n  },\\n  \\\"billingAddress\\\": {\\n    \\\"name\\\": \\\"Jessica Lin\\\",\\n    \\\"street1\\\": \\\"123 test st\\\",\\n    \\\"street2\\\": \\\"3g\\\",\\n    \\\"city\\\": \\\"santa cruz\\\",\\n    \\\"state\\\": \\\"CA\\\",\\n    \\\"postalCode\\\": \\\"95060-55\\\",\\n    \\\"country\\\": \\\"USA\\\"\\n  },\\n  \\\"personalContact\\\": {\\n    \\\"email\\\": \\\"jessica.lin:::at:::paystand.com\\n  },\\n  \\\"fees\\\": [\\n    {..}\\n  ],\\n  \\\"holds\\\": [\\n    {..}\\n  ],\\n  \\\"sourceId\\\": \\\"crjeild6qpfse3a09vhtxw\\\",\\n  \\\"sourceType\\\": \\\"Card\\\",\\n  \\\"status\\\": \\\"posted\\\",\\n  \\\"created\\\": \\\"2015-10-28T22:55:09.000Z\\\",\\n  \\\"lastUpdated\\\": \\\"2015-10-28T22:55:13.000Z\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Response\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"Update a Payment","slug":"update-payment","type":"endpoint","title":"Update a payment"}

putUpdate a payment

Update a Payment

Definition

{{ api_url }}{{ page_api_url }}

Documentation

[block:callout] { "type": "warning", "body": "Payment details such as \"amount\", \"currency\", \"billingAddress\", and the payment source fund cannot be altered once the payment has been created.", "title": "Payment details" } [/block] [block:parameters] { "data": { "0-0": "description", "0-1": "Optional", "1-0": "meta", "1-1": "Optional", "h-0": "Parameter", "h-1": "Required" }, "cols": 2, "rows": 2 } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n\t\"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "Headers" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"description\": \"Card payment update\",\n \"meta\": {\n \"clientPaymentId\": \"604648a0152646a1bd79c4\",\n \"note\": \"Payment has been updated\"\n }\n}", "language": "json", "name": "Request" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"object\":\"payment\",\n \"id\":\"h3qo5rine8itrr43wfen2356\",\n \"amount\": \"20.37\",\n \"currency\": \"USD\",\n \"description\": \"Card payment update\",\n \"meta\": {\n \"clientPaymentId\": \"604648a0152646a1bd79c4\",\n \"note\": \"Payment has been updated\"\n },\n \"billingAddress\": {\n \"name\": \"Jessica Lin\",\n \"street1\": \"123 test st\",\n \"street2\": \"3g\",\n \"city\": \"santa cruz\",\n \"state\": \"CA\",\n \"postalCode\": \"95060-55\",\n \"country\": \"USA\"\n },\n \"personalContact\": {\n \"email\": \"jessica.lin@paystand.com\n },\n \"fees\": [\n {..}\n ],\n \"holds\": [\n {..}\n ],\n \"sourceId\": \"crjeild6qpfse3a09vhtxw\",\n \"sourceType\": \"Card\",\n \"status\": \"posted\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "Response" } ], "sidebar": true } [/block]