{"_id":"59fb6fac3010280010381f72","project":"542998547a6b69080076806e","version":{"_id":"542998547a6b690800768071","__v":9,"project":"542998547a6b69080076806e","createdAt":"2014-09-29T17:35:16.249Z","releaseDate":"2014-09-29T17:35:16.249Z","categories":["542998547a6b690800768072","5433027990d63b1c0030c0f1","5433028190d63b1c0030c0f2","5433028d9a2b451a00ad4508","5433055790d63b1c0030c10a","5461417d37e5bc200049e1e4","54624066ddd31b0800a58db4","54625de66d1f1010002f3901","54d309955616470d0013cc55"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"54d309955616470d0013cc55","pages":["54d309f42ce0e00d00751632","56b36ff3ce8e5a1700f7c3e0"],"__v":2,"project":"542998547a6b69080076806e","version":"542998547a6b690800768071","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-02-05T06:11:33.180Z","from_sync":false,"order":9999,"slug":"api-access","title":"API Access"},"user":"5697f0662cf4060d004eaa76","__v":1,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-02T19:19:08.467Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"name":"","code":"","language":"text"}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"Public\": {\n        \"AppInfo\": {\n            \"CurrencyIcon\": \"/img/offerwall/v3/coins.png\",\n            \"VC\": \"credits\"\n        },\n        \"LocalRate\": {\n            \"CurrencyCode\": \"CAD\",\n            \"CurrencySymbol\": \"$\",\n            \"ToUSRate\": 0.87,\n            \"Rate\": 0.868485,\n            \"ToUSText\": \"0.87 USD <span style='font-weight: normal;'>=</span> 1 CAD\",\n            \"HasLocalRate\": true\n        },\n        \"DPProviders\": [\n            {\n                \"OfferID\": 7197,\n                \"DpayType\": \"cash\",\n                \"Groups\": [\n                    \"creditcard\"\n                ],\n                \"Name\": \"Gate2Shop\",\n                \"ShortName\": \"gate2shop\",\n                \"Description\": \"Buy credits with a variety of credit cards\",\n                \"ShortDescription\": \"Credit Card\",\n                \"LongDescription\": \"Pay directly using your <b>credit card</b>.\",\n                \"ClickURL\": \"//127.0.0.1/super/dpay?h=qklpxnirydfjkpynbnnkjjcillnpohnkgox.702789491499&dpsl=0&cc=CA\",\n                \"PopURL\": \"//127.0.0.1:8080/super/popup?h=uittyljizjfukjzqaimcnhkmmjogsnnvgiy.664032991778&dpsl=0&cc=CA\",\n                \"OpenNewWindow\": true,\n                \"GeoAvailability\": \"ad,ae,af,ag,ai,al,am,an,ao,aq,ar,as,at,au,aw,ax,az,ba,bb,bd,be,bf,bg,bh,bi,bj,bl,bm,bn,bo,br,bs,bt,bv,bw,by,bz,ca,cc,cd,cf,cg,ch,ci,ck,cl,cm,cn,co,cr,cu,cv,cx,cy,cz,de,dj,dk,dm,do,dz,ec,ee,eg,eh,er,es,et,fi,fj,fk,fm,fo,fr,ga,gb,gd,ge,gf,gg,gh,gi,gl,gm,gn,gp,gq,gr,gs,gt,gu,gw,gy,hk,hm,hn,hr,ht,hu,id,ie,il,im,in,io,ir,is,it,je,jm,jo,jp,ke,kg,kh,ki,km,kn,kp,kr,kw,ky,kz,la,lb,lc,li,lk,lr,ls,lt,lu,lv,ly,ma,mc,md,me,mf,mg,mh,mk,ml,mm,mn,mo,mp,mq,mr,ms,mt,mu,mv,mw,mx,my,mz,na,nc,ne,nf,ng,ni,nl,no,np,nr,nu,nz,om,pa,pe,pf,pg,ph,pk,pl,pm,pn,pr,ps,pt,pw,py,qa,re,ro,rs,ru,rw,sa,sb,sc,sd,se,sg,sh,si,sj,sk,sl,sm,sn,so,sr,st,sv,sy,sz,tc,td,tf,tg,th,tj,tk,tl,tm,tn,to,tr,tt,tv,tw,tz,ua,ug,uk,um,us,uy,uz,va,vc,ve,vg,vi,vn,vu,wf,ws,ye,yt,za,zm,zw\",\n                \"OfferImpressionPixelURL\": \"http://127.0.0.1:8081/offer_impression?data=eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1MDk2NDYyMDAsIm5iZiI6MTUwOTY0NjIwMCwiaWlkIjo2MzMxOTE1MDk1MzcyNDk1LCJldmVudF9zb3VyY2UiOiI4NSIsImFwcF9pZCI6IjQxNyIsInNlc3Npb25faWQiOiI3NTE5MDQ3MiIsImNvdW50cnlfY29kZSI6IkNBIn0.itC1O6qMPpissdUrTj1GPeLEUyEm0mg-YSfp3oIM0gk&oids=7197\",\n                \"PricePointType\": \"variable\",\n                \"Image\": \"http://assets.superrewards-offers.com/img/directpay/widget/creditcard.png\",\n                \"PricePoints\": [\n                    {\n                        \"points\": 2500,\n                        \"amount\": 50,\n                        \"us_amount\": \"$50.00 USD\",\n                        \"local_amount\": \"$57.57 CAD\",\n                        \"us_text\": \"2500 credits for $50.00 USD\",\n                        \"local_text\": \"2500 credits for $57.57 CAD\",\n                        \"entrypointurl\": \"\"\n                    },\n                    {\n                        \"points\": 2000,\n                        \"amount\": 40,\n                        \"us_amount\": \"$40.00 USD\",\n                        \"local_amount\": \"$46.06 CAD\",\n                        \"us_text\": \"2000 credits for $40.00 USD\",\n                        \"local_text\": \"2000 credits for $46.06 CAD\",\n                        \"entrypointurl\": \"\"\n                    },\n                    {\n                        \"points\": 1500,\n                        \"amount\": 30,\n                        \"us_amount\": \"$30.00 USD\",\n                        \"local_amount\": \"$34.54 CAD\",\n                        \"us_text\": \"1500 credits for $30.00 USD\",\n                        \"local_text\": \"1500 credits for $34.54 CAD\",\n                        \"entrypointurl\": \"\"\n                    },\n                    {\n                        \"points\": 1000,\n                        \"amount\": 20,\n                        \"us_amount\": \"$20.00 USD\",\n                        \"local_amount\": \"$23.03 CAD\",\n                        \"us_text\": \"1000 credits for $20.00 USD\",\n                        \"local_text\": \"1000 credits for $23.03 CAD\",\n                        \"entrypointurl\": \"\"\n                    },\n                    {\n                        \"points\": 500,\n                        \"amount\": 10,\n                        \"us_amount\": \"$10.00 USD\",\n                        \"local_amount\": \"$11.51 CAD\",\n                        \"us_text\": \"500 credits for $10.00 USD\",\n                        \"local_text\": \"500 credits for $11.51 CAD\",\n                        \"entrypointurl\": \"\"\n                    },\n                    {\n                        \"points\": 250,\n                        \"amount\": 5,\n                        \"us_amount\": \"$5.00 USD\",\n                        \"local_amount\": \"$5.76 CAD\",\n                        \"us_text\": \"250 credits for $5.00 USD\",\n                        \"local_text\": \"250 credits for $5.76 CAD\",\n                        \"entrypointurl\": \"\"\n                    }\n                ]\n            }\n        ]\n    },\n    \"ErrorCode\": \"\",\n    \"ErrorMessage\": \"\",\n    \"HTTPResponseCode\": 200\n}","name":""},{"status":400,"language":"json","code":"{\n    \"Offers\": [],\n    \"ErrorCode\": \"400v0\",\n    \"ErrorMessage\": \"INVALID REQUEST: No arguments passed\",\n    \"HTTPResponseCode\": 400\n}","name":""}]},"auth":"never","params":[{"_id":"54d309f42ce0e00d00751633","ref":"","in":"query","required":true,"desc":"App hash","default":"icfb","type":"string","name":"h"},{"_id":"54d30e03d0b2871900cda6b9","ref":"","in":"query","required":true,"desc":"Unique User ID in your system.","default":"12340987","type":"int","name":"uid"},{"_id":"561458cf79fdd00d0085b1fb","ref":"","in":"query","required":true,"desc":"The user's IP address, so we can determine which offers to fetch based on geographic location","default":"","type":"string","name":"ip"},{"_id":"54d30e03d0b2871900cda6b8","ref":"","in":"query","required":false,"desc":"The number of offers to return (per tab). Defaults to 30.","default":"30","type":"int","name":"n_offers"},{"_id":"54d309f42ce0e00d00751634","ref":"","in":"query","required":false,"desc":"When requesting paginated results, set to the page number you are requesting. 0 based. Defaults to 0 if not specified.","default":"0","type":"int","name":"page"},{"_id":"54d30e03d0b2871900cda6b3","ref":"","in":"query","required":false,"desc":"Client supplied custom parameters. Specify any parameter you require (starting with \"custom_\"). These custom parameters are passed back to your server postback endpoint upon successfull completion.","default":"","type":"string","name":"custom_MYVALUE"},{"_id":"59fb6fac3010280010381f73","ref":"","in":"query","required":false,"desc":"Set &type=directpay to use the Public API for Direct Payment data","default":"","type":"string","name":"type"}],"url":"/Public"},"isReference":false,"order":999,"body":"[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"This exposes the same API we use to display our offer wall if you [use our iFrame integration](doc:getting-started) so that you can incorporate direct pay methods into your own user experience, in the best times and places for your users.\",\n  \"title\": \"Customize Your Experience\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Required Fields\"\n}\n[/block]\n\nWhile it has options that allow a lot of flexibility, you only need two fields:\n* `h`: the app hash for your app, generated by our system and available in your [Dashboard](https://pub.superrewards.com).  For more info see [Foundation: Hashes and Keys](doc:foundation-app-hashes-keys-and-signing).\n* `uid`: a unique ID for the user, either numeric or text. Check out our [Notes on UIDs](doc:notes-on-uids). \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Using The Results\"\n}\n[/block]\nThe Direct Payment Methods API returns three objects inside a 'Public' object as a JSON encoded string. AppInfo, LocalRate, and DPProviders. Each of these provide information which can be used to customize your display and inform the functionality of your interface.\n[block:api-header]\n{\n  \"title\": \"AppInfo\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"CurrencyIcon\",\n    \"h-0\": \"Field Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Example Value\",\n    \"0-1\": \"The image URL for your virtual currency icon. Can be changed in your publisher dashboard.\",\n    \"0-2\": \"https://wall.superrewards.com/img/offerwall/v3/coins.png\",\n    \"1-0\": \"VC\",\n    \"1-1\": \"The name you've given for your virtual currency. Can be set in your publisher dashboard.\",\n    \"1-2\": \"Credits\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"LocalRate\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Example Value\",\n    \"0-0\": \"CurrencyCode\",\n    \"0-1\": \"The currency code for the user's locale, which payment method prices will appear in unless they do not support the local currency.\",\n    \"0-2\": \"USD, CAD, EUR\",\n    \"1-0\": \"CurrencySymbol\",\n    \"1-1\": \"The symbol for the user's local currency.\",\n    \"1-2\": \"$\",\n    \"2-0\": \"ToUSRate\",\n    \"2-1\": \"Rounded currency conversion for the user's local currency to US dollars, for display purposes.\",\n    \"2-2\": \"0.87\",\n    \"3-0\": \"Rate\",\n    \"3-1\": \"Unrounded conversion rate.\",\n    \"3-2\": \"0.868485\",\n    \"4-0\": \"ToUSText\",\n    \"4-1\": \"Nicely formatted text string stating the conversion rate between USD and the user's local currency.\",\n    \"4-2\": \"0.87 USD <span style='font-weight: normal;'>=</span> 1 CAD\",\n    \"5-0\": \"HasLocalRate\",\n    \"5-1\": \"Boolean, states whether the user's local currency is supported by the payment method. If not, it will default to USD.\",\n    \"5-2\": \"true\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"DPProviders\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Example Value\",\n    \"0-0\": \"OfferID\",\n    \"0-1\": \"Our internal offer ID for this payment method\",\n    \"0-2\": \"7197\",\n    \"1-0\": \"Name\",\n    \"1-1\": \"Payment Method Name\",\n    \"1-2\": \"Paypal, Gate2Shop\",\n    \"2-0\": \"Description\",\n    \"3-0\": \"ShortDescription\",\n    \"4-0\": \"LongDescription\",\n    \"5-0\": \"ClickURL\",\n    \"6-0\": \"PopURL\",\n    \"7-0\": \"OpenNewWindow\",\n    \"8-0\": \"OfferImpressionPixelURL\",\n    \"9-0\": \"Image\",\n    \"10-0\": \"PricePoints\",\n    \"2-1\": \"Payment method description\",\n    \"3-1\": \"Shorter payment method description\",\n    \"4-1\": \"Longer payment method description. May contain HTML markup.\",\n    \"5-1\": \"The URL you must use to redirect the user to the payment provider; must provide &amount parameter using a valid price point (as listed in the PricePoints object JSON)\",\n    \"6-1\": \"URL to redirect a user to SuperRewards own payment popup widget, where they can then select a price point and carry on to the provider's payment page\",\n    \"7-1\": \"Should this provider be opened in a new window? Reference this in case your default behaviour is to open the provider payment page in a modal or iframe.\",\n    \"8-1\": \"Used for tracking an impression (view) for this offer in SuperRewards\",\n    \"9-1\": \"Payment provider logo image URL\",\n    \"10-1\": \"Array of valid price points for the payment method\",\n    \"2-2\": \"\\\"Buy credits with a variety of credit cards\\\"\",\n    \"3-2\": \"\\\"Credit Card\\\"\",\n    \"4-2\": \"\\\"Pay directly using your <b>credit card</b>.\\\"\",\n    \"5-2\": \"//wall.superrewards.com/super/dpay?h=skuoynnizefuqszlnchjljlhilsgsinvmry.141021574646&dpsl=0\",\n    \"6-2\": \"//wall.superrewards.com/super/popup?h=jomryoeszilrovzufblacndkgmjqsmtskuy.881280943314&dpsl=0\",\n    \"7-2\": \"true\",\n    \"8-2\": \"https://fast.superrewards.com/offer_impression?data=eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1MDk2NTA4NTUsIm5iZiI6MTUwOTY1MDg1NSwiaWlkIjo2MzMxOTM0NjIwNDM1Mzc5LCJldmVudF9zb3VyY2UiOiI4NSIsImFwcF9pZCI6IjQxNyIsInNlc3Npb25faWQiOiI3NTE5MDQ4MCIsImNvdW50cnlfY29kZSI6IkNBIn0.dUepZXtjbEn_E3LSGD5uhPpnfU4jnjA9HziPaURBGvE&oids=7197\",\n    \"9-2\": \"http://assets.superrewards-offers.com/img/directpay/widget/creditcard.png\",\n    \"10-2\": \"See below\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"PricePoints JSON fields\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Example Value\",\n    \"0-0\": \"Points\",\n    \"0-1\": \"Number of points this price point is worth, taking into account your app's VC ratio\",\n    \"0-2\": \"2500\",\n    \"1-0\": \"Amount\",\n    \"2-0\": \"USAmount\",\n    \"3-0\": \"LocalAmount\",\n    \"4-0\": \"USText\",\n    \"5-0\": \"LocalText\",\n    \"1-1\": \"The USD price for this price point. Pass this value in the &amount parameter on the click URL\",\n    \"2-1\": \"Nicely formatted amount, including currency symbol, code, and proper thousands and cents separator, if applicable.\",\n    \"1-2\": \"50\",\n    \"2-2\": \"$50.00 USD\",\n    \"3-1\": \"Nicely formatted amount including currency symbol and thousands separator, if applicable, for local price.\",\n    \"3-2\": \"$57.57 CAD\",\n    \"4-1\": \"Text string describing how many points for how much money, in USD\",\n    \"4-2\": \"\\\"2500 credits for $50.00 USD\\\"\",\n    \"5-1\": \"Text string describing how many points for how much money, in local currency\",\n    \"5-2\": \"\\\"2500 credits for $57.57 CAD\\\"\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"An Easy Test\",\n  \"body\": \"To try out the live tool below, use these values to get one offer back from the server:\\n* `h`: `icfb` (this is one of our test apps)\\n* `uid`: `9876541` (a fake user ID)\\n* `type`: `directpay`\"\n}\n[/block]","excerpt":"Our Public API for retrieving direct payment method data","slug":"direct-payment-methods-api","type":"endpoint","title":"Direct Payment Methods API"}

