{"__v":29,"_id":"555e6654750e240d00cc2f41","category":{"__v":6,"_id":"556f6b2aebba950d008e951a","pages":["556f727cfc3aa80d00e1ac57","556f72cafc3aa80d00e1ac59","556f737d9893290d00988cdd","556f74989893290d00988cee","556f75109893290d00988cf1","556f7573fc3aa80d00e1ac6e"],"project":"555e500957fe0a0d00c8f1e7","version":"555e500957fe0a0d00c8f1ea","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-06-03T21:01:30.170Z","from_sync":false,"order":3,"slug":"payments","title":"Running a Campaign"},"parentDoc":null,"project":"555e500957fe0a0d00c8f1e7","user":"550c941bd1063b2d00359239","version":{"__v":13,"_id":"555e500957fe0a0d00c8f1ea","project":"555e500957fe0a0d00c8f1e7","createdAt":"2015-05-21T21:37:13.474Z","releaseDate":"2015-05-21T21:37:13.474Z","categories":["555e500957fe0a0d00c8f1eb","555e5fcedf54680d001800db","555e60d7df54680d001800fb","555e6766df54680d00180118","556f4d5debba950d008e9462","556f60959893290d00988c5b","556f6216ebba950d008e94e6","556f6b2aebba950d008e951a","556f71b6fc3aa80d00e1ac55","5570a30bcc189a21001ab44c","56ba3656ce5d540d00e2d789","56bce73a3ad5140d00055345","592874f7bdc27e1b00e571b1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-05-21T23:12:20.871Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":true,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"Tilt Pro puts you in full control of the data associated with your contributions and payments. The following sections are applicable to both crowdfunding and pre-order campaigns.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Where to find payment data\"\n}\n[/block]\nYou can find information about your payments by visiting the campaign payments page.\n\nNavigate to the payments page by clicking the \"View Payments\" button located in the navbar of your admin panel.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/j0p8gcPQmyYCFojQJcRc_view_payments.png\",\n        \"view_payments.png\",\n        \"2554\",\n        \"110\",\n        \"#29852f\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Payment Statuses Explained\"\n}\n[/block]\nIn your payments dashboard, you'll notice several different payment statuses. Make sure you're familiar with each status so that you can answer questions from your customers along the way.\n\n+ **Authorized** - We've put a hold on the card, but the customer has not yet been charged. [More Info](https://docs.tilt.com/v1.0/docs/payment-basics#section-2-charge-at-a-later-date-).\n+ **Rejected** - Card was initially authorized, but our attempt to charge that card failed. [More Info](https://docs.tilt.com/v1.0/docs/payment-basics#section-2-charge-at-a-later-date-).\n+ **Charged** - Successful payment with an active order.\n+ **Refunded** - The customer made a successful payment, which has been refunded. [More Info](https://docs.tilt.com/docs/refunds).\n+ **Error** - Payment attempt unsuccessful.\n+ **Released** - Funds have been collected by Tilt and then paid to the organizer. \n+ **Disputed** - The customer filed a chargeback on this order with their bank. [More Info](doc:chargebacks) \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Editing payment information\"\n}\n[/block]\nTo edit information about a specific payment, click the \"Edit\" link located next to the respective payment.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/HYAUgq5hRvSruIdurW2K_edit_payment.png\",\n        \"edit_payment.png\",\n        \"2116\",\n        \"960\",\n        \"#206591\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nWhen clicked, you'll be taken to a page where you can edit information, including shipping address and any applicable custom options, associated with the payment.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/zAoAwxvhQA29tnwp2IjI_editing_payment.png\",\n        \"editing_payment.png\",\n        \"2154\",\n        \"1380\",\n        \"#2f7189\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Exporting payment data\"\n}\n[/block]\nTilt Pro provides two ways to export payment data: via a downloadable CSV and as a JSON array via an API endpoint. The returned data can be consumed by 3rd party applications like BackerKit and fulfillment / shipping companies.\n\n## To download a CSV of all payments:\n\n1. Click the \"View Payments\" button located in the navbar of your admin panel to navigate to the payments page\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ZuKnx1ryQs2KxRDWJIqo_view_payments.png\",\n        \"view_payments.png\",\n        \"2554\",\n        \"110\",\n        \"#29852f\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n2. Click the download icon on the payments page. Your CSV will begin downloading immediately.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/7375cbd-Screen_Shot_2016-09-07_at_4.26.34_PM.png\",\n        \"Screen Shot 2016-09-07 at 4.26.34 PM.png\",\n        1698,\n        576,\n        \"#f8f8f8\"\n      ]\n    }\n  ]\n}\n[/block]\n## To access your payment data as a JSON array via the /payments API endpoint:\n\n1. To find your API credentials and example usage, click on the \"Edit Campaign\" link in the navbar of your admin panel and scroll down to the \"Advanced Settings\" section.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/LzRf3XYQHaTwxcxODw7E_edit_campaign.png\",\n        \"edit_campaign.png\",\n        \"2550\",\n        \"98\",\n        \"#1967d6\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/7WuQukGlSIKqkQO23Z6A_advanced_settings.png\",\n        \"advanced_settings.png\",\n        \"2072\",\n        \"1050\",\n        \"#397387\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nHere's a sample JSON array returned by the /payments endpoint:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[\\n  {\\n  id: 297744,\\n  ct_payment_id: \\\"CON941AA4FE7FAD48518C3C1283DEB554F6\\\",\\n  status: \\\"charged\\\",\\n  quantity: 1,\\n  total_amount_charged: 10900,\\n  amount: 10900,\\n  subtotal_amount: 9900,\\n  shipping_fee_amount: 1000,\\n  user_fee_amount: 0,\\n  fullname: \\\"Bruce Wayne\\\",\\n  email: \\\"brucew:::at:::tilt.com\\\",\\n  address_one: \\\"370 Townsend St\\\",\\n  address_two: \\\"\\\",\\n  city: \\\"San Francisco\\\",\\n  state: \\\"CA\\\",\\n  postal_code: \\\"94107-1607\\\",\\n  country: \\\"US\\\",\\n  additional_info: null,\\n  reward_id: 9530,\\n  custom_options: {\\n  color: \\\"Onyx\\\"\\n  },\\n  promo_code_code: null,\\n  promo_code_amount: null,\\n  referral_code: \\\"Hx39HiC3\\\",\\n  referring_code: null,\\n  referred_count: null,\\n  created_at: \\\"2015-09-24T19:05:18+00:00\\\",\\n  updated_at: \\\"2015-09-24T19:05:24+00:00\\\",\\n  is_recurring: false,\\n  original_total_charged: 10900,\\n  refunded_total: 0\\n  }\\n]\\n\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n2. You can filter results returned by the endpoint by including the following URL parameters:\n\n*`created_after` or `updated_after`:*\n* ISO8601 date string, like 2015-10-07T15:04:46Z\n\n*`order_by`:*\n\n* created_at\n* updated_at\n* status\n\n*`order_direction`:*\n\n* asc\n* desc\n\n*`limit`:*\n\n* 1…5k (defaults to 5k)\n\n*`offset`*\n\n*Example usage (get the 5000 most recently updated payments):*\n\n```\n?order_by=updated_at&order_direction=desc\n```","excerpt":"","slug":"managing-customer-data","type":"basic","title":"Managing Payment Data"}

Managing Payment Data


Tilt Pro puts you in full control of the data associated with your contributions and payments. The following sections are applicable to both crowdfunding and pre-order campaigns. [block:api-header] { "type": "basic", "title": "Where to find payment data" } [/block] You can find information about your payments by visiting the campaign payments page. Navigate to the payments page by clicking the "View Payments" button located in the navbar of your admin panel. [block:image] { "images": [ { "image": [ "https://files.readme.io/j0p8gcPQmyYCFojQJcRc_view_payments.png", "view_payments.png", "2554", "110", "#29852f", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Payment Statuses Explained" } [/block] In your payments dashboard, you'll notice several different payment statuses. Make sure you're familiar with each status so that you can answer questions from your customers along the way. + **Authorized** - We've put a hold on the card, but the customer has not yet been charged. [More Info](https://docs.tilt.com/v1.0/docs/payment-basics#section-2-charge-at-a-later-date-). + **Rejected** - Card was initially authorized, but our attempt to charge that card failed. [More Info](https://docs.tilt.com/v1.0/docs/payment-basics#section-2-charge-at-a-later-date-). + **Charged** - Successful payment with an active order. + **Refunded** - The customer made a successful payment, which has been refunded. [More Info](https://docs.tilt.com/docs/refunds). + **Error** - Payment attempt unsuccessful. + **Released** - Funds have been collected by Tilt and then paid to the organizer. + **Disputed** - The customer filed a chargeback on this order with their bank. [More Info](doc:chargebacks) [block:api-header] { "type": "basic", "title": "Editing payment information" } [/block] To edit information about a specific payment, click the "Edit" link located next to the respective payment. [block:image] { "images": [ { "image": [ "https://files.readme.io/HYAUgq5hRvSruIdurW2K_edit_payment.png", "edit_payment.png", "2116", "960", "#206591", "" ] } ] } [/block] When clicked, you'll be taken to a page where you can edit information, including shipping address and any applicable custom options, associated with the payment. [block:image] { "images": [ { "image": [ "https://files.readme.io/zAoAwxvhQA29tnwp2IjI_editing_payment.png", "editing_payment.png", "2154", "1380", "#2f7189", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Exporting payment data" } [/block] Tilt Pro provides two ways to export payment data: via a downloadable CSV and as a JSON array via an API endpoint. The returned data can be consumed by 3rd party applications like BackerKit and fulfillment / shipping companies. ## To download a CSV of all payments: 1. Click the "View Payments" button located in the navbar of your admin panel to navigate to the payments page [block:image] { "images": [ { "image": [ "https://files.readme.io/ZuKnx1ryQs2KxRDWJIqo_view_payments.png", "view_payments.png", "2554", "110", "#29852f", "" ] } ] } [/block] 2. Click the download icon on the payments page. Your CSV will begin downloading immediately. [block:image] { "images": [ { "image": [ "https://files.readme.io/7375cbd-Screen_Shot_2016-09-07_at_4.26.34_PM.png", "Screen Shot 2016-09-07 at 4.26.34 PM.png", 1698, 576, "#f8f8f8" ] } ] } [/block] ## To access your payment data as a JSON array via the /payments API endpoint: 1. To find your API credentials and example usage, click on the "Edit Campaign" link in the navbar of your admin panel and scroll down to the "Advanced Settings" section. [block:image] { "images": [ { "image": [ "https://files.readme.io/LzRf3XYQHaTwxcxODw7E_edit_campaign.png", "edit_campaign.png", "2550", "98", "#1967d6", "" ] } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/7WuQukGlSIKqkQO23Z6A_advanced_settings.png", "advanced_settings.png", "2072", "1050", "#397387", "" ] } ] } [/block] Here's a sample JSON array returned by the /payments endpoint: [block:code] { "codes": [ { "code": "[\n {\n id: 297744,\n ct_payment_id: \"CON941AA4FE7FAD48518C3C1283DEB554F6\",\n status: \"charged\",\n quantity: 1,\n total_amount_charged: 10900,\n amount: 10900,\n subtotal_amount: 9900,\n shipping_fee_amount: 1000,\n user_fee_amount: 0,\n fullname: \"Bruce Wayne\",\n email: \"brucew@tilt.com\",\n address_one: \"370 Townsend St\",\n address_two: \"\",\n city: \"San Francisco\",\n state: \"CA\",\n postal_code: \"94107-1607\",\n country: \"US\",\n additional_info: null,\n reward_id: 9530,\n custom_options: {\n color: \"Onyx\"\n },\n promo_code_code: null,\n promo_code_amount: null,\n referral_code: \"Hx39HiC3\",\n referring_code: null,\n referred_count: null,\n created_at: \"2015-09-24T19:05:18+00:00\",\n updated_at: \"2015-09-24T19:05:24+00:00\",\n is_recurring: false,\n original_total_charged: 10900,\n refunded_total: 0\n }\n]\n", "language": "json" } ] } [/block] 2. You can filter results returned by the endpoint by including the following URL parameters: *`created_after` or `updated_after`:* * ISO8601 date string, like 2015-10-07T15:04:46Z *`order_by`:* * created_at * updated_at * status *`order_direction`:* * asc * desc *`limit`:* * 1…5k (defaults to 5k) *`offset`* *Example usage (get the 5000 most recently updated payments):* ``` ?order_by=updated_at&order_direction=desc ```