getDirect Payment Methods API

Our Public API for retrieving direct payment method data

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

h:
required
stringicfb
App hash
uid:
required
integer12340987
Unique User ID in your system.
ip:
required
string
The user's IP address, so we can determine which offers to fetch based on geographic location
n_offers:
integer30
The number of offers to return (per tab). Defaults to 30.
page:
integer0
When requesting paginated results, set to the page number you are requesting. 0 based. Defaults to 0 if not specified.
custom_MYVALUE:
string
Client supplied custom parameters. Specify any parameter you require (starting with "custom_"). These custom parameters are passed back to your server postback endpoint upon successfull completion.
type:
string
Set &type=directpay to use the Public API for Direct Payment data

Result Format


Documentation

[block:callout] { "type": "success", "body": "This exposes the same API we use to display our offer wall if you [use our iFrame integration](doc:getting-started) so that you can incorporate direct pay methods into your own user experience, in the best times and places for your users.", "title": "Customize Your Experience" } [/block] [block:api-header] { "type": "basic", "title": "Required Fields" } [/block] While it has options that allow a lot of flexibility, you only need two fields: * `h`: the app hash for your app, generated by our system and available in your [Dashboard](https://pub.superrewards.com). For more info see [Foundation: Hashes and Keys](doc:foundation-app-hashes-keys-and-signing). * `uid`: a unique ID for the user, either numeric or text. Check out our [Notes on UIDs](doc:notes-on-uids). [block:api-header] { "type": "basic", "title": "Using The Results" } [/block] The Direct Payment Methods API returns three objects inside a 'Public' object as a JSON encoded string. AppInfo, LocalRate, and DPProviders. Each of these provide information which can be used to customize your display and inform the functionality of your interface. [block:api-header] { "title": "AppInfo" } [/block] [block:parameters] { "data": { "0-0": "CurrencyIcon", "h-0": "Field Name", "h-1": "Description", "h-2": "Example Value", "0-1": "The image URL for your virtual currency icon. Can be changed in your publisher dashboard.", "0-2": "https://wall.superrewards.com/img/offerwall/v3/coins.png", "1-0": "VC", "1-1": "The name you've given for your virtual currency. Can be set in your publisher dashboard.", "1-2": "Credits" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "title": "LocalRate" } [/block] [block:parameters] { "data": { "h-0": "Field Name", "h-1": "Description", "h-2": "Example Value", "0-0": "CurrencyCode", "0-1": "The currency code for the user's locale, which payment method prices will appear in unless they do not support the local currency.", "0-2": "USD, CAD, EUR", "1-0": "CurrencySymbol", "1-1": "The symbol for the user's local currency.", "1-2": "$", "2-0": "ToUSRate", "2-1": "Rounded currency conversion for the user's local currency to US dollars, for display purposes.", "2-2": "0.87", "3-0": "Rate", "3-1": "Unrounded conversion rate.", "3-2": "0.868485", "4-0": "ToUSText", "4-1": "Nicely formatted text string stating the conversion rate between USD and the user's local currency.", "4-2": "0.87 USD <span style='font-weight: normal;'>=</span> 1 CAD", "5-0": "HasLocalRate", "5-1": "Boolean, states whether the user's local currency is supported by the payment method. If not, it will default to USD.", "5-2": "true" }, "cols": 3, "rows": 6 } [/block] [block:api-header] { "title": "DPProviders" } [/block] [block:parameters] { "data": { "h-0": "Field Name", "h-1": "Description", "h-2": "Example Value", "0-0": "OfferID", "0-1": "Our internal offer ID for this payment method", "0-2": "7197", "1-0": "Name", "1-1": "Payment Method Name", "1-2": "Paypal, Gate2Shop", "2-0": "Description", "3-0": "ShortDescription", "4-0": "LongDescription", "5-0": "ClickURL", "6-0": "PopURL", "7-0": "OpenNewWindow", "8-0": "OfferImpressionPixelURL", "9-0": "Image", "10-0": "PricePoints", "2-1": "Payment method description", "3-1": "Shorter payment method description", "4-1": "Longer payment method description. May contain HTML markup.", "5-1": "The URL you must use to redirect the user to the payment provider; must provide &amount parameter using a valid price point (as listed in the PricePoints object JSON)", "6-1": "URL to redirect a user to SuperRewards own payment popup widget, where they can then select a price point and carry on to the provider's payment page", "7-1": "Should this provider be opened in a new window? Reference this in case your default behaviour is to open the provider payment page in a modal or iframe.", "8-1": "Used for tracking an impression (view) for this offer in SuperRewards", "9-1": "Payment provider logo image URL", "10-1": "Array of valid price points for the payment method", "2-2": "\"Buy credits with a variety of credit cards\"", "3-2": "\"Credit Card\"", "4-2": "\"Pay directly using your <b>credit card</b>.\"", "5-2": "//wall.superrewards.com/super/dpay?h=skuoynnizefuqszlnchjljlhilsgsinvmry.141021574646&dpsl=0", "6-2": "//wall.superrewards.com/super/popup?h=jomryoeszilrovzufblacndkgmjqsmtskuy.881280943314&dpsl=0", "7-2": "true", "8-2": "https://fast.superrewards.com/offer_impression?data=eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1MDk2NTA4NTUsIm5iZiI6MTUwOTY1MDg1NSwiaWlkIjo2MzMxOTM0NjIwNDM1Mzc5LCJldmVudF9zb3VyY2UiOiI4NSIsImFwcF9pZCI6IjQxNyIsInNlc3Npb25faWQiOiI3NTE5MDQ4MCIsImNvdW50cnlfY29kZSI6IkNBIn0.dUepZXtjbEn_E3LSGD5uhPpnfU4jnjA9HziPaURBGvE&oids=7197", "9-2": "http://assets.superrewards-offers.com/img/directpay/widget/creditcard.png", "10-2": "See below" }, "cols": 3, "rows": 11 } [/block] [block:api-header] { "title": "PricePoints JSON fields" } [/block] [block:parameters] { "data": { "h-0": "Field Name", "h-1": "Description", "h-2": "Example Value", "0-0": "Points", "0-1": "Number of points this price point is worth, taking into account your app's VC ratio", "0-2": "2500", "1-0": "Amount", "2-0": "USAmount", "3-0": "LocalAmount", "4-0": "USText", "5-0": "LocalText", "1-1": "The USD price for this price point. Pass this value in the &amount parameter on the click URL", "2-1": "Nicely formatted amount, including currency symbol, code, and proper thousands and cents separator, if applicable.", "1-2": "50", "2-2": "$50.00 USD", "3-1": "Nicely formatted amount including currency symbol and thousands separator, if applicable, for local price.", "3-2": "$57.57 CAD", "4-1": "Text string describing how many points for how much money, in USD", "4-2": "\"2500 credits for $50.00 USD\"", "5-1": "Text string describing how many points for how much money, in local currency", "5-2": "\"2500 credits for $57.57 CAD\"" }, "cols": 3, "rows": 6 } [/block] [block:callout] { "type": "success", "title": "An Easy Test", "body": "To try out the live tool below, use these values to get one offer back from the server:\n* `h`: `icfb` (this is one of our test apps)\n* `uid`: `9876541` (a fake user ID)\n* `type`: `directpay`" } [/block]

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 }}