{"_id":"5d56fccfb1b7fc00334d193d","type":"basic","user":"55dd080d0efd5821000d53b3","body":"The PayStand API and Checkout Integration provide easy to use, customizable payment processing experiences for your app or website.\n\nThis document is intended for developers integrating payment processing features from PayStand into their own app or website.\n\nIf you have questions or want more information about this document or PayStand products and services, please call us at (800) 708-6413.","category":"5d56fccfb1b7fc00334d1913","githubsync":"","parentDoc":null,"slug":"getting-started","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":"","auth":"required","params":[]},"createdAt":"2015-08-26T00:29:08.950Z","excerpt":"","order":0,"updates":[],"version":"5d56fccfb1b7fc00334d1a04","__v":2,"hidden":false,"link_external":false,"sync_unique":"","title":"Getting Started","isReference":false,"link_url":"","project":"55dd0853d2d97337001800e2","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Getting Started


The PayStand API and Checkout Integration provide easy to use, customizable payment processing experiences for your app or website. This document is intended for developers integrating payment processing features from PayStand into their own app or website. If you have questions or want more information about this document or PayStand products and services, please call us at (800) 708-6413.
View all 86 endpoints
The PayStand API and Checkout Integration provide easy to use, customizable payment processing experiences for your app or website. This document is intended for developers integrating payment processing features from PayStand into their own app or website. If you have questions or want more information about this document or PayStand products and services, please call us at (800) 708-6413.
{"_id":"5d56fccfb1b7fc00334d1969","api":{"auth":"required","params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"createdAt":"2015-12-02T21:32:15.022Z","link_external":false,"type":"basic","body":"[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"Please contact [support@paystand.com](mailto:support@paystand.com) to request access to the PayStand Developer API, or contact your support representative for more details.\",\n  \"title\": \"Contact us\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"...you will be given the information in the table below which you can use to request [Access Tokens](doc:access-tokens) and to make Authenticated API requests.\",\n  \"title\": \"Once you've been granted access\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"applicationId\",\n    \"0-1\": \"The applicationId used to identify the Application.\",\n    \"1-0\": \"clientId\",\n    \"1-1\": \"The application client id.\",\n    \"2-0\": \"clientSecret\",\n    \"2-1\": \"The application client secret.\",\n    \"3-0\": \"customerId\",\n    \"3-1\": \"The application's customerId\",\n    \"4-0\": \"publishableKey\",\n    \"4-1\": \"The publishableKey associated with the Platform application's customer.\",\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]","excerpt":"","title":"API Access","updates":[],"user":"55f8467359eace0d0087db7e","order":1,"project":"55dd0853d2d97337001800e2","__v":12,"category":"5d56fccfb1b7fc00334d1913","hidden":false,"isReference":false,"link_url":"","sync_unique":"","version":"5d56fccfb1b7fc00334d1a04","githubsync":"","parentDoc":null,"slug":"getting-api-access","next":{"description":"","pages":[]},"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

API Access


[block:callout] { "type": "success", "body": "Please contact [support@paystand.com](mailto:support@paystand.com) to request access to the PayStand Developer API, or contact your support representative for more details.", "title": "Contact us" } [/block] [block:callout] { "type": "info", "body": "...you will be given the information in the table below which you can use to request [Access Tokens](doc:access-tokens) and to make Authenticated API requests.", "title": "Once you've been granted access" } [/block] [block:parameters] { "data": { "0-0": "applicationId", "0-1": "The applicationId used to identify the Application.", "1-0": "clientId", "1-1": "The application client id.", "2-0": "clientSecret", "2-1": "The application client secret.", "3-0": "customerId", "3-1": "The application's customerId", "4-0": "publishableKey", "4-1": "The publishableKey associated with the Platform application's customer.", "h-0": "Parameter", "h-1": "Description" }, "cols": 2, "rows": 5 } [/block]
[block:callout] { "type": "success", "body": "Please contact [support@paystand.com](mailto:support@paystand.com) to request access to the PayStand Developer API, or contact your support representative for more details.", "title": "Contact us" } [/block] [block:callout] { "type": "info", "body": "...you will be given the information in the table below which you can use to request [Access Tokens](doc:access-tokens) and to make Authenticated API requests.", "title": "Once you've been granted access" } [/block] [block:parameters] { "data": { "0-0": "applicationId", "0-1": "The applicationId used to identify the Application.", "1-0": "clientId", "1-1": "The application client id.", "2-0": "clientSecret", "2-1": "The application client secret.", "3-0": "customerId", "3-1": "The application's customerId", "4-0": "publishableKey", "4-1": "The publishableKey associated with the Platform application's customer.", "h-0": "Parameter", "h-1": "Description" }, "cols": 2, "rows": 5 } [/block]
{"_id":"5d56fccfb1b7fc00334d1968","version":"5d56fccfb1b7fc00334d1a04","__v":11,"excerpt":"","sync_unique":"","updates":[],"user":"55f8467359eace0d0087db7e","project":"55dd0853d2d97337001800e2","slug":"headers","title":"API Requests","body":"All APIs should operate using HTTPS (Secure HTTP using SSL).\n\nThe appropriate transmission method (POST, PUT, GET) are specified in the description of the individual endpoints later in this document.\n\nThe base URL for all APIs is “/api/v3”.\n\nAll request and response data is in JSON format.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Header\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"Accept\",\n    \"h-2\": \"\",\n    \"0-1\": \"Should be \\\"application/json\\\".\",\n    \"1-0\": \"Content-Type\",\n    \"1-1\": \"Should be \\\"application/json\\\".\",\n    \"2-0\": \"X-PUBLISHABLE-KEY\",\n    \"3-0\": \"X-CUSTOMER-ID\",\n    \"4-0\": \"Authorization\",\n    \"2-1\": \"A customer's publishable api key. This is required for non authenticated calls.\",\n    \"3-1\": \"Customer id. This is required for authenticated calls.\",\n    \"4-1\": \"The token type and access token values separated by a space.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"X-PUBLISHABLE-KEY\\\": \\\"9d56cd0a8fd84ba88a6a2209\\\",\\n  \\\"Accept\\\": \\\"application/json\\\",\\n  \\\"Content-Type\\\": \\\"application/json\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Non-authenticated Header\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 4e81e490877d45eca2a403c1\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"09b06ca057d6435bbdef67cf\\\",\\n  \\\"Accept\\\": \\\"application/json\\\",\\n  \\\"Content-Type\\\": \\\"application/json\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Authenticated Header\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","hidden":false,"link_external":false,"link_url":"","order":2,"category":"5d56fccfb1b7fc00334d1913","type":"basic","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"","auth":"required"},"createdAt":"2015-12-02T21:27:30.422Z","githubsync":"","isReference":false,"parentDoc":null,"next":{"description":"","pages":[]},"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

API Requests


All APIs should operate using HTTPS (Secure HTTP using SSL). The appropriate transmission method (POST, PUT, GET) are specified in the description of the individual endpoints later in this document. The base URL for all APIs is “/api/v3”. All request and response data is in JSON format. [block:parameters] { "data": { "h-0": "Header", "h-1": "Description", "0-0": "Accept", "h-2": "", "0-1": "Should be \"application/json\".", "1-0": "Content-Type", "1-1": "Should be \"application/json\".", "2-0": "X-PUBLISHABLE-KEY", "3-0": "X-CUSTOMER-ID", "4-0": "Authorization", "2-1": "A customer's publishable api key. This is required for non authenticated calls.", "3-1": "Customer id. This is required for authenticated calls.", "4-1": "The token type and access token values separated by a space." }, "cols": 2, "rows": 5 } [/block] [block:code] { "codes": [ { "code": "{\n \"X-PUBLISHABLE-KEY\": \"9d56cd0a8fd84ba88a6a2209\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "Non-authenticated Header" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 4e81e490877d45eca2a403c1\",\n \"X-CUSTOMER-ID\": \"09b06ca057d6435bbdef67cf\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "Authenticated Header" } ], "sidebar": true } [/block]
All APIs should operate using HTTPS (Secure HTTP using SSL). The appropriate transmission method (POST, PUT, GET) are specified in the description of the individual endpoints later in this document. The base URL for all APIs is “/api/v3”. All request and response data is in JSON format. [block:parameters] { "data": { "h-0": "Header", "h-1": "Description", "0-0": "Accept", "h-2": "", "0-1": "Should be \"application/json\".", "1-0": "Content-Type", "1-1": "Should be \"application/json\".", "2-0": "X-PUBLISHABLE-KEY", "3-0": "X-CUSTOMER-ID", "4-0": "Authorization", "2-1": "A customer's publishable api key. This is required for non authenticated calls.", "3-1": "Customer id. This is required for authenticated calls.", "4-1": "The token type and access token values separated by a space." }, "cols": 2, "rows": 5 } [/block] [block:code] { "codes": [ { "code": "{\n \"X-PUBLISHABLE-KEY\": \"9d56cd0a8fd84ba88a6a2209\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "Non-authenticated Header" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 4e81e490877d45eca2a403c1\",\n \"X-CUSTOMER-ID\": \"09b06ca057d6435bbdef67cf\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "Authenticated Header" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d1959","title":"Testing the API","category":"5d56fccfb1b7fc00334d1913","createdAt":"2015-11-29T19:52:42.102Z","githubsync":"","link_url":"","order":3,"parentDoc":null,"project":"55dd0853d2d97337001800e2","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required"},"body":"PayStand provides different credentials for you to test your integration against different responses.\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"Please click [here](doc:test-cards) for test cards, banks, and bank logins.\",\n  \"title\": \"How do I test a payment?\"\n}\n[/block]","hidden":false,"isReference":false,"slug":"sandbox","type":"basic","__v":65,"sync_unique":"","updates":[],"version":"5d56fccfb1b7fc00334d1a04","excerpt":"Test Cards, Banks, and Bank Logins","link_external":false,"user":"55dd080d0efd5821000d53b3","next":{"description":"","pages":[]},"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Testing the API

Test Cards, Banks, and Bank Logins

PayStand provides different credentials for you to test your integration against different responses. [block:callout] { "type": "success", "body": "Please click [here](doc:test-cards) for test cards, banks, and bank logins.", "title": "How do I test a payment?" } [/block]
PayStand provides different credentials for you to test your integration against different responses. [block:callout] { "type": "success", "body": "Please click [here](doc:test-cards) for test cards, banks, and bank logins.", "title": "How do I test a payment?" } [/block]
{"_id":"5d56fccfb1b7fc00334d19fb","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d193a","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-11T14:38:02.548Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Access tokens are used to authenticate users and applications on the API. To get started, create an access token.\n\n[Create an access token](doc:access-tokens)","excerpt":"","slug":"getting-started-3","type":"basic","title":"Getting Started","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Getting Started


Access tokens are used to authenticate users and applications on the API. To get started, create an access token. [Create an access token](doc:access-tokens)
Access tokens are used to authenticate users and applications on the API. To get started, create an access token. [Create an access token](doc:access-tokens)
{"_id":"5d56fccfb1b7fc00334d1995","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1922","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-29T00:52:21.253Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"# Documentation\n\n## Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"grant_type\",\n    \"1-0\": \"client_id\",\n    \"2-0\": \"client_secret\",\n    \"3-0\": \"scope\",\n    \"1-1\": \"This will be provided by PayStand.\",\n    \"2-1\": \"This will be provided by PayStand.\",\n    \"0-1\": \"```client_credentials```\",\n    \"3-1\": \"auth\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n## Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"access_token\",\n    \"1-0\": \"expires_in\",\n    \"2-0\": \"scope\",\n    \"3-0\": \"refresh_token\",\n    \"4-0\": \"token_type\",\n    \"1-1\": \"The time this token will expire.\",\n    \"2-1\": \"The scope for this access token.\",\n    \"3-1\": \"\",\n    \"4-1\": \"The token type. This will need to be sent as part of the Authorization header.\",\n    \"0-1\": \"The access token. This will need to be sent as part of the Authorization header.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]","excerpt":"","slug":"access-token","type":"basic","title":"Access Token","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Access Token


# Documentation ## Request [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "grant_type", "1-0": "client_id", "2-0": "client_secret", "3-0": "scope", "1-1": "This will be provided by PayStand.", "2-1": "This will be provided by PayStand.", "0-1": "```client_credentials```", "3-1": "auth" }, "cols": 2, "rows": 4 } [/block] ## Response [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "access_token", "1-0": "expires_in", "2-0": "scope", "3-0": "refresh_token", "4-0": "token_type", "1-1": "The time this token will expire.", "2-1": "The scope for this access token.", "3-1": "", "4-1": "The token type. This will need to be sent as part of the Authorization header.", "0-1": "The access token. This will need to be sent as part of the Authorization header." }, "cols": 2, "rows": 5 } [/block]
# Documentation ## Request [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "grant_type", "1-0": "client_id", "2-0": "client_secret", "3-0": "scope", "1-1": "This will be provided by PayStand.", "2-1": "This will be provided by PayStand.", "0-1": "```client_credentials```", "3-1": "auth" }, "cols": 2, "rows": 4 } [/block] ## Response [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "access_token", "1-0": "expires_in", "2-0": "scope", "3-0": "refresh_token", "4-0": "token_type", "1-1": "The time this token will expire.", "2-1": "The scope for this access token.", "3-1": "", "4-1": "The token type. This will need to be sent as part of the Authorization header.", "0-1": "The access token. This will need to be sent as part of the Authorization header." }, "cols": 2, "rows": 5 } [/block]
{"_id":"5d56fccfb1b7fc00334d1967","hidden":false,"link_external":false,"sync_unique":"","type":"post","user":"55f8467359eace0d0087db7e","excerpt":"","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\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  \\\"grant_type\\\": \\\"client_credentials\\\",\\n  \\\"client_id\\\": \\\"210858fbe0f648a480aa8e0c\\\",\\n  \\\"client_secret\\\": \\\"65c7ffa267064e0e8ffb46e9\\\",\\n  \\\"scope\\\": \\\"auth\\\"\\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  \\\"access_token\\\": \\\"d861a41675f645a2b9bcd27\\\",\\n  \\\"expires_in\\\": 1209600,\\n  \\\"scope\\\": \\\"auth\\\",\\n  \\\"refresh_token\\\": \\\"f20c7998e3684b8a80e77fba\\\",\\n  \\\"token_type\\\": \\\"Bearer\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"RESPONSE\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5d56fccfb1b7fc00334d1922","githubsync":"","link_url":"","order":1,"parentDoc":null,"title":"Create an access token","__v":25,"api":{"params":[{"_id":"5b5cb10acd6c2800034604a3","ref":"","in":"body","required":false,"desc":"","default":"required","type":"string","name":"grant_type"},{"_id":"5b5cb10acd6c2800034604a2","ref":"","in":"body","required":false,"desc":"","default":"required","type":"string","name":"client_id"},{"_id":"5b5cb10acd6c2800034604a1","ref":"","in":"body","required":false,"desc":"","default":"required","type":"string","name":"client_secret"},{"_id":"5b5cb10acd6c2800034604a0","ref":"","in":"body","required":false,"desc":"","default":"required","type":"string","name":"scope"},{"_id":"5b5cb10acd6c28000346049f","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5cb10acd6c28000346049e","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"}],"results":{"codes":[{"language":"text","code":""}]},"settings":"5693eae65f1c951900644c21","url":"/oauth/token","auth":"required","examples":{"codes":[]},"method":"post"},"createdAt":"2015-12-02T21:21:07.901Z","isReference":false,"slug":"access-tokens","updates":[],"next":{"description":"","pages":[]},"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postCreate an access token


Body Params

grant_type:
stringrequired
client_id:
stringrequired
client_secret:
stringrequired
scope:
stringrequired

Headers

Accept:
stringapplication/json
Content-Type:
stringapplication/json
[block:code] { "codes": [ { "code": "{\n\t\"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"210858fbe0f648a480aa8e0c\",\n \"client_secret\": \"65c7ffa267064e0e8ffb46e9\",\n \"scope\": \"auth\"\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"access_token\": \"d861a41675f645a2b9bcd27\",\n \"expires_in\": 1209600,\n \"scope\": \"auth\",\n \"refresh_token\": \"f20c7998e3684b8a80e77fba\",\n \"token_type\": \"Bearer\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


[block:code] { "codes": [ { "code": "{\n\t\"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"210858fbe0f648a480aa8e0c\",\n \"client_secret\": \"65c7ffa267064e0e8ffb46e9\",\n \"scope\": \"auth\"\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"access_token\": \"d861a41675f645a2b9bcd27\",\n \"expires_in\": 1209600,\n \"scope\": \"auth\",\n \"refresh_token\": \"f20c7998e3684b8a80e77fba\",\n \"token_type\": \"Bearer\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19b6","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1926","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-02T13:49:45.928Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Assurety allows a customer to securely store data on the blockchain. The data can be disclosed to third parties in a secure way, enabling them to verify the authenticity of the data against the blockchain.\n\n## Creating Assurety\nBefore being able to create Assurety Records, you will need to create the following objects:\n\n[Create an Assuror](doc:manage-assurors)\nAn Assuror represents a real world entity that can assure records.  An Assuror can create and manage wallets, schemas, and records. \n\n[Create a Wallet](doc:manage-wallets)\nAssurety Wallets are used to store cryptographic private/public key pairs associated with a public blockchain address. Wallets uniquely identify someone performing an action on the blockchain. Create a wallet to establish your identity.\n\n[Add a Schema](doc:managing-schemas)\nAn Assurety Schema is a special type of blockchain contract that conforms to the specification added to it. Add a schema to establish the shape of the data you want to assure.\n\n[Assure a Record](doc:managing-records)\nOnce an Assurer, a Wallet, and a Schema have been created, an Assurety Record can then be created.  An Assurety Record is a set of data that conforms to a schema specification and is represented as a smart contract token on a blockchain. Creating a record is the act of assuring data on the blockchain.\n\n## Verifying Assurety\n\n[Retrieve an ABI](doc:get-a-contract-spec)\nRetrieve a deployed contract's ABI interface. An ABI can be used with various tools to easily interact with a deployed contract. It is primarily used during assurety to retrieve a token from a contract to view the stored imprint.\n\n[Retrieve a Schema](doc:retreive-a-contract-schema)\nRetrieve a deployed contract's schema. Disclosures contain links to retrieve the schemas. Schemas can be used to validate disclosures. \n\n[Retrieve an Imprint](doc:get-an-imprint)\nRetrieve a record's imprint. Paystand stores a copy of the imprint for its own records in addition to the imprint being stored on the blockchain.\n\n[Retrieve a Token's metadata](doc:retreive-a-token)\nRetrieve a record's token meta data. Typically a name and description for the token.\n\n## What's next\n\n[Retrieve a Chain](doc:get-a-chain) \nGet the current details of a chain such as its host and port.\n\n[Retrieve a Contract](doc:get-a-contract)\nGet the current details of a contract, such as its ABI.","excerpt":"","slug":"assurety","type":"basic","title":"Getting Started","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Getting Started


Assurety allows a customer to securely store data on the blockchain. The data can be disclosed to third parties in a secure way, enabling them to verify the authenticity of the data against the blockchain. ## Creating Assurety Before being able to create Assurety Records, you will need to create the following objects: [Create an Assuror](doc:manage-assurors) An Assuror represents a real world entity that can assure records. An Assuror can create and manage wallets, schemas, and records. [Create a Wallet](doc:manage-wallets) Assurety Wallets are used to store cryptographic private/public key pairs associated with a public blockchain address. Wallets uniquely identify someone performing an action on the blockchain. Create a wallet to establish your identity. [Add a Schema](doc:managing-schemas) An Assurety Schema is a special type of blockchain contract that conforms to the specification added to it. Add a schema to establish the shape of the data you want to assure. [Assure a Record](doc:managing-records) Once an Assurer, a Wallet, and a Schema have been created, an Assurety Record can then be created. An Assurety Record is a set of data that conforms to a schema specification and is represented as a smart contract token on a blockchain. Creating a record is the act of assuring data on the blockchain. ## Verifying Assurety [Retrieve an ABI](doc:get-a-contract-spec) Retrieve a deployed contract's ABI interface. An ABI can be used with various tools to easily interact with a deployed contract. It is primarily used during assurety to retrieve a token from a contract to view the stored imprint. [Retrieve a Schema](doc:retreive-a-contract-schema) Retrieve a deployed contract's schema. Disclosures contain links to retrieve the schemas. Schemas can be used to validate disclosures. [Retrieve an Imprint](doc:get-an-imprint) Retrieve a record's imprint. Paystand stores a copy of the imprint for its own records in addition to the imprint being stored on the blockchain. [Retrieve a Token's metadata](doc:retreive-a-token) Retrieve a record's token meta data. Typically a name and description for the token. ## What's next [Retrieve a Chain](doc:get-a-chain) Get the current details of a chain such as its host and port. [Retrieve a Contract](doc:get-a-contract) Get the current details of a contract, such as its ABI.
Assurety allows a customer to securely store data on the blockchain. The data can be disclosed to third parties in a secure way, enabling them to verify the authenticity of the data against the blockchain. ## Creating Assurety Before being able to create Assurety Records, you will need to create the following objects: [Create an Assuror](doc:manage-assurors) An Assuror represents a real world entity that can assure records. An Assuror can create and manage wallets, schemas, and records. [Create a Wallet](doc:manage-wallets) Assurety Wallets are used to store cryptographic private/public key pairs associated with a public blockchain address. Wallets uniquely identify someone performing an action on the blockchain. Create a wallet to establish your identity. [Add a Schema](doc:managing-schemas) An Assurety Schema is a special type of blockchain contract that conforms to the specification added to it. Add a schema to establish the shape of the data you want to assure. [Assure a Record](doc:managing-records) Once an Assurer, a Wallet, and a Schema have been created, an Assurety Record can then be created. An Assurety Record is a set of data that conforms to a schema specification and is represented as a smart contract token on a blockchain. Creating a record is the act of assuring data on the blockchain. ## Verifying Assurety [Retrieve an ABI](doc:get-a-contract-spec) Retrieve a deployed contract's ABI interface. An ABI can be used with various tools to easily interact with a deployed contract. It is primarily used during assurety to retrieve a token from a contract to view the stored imprint. [Retrieve a Schema](doc:retreive-a-contract-schema) Retrieve a deployed contract's schema. Disclosures contain links to retrieve the schemas. Schemas can be used to validate disclosures. [Retrieve an Imprint](doc:get-an-imprint) Retrieve a record's imprint. Paystand stores a copy of the imprint for its own records in addition to the imprint being stored on the blockchain. [Retrieve a Token's metadata](doc:retreive-a-token) Retrieve a record's token meta data. Typically a name and description for the token. ## What's next [Retrieve a Chain](doc:get-a-chain) Get the current details of a chain such as its host and port. [Retrieve a Contract](doc:get-a-contract) Get the current details of a contract, such as its ABI.
{"_id":"5d56fccfb1b7fc00334d19a5","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192a","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-01T22:40:55.712Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /assurety/assurors\\n PUT /assurety/assurors/:id\\n GET /assurety/assurors/:id\\n GET /assurety/assurors\\nPOST /assurety/assurors/:id/activate\\nPOST /assurety/assurors/:id/deactivate\",\n      \"language\": \"json\",\n      \"name\": \"ENDPOINTS\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\nAn Assuror represents a real world entity that can assure records.  An Assuror can create and manage wallets, schemas, and records.","excerpt":"","slug":"manage-assurors","type":"basic","title":"Assurety Assurors","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Assurety Assurors


[block:code] { "codes": [ { "code": "POST /assurety/assurors\n PUT /assurety/assurors/:id\n GET /assurety/assurors/:id\n GET /assurety/assurors\nPOST /assurety/assurors/:id/activate\nPOST /assurety/assurors/:id/deactivate", "language": "json", "name": "ENDPOINTS" } ], "sidebar": true } [/block] An Assuror represents a real world entity that can assure records. An Assuror can create and manage wallets, schemas, and records.
[block:code] { "codes": [ { "code": "POST /assurety/assurors\n PUT /assurety/assurors/:id\n GET /assurety/assurors/:id\n GET /assurety/assurors\nPOST /assurety/assurors/:id/activate\nPOST /assurety/assurors/:id/deactivate", "language": "json", "name": "ENDPOINTS" } ], "sidebar": true } [/block] An Assuror represents a real world entity that can assure records. An Assuror can create and manage wallets, schemas, and records.
{"_id":"5d56fccfb1b7fc00334d19ce","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192a","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-04T17:23:10.694Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuror\\\",\\n  \\\"name\\\": \\\"Gano Welding Supplies, Inc\\\",\\n  \\\"description\\\": \\\"Welding Certificates\\\",\\n  \\\"status\\\": \\\"active\\\",\\n  \\\"meta\\\": {},\\n  \\\"created\\\": \\\"2015-10-28T22:55:09.000Z\\\",\\n  \\\"lastUpdated\\\": \\\"2015-10-28T22:55:13.000Z\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"THE ASSUROR OBJECT\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-1\": \"\",\n    \"h-0\": \"\",\n    \"0-0\": \"**id** *string*\\nThe unique identifier for the assuror.\",\n    \"1-0\": \"**object** *string, value is \\\"assuror\\\"* \",\n    \"2-0\": \"**name** *string* \\nA name describing the assuror.\",\n    \"3-0\": \"**description** *string* \\nA short description of the assuror.\",\n    \"4-0\": \"**meta** *object/hash*\\nOptional key/values to help link the assuror to an external system.\",\n    \"5-0\": \"**status** *string, possible values are: active, inactive, disabled* \\n*active*\\nAn assuror is created in the 'active' state. While in the 'active' state, an assuror can update themselves, manage wallets, create and update schemas, and issue certification records against those schemas. An assuror in the 'inactive' state can be moved to the 'active' state by calling the Activate assuror endpoint.\\n\\n*inactive*\\nAn assuror can be moved to the 'inactive' state by calling the Deactivate assuror endpoint. While in the 'inactive' state, an assuror can still update themselves, update wallets, update schemas, and update records that have already been created. They will not be able to create any new wallets, schemas, or records however.\\n\\n*disabled*\\nAn assuror may be moved automatically to the 'disabled' state under certain circumstances by Paystand. While an assuror is in the 'disabled' state they will not be allowed to perform any action on the assuror, its wallets, its schemas, or its records. Resources that had previously been created for the assuror can still be retrieved, however.\",\n    \"6-0\": \"**created** *datestring* \\nThe date the assuror was created.\",\n    \"6-1\": \"\",\n    \"7-0\": \"**lastUpdated** *datestring* \\nThe date the assuror was last updated.\",\n    \"0-1\": \"\",\n    \"1-1\": \"\",\n    \"7-1\": \"\",\n    \"5-1\": \"\",\n    \"2-1\": \"\",\n    \"3-1\": \"\",\n    \"4-1\": \"\"\n  },\n  \"cols\": 1,\n  \"rows\": 8\n}\n[/block]","excerpt":"","slug":"the-assuror-object","type":"basic","title":"The assuror Object","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

The assuror Object


[block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuror\",\n \"name\": \"Gano Welding Supplies, Inc\",\n \"description\": \"Welding Certificates\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "THE ASSUROR OBJECT" } ], "sidebar": true } [/block] [block:parameters] { "data": { "h-1": "", "h-0": "", "0-0": "**id** *string*\nThe unique identifier for the assuror.", "1-0": "**object** *string, value is \"assuror\"* ", "2-0": "**name** *string* \nA name describing the assuror.", "3-0": "**description** *string* \nA short description of the assuror.", "4-0": "**meta** *object/hash*\nOptional key/values to help link the assuror to an external system.", "5-0": "**status** *string, possible values are: active, inactive, disabled* \n*active*\nAn assuror is created in the 'active' state. While in the 'active' state, an assuror can update themselves, manage wallets, create and update schemas, and issue certification records against those schemas. An assuror in the 'inactive' state can be moved to the 'active' state by calling the Activate assuror endpoint.\n\n*inactive*\nAn assuror can be moved to the 'inactive' state by calling the Deactivate assuror endpoint. While in the 'inactive' state, an assuror can still update themselves, update wallets, update schemas, and update records that have already been created. They will not be able to create any new wallets, schemas, or records however.\n\n*disabled*\nAn assuror may be moved automatically to the 'disabled' state under certain circumstances by Paystand. While an assuror is in the 'disabled' state they will not be allowed to perform any action on the assuror, its wallets, its schemas, or its records. Resources that had previously been created for the assuror can still be retrieved, however.", "6-0": "**created** *datestring* \nThe date the assuror was created.", "6-1": "", "7-0": "**lastUpdated** *datestring* \nThe date the assuror was last updated.", "0-1": "", "1-1": "", "7-1": "", "5-1": "", "2-1": "", "3-1": "", "4-1": "" }, "cols": 1, "rows": 8 } [/block]
[block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuror\",\n \"name\": \"Gano Welding Supplies, Inc\",\n \"description\": \"Welding Certificates\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "THE ASSUROR OBJECT" } ], "sidebar": true } [/block] [block:parameters] { "data": { "h-1": "", "h-0": "", "0-0": "**id** *string*\nThe unique identifier for the assuror.", "1-0": "**object** *string, value is \"assuror\"* ", "2-0": "**name** *string* \nA name describing the assuror.", "3-0": "**description** *string* \nA short description of the assuror.", "4-0": "**meta** *object/hash*\nOptional key/values to help link the assuror to an external system.", "5-0": "**status** *string, possible values are: active, inactive, disabled* \n*active*\nAn assuror is created in the 'active' state. While in the 'active' state, an assuror can update themselves, manage wallets, create and update schemas, and issue certification records against those schemas. An assuror in the 'inactive' state can be moved to the 'active' state by calling the Activate assuror endpoint.\n\n*inactive*\nAn assuror can be moved to the 'inactive' state by calling the Deactivate assuror endpoint. While in the 'inactive' state, an assuror can still update themselves, update wallets, update schemas, and update records that have already been created. They will not be able to create any new wallets, schemas, or records however.\n\n*disabled*\nAn assuror may be moved automatically to the 'disabled' state under certain circumstances by Paystand. While an assuror is in the 'disabled' state they will not be allowed to perform any action on the assuror, its wallets, its schemas, or its records. Resources that had previously been created for the assuror can still be retrieved, however.", "6-0": "**created** *datestring* \nThe date the assuror was created.", "6-1": "", "7-0": "**lastUpdated** *datestring* \nThe date the assuror was last updated.", "0-1": "", "1-1": "", "7-1": "", "5-1": "", "2-1": "", "3-1": "", "4-1": "" }, "cols": 1, "rows": 8 } [/block]
{"_id":"5d56fccfb1b7fc00334d19a6","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192a","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-01T22:46:58.444Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"language":"text","code":""}]},"settings":"5693eae65f1c951900644c21","examples":{"codes":[]},"auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1a9b6988fc6400119d001c","ref":"","in":"body","required":false,"desc":"A name for the assuror","default":"required","type":"string","name":"name"},{"_id":"5d1a9b6988fc6400119d001b","ref":"","in":"body","required":false,"desc":"A short description for the assuror","default":"required","type":"string","name":"description"},{"_id":"5d1a9cc0c2c85a0012c941e7","ref":"","in":"body","required":false,"desc":"Optional key/value store to link external data","default":"optiona","type":"object","name":"meta"}],"url":"/assurety/assurors"},"isReference":false,"order":2,"body":"To create an Assurer, supply a name, a description, and optionally include meta parameters to link the Assuror with external data.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST: /assurety/assurors\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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\\t\\\"name\\\": \\\"Gano Welding Supplies, Inc\\\",\\n  \\\"description\\\": \\\"Welding Certificates\\\",\\n  \\\"meta\\\": {}\\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  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuror\\\",\\n  \\\"name\\\": \\\"Gano Welding Supplies, Inc\\\",\\n  \\\"description\\\": \\\"Welding Certificates\\\",\\n  \\\"status\\\": \\\"active\\\",\\n  \\\"meta\\\": {},\\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":"","slug":"create-assuror","type":"post","title":"Create an Assuror","__v":28,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postCreate an Assuror


Body Params

name:
stringrequired
A name for the assuror
description:
stringrequired
A short description for the assuror
meta:
objectoptiona
Optional key/value store to link external data

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
To create an Assurer, supply a name, a description, and optionally include meta parameters to link the Assuror with external data. [block:code] { "codes": [ { "code": "POST: /assurety/assurors", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n\t\"name\": \"Gano Welding Supplies, Inc\",\n \"description\": \"Welding Certificates\",\n \"meta\": {}\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuror\",\n \"name\": \"Gano Welding Supplies, Inc\",\n \"description\": \"Welding Certificates\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


To create an Assurer, supply a name, a description, and optionally include meta parameters to link the Assuror with external data. [block:code] { "codes": [ { "code": "POST: /assurety/assurors", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n\t\"name\": \"Gano Welding Supplies, Inc\",\n \"description\": \"Welding Certificates\",\n \"meta\": {}\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuror\",\n \"name\": \"Gano Welding Supplies, Inc\",\n \"description\": \"Welding Certificates\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19b2","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192a","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-01T23:36:49.763Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"5693eae65f1c951900644c21","results":{"codes":[{"language":"text","code":""}]},"method":"put","auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b5ea7096232004a6e49b9","ref":"","in":"path","required":false,"desc":"The id of the assuror","default":"required","type":"string","name":"id"},{"_id":"5d1cd87a81113a00450de1f5","ref":"","in":"body","required":false,"desc":"The name for the assuror","default":"optional","type":"string","name":"name"},{"_id":"5d1cd87a81113a00450de1f4","ref":"","in":"body","required":false,"desc":"A short description for the assuror","default":"optional","type":"string","name":"description"},{"_id":"5d1cd87a81113a00450de1f3","ref":"","in":"body","required":false,"desc":"Optional key/value store to link to external resources","default":"optional","type":"object","name":"meta"}],"url":"/assurety/assurors/:id"},"isReference":false,"order":3,"body":"Specify new values for Assurer name, description, and meta parameters. Parameters that are not specified in the update request will be left unchanged.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"PUT: /assurety/assurors/c26c288cc9d8477eb58fe9c5\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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\\t\\\"name\\\": \\\"Gano Welding Supplies, Inc\\\",\\n  \\\"description\\\": \\\"Welding Certificates\\\",\\n  \\\"meta\\\": {}\\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  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuror\\\",\\n  \\\"name\\\": \\\"Gano Welding Supplies, Inc\\\",\\n  \\\"description\\\": \\\"Welding Certificates\\\",\\n  \\\"status\\\": \\\"active\\\",\\n  \\\"meta\\\": {},\\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":"","slug":"update-an-assuror","type":"put","title":"Update an Assuror","__v":12,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

putUpdate an Assuror


Path Params

id:
stringrequired
The id of the assuror

Body Params

name:
stringoptional
The name for the assuror
description:
stringoptional
A short description for the assuror
meta:
objectoptional
Optional key/value store to link to external resources

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
Specify new values for Assurer name, description, and meta parameters. Parameters that are not specified in the update request will be left unchanged. [block:code] { "codes": [ { "code": "PUT: /assurety/assurors/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n\t\"name\": \"Gano Welding Supplies, Inc\",\n \"description\": \"Welding Certificates\",\n \"meta\": {}\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuror\",\n \"name\": \"Gano Welding Supplies, Inc\",\n \"description\": \"Welding Certificates\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Specify new values for Assurer name, description, and meta parameters. Parameters that are not specified in the update request will be left unchanged. [block:code] { "codes": [ { "code": "PUT: /assurety/assurors/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n\t\"name\": \"Gano Welding Supplies, Inc\",\n \"description\": \"Welding Certificates\",\n \"meta\": {}\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuror\",\n \"name\": \"Gano Welding Supplies, Inc\",\n \"description\": \"Welding Certificates\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19a7","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192a","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-01T22:55:19.455Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"5693eae65f1c951900644c21","results":{"codes":[{"language":"text","code":""}]},"method":"get","auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b5f1dd2b3a600740fd8b0","ref":"","in":"path","required":false,"desc":"The id of the assuror","default":"required","type":"string","name":"id"}],"url":"/assurety/assurors/:id"},"isReference":false,"order":4,"body":"Retrieve Assuror details.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET: /assurety/assurors/c26c288cc9d8477eb58fe9c5\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuror\\\",\\n  \\\"name\\\": \\\"Gano Welding Supplies, Inc\\\",\\n  \\\"description\\\": \\\"Welding Certificates\\\",\\n  \\\"status\\\": \\\"active\\\",\\n  \\\"meta\\\": {},\\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":"","slug":"get-an-assuror","type":"get","title":"Retrieve an Assuror","__v":9,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getRetrieve an Assuror


Path Params

id:
stringrequired
The id of the assuror

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
Retrieve Assuror details. [block:code] { "codes": [ { "code": "GET: /assurety/assurors/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuror\",\n \"name\": \"Gano Welding Supplies, Inc\",\n \"description\": \"Welding Certificates\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Retrieve Assuror details. [block:code] { "codes": [ { "code": "GET: /assurety/assurors/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuror\",\n \"name\": \"Gano Welding Supplies, Inc\",\n \"description\": \"Welding Certificates\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19ba","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192a","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-02T14:17:46.265Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"language":"text","code":""}]},"settings":"5693eae65f1c951900644c21","examples":{"codes":[]},"auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b5ea7096232004a6e49b9","ref":"","in":"path","required":false,"desc":"The id of the assuror","default":"required","type":"string","name":"id"}],"url":"/assurety/assurors/:id/activate"},"isReference":false,"order":6,"body":"Activate an Assuror, updating the Assurer status from “inactive” to \"active\".  Once provided a status of “active”, the Assuror can then create wallets, schemas, and records.\n\nIf the Assuror status is currently \"active\", this endpoint will have no effect when posted.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST: /assurety/assurors/c26c288cc9d8477eb58fe9c5/activate \",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuror\\\",\\n  \\\"name\\\": \\\"Gano Welding Supplies, Inc\\\",\\n  \\\"description\\\": \\\"Welding Certificates\\\",\\n  \\\"status\\\": \\\"active\\\",\\n  \\\"meta\\\": {},\\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":"","slug":"activate-assuror","type":"post","title":"Activate an Assuror","__v":9,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postActivate an Assuror


Path Params

id:
stringrequired
The id of the assuror

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
Activate an Assuror, updating the Assurer status from “inactive” to "active". Once provided a status of “active”, the Assuror can then create wallets, schemas, and records. If the Assuror status is currently "active", this endpoint will have no effect when posted. [block:code] { "codes": [ { "code": "POST: /assurety/assurors/c26c288cc9d8477eb58fe9c5/activate ", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuror\",\n \"name\": \"Gano Welding Supplies, Inc\",\n \"description\": \"Welding Certificates\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Activate an Assuror, updating the Assurer status from “inactive” to "active". Once provided a status of “active”, the Assuror can then create wallets, schemas, and records. If the Assuror status is currently "active", this endpoint will have no effect when posted. [block:code] { "codes": [ { "code": "POST: /assurety/assurors/c26c288cc9d8477eb58fe9c5/activate ", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuror\",\n \"name\": \"Gano Welding Supplies, Inc\",\n \"description\": \"Welding Certificates\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19bb","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192a","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-02T14:18:21.453Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"5693eae65f1c951900644c21","results":{"codes":[{"language":"text","code":""}]},"method":"post","auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b5ea7096232004a6e49b9","ref":"","in":"path","required":false,"desc":"The id of the assuror","default":"required","type":"string","name":"id"}],"url":"/assurety/assurors/:id/deactivate"},"isReference":false,"order":7,"body":"Deactivate an Assuror, updating the Assurer status from “active” to \"inactive\".  Once provided a status of “inactive”, the Assuror can not create wallets, schemas, and records.\n\nIf the Assuror status is currently \"inactive\", this endpoint will have no effect when posted.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST: /assurety/assurors/c26c288cc9d8477eb58fe9c5/deactivate\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuror\\\",\\n  \\\"name\\\": \\\"Gano Welding Supplies, Inc\\\",\\n  \\\"description\\\": \\\"Welding Certificates\\\",\\n  \\\"status\\\": \\\"inactive\\\",\\n  \\\"meta\\\": {},\\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":"","slug":"deactivate-assuror","type":"post","title":"Deactivate an Assuror","__v":9,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postDeactivate an Assuror


Path Params

id:
stringrequired
The id of the assuror

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
Deactivate an Assuror, updating the Assurer status from “active” to "inactive". Once provided a status of “inactive”, the Assuror can not create wallets, schemas, and records. If the Assuror status is currently "inactive", this endpoint will have no effect when posted. [block:code] { "codes": [ { "code": "POST: /assurety/assurors/c26c288cc9d8477eb58fe9c5/deactivate", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuror\",\n \"name\": \"Gano Welding Supplies, Inc\",\n \"description\": \"Welding Certificates\",\n \"status\": \"inactive\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Deactivate an Assuror, updating the Assurer status from “active” to "inactive". Once provided a status of “inactive”, the Assuror can not create wallets, schemas, and records. If the Assuror status is currently "inactive", this endpoint will have no effect when posted. [block:code] { "codes": [ { "code": "POST: /assurety/assurors/c26c288cc9d8477eb58fe9c5/deactivate", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuror\",\n \"name\": \"Gano Welding Supplies, Inc\",\n \"description\": \"Welding Certificates\",\n \"status\": \"inactive\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19c0","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1928","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-02T17:13:09.998Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /assurety/chains/:id\\nGET /assurety/chains\",\n      \"language\": \"json\",\n      \"name\": \"ENDPOINTS\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\nAsurrety Chains can not be created directly via API, but can be retrieved and listed.  \n\nAssurety Chains are references to live blockchain networks.  As more use cases are enabled for the blockchain, Paystand will create more Assurety Chains.\n\nWhen an Assurety Schema is created, it will automatically be assigned an existing Assurety Chain in its chain parameter.  \n\nAs a result, all Assurety Records will be attributed the same chain parameter as the Assurrety Schema that was used when creating the Record.\n\nNote that Assurety Chains can vary between Paystand’s sandbox and production environments.","excerpt":"","slug":"assurety-chains","type":"basic","title":"Assurety Chains","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Assurety Chains


[block:code] { "codes": [ { "code": "GET /assurety/chains/:id\nGET /assurety/chains", "language": "json", "name": "ENDPOINTS" } ], "sidebar": true } [/block] Asurrety Chains can not be created directly via API, but can be retrieved and listed. Assurety Chains are references to live blockchain networks. As more use cases are enabled for the blockchain, Paystand will create more Assurety Chains. When an Assurety Schema is created, it will automatically be assigned an existing Assurety Chain in its chain parameter. As a result, all Assurety Records will be attributed the same chain parameter as the Assurrety Schema that was used when creating the Record. Note that Assurety Chains can vary between Paystand’s sandbox and production environments.
[block:code] { "codes": [ { "code": "GET /assurety/chains/:id\nGET /assurety/chains", "language": "json", "name": "ENDPOINTS" } ], "sidebar": true } [/block] Asurrety Chains can not be created directly via API, but can be retrieved and listed. Assurety Chains are references to live blockchain networks. As more use cases are enabled for the blockchain, Paystand will create more Assurety Chains. When an Assurety Schema is created, it will automatically be assigned an existing Assurety Chain in its chain parameter. As a result, all Assurety Records will be attributed the same chain parameter as the Assurrety Schema that was used when creating the Record. Note that Assurety Chains can vary between Paystand’s sandbox and production environments.
{"_id":"5d56fccfb1b7fc00334d19cb","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1928","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-04T16:21:00.595Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretyChain\\\",\\n  \\\"name\\\": \\\"Generic Chain\\\",\\n  \\\"description\\\": \\\"A generic assurety chain.\\\",\\n  \\\"url\\\": \\\"http://private-chain.paystand.com:8540\\\",\\n  \\\"host\\\": \\\"private-chain.paystand.com\\\",\\n  \\\"port\\\": \\\"8540\\\",\\n  \\\"status\\\": \\\"active\\\",\\n  \\\"created\\\": \\\"2015-10-28T22:55:09.000Z\\\",\\n  \\\"lastUpdated\\\": \\\"2015-10-28T22:55:13.000Z\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"THE CHAIN OBJECT\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-1\": \"\",\n    \"h-0\": \"\",\n    \"0-0\": \"**id** *string*\\nThe unique identifier for the chain.\",\n    \"1-0\": \"**object** *string, value is \\\"assuretyChain\\\"*\",\n    \"2-0\": \"**name** *string*\\nThe name of the chain.\",\n    \"3-0\": \"**description** *string*\\nA short description about the chain.\",\n    \"4-0\": \"**url** *string*\\nThe full network url for the chain.\",\n    \"7-0\": \"**status** *string, possible values are: active, inactive*\\n*active*\\nWhen an Assurety Chain is in the 'active' state, the chain is available to accept new Assurety Schemas and Assurety Records.\\n\\n*inactive*\\nWhen an Assurety Chain is in the 'inactive' state, it is no longer available to accept new Assurety Schemas or Assurety Records. Previously created Assurety Schemas and Assurety Records can still be accessed and verified directly from the underlying blockchain chain.\",\n    \"8-0\": \"**created** *datestring*\\nThe date the chain was created.\",\n    \"8-1\": \"\",\n    \"9-0\": \"**lastUpdated** *datestring*\\nThe date the chain was last updated.\",\n    \"0-1\": \"\",\n    \"1-1\": \"\",\n    \"9-1\": \"\",\n    \"7-1\": \"\",\n    \"2-1\": \"\",\n    \"3-1\": \"\",\n    \"4-1\": \"\",\n    \"5-0\": \"**host** *string*\\nThe network host for the chain.\",\n    \"6-0\": \"**port** *positive integer string*\\nThe chains networking port.\",\n    \"6-1\": \"\",\n    \"5-1\": \"\"\n  },\n  \"cols\": 1,\n  \"rows\": 10\n}\n[/block]","excerpt":"","slug":"the-chain-object","type":"basic","title":"The assuretyChain Object","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

The assuretyChain Object


[block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyChain\",\n \"name\": \"Generic Chain\",\n \"description\": \"A generic assurety chain.\",\n \"url\": \"http://private-chain.paystand.com:8540\",\n \"host\": \"private-chain.paystand.com\",\n \"port\": \"8540\",\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "THE CHAIN OBJECT" } ], "sidebar": true } [/block] [block:parameters] { "data": { "h-1": "", "h-0": "", "0-0": "**id** *string*\nThe unique identifier for the chain.", "1-0": "**object** *string, value is \"assuretyChain\"*", "2-0": "**name** *string*\nThe name of the chain.", "3-0": "**description** *string*\nA short description about the chain.", "4-0": "**url** *string*\nThe full network url for the chain.", "7-0": "**status** *string, possible values are: active, inactive*\n*active*\nWhen an Assurety Chain is in the 'active' state, the chain is available to accept new Assurety Schemas and Assurety Records.\n\n*inactive*\nWhen an Assurety Chain is in the 'inactive' state, it is no longer available to accept new Assurety Schemas or Assurety Records. Previously created Assurety Schemas and Assurety Records can still be accessed and verified directly from the underlying blockchain chain.", "8-0": "**created** *datestring*\nThe date the chain was created.", "8-1": "", "9-0": "**lastUpdated** *datestring*\nThe date the chain was last updated.", "0-1": "", "1-1": "", "9-1": "", "7-1": "", "2-1": "", "3-1": "", "4-1": "", "5-0": "**host** *string*\nThe network host for the chain.", "6-0": "**port** *positive integer string*\nThe chains networking port.", "6-1": "", "5-1": "" }, "cols": 1, "rows": 10 } [/block]
[block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyChain\",\n \"name\": \"Generic Chain\",\n \"description\": \"A generic assurety chain.\",\n \"url\": \"http://private-chain.paystand.com:8540\",\n \"host\": \"private-chain.paystand.com\",\n \"port\": \"8540\",\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "THE CHAIN OBJECT" } ], "sidebar": true } [/block] [block:parameters] { "data": { "h-1": "", "h-0": "", "0-0": "**id** *string*\nThe unique identifier for the chain.", "1-0": "**object** *string, value is \"assuretyChain\"*", "2-0": "**name** *string*\nThe name of the chain.", "3-0": "**description** *string*\nA short description about the chain.", "4-0": "**url** *string*\nThe full network url for the chain.", "7-0": "**status** *string, possible values are: active, inactive*\n*active*\nWhen an Assurety Chain is in the 'active' state, the chain is available to accept new Assurety Schemas and Assurety Records.\n\n*inactive*\nWhen an Assurety Chain is in the 'inactive' state, it is no longer available to accept new Assurety Schemas or Assurety Records. Previously created Assurety Schemas and Assurety Records can still be accessed and verified directly from the underlying blockchain chain.", "8-0": "**created** *datestring*\nThe date the chain was created.", "8-1": "", "9-0": "**lastUpdated** *datestring*\nThe date the chain was last updated.", "0-1": "", "1-1": "", "9-1": "", "7-1": "", "2-1": "", "3-1": "", "4-1": "", "5-0": "**host** *string*\nThe network host for the chain.", "6-0": "**port** *positive integer string*\nThe chains networking port.", "6-1": "", "5-1": "" }, "cols": 1, "rows": 10 } [/block]
{"_id":"5d56fccfb1b7fc00334d19c1","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1928","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-02T17:13:22.333Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"5693eae65f1c951900644c21","results":{"codes":[{"language":"text","code":""}]},"method":"get","auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b7a9dc9254a001869f686","ref":"","in":"path","required":false,"desc":"The id of the Assurety Chain","default":"required","type":"string","name":"id"}],"url":"/assurety/chains/:id"},"isReference":false,"order":2,"body":"Retrieve Chain details.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET: /assurety/chains/c26c288cc9d8477eb58fe9c5\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretyChain\\\",\\n  \\\"name\\\": \\\"Generic Chain\\\",\\n  \\\"description\\\": \\\"A generic assurety chain.\\\",\\n  \\\"url\\\": \\\"http://private-chain.paystand.com:8540\\\",\\n  \\\"host\\\": \\\"private-chain.paystand.com\\\",\\n  \\\"port\\\": \\\"8540\\\",\\n  \\\"status\\\": \\\"active\\\",\\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":"","slug":"get-a-chain","type":"get","title":"Retrieve a Chain","__v":12,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getRetrieve a Chain


Path Params

id:
stringrequired
The id of the Assurety Chain

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
Retrieve Chain details. [block:code] { "codes": [ { "code": "GET: /assurety/chains/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyChain\",\n \"name\": \"Generic Chain\",\n \"description\": \"A generic assurety chain.\",\n \"url\": \"http://private-chain.paystand.com:8540\",\n \"host\": \"private-chain.paystand.com\",\n \"port\": \"8540\",\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Retrieve Chain details. [block:code] { "codes": [ { "code": "GET: /assurety/chains/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyChain\",\n \"name\": \"Generic Chain\",\n \"description\": \"A generic assurety chain.\",\n \"url\": \"http://private-chain.paystand.com:8540\",\n \"host\": \"private-chain.paystand.com\",\n \"port\": \"8540\",\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19c2","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1928","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-02T17:13:30.448Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"language":"text","code":""}]},"settings":"5693eae65f1c951900644c21","examples":{"codes":[]},"auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"}],"url":"/assurety/chains"},"isReference":false,"order":3,"body":"List all assuretyChain objects.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET: /assurety/chains\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretyChain\\\",\\n  \\\"name\\\": \\\"Generic Chain\\\",\\n  \\\"description\\\": \\\"A generic assurety chain.\\\",\\n  \\\"url\\\": \\\"http://private-chain.paystand.com:8540\\\",\\n  \\\"host\\\": \\\"private-chain.paystand.com\\\",\\n  \\\"port\\\": \\\"8540\\\",\\n  \\\"status\\\": \\\"active\\\",\\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":"","slug":"list-chains","type":"get","title":"List all Chains","__v":7,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getList all Chains


Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
List all assuretyChain objects. [block:code] { "codes": [ { "code": "GET: /assurety/chains", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "[{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyChain\",\n \"name\": \"Generic Chain\",\n \"description\": \"A generic assurety chain.\",\n \"url\": \"http://private-chain.paystand.com:8540\",\n \"host\": \"private-chain.paystand.com\",\n \"port\": \"8540\",\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}]", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


List all assuretyChain objects. [block:code] { "codes": [ { "code": "GET: /assurety/chains", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "[{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyChain\",\n \"name\": \"Generic Chain\",\n \"description\": \"A generic assurety chain.\",\n \"url\": \"http://private-chain.paystand.com:8540\",\n \"host\": \"private-chain.paystand.com\",\n \"port\": \"8540\",\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}]", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19c5","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1929","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-02T22:06:48.151Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /assurety/contracts/:id\",\n      \"language\": \"json\",\n      \"name\": \"ENDPOINTS\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\nAsurrety Contracts can not be created directly via API, but can be retrieved. \n\nAn Assurety Contract is the specification of a version of a [Smart Contract](https://en.wikipedia.org/wiki/Smart_contract) that can be deployed and used on a [blockchain](https://en.wikipedia.org/wiki/Blockchain).\n\nWhen an Assurety Schema is created, it will automatically be assigned an Assurety Contract in its contract parameter.\n\nAssurety Schemas deploy Assurety Contracts to manage their Assurety Records. \n\nThe relationship between an Assurety Contract and an Assurety Schema is similar to the relationship between a **Class** and an instance (or **Object**) of that Class in most programming languages. Like a Class, an Assurety Contract describes a structure, or interface, or specification, but cannot be directly interacted with. It can be used to create several instances of itself that can be interacted with though. These instances of Assurety Contracts are created by deploying them to a blockchain. Once deployed and initialized on the blockchain, we refer to them as Assurety Schemas tracked by their deployed contract address.\n\nAssurety Contracts are primarily used for reference when attempting to directly interact with a blockchain smart contract as an Assurety Contract contains an **ABI** that can be used with SDKs such as [Web3.js](https://web3js.readthedocs.io/en/1.0/).","excerpt":"","slug":"assurety-contracts","type":"basic","title":"Assurety Contracts","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Assurety Contracts


[block:code] { "codes": [ { "code": "GET /assurety/contracts/:id", "language": "json", "name": "ENDPOINTS" } ], "sidebar": true } [/block] Asurrety Contracts can not be created directly via API, but can be retrieved. An Assurety Contract is the specification of a version of a [Smart Contract](https://en.wikipedia.org/wiki/Smart_contract) that can be deployed and used on a [blockchain](https://en.wikipedia.org/wiki/Blockchain). When an Assurety Schema is created, it will automatically be assigned an Assurety Contract in its contract parameter. Assurety Schemas deploy Assurety Contracts to manage their Assurety Records. The relationship between an Assurety Contract and an Assurety Schema is similar to the relationship between a **Class** and an instance (or **Object**) of that Class in most programming languages. Like a Class, an Assurety Contract describes a structure, or interface, or specification, but cannot be directly interacted with. It can be used to create several instances of itself that can be interacted with though. These instances of Assurety Contracts are created by deploying them to a blockchain. Once deployed and initialized on the blockchain, we refer to them as Assurety Schemas tracked by their deployed contract address. Assurety Contracts are primarily used for reference when attempting to directly interact with a blockchain smart contract as an Assurety Contract contains an **ABI** that can be used with SDKs such as [Web3.js](https://web3js.readthedocs.io/en/1.0/).
[block:code] { "codes": [ { "code": "GET /assurety/contracts/:id", "language": "json", "name": "ENDPOINTS" } ], "sidebar": true } [/block] Asurrety Contracts can not be created directly via API, but can be retrieved. An Assurety Contract is the specification of a version of a [Smart Contract](https://en.wikipedia.org/wiki/Smart_contract) that can be deployed and used on a [blockchain](https://en.wikipedia.org/wiki/Blockchain). When an Assurety Schema is created, it will automatically be assigned an Assurety Contract in its contract parameter. Assurety Schemas deploy Assurety Contracts to manage their Assurety Records. The relationship between an Assurety Contract and an Assurety Schema is similar to the relationship between a **Class** and an instance (or **Object**) of that Class in most programming languages. Like a Class, an Assurety Contract describes a structure, or interface, or specification, but cannot be directly interacted with. It can be used to create several instances of itself that can be interacted with though. These instances of Assurety Contracts are created by deploying them to a blockchain. Once deployed and initialized on the blockchain, we refer to them as Assurety Schemas tracked by their deployed contract address. Assurety Contracts are primarily used for reference when attempting to directly interact with a blockchain smart contract as an Assurety Contract contains an **ABI** that can be used with SDKs such as [Web3.js](https://web3js.readthedocs.io/en/1.0/).
{"_id":"5d56fccfb1b7fc00334d19cc","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1929","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-04T16:21:11.599Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretyContract\\\",\\n  \\\"name\\\": \\\"Hello World Contract\\\",\\n  \\\"description\\\": \\\"A contract to say hello to the world.\\\",\\n  \\\"type\\\": \\\"hello_world\\\",\\n  \\\"version\\\": \\\"1\\\",\\n  \\\"abi\\\": [\\n    {\\n      \\\"constant\\\": true,\\n      \\\"inputs\\\": [],\\n      \\\"name\\\": \\\"sayHello\\\",\\n      \\\"outputs\\\": [\\n        {\\n          \\\"name\\\": \\\"\\\",\\n          \\\"type\\\": \\\"string\\\"\\n        }\\n      ],\\n      \\\"payable\\\": false,\\n      \\\"stateMutability\\\": \\\"pure\\\",\\n      \\\"type\\\": \\\"function\\\"\\n    }\\n  ],\\n  \\\"status\\\": \\\"active\\\",\\n  \\\"created\\\": \\\"2015-10-28T22:55:09.000Z\\\",\\n  \\\"lastUpdated\\\": \\\"2015-10-28T22:55:13.000Z\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"THE CONTRACT OBJECT\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-1\": \"Specification\",\n    \"h-0\": \"\",\n    \"0-0\": \"**id** *string*\\nThe unique identifier.\",\n    \"1-0\": \"**object** *string, value is \\\"assuretyContract\\\"*\",\n    \"2-0\": \"**name** *string*\\nThe name of the contract.\",\n    \"3-0\": \"**description** *string*\\nA short description about the contract.\",\n    \"4-0\": \"**type** *string, value is \\\"certificate\\\"*\\nString representing the type of contract. The only value currently supported is **certificate**.\",\n    \"7-0\": \"**status** *string, possible values are: active, inactive*\\n*active* \\nWhile in the \\\"active\\\" state, it can be deployed to any active Assurety Chain.\\n\\n*inactive* \\nWhile in the \\\"inactive\\\" state, it cannot be deployed to any Assurety Chain. Assurety Schemas using an Assurety Contract that is currently in an \\\"inactive\\\" state can still use and interact with the underlying smart contract using the Assurety Contract ABI as usual.\",\n    \"8-0\": \"**created** *datestring*\\nThe date the contract was created.\",\n    \"8-1\": \"\",\n    \"9-0\": \"**lastUpdated** *datestring*\\nThe date the contract was last updated.\",\n    \"0-1\": \"\",\n    \"1-1\": \"\",\n    \"9-1\": \"\",\n    \"7-1\": \"\",\n    \"2-1\": \"\",\n    \"3-1\": \"\",\n    \"4-1\": \"\",\n    \"5-0\": \"**version** *positive integer string*\\nInteger String representing the version for the Assurety Contract type. Each **type** will have its own versioning.\",\n    \"6-0\": \"**abi** *array of objects*\\nAn [ABI](https://solidity.readthedocs.io/en/v0.5.10/abi-spec.html) is a JSON representation of a smart contract interface. They are used by SDKs to interact with blockchain smart contracts directly.\",\n    \"6-1\": \"\",\n    \"5-1\": \"\"\n  },\n  \"cols\": 1,\n  \"rows\": 10\n}\n[/block]","excerpt":"","slug":"the-contract-object","type":"basic","title":"The assuretyContract Object","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

The assuretyContract Object


[block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyContract\",\n \"name\": \"Hello World Contract\",\n \"description\": \"A contract to say hello to the world.\",\n \"type\": \"hello_world\",\n \"version\": \"1\",\n \"abi\": [\n {\n \"constant\": true,\n \"inputs\": [],\n \"name\": \"sayHello\",\n \"outputs\": [\n {\n \"name\": \"\",\n \"type\": \"string\"\n }\n ],\n \"payable\": false,\n \"stateMutability\": \"pure\",\n \"type\": \"function\"\n }\n ],\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "THE CONTRACT OBJECT" } ], "sidebar": true } [/block] [block:parameters] { "data": { "h-1": "Specification", "h-0": "", "0-0": "**id** *string*\nThe unique identifier.", "1-0": "**object** *string, value is \"assuretyContract\"*", "2-0": "**name** *string*\nThe name of the contract.", "3-0": "**description** *string*\nA short description about the contract.", "4-0": "**type** *string, value is \"certificate\"*\nString representing the type of contract. The only value currently supported is **certificate**.", "7-0": "**status** *string, possible values are: active, inactive*\n*active* \nWhile in the \"active\" state, it can be deployed to any active Assurety Chain.\n\n*inactive* \nWhile in the \"inactive\" state, it cannot be deployed to any Assurety Chain. Assurety Schemas using an Assurety Contract that is currently in an \"inactive\" state can still use and interact with the underlying smart contract using the Assurety Contract ABI as usual.", "8-0": "**created** *datestring*\nThe date the contract was created.", "8-1": "", "9-0": "**lastUpdated** *datestring*\nThe date the contract was last updated.", "0-1": "", "1-1": "", "9-1": "", "7-1": "", "2-1": "", "3-1": "", "4-1": "", "5-0": "**version** *positive integer string*\nInteger String representing the version for the Assurety Contract type. Each **type** will have its own versioning.", "6-0": "**abi** *array of objects*\nAn [ABI](https://solidity.readthedocs.io/en/v0.5.10/abi-spec.html) is a JSON representation of a smart contract interface. They are used by SDKs to interact with blockchain smart contracts directly.", "6-1": "", "5-1": "" }, "cols": 1, "rows": 10 } [/block]
[block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyContract\",\n \"name\": \"Hello World Contract\",\n \"description\": \"A contract to say hello to the world.\",\n \"type\": \"hello_world\",\n \"version\": \"1\",\n \"abi\": [\n {\n \"constant\": true,\n \"inputs\": [],\n \"name\": \"sayHello\",\n \"outputs\": [\n {\n \"name\": \"\",\n \"type\": \"string\"\n }\n ],\n \"payable\": false,\n \"stateMutability\": \"pure\",\n \"type\": \"function\"\n }\n ],\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "THE CONTRACT OBJECT" } ], "sidebar": true } [/block] [block:parameters] { "data": { "h-1": "Specification", "h-0": "", "0-0": "**id** *string*\nThe unique identifier.", "1-0": "**object** *string, value is \"assuretyContract\"*", "2-0": "**name** *string*\nThe name of the contract.", "3-0": "**description** *string*\nA short description about the contract.", "4-0": "**type** *string, value is \"certificate\"*\nString representing the type of contract. The only value currently supported is **certificate**.", "7-0": "**status** *string, possible values are: active, inactive*\n*active* \nWhile in the \"active\" state, it can be deployed to any active Assurety Chain.\n\n*inactive* \nWhile in the \"inactive\" state, it cannot be deployed to any Assurety Chain. Assurety Schemas using an Assurety Contract that is currently in an \"inactive\" state can still use and interact with the underlying smart contract using the Assurety Contract ABI as usual.", "8-0": "**created** *datestring*\nThe date the contract was created.", "8-1": "", "9-0": "**lastUpdated** *datestring*\nThe date the contract was last updated.", "0-1": "", "1-1": "", "9-1": "", "7-1": "", "2-1": "", "3-1": "", "4-1": "", "5-0": "**version** *positive integer string*\nInteger String representing the version for the Assurety Contract type. Each **type** will have its own versioning.", "6-0": "**abi** *array of objects*\nAn [ABI](https://solidity.readthedocs.io/en/v0.5.10/abi-spec.html) is a JSON representation of a smart contract interface. They are used by SDKs to interact with blockchain smart contracts directly.", "6-1": "", "5-1": "" }, "cols": 1, "rows": 10 } [/block]
{"_id":"5d56fccfb1b7fc00334d19c3","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1929","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-02T17:54:36.558Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"5693eae65f1c951900644c21","results":{"codes":[{"language":"text","code":""}]},"method":"get","auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b743d9d26ea04d1296ed6","ref":"","in":"path","required":false,"desc":"The id of the assurety contract","default":"required","type":"string","name":"id"}],"url":"/assurety/contracts/:id"},"isReference":false,"order":2,"body":"Retrieves Contract details.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET: /assurety/contracts/c26c288cc9d8477eb58fe9c5\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\t\\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretyContract\\\",\\n  \\\"name\\\": \\\"Hello World Contract\\\",\\n  \\\"description\\\": \\\"A contract to say hello to the world.\\\",\\n  \\\"type\\\": \\\"hello_world\\\",\\n  \\\"version\\\": \\\"1\\\",\\n  \\\"abi\\\": [\\n    {\\n      \\\"constant\\\": true,\\n      \\\"inputs\\\": [],\\n      \\\"name\\\": \\\"sayHello\\\",\\n      \\\"outputs\\\": [\\n        {\\n          \\\"name\\\": \\\"\\\",\\n          \\\"type\\\": \\\"string\\\"\\n        }\\n      ],\\n      \\\"payable\\\": false,\\n      \\\"stateMutability\\\": \\\"pure\\\",\\n      \\\"type\\\": \\\"function\\\"\\n    }\\n  ],\\n  \\\"status\\\": \\\"active\\\",\\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":"","slug":"get-a-contract","type":"get","title":"Retrieve a Contract","__v":16,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getRetrieve a Contract


Path Params

id:
stringrequired
The id of the assurety contract

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
Retrieves Contract details. [block:code] { "codes": [ { "code": "GET: /assurety/contracts/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n\t\"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyContract\",\n \"name\": \"Hello World Contract\",\n \"description\": \"A contract to say hello to the world.\",\n \"type\": \"hello_world\",\n \"version\": \"1\",\n \"abi\": [\n {\n \"constant\": true,\n \"inputs\": [],\n \"name\": \"sayHello\",\n \"outputs\": [\n {\n \"name\": \"\",\n \"type\": \"string\"\n }\n ],\n \"payable\": false,\n \"stateMutability\": \"pure\",\n \"type\": \"function\"\n }\n ],\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Retrieves Contract details. [block:code] { "codes": [ { "code": "GET: /assurety/contracts/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n\t\"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyContract\",\n \"name\": \"Hello World Contract\",\n \"description\": \"A contract to say hello to the world.\",\n \"type\": \"hello_world\",\n \"version\": \"1\",\n \"abi\": [\n {\n \"constant\": true,\n \"inputs\": [],\n \"name\": \"sayHello\",\n \"outputs\": [\n {\n \"name\": \"\",\n \"type\": \"string\"\n }\n ],\n \"payable\": false,\n \"stateMutability\": \"pure\",\n \"type\": \"function\"\n }\n ],\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19c7","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192b","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-03T14:42:37.682Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Once a Schema Record is created on a blockchain, these endpoints can be used to then retrieve information publicly that can aid in the verification of disclosed blockchain data, as well as to interact with the blockchain resource directly.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /assurety/public/contracts/abi/:address\\nGET /assurety/public/contracts/schema/:address\\nGET /assurety/public/imprint/:address/:token\\nGET /assurety/public/tokens/:schemaId/:token\",\n      \"language\": \"json\",\n      \"name\": \"ENDPOINTS\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"public-assurety-api","type":"basic","title":"Assurety Public","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Assurety Public


Once a Schema Record is created on a blockchain, these endpoints can be used to then retrieve information publicly that can aid in the verification of disclosed blockchain data, as well as to interact with the blockchain resource directly. [block:code] { "codes": [ { "code": "GET /assurety/public/contracts/abi/:address\nGET /assurety/public/contracts/schema/:address\nGET /assurety/public/imprint/:address/:token\nGET /assurety/public/tokens/:schemaId/:token", "language": "json", "name": "ENDPOINTS" } ], "sidebar": true } [/block]
Once a Schema Record is created on a blockchain, these endpoints can be used to then retrieve information publicly that can aid in the verification of disclosed blockchain data, as well as to interact with the blockchain resource directly. [block:code] { "codes": [ { "code": "GET /assurety/public/contracts/abi/:address\nGET /assurety/public/contracts/schema/:address\nGET /assurety/public/imprint/:address/:token\nGET /assurety/public/tokens/:schemaId/:token", "language": "json", "name": "ENDPOINTS" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19c6","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192b","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-03T14:40:57.915Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"language":"text","code":""}]},"settings":"5693eae65f1c951900644c21","examples":{"codes":[]},"auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5d1b743d9d26ea04d1296ed6","ref":"","in":"path","required":false,"desc":"The contract address","default":"required","type":"string","name":"address"}],"url":"/assurety/public/contracts/abi/:address"},"isReference":false,"order":1,"body":"Retrieves a deployed contract's ABI interface.\n\nProvide the contract's public blockchain address, and the stringified contract ABI object will be returned. The parsed ABI can then be used to interact with a contract on the chain using a library such as [Web3.js](https://web3js.readthedocs.io/en/1.0/).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET: /assurety/public/contracts/abi/0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n      \"language\": \"text\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\\"[{\\\"constant\\\":true,\\\"inputs\\\":[],\\\"name\\\":\\\"sayHello\\\",\\\"outputs\\\":[{\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"string\\\"}],\\\"payable\\\":false,\\\"stateMutability\\\":\\\"pure\\\",\\\"type\\\":\\\"function\\\"}]\\\"\",\n      \"language\": \"text\",\n      \"name\": \"RESPONSE\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"get-a-contract-spec","type":"get","title":"Retrieve an ABI","__v":33,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getRetrieve an ABI


Path Params

address:
stringrequired
The contract address

Headers

Accept:
stringapplication/json
Content-Type:
stringapplication/json
Retrieves a deployed contract's ABI interface. Provide the contract's public blockchain address, and the stringified contract ABI object will be returned. The parsed ABI can then be used to interact with a contract on the chain using a library such as [Web3.js](https://web3js.readthedocs.io/en/1.0/). [block:code] { "codes": [ { "code": "GET: /assurety/public/contracts/abi/0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2", "language": "text", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "\"[{\"constant\":true,\"inputs\":[],\"name\":\"sayHello\",\"outputs\":[{\"name\":\"\",\"type\":\"string\"}],\"payable\":false,\"stateMutability\":\"pure\",\"type\":\"function\"}]\"", "language": "text", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Retrieves a deployed contract's ABI interface. Provide the contract's public blockchain address, and the stringified contract ABI object will be returned. The parsed ABI can then be used to interact with a contract on the chain using a library such as [Web3.js](https://web3js.readthedocs.io/en/1.0/). [block:code] { "codes": [ { "code": "GET: /assurety/public/contracts/abi/0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2", "language": "text", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "\"[{\"constant\":true,\"inputs\":[],\"name\":\"sayHello\",\"outputs\":[{\"name\":\"\",\"type\":\"string\"}],\"payable\":false,\"stateMutability\":\"pure\",\"type\":\"function\"}]\"", "language": "text", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19d2","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192b","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-04T20:54:41.778Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"5693eae65f1c951900644c21","results":{"codes":[{"language":"text","code":""}]},"method":"get","auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5d1b743d9d26ea04d1296ed6","ref":"","in":"path","required":false,"desc":"The contract address","default":"required","type":"string","name":"address"}],"url":"/assurety/public/contracts/schema/:address"},"isReference":false,"order":2,"body":"Retrieves a deployed contract's schema. \n\nProvide the contract's public blockchain address ,and the contract's schema object will be returned. The schema can then be used to generate an imprint given the evidence, and a proof of that evidence.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET: /assurety/public/contracts/schema/0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n      \"language\": \"text\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"properties\\\": {\\n    \\\"@type\\\": {\\n      \\\"type\\\": \\\"string\\\"\\n    },\\n    \\\"hello\\\": {\\n      \\\"type\\\": \\\"string\\\"\\n    }\\n  },\\n  \\\"type\\\": \\\"object\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"RESPONSE\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"retrieve-a-contract-schema","type":"get","title":"Retrieve a Schema","__v":3,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getRetrieve a Schema


Path Params

address:
stringrequired
The contract address

Headers

Accept:
stringapplication/json
Content-Type:
stringapplication/json
Retrieves a deployed contract's schema. Provide the contract's public blockchain address ,and the contract's schema object will be returned. The schema can then be used to generate an imprint given the evidence, and a proof of that evidence. [block:code] { "codes": [ { "code": "GET: /assurety/public/contracts/schema/0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2", "language": "text", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"properties\": {\n \"@type\": {\n \"type\": \"string\"\n },\n \"hello\": {\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Retrieves a deployed contract's schema. Provide the contract's public blockchain address ,and the contract's schema object will be returned. The schema can then be used to generate an imprint given the evidence, and a proof of that evidence. [block:code] { "codes": [ { "code": "GET: /assurety/public/contracts/schema/0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2", "language": "text", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"properties\": {\n \"@type\": {\n \"type\": \"string\"\n },\n \"hello\": {\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19c4","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192b","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-02T17:58:10.911Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"5693eae65f1c951900644c21","results":{"codes":[{"language":"text","code":""}]},"method":"get","auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5d1b75b0096232004a6e4d37","ref":"","in":"path","required":false,"desc":"The address of the contract","default":"required","type":"string","name":"address"},{"_id":"5d1d1cbd321d6a0042083b4e","ref":"","in":"path","required":false,"desc":"The token to get an imprint of","default":"required","type":"string","name":"token"}],"url":"/assurety/public/imprint/:address/:token"},"isReference":false,"order":3,"body":"Retrieves a record's imprint, provided a deployed contract's public address as well as a token on that contract.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET: /assurety/public/imprint/0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2/1\",\n      \"language\": \"text\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"imprint\\\": \\\"0x642c19d1a7f27bbe601defe6d730ea321d60b156d73fc814bd62ce8ed8640b5d\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"RESPONSE\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"get-an-imprint","type":"get","title":"Retrieve an Imprint","__v":18,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getRetrieve an Imprint


Path Params

address:
stringrequired
The address of the contract
token:
stringrequired
The token to get an imprint of

Headers

Accept:
stringapplication/json
Content-Type:
stringapplication/json
Retrieves a record's imprint, provided a deployed contract's public address as well as a token on that contract. [block:code] { "codes": [ { "code": "GET: /assurety/public/imprint/0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2/1", "language": "text", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"imprint\": \"0x642c19d1a7f27bbe601defe6d730ea321d60b156d73fc814bd62ce8ed8640b5d\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Retrieves a record's imprint, provided a deployed contract's public address as well as a token on that contract. [block:code] { "codes": [ { "code": "GET: /assurety/public/imprint/0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2/1", "language": "text", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"imprint\": \"0x642c19d1a7f27bbe601defe6d730ea321d60b156d73fc814bd62ce8ed8640b5d\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19e8","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192b","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-07T00:23:22.319Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"language":"text","code":""}]},"settings":"5693eae65f1c951900644c21","examples":{"codes":[]},"auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5d1b75b0096232004a6e4d37","ref":"","in":"path","required":false,"desc":"The contract address where the token is stored","default":"required","type":"string","name":"address"},{"_id":"5d1d1cbd321d6a0042083b4e","ref":"","in":"path","required":false,"desc":"The token to get an imprint of","default":"required","type":"string","name":"token"}],"url":"/assurety/public/tokens/:address/:token"},"isReference":false,"order":4,"body":"Retrieves a token, provided a schema as well as a token.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET: /assurety/public/tokens/0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2/1\",\n      \"language\": \"text\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"token\\\": \\\"1\\\",\\n  \\\"address\\\": \\\"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\\\",\\n  \\\"name\\\": \\\"Payment Posted\\\",\\n  \\\"description\\\": \\\"The payment has been posted.\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"RESPONSE\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"retrieve-a-token","type":"get","title":"Retrieve a Token","__v":6,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getRetrieve a Token


Path Params

address:
stringrequired
The contract address where the token is stored
token:
stringrequired
The token to get an imprint of

Headers

Accept:
stringapplication/json
Content-Type:
stringapplication/json
Retrieves a token, provided a schema as well as a token. [block:code] { "codes": [ { "code": "GET: /assurety/public/tokens/0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2/1", "language": "text", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"token\": \"1\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"name\": \"Payment Posted\",\n \"description\": \"The payment has been posted.\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Retrieves a token, provided a schema as well as a token. [block:code] { "codes": [ { "code": "GET: /assurety/public/tokens/0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2/1", "language": "text", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"token\": \"1\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"name\": \"Payment Posted\",\n \"description\": \"The payment has been posted.\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19b9","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192d","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-02T13:51:00.326Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /assurety/schemas/:id/records\\n PUT /assurety/records/:id\\n GET /assurety/records/:id\\n GET /assurety/schemas/:id/records\\nPOST /assurety/records/:id/disclose\",\n      \"language\": \"json\",\n      \"name\": \"ENDPOINTS\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\nOnce an Assurer, a Wallet, and a Schema have been created, an Assurety Record can be created. \n\nAn Assurety Record is a set of data that conforms to a schema specification and is represented as a smart contract token on a blockchain. The data is stored on the blockchain (in the token) as a cryptographic imprint. The underlying data cannot be recovered from the imprint alone, and so is secure to store on the blockchain as a public asset. The token, and thus the imprint, can never be removed, modified, or tampered with once it is on the blockchain.\n\nOnce a record is created, some or all of the information contained within the record can be cryptographically disclosed to third parties in such a way that they can verify the accuracy of the information against the imprint on the blockchain.","excerpt":"","slug":"managing-records","type":"basic","title":"Assurety Records","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Assurety Records


[block:code] { "codes": [ { "code": "POST /assurety/schemas/:id/records\n PUT /assurety/records/:id\n GET /assurety/records/:id\n GET /assurety/schemas/:id/records\nPOST /assurety/records/:id/disclose", "language": "json", "name": "ENDPOINTS" } ], "sidebar": true } [/block] Once an Assurer, a Wallet, and a Schema have been created, an Assurety Record can be created. An Assurety Record is a set of data that conforms to a schema specification and is represented as a smart contract token on a blockchain. The data is stored on the blockchain (in the token) as a cryptographic imprint. The underlying data cannot be recovered from the imprint alone, and so is secure to store on the blockchain as a public asset. The token, and thus the imprint, can never be removed, modified, or tampered with once it is on the blockchain. Once a record is created, some or all of the information contained within the record can be cryptographically disclosed to third parties in such a way that they can verify the accuracy of the information against the imprint on the blockchain.
[block:code] { "codes": [ { "code": "POST /assurety/schemas/:id/records\n PUT /assurety/records/:id\n GET /assurety/records/:id\n GET /assurety/schemas/:id/records\nPOST /assurety/records/:id/disclose", "language": "json", "name": "ENDPOINTS" } ], "sidebar": true } [/block] Once an Assurer, a Wallet, and a Schema have been created, an Assurety Record can be created. An Assurety Record is a set of data that conforms to a schema specification and is represented as a smart contract token on a blockchain. The data is stored on the blockchain (in the token) as a cryptographic imprint. The underlying data cannot be recovered from the imprint alone, and so is secure to store on the blockchain as a public asset. The token, and thus the imprint, can never be removed, modified, or tampered with once it is on the blockchain. Once a record is created, some or all of the information contained within the record can be cryptographically disclosed to third parties in such a way that they can verify the accuracy of the information against the imprint on the blockchain.
{"_id":"5d56fccfb1b7fc00334d19d0","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192d","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-04T17:30:00.615Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"993f6e7efd9d4728a047c132\\\",\\n  \\\"object\\\": \\\"assuretyRecord\\\",\\n  \\\"assuror\\\": \\\"30dd879cee2f11db83140800\\\",\\n  \\\"schema\\\": \\\"99f52d09d7e74be9a9f94eab\\\",\\n  \\\"chain\\\": \\\"b2e849a26b3241fead1e744a\\\",\\n  \\\"wallet\\\": \\\"f4375b83edc849b4884753ec\\\",\\n  \\\"token\\\": \\\"1\\\",\\n  \\\"data\\\": {\\n    \\\"@type\\\": \\\"certification\\\",\\n    \\\"hello\\\": \\\"World\\\"\\n  },\\n  \\\"imprint\\\": \\\"0x642c19d1a7f27bbe...156d73fc814bd62ce8ed8640b5d\\\",\\n  \\\"name\\\": \\\"Generic Record\\\",\\n  \\\"description\\\": \\\"A generic assurety record.\\\",\\n  \\\"meta\\\": {},\\n  \\\"status\\\": \\\"active\\\",\\n  \\\"created\\\": \\\"2015-10-28T22:55:09.000Z\\\",\\n  \\\"lastUpdated\\\": \\\"2015-10-28T22:55:13.000Z\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"THE RECORD OBJECT\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**id** *string* \\nThe unique identifier for the record.\",\n    \"1-0\": \"**object** *string, value is \\\"assuretyRecord\\\"* \",\n    \"2-0\": \"**assuror** *string [expandable]* \\nThe assuror associated with the record.\",\n    \"3-0\": \"**schema** *string [expandable]* \\nThe schema associated with the record.\",\n    \"4-0\": \"**chain** *string [expandable]* \\nThe chain where the token is stored.\",\n    \"5-0\": \"**wallet** *string [expandable]* \\nThe wallet owning the token.\",\n    \"6-0\": \"**token** *integer string* \\nThe token stored on the blockchain.\",\n    \"7-0\": \"**data** *object/hash* \\nThe record data. Must conform to the schema specification outlined in its related schema. This is the data that is getting assured.\",\n    \"8-0\": \"**imprint** *string* \\nA cryptographic imprint of the record data.\",\n    \"9-0\": \"**name** *string* \\nThe name of the record.\",\n    \"10-0\": \"**description** *string* \\nA short description of the record.\",\n    \"11-0\": \"**meta** *object/hash* \\nOptional key/values to help link the record to an external system.\",\n    \"12-0\": \"**status** *string, possible values are: active* \\ntodo\",\n    \"13-0\": \"**created** *datestring* \\nThe date the record was created.\",\n    \"14-0\": \"**lastUpdated** *datestring*\\nThe date the record was last updated.\"\n  },\n  \"cols\": 1,\n  \"rows\": 15\n}\n[/block]","excerpt":"","slug":"the-record-object","type":"basic","title":"The assuretyRecord Object","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

The assuretyRecord Object


[block:code] { "codes": [ { "code": "{\n \"id\": \"993f6e7efd9d4728a047c132\",\n \"object\": \"assuretyRecord\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"schema\": \"99f52d09d7e74be9a9f94eab\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"wallet\": \"f4375b83edc849b4884753ec\",\n \"token\": \"1\",\n \"data\": {\n \"@type\": \"certification\",\n \"hello\": \"World\"\n },\n \"imprint\": \"0x642c19d1a7f27bbe...156d73fc814bd62ce8ed8640b5d\",\n \"name\": \"Generic Record\",\n \"description\": \"A generic assurety record.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "THE RECORD OBJECT" } ], "sidebar": true } [/block] [block:parameters] { "data": { "0-0": "**id** *string* \nThe unique identifier for the record.", "1-0": "**object** *string, value is \"assuretyRecord\"* ", "2-0": "**assuror** *string [expandable]* \nThe assuror associated with the record.", "3-0": "**schema** *string [expandable]* \nThe schema associated with the record.", "4-0": "**chain** *string [expandable]* \nThe chain where the token is stored.", "5-0": "**wallet** *string [expandable]* \nThe wallet owning the token.", "6-0": "**token** *integer string* \nThe token stored on the blockchain.", "7-0": "**data** *object/hash* \nThe record data. Must conform to the schema specification outlined in its related schema. This is the data that is getting assured.", "8-0": "**imprint** *string* \nA cryptographic imprint of the record data.", "9-0": "**name** *string* \nThe name of the record.", "10-0": "**description** *string* \nA short description of the record.", "11-0": "**meta** *object/hash* \nOptional key/values to help link the record to an external system.", "12-0": "**status** *string, possible values are: active* \ntodo", "13-0": "**created** *datestring* \nThe date the record was created.", "14-0": "**lastUpdated** *datestring*\nThe date the record was last updated." }, "cols": 1, "rows": 15 } [/block]
[block:code] { "codes": [ { "code": "{\n \"id\": \"993f6e7efd9d4728a047c132\",\n \"object\": \"assuretyRecord\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"schema\": \"99f52d09d7e74be9a9f94eab\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"wallet\": \"f4375b83edc849b4884753ec\",\n \"token\": \"1\",\n \"data\": {\n \"@type\": \"certification\",\n \"hello\": \"World\"\n },\n \"imprint\": \"0x642c19d1a7f27bbe...156d73fc814bd62ce8ed8640b5d\",\n \"name\": \"Generic Record\",\n \"description\": \"A generic assurety record.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "THE RECORD OBJECT" } ], "sidebar": true } [/block] [block:parameters] { "data": { "0-0": "**id** *string* \nThe unique identifier for the record.", "1-0": "**object** *string, value is \"assuretyRecord\"* ", "2-0": "**assuror** *string [expandable]* \nThe assuror associated with the record.", "3-0": "**schema** *string [expandable]* \nThe schema associated with the record.", "4-0": "**chain** *string [expandable]* \nThe chain where the token is stored.", "5-0": "**wallet** *string [expandable]* \nThe wallet owning the token.", "6-0": "**token** *integer string* \nThe token stored on the blockchain.", "7-0": "**data** *object/hash* \nThe record data. Must conform to the schema specification outlined in its related schema. This is the data that is getting assured.", "8-0": "**imprint** *string* \nA cryptographic imprint of the record data.", "9-0": "**name** *string* \nThe name of the record.", "10-0": "**description** *string* \nA short description of the record.", "11-0": "**meta** *object/hash* \nOptional key/values to help link the record to an external system.", "12-0": "**status** *string, possible values are: active* \ntodo", "13-0": "**created** *datestring* \nThe date the record was created.", "14-0": "**lastUpdated** *datestring*\nThe date the record was last updated." }, "cols": 1, "rows": 15 } [/block]
{"_id":"5d56fccfb1b7fc00334d19d1","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192d","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-04T20:36:32.775Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"env\\\": \\\"sandbox\\\",\\n  \\\"schema\\\": \\\"https://api.paystand.com/v3/assurety/public/contracts/schema/0x..2\\\",\\n  \\\"chain\\\": \\\"https://example-chain.paystand.co:8540\\\",\\n  \\\"address\\\": \\\"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\\\",\\n  \\\"token\\\": \\\"1\\\",\\n  \\\"evidence\\\": {\\n    \\\"@type\\\": \\\"certification\\\",\\n  \\t\\\"hello\\\": \\\"World\\\"\\n  },\\n  \\\"proof\\\": [\\n    {\\n      \\\"path\\\": [],\\n      \\\"nodes\\\": [\\n        {\\n          \\\"index\\\": 1,\\n          \\\"hash\\\": \\\"48ec6ac9e0d36265c15620dc6aa...\\\"\\n        }\\n      ],\\n      \\\"values\\\": [\\n        {\\n          \\\"index\\\": 2,\\n          \\\"value\\\": \\\"78002eb9b19344e451c1f8eba2...\\\",\\n          \\\"nonce\\\": \\\"d4735e3a265e16eee03f59718b...\\\"\\n        }\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"THE DISCLOSURE OBJECT\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**env** *string, possible values are: sandbox, live* \\nThe Paystand environment. Useful in communicating with Paystand to verify the generated imprints against public Paystand records.\",\n    \"2-0\": \"**chain** *string* \\nThe url of the chain containing the record (token).\",\n    \"3-0\": \"**address** *string* \\nThe address of the deployed contract containing the record (token).\",\n    \"4-0\": \"**token** *integer string* \\nThe token associated with the record where the imprint is stored.\",\n    \"5-0\": \"**evidence** *object/hash* \\nThe disclosed information.\",\n    \"6-0\": \"**proof** *array of objects* \\nA cryptographic proof of the evidence. Can be used along with the evidence and the original schema to generate an imprint which can be compared to the imprint stored as part of the token.\",\n    \"1-0\": \"**schema** *string*\\nThe url where the schema can be retrieved.\"\n  },\n  \"cols\": 1,\n  \"rows\": 7\n}\n[/block]","excerpt":"","slug":"the-disclosure-object","type":"basic","title":"The disclosure Object","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

The disclosure Object


[block:code] { "codes": [ { "code": "{\n \"env\": \"sandbox\",\n \"schema\": \"https://api.paystand.com/v3/assurety/public/contracts/schema/0x..2\",\n \"chain\": \"https://example-chain.paystand.co:8540\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"token\": \"1\",\n \"evidence\": {\n \"@type\": \"certification\",\n \t\"hello\": \"World\"\n },\n \"proof\": [\n {\n \"path\": [],\n \"nodes\": [\n {\n \"index\": 1,\n \"hash\": \"48ec6ac9e0d36265c15620dc6aa...\"\n }\n ],\n \"values\": [\n {\n \"index\": 2,\n \"value\": \"78002eb9b19344e451c1f8eba2...\",\n \"nonce\": \"d4735e3a265e16eee03f59718b...\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "THE DISCLOSURE OBJECT" } ], "sidebar": true } [/block] [block:parameters] { "data": { "0-0": "**env** *string, possible values are: sandbox, live* \nThe Paystand environment. Useful in communicating with Paystand to verify the generated imprints against public Paystand records.", "2-0": "**chain** *string* \nThe url of the chain containing the record (token).", "3-0": "**address** *string* \nThe address of the deployed contract containing the record (token).", "4-0": "**token** *integer string* \nThe token associated with the record where the imprint is stored.", "5-0": "**evidence** *object/hash* \nThe disclosed information.", "6-0": "**proof** *array of objects* \nA cryptographic proof of the evidence. Can be used along with the evidence and the original schema to generate an imprint which can be compared to the imprint stored as part of the token.", "1-0": "**schema** *string*\nThe url where the schema can be retrieved." }, "cols": 1, "rows": 7 } [/block]
[block:code] { "codes": [ { "code": "{\n \"env\": \"sandbox\",\n \"schema\": \"https://api.paystand.com/v3/assurety/public/contracts/schema/0x..2\",\n \"chain\": \"https://example-chain.paystand.co:8540\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"token\": \"1\",\n \"evidence\": {\n \"@type\": \"certification\",\n \t\"hello\": \"World\"\n },\n \"proof\": [\n {\n \"path\": [],\n \"nodes\": [\n {\n \"index\": 1,\n \"hash\": \"48ec6ac9e0d36265c15620dc6aa...\"\n }\n ],\n \"values\": [\n {\n \"index\": 2,\n \"value\": \"78002eb9b19344e451c1f8eba2...\",\n \"nonce\": \"d4735e3a265e16eee03f59718b...\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "THE DISCLOSURE OBJECT" } ], "sidebar": true } [/block] [block:parameters] { "data": { "0-0": "**env** *string, possible values are: sandbox, live* \nThe Paystand environment. Useful in communicating with Paystand to verify the generated imprints against public Paystand records.", "2-0": "**chain** *string* \nThe url of the chain containing the record (token).", "3-0": "**address** *string* \nThe address of the deployed contract containing the record (token).", "4-0": "**token** *integer string* \nThe token associated with the record where the imprint is stored.", "5-0": "**evidence** *object/hash* \nThe disclosed information.", "6-0": "**proof** *array of objects* \nA cryptographic proof of the evidence. Can be used along with the evidence and the original schema to generate an imprint which can be compared to the imprint stored as part of the token.", "1-0": "**schema** *string*\nThe url where the schema can be retrieved." }, "cols": 1, "rows": 7 } [/block]
{"_id":"5d56fccfb1b7fc00334d19ae","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192d","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-01T22:58:59.389Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"language":"text","code":""}]},"settings":"5693eae65f1c951900644c21","examples":{"codes":[]},"auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b75b0096232004a6e4d37","ref":"","in":"path","required":false,"desc":"The id of the assurety schema","default":"required","type":"string","name":"id"},{"_id":"5d1b760d5603840013e34c20","ref":"","in":"body","required":false,"desc":"A name for the schema","default":"required","type":"string","name":"name"},{"_id":"5d1b760d5603840013e34c1f","ref":"","in":"body","required":false,"desc":"A short description for the wallet","default":"required","type":"string","name":"description"},{"_id":"5d1b760d5603840013e34c1e","ref":"","in":"body","required":false,"desc":"Optional key/value store to link external data","default":"optional","type":"object","name":"meta"},{"_id":"5d1b760d5603840013e34c1d","ref":"","in":"body","required":false,"desc":"Record data matching its related schema specification.","default":"required","type":"object","name":"data"},{"_id":"5d1ccf2ddb54e1005c451beb","ref":"","in":"query","required":false,"desc":"Comma separated list of parameters to expand","default":"optional","type":"string","name":"expand"}],"url":"/assurety/schemas/:id/records?expand=:expand"},"isReference":false,"order":3,"body":"To create a Record, supply a name, a description, a hash representing the record that matches the schema specification of the related schema, and optionally include meta parameters to link the Record with external data.\n\nNote that once a Record is created, the \"data\" parameter can no longer be updated.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST: /assurety/schemas/c26c288cc9d8477eb58fe9c5/records\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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  \\\"name\\\": \\\"Generic Record\\\",\\n  \\\"description\\\": \\\"A generic assurety record.\\\",\\n  \\\"meta\\\": {},\\n  \\\"data\\\": {\\n    \\\"@type\\\": \\\"certification\\\",\\n    \\\"hello\\\": \\\"World\\\"\\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  \\\"id\\\": \\\"993f6e7efd9d4728a047c132\\\",\\n  \\\"object\\\": \\\"assuretyRecord\\\",\\n  \\\"assuror\\\": \\\"30dd879cee2f11db83140800\\\",\\n  \\\"schema\\\": \\\"99f52d09d7e74be9a9f94eab\\\",\\n  \\\"chain\\\": \\\"b2e849a26b3241fead1e744a\\\",\\n  \\\"wallet\\\": \\\"f4375b83edc849b4884753ec\\\",\\n  \\\"token\\\": \\\"1\\\",\\n  \\\"data\\\": {\\n    \\\"@type\\\": \\\"certification\\\",\\n    \\\"hello\\\": \\\"World\\\"\\n  },\\n  \\\"imprint\\\": \\\"0x642c19d1a7f27bbe60...156d73fc814bd62ce8ed8640b5d\\\",\\n  \\\"name\\\": \\\"Generic Record\\\",\\n  \\\"description\\\": \\\"A generic assurety record.\\\",\\n  \\\"meta\\\": {},\\n  \\\"status\\\": \\\"active\\\",\\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":"","slug":"create-a-record","type":"post","title":"Create a Record","__v":28,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postCreate a Record


Path Params

id:
stringrequired
The id of the assurety schema

Query Params

expand:
stringoptional
Comma separated list of parameters to expand

Body Params

name:
stringrequired
A name for the schema
description:
stringrequired
A short description for the wallet
meta:
objectoptional
Optional key/value store to link external data
data:
objectrequired
Record data matching its related schema specification.

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
To create a Record, supply a name, a description, a hash representing the record that matches the schema specification of the related schema, and optionally include meta parameters to link the Record with external data. Note that once a Record is created, the "data" parameter can no longer be updated. [block:code] { "codes": [ { "code": "POST: /assurety/schemas/c26c288cc9d8477eb58fe9c5/records", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Generic Record\",\n \"description\": \"A generic assurety record.\",\n \"meta\": {},\n \"data\": {\n \"@type\": \"certification\",\n \"hello\": \"World\"\n }\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"993f6e7efd9d4728a047c132\",\n \"object\": \"assuretyRecord\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"schema\": \"99f52d09d7e74be9a9f94eab\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"wallet\": \"f4375b83edc849b4884753ec\",\n \"token\": \"1\",\n \"data\": {\n \"@type\": \"certification\",\n \"hello\": \"World\"\n },\n \"imprint\": \"0x642c19d1a7f27bbe60...156d73fc814bd62ce8ed8640b5d\",\n \"name\": \"Generic Record\",\n \"description\": \"A generic assurety record.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


To create a Record, supply a name, a description, a hash representing the record that matches the schema specification of the related schema, and optionally include meta parameters to link the Record with external data. Note that once a Record is created, the "data" parameter can no longer be updated. [block:code] { "codes": [ { "code": "POST: /assurety/schemas/c26c288cc9d8477eb58fe9c5/records", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Generic Record\",\n \"description\": \"A generic assurety record.\",\n \"meta\": {},\n \"data\": {\n \"@type\": \"certification\",\n \"hello\": \"World\"\n }\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"993f6e7efd9d4728a047c132\",\n \"object\": \"assuretyRecord\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"schema\": \"99f52d09d7e74be9a9f94eab\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"wallet\": \"f4375b83edc849b4884753ec\",\n \"token\": \"1\",\n \"data\": {\n \"@type\": \"certification\",\n \"hello\": \"World\"\n },\n \"imprint\": \"0x642c19d1a7f27bbe60...156d73fc814bd62ce8ed8640b5d\",\n \"name\": \"Generic Record\",\n \"description\": \"A generic assurety record.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19b5","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192d","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-01T23:38:08.906Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"5693eae65f1c951900644c21","results":{"codes":[{"language":"text","code":""}]},"method":"put","auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b7a57f7722c002d5d8932","ref":"","in":"path","required":false,"desc":"The id of the assurety record","default":"required","type":"string","name":"id"},{"_id":"5d1b7a57f7722c002d5d8931","ref":"","in":"body","required":false,"desc":"A name for the schema","default":"optional","type":"string","name":"name"},{"_id":"5d1b7a57f7722c002d5d8930","ref":"","in":"body","required":false,"desc":"A short description for the wallet","default":"optional","type":"string","name":"description"},{"_id":"5d1b7a57f7722c002d5d892f","ref":"","in":"body","required":false,"desc":"Optional key/value store to link external data","default":"optional","type":"object","name":"meta"},{"_id":"5d1ccf4aa67c370027d6b26f","ref":"","in":"query","required":false,"desc":"Comma separated list of parameters to expand","default":"optional","type":"string","name":"expand"}],"url":"/assurety/records/:id?expand=:expand"},"isReference":false,"order":4,"body":"Specify new values for Record name, description, and meta parameters. Parameters that are not specified in the update request will be left unchanged.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"PUT: /assurety/records/c26c288cc9d8477eb58fe9c5\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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  \\\"name\\\": \\\"Generic Record\\\",\\n  \\\"description\\\": \\\"A generic assurety record.\\\",\\n  \\\"meta\\\": {}\\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  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretyRecord\\\",\\n  \\\"assuror\\\": \\\"30dd879cee2f11db83140800\\\",\\n  \\\"schema\\\": \\\"99f52d09d7e74be9a9f94eab\\\",\\n  \\\"chain\\\": \\\"b2e849a26b3241fead1e744a\\\",\\n  \\\"wallet\\\": \\\"f4375b83edc849b4884753ec\\\",\\n  \\\"token\\\": \\\"1\\\",\\n  \\\"data\\\": {\\n    \\\"@type\\\": \\\"certification\\\",\\n    \\\"hello\\\": \\\"World\\\"\\n  },\\n  \\\"imprint\\\": \\\"0x642c19d1a7f27bbe60...156d73fc814bd62ce8ed8640b5d\\\",\\n  \\\"name\\\": \\\"Generic Record\\\",\\n  \\\"description\\\": \\\"A generic assurety record.\\\",\\n  \\\"meta\\\": {},\\n  \\\"status\\\": \\\"active\\\",\\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":"","slug":"update-a-record","type":"put","title":"Update a Record","__v":17,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

putUpdate a Record


Path Params

id:
stringrequired
The id of the assurety record

Query Params

expand:
stringoptional
Comma separated list of parameters to expand

Body Params

name:
stringoptional
A name for the schema
description:
stringoptional
A short description for the wallet
meta:
objectoptional
Optional key/value store to link external data

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
Specify new values for Record name, description, and meta parameters. Parameters that are not specified in the update request will be left unchanged. [block:code] { "codes": [ { "code": "PUT: /assurety/records/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Generic Record\",\n \"description\": \"A generic assurety record.\",\n \"meta\": {}\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyRecord\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"schema\": \"99f52d09d7e74be9a9f94eab\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"wallet\": \"f4375b83edc849b4884753ec\",\n \"token\": \"1\",\n \"data\": {\n \"@type\": \"certification\",\n \"hello\": \"World\"\n },\n \"imprint\": \"0x642c19d1a7f27bbe60...156d73fc814bd62ce8ed8640b5d\",\n \"name\": \"Generic Record\",\n \"description\": \"A generic assurety record.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Specify new values for Record name, description, and meta parameters. Parameters that are not specified in the update request will be left unchanged. [block:code] { "codes": [ { "code": "PUT: /assurety/records/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Generic Record\",\n \"description\": \"A generic assurety record.\",\n \"meta\": {}\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyRecord\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"schema\": \"99f52d09d7e74be9a9f94eab\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"wallet\": \"f4375b83edc849b4884753ec\",\n \"token\": \"1\",\n \"data\": {\n \"@type\": \"certification\",\n \"hello\": \"World\"\n },\n \"imprint\": \"0x642c19d1a7f27bbe60...156d73fc814bd62ce8ed8640b5d\",\n \"name\": \"Generic Record\",\n \"description\": \"A generic assurety record.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19b0","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192d","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-01T22:59:20.015Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"language":"text","code":""}]},"settings":"5693eae65f1c951900644c21","examples":{"codes":[]},"auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b7a9dc9254a001869f686","ref":"","in":"path","required":false,"desc":"The id of the assurety record","default":"required","type":"string","name":"id"},{"_id":"5d1ccf53a67c370027d6b270","ref":"","in":"query","required":false,"desc":"Comma separated list of parameters to expand","default":"optional","type":"string","name":"expand"}],"url":"/assurety/records/:id?expand=:expand"},"isReference":false,"order":5,"body":"Retrieve Record details.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET: /assurety/records/c26c288cc9d8477eb58fe9c5\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretyRecord\\\",\\n  \\\"assuror\\\": \\\"30dd879cee2f11db83140800\\\",\\n  \\\"schema\\\": \\\"99f52d09d7e74be9a9f94eab\\\",\\n  \\\"chain\\\": \\\"b2e849a26b3241fead1e744a\\\",\\n  \\\"wallet\\\": \\\"f4375b83edc849b4884753ec\\\",\\n  \\\"token\\\": \\\"1\\\",\\n  \\\"data\\\": {\\n    \\\"@type\\\": \\\"certification\\\",\\n    \\\"hello\\\": \\\"World\\\"\\n  },\\n  \\\"imprint\\\": \\\"0x642c19d1a7f27bbe60...156d73fc814bd62ce8ed8640b5d\\\",\\n  \\\"name\\\": \\\"Generic Record\\\",\\n  \\\"description\\\": \\\"A generic assurety record.\\\",\\n  \\\"meta\\\": {},\\n  \\\"status\\\": \\\"active\\\",\\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":"","slug":"get-a-record","type":"get","title":"Retrieve a Record","__v":19,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getRetrieve a Record


Path Params

id:
stringrequired
The id of the assurety record

Query Params

expand:
stringoptional
Comma separated list of parameters to expand

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
Retrieve Record details. [block:code] { "codes": [ { "code": "GET: /assurety/records/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyRecord\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"schema\": \"99f52d09d7e74be9a9f94eab\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"wallet\": \"f4375b83edc849b4884753ec\",\n \"token\": \"1\",\n \"data\": {\n \"@type\": \"certification\",\n \"hello\": \"World\"\n },\n \"imprint\": \"0x642c19d1a7f27bbe60...156d73fc814bd62ce8ed8640b5d\",\n \"name\": \"Generic Record\",\n \"description\": \"A generic assurety record.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Retrieve Record details. [block:code] { "codes": [ { "code": "GET: /assurety/records/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyRecord\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"schema\": \"99f52d09d7e74be9a9f94eab\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"wallet\": \"f4375b83edc849b4884753ec\",\n \"token\": \"1\",\n \"data\": {\n \"@type\": \"certification\",\n \"hello\": \"World\"\n },\n \"imprint\": \"0x642c19d1a7f27bbe60...156d73fc814bd62ce8ed8640b5d\",\n \"name\": \"Generic Record\",\n \"description\": \"A generic assurety record.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19af","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192d","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-01T22:59:12.614Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"5693eae65f1c951900644c21","results":{"codes":[{"language":"text","code":""}]},"method":"get","auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b7af1c3b45f0482904e1d","ref":"","in":"path","required":false,"desc":"The id of the assurety schema.","default":"required","type":"string","name":"id"},{"_id":"5d1ccf5e99922b0018fe1e0b","ref":"","in":"query","required":false,"desc":"Comma separated list of parameters to expand","default":"optional","type":"string","name":"expand"}],"url":"/assurety/schemas/:id/records?expand=:expand"},"isReference":false,"order":6,"body":"List all assuretyRecord objects related to a Schema.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET: /assurety/schemas/c26c288cc9d8477eb58fe9c5/records\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretyRecord\\\",\\n  \\\"assuror\\\": \\\"30dd879cee2f11db83140800\\\",\\n  \\\"schema\\\": \\\"99f52d09d7e74be9a9f94eab\\\",\\n  \\\"chain\\\": \\\"b2e849a26b3241fead1e744a\\\",\\n  \\\"wallet\\\": \\\"f4375b83edc849b4884753ec\\\",\\n  \\\"token\\\": \\\"1\\\",\\n  \\\"data\\\": {\\n    \\\"@type\\\": \\\"certification\\\",\\n    \\\"hello\\\": \\\"World\\\"\\n  },\\n  \\\"imprint\\\": \\\"0x642c19d1a7f27bbe60...156d73fc814bd62ce8ed8640b5d\\\",\\n  \\\"name\\\": \\\"Generic Record\\\",\\n  \\\"description\\\": \\\"A generic assurety record.\\\",\\n  \\\"meta\\\": {},\\n  \\\"status\\\": \\\"active\\\",\\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":"","slug":"list-records","type":"get","title":"List all Records","__v":18,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getList all Records


Path Params

id:
stringrequired
The id of the assurety schema.

Query Params

expand:
stringoptional
Comma separated list of parameters to expand

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
List all assuretyRecord objects related to a Schema. [block:code] { "codes": [ { "code": "GET: /assurety/schemas/c26c288cc9d8477eb58fe9c5/records", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "[{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyRecord\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"schema\": \"99f52d09d7e74be9a9f94eab\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"wallet\": \"f4375b83edc849b4884753ec\",\n \"token\": \"1\",\n \"data\": {\n \"@type\": \"certification\",\n \"hello\": \"World\"\n },\n \"imprint\": \"0x642c19d1a7f27bbe60...156d73fc814bd62ce8ed8640b5d\",\n \"name\": \"Generic Record\",\n \"description\": \"A generic assurety record.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}]", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


List all assuretyRecord objects related to a Schema. [block:code] { "codes": [ { "code": "GET: /assurety/schemas/c26c288cc9d8477eb58fe9c5/records", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "[{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyRecord\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"schema\": \"99f52d09d7e74be9a9f94eab\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"wallet\": \"f4375b83edc849b4884753ec\",\n \"token\": \"1\",\n \"data\": {\n \"@type\": \"certification\",\n \"hello\": \"World\"\n },\n \"imprint\": \"0x642c19d1a7f27bbe60...156d73fc814bd62ce8ed8640b5d\",\n \"name\": \"Generic Record\",\n \"description\": \"A generic assurety record.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}]", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19c8","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192d","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-03T18:02:55.292Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"5693eae65f1c951900644c21","results":{"codes":[{"language":"text","code":""}]},"method":"post","auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b743d9d26ea04d1296ed6","ref":"","in":"path","required":false,"desc":"The id of the Assurety Record","default":"required","type":"string","name":"id"},{"_id":"5d1e632d1b55d801f444257f","ref":"","in":"body","required":false,"desc":"A 2D array of strings of parameters to disclose from the record. Each sub array should be an array of strings indicating the path of the parameters to disclose.","default":"required","type":"mixed","name":"disclose"}],"url":"/assurety/records/:id/disclose"},"isReference":false,"order":7,"body":"Disclose some or all of a Record in a format that can be securely sent to third parties and can then be further verified by them. \n\nProvide a list of the properties that should be disclosed, and a base64 encoding of the disclosure object will be returned.\n\nThe encoded data can be decoded using the base64 decoder of your choice to reveal the disclosure object. Here is an online decoder to verify your data manually [Base64 Decoder](https://emn178.github.io/online-tools/base64_decode.html).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST: /assurety/records/c26c288cc9d8477eb58fe9c5/disclose\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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\\tdisclose: [[\\\"hello\\\"]]\\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  \\\"encoded\\\": \\\"ewogICJlbnYiOiAic2FuZGJveCIsCiAgInNjaGVtYSI6ICJodHRwczovL2FwaS5wYXlzdGFuZC5jb20vdjMvYXNzdXJldHkvcHVibGljL2NvbnRyYWN0cy9zY2hlbWEvMHguLjIiLAogICJjaGFpbiI6ICJodHRwczovL2V4YW1wbGUtY2hhaW4ucGF5c3RhbmQuY286ODU0MCIsCiAgImFkZHJlc3MiOiAiMHg1Yzc1RTJFQjU0OTJhQjgwOGIyOTUyOWU0MDZGMjZGOUNBRDIxZkQyIiwKICAidG9rZW4iOiAiMSIsCiAgImV2aWRlbmNlIjogewogICAgIkB0eXBlIjogIkNlcnRpZmljYXRpb24iLAogICAgImhlbGxvIjogIldvcmxkIgogIH0sCiAgInByb29mIjogWwogICAgewogICAgICAicGF0aCI6IFtdLAogICAgICAibm9kZXMiOiBbCiAgICAgICAgewogICAgICAgICAgImluZGV4IjogMSwKICAgICAgICAgICJoYXNoIjogIjQ4ZWM2YWM5ZTBkMzYyNjVjMTU2MjBkYzZhYS4uLiIKICAgICAgICB9CiAgICAgIF0sCiAgICAgICJ2YWx1ZXMiOiBbCiAgICAgICAgewogICAgICAgICAgImluZGV4IjogMiwKICAgICAgICAgICJ2YWx1ZSI6ICI3ODAwMmViOWIxOTM0NGU0NTFjMWY4ZWJhMi4uLiIsCiAgICAgICAgICAibm9uY2UiOiAiZDQ3MzVlM2EyNjVlMTZlZWUwM2Y1OTcxOGIuLi4iCiAgICAgICAgfQogICAgICBdCiAgICB9CiAgXQp9\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"RESPONSE\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"env\\\": \\\"sandbox\\\",\\n  \\\"schemaUrl\\\": \\\"https://api.paystand.com/v3/assurety/public/contracts/schema/0x..2\\\",\\n  \\\"chainUrl\\\": \\\"https://example-chain.paystand.co:8540\\\",\\n  \\\"address\\\": \\\"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\\\",\\n  \\\"token\\\": \\\"1\\\",\\n  \\\"evidence\\\": {\\n    \\\"@type\\\": \\\"certification\\\",\\n  \\t\\\"hello\\\": \\\"World\\\"\\n  },\\n  \\\"proof\\\": [\\n    {\\n      \\\"path\\\": [],\\n      \\\"nodes\\\": [\\n        {\\n          \\\"index\\\": 1,\\n          \\\"hash\\\": \\\"48ec6ac9e0d36265c15620dc6aa...\\\"\\n        }\\n      ],\\n      \\\"values\\\": [\\n        {\\n          \\\"index\\\": 2,\\n          \\\"value\\\": \\\"78002eb9b19344e451c1f8eba2...\\\",\\n          \\\"nonce\\\": \\\"d4735e3a265e16eee03f59718b...\\\"\\n        }\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"DECODED\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"disclose-a-record","type":"post","title":"Disclose a Record","__v":21,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postDisclose a Record


Path Params

id:
stringrequired
The id of the Assurety Record

Body Params

disclose:
mixedrequired
A 2D array of strings of parameters to disclose from the record. Each sub array should be an array of strings indicating the path of the parameters to disclose.

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
Disclose some or all of a Record in a format that can be securely sent to third parties and can then be further verified by them. Provide a list of the properties that should be disclosed, and a base64 encoding of the disclosure object will be returned. The encoded data can be decoded using the base64 decoder of your choice to reveal the disclosure object. Here is an online decoder to verify your data manually [Base64 Decoder](https://emn178.github.io/online-tools/base64_decode.html). [block:code] { "codes": [ { "code": "POST: /assurety/records/c26c288cc9d8477eb58fe9c5/disclose", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n\tdisclose: [[\"hello\"]]\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"encoded\": \"ewogICJlbnYiOiAic2FuZGJveCIsCiAgInNjaGVtYSI6ICJodHRwczovL2FwaS5wYXlzdGFuZC5jb20vdjMvYXNzdXJldHkvcHVibGljL2NvbnRyYWN0cy9zY2hlbWEvMHguLjIiLAogICJjaGFpbiI6ICJodHRwczovL2V4YW1wbGUtY2hhaW4ucGF5c3RhbmQuY286ODU0MCIsCiAgImFkZHJlc3MiOiAiMHg1Yzc1RTJFQjU0OTJhQjgwOGIyOTUyOWU0MDZGMjZGOUNBRDIxZkQyIiwKICAidG9rZW4iOiAiMSIsCiAgImV2aWRlbmNlIjogewogICAgIkB0eXBlIjogIkNlcnRpZmljYXRpb24iLAogICAgImhlbGxvIjogIldvcmxkIgogIH0sCiAgInByb29mIjogWwogICAgewogICAgICAicGF0aCI6IFtdLAogICAgICAibm9kZXMiOiBbCiAgICAgICAgewogICAgICAgICAgImluZGV4IjogMSwKICAgICAgICAgICJoYXNoIjogIjQ4ZWM2YWM5ZTBkMzYyNjVjMTU2MjBkYzZhYS4uLiIKICAgICAgICB9CiAgICAgIF0sCiAgICAgICJ2YWx1ZXMiOiBbCiAgICAgICAgewogICAgICAgICAgImluZGV4IjogMiwKICAgICAgICAgICJ2YWx1ZSI6ICI3ODAwMmViOWIxOTM0NGU0NTFjMWY4ZWJhMi4uLiIsCiAgICAgICAgICAibm9uY2UiOiAiZDQ3MzVlM2EyNjVlMTZlZWUwM2Y1OTcxOGIuLi4iCiAgICAgICAgfQogICAgICBdCiAgICB9CiAgXQp9\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"env\": \"sandbox\",\n \"schemaUrl\": \"https://api.paystand.com/v3/assurety/public/contracts/schema/0x..2\",\n \"chainUrl\": \"https://example-chain.paystand.co:8540\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"token\": \"1\",\n \"evidence\": {\n \"@type\": \"certification\",\n \t\"hello\": \"World\"\n },\n \"proof\": [\n {\n \"path\": [],\n \"nodes\": [\n {\n \"index\": 1,\n \"hash\": \"48ec6ac9e0d36265c15620dc6aa...\"\n }\n ],\n \"values\": [\n {\n \"index\": 2,\n \"value\": \"78002eb9b19344e451c1f8eba2...\",\n \"nonce\": \"d4735e3a265e16eee03f59718b...\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "DECODED" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Disclose some or all of a Record in a format that can be securely sent to third parties and can then be further verified by them. Provide a list of the properties that should be disclosed, and a base64 encoding of the disclosure object will be returned. The encoded data can be decoded using the base64 decoder of your choice to reveal the disclosure object. Here is an online decoder to verify your data manually [Base64 Decoder](https://emn178.github.io/online-tools/base64_decode.html). [block:code] { "codes": [ { "code": "POST: /assurety/records/c26c288cc9d8477eb58fe9c5/disclose", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n\tdisclose: [[\"hello\"]]\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"encoded\": \"ewogICJlbnYiOiAic2FuZGJveCIsCiAgInNjaGVtYSI6ICJodHRwczovL2FwaS5wYXlzdGFuZC5jb20vdjMvYXNzdXJldHkvcHVibGljL2NvbnRyYWN0cy9zY2hlbWEvMHguLjIiLAogICJjaGFpbiI6ICJodHRwczovL2V4YW1wbGUtY2hhaW4ucGF5c3RhbmQuY286ODU0MCIsCiAgImFkZHJlc3MiOiAiMHg1Yzc1RTJFQjU0OTJhQjgwOGIyOTUyOWU0MDZGMjZGOUNBRDIxZkQyIiwKICAidG9rZW4iOiAiMSIsCiAgImV2aWRlbmNlIjogewogICAgIkB0eXBlIjogIkNlcnRpZmljYXRpb24iLAogICAgImhlbGxvIjogIldvcmxkIgogIH0sCiAgInByb29mIjogWwogICAgewogICAgICAicGF0aCI6IFtdLAogICAgICAibm9kZXMiOiBbCiAgICAgICAgewogICAgICAgICAgImluZGV4IjogMSwKICAgICAgICAgICJoYXNoIjogIjQ4ZWM2YWM5ZTBkMzYyNjVjMTU2MjBkYzZhYS4uLiIKICAgICAgICB9CiAgICAgIF0sCiAgICAgICJ2YWx1ZXMiOiBbCiAgICAgICAgewogICAgICAgICAgImluZGV4IjogMiwKICAgICAgICAgICJ2YWx1ZSI6ICI3ODAwMmViOWIxOTM0NGU0NTFjMWY4ZWJhMi4uLiIsCiAgICAgICAgICAibm9uY2UiOiAiZDQ3MzVlM2EyNjVlMTZlZWUwM2Y1OTcxOGIuLi4iCiAgICAgICAgfQogICAgICBdCiAgICB9CiAgXQp9\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"env\": \"sandbox\",\n \"schemaUrl\": \"https://api.paystand.com/v3/assurety/public/contracts/schema/0x..2\",\n \"chainUrl\": \"https://example-chain.paystand.co:8540\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"token\": \"1\",\n \"evidence\": {\n \"@type\": \"certification\",\n \t\"hello\": \"World\"\n },\n \"proof\": [\n {\n \"path\": [],\n \"nodes\": [\n {\n \"index\": 1,\n \"hash\": \"48ec6ac9e0d36265c15620dc6aa...\"\n }\n ],\n \"values\": [\n {\n \"index\": 2,\n \"value\": \"78002eb9b19344e451c1f8eba2...\",\n \"nonce\": \"d4735e3a265e16eee03f59718b...\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "DECODED" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19b8","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192c","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-02T13:50:48.547Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /assurety/assurors/:id/schemas\\n PUT /assurety/schemas/:id\\n GET /assurety/schemas/:id\\n GET /assurety/assurors/:id/schemas\\nPOST /assurety/schemas/:id/activate\\nPOST /assurety/schemas/:id/deactivate\",\n      \"language\": \"json\",\n      \"name\": \"ENDPOINTS\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\nAssurety Schemas are a special type of blockchain contract that conform to a pre-defined specification for the purposes of ensuring that all records (data) created using that schema (contract) adhere to the pre-defined specification. \n\nAfter creating an Assuror and a Wallet, the next step is usually to define specification to be used to assure future records and to create an Assurety Schema against your assuror, using the created wallet and your defined specification.\n\nNote that the specification must adhere to the [JSON Schema](http://json-schema.org/) standard. Also note that once an Assurety Schema is created, the \"specification\" and \"wallet\" parameters will no longer be able to be updated.\n\n\nOnce an Assurer and Wallet have been created, a specification can then be defined and added to an Assurety Schema. An Assurety Schema is a special type of blockchain contract that conforms to the specification added to it.  This Schema (contract) can then be used to assure that all Records created with the Schema adhere to its specification.\n\nNote that the specification added to an Assurety Schema must adhere to the [JSON Schema](http://json-schema.org/) standard. Also note that once an Assurety Schema is created, the \"specification\" and \"wallet\" parameters can not be updated afterwards.","excerpt":"","slug":"managing-schemas","type":"basic","title":"Assurety Schemas","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Assurety Schemas


[block:code] { "codes": [ { "code": "POST /assurety/assurors/:id/schemas\n PUT /assurety/schemas/:id\n GET /assurety/schemas/:id\n GET /assurety/assurors/:id/schemas\nPOST /assurety/schemas/:id/activate\nPOST /assurety/schemas/:id/deactivate", "language": "json", "name": "ENDPOINTS" } ], "sidebar": true } [/block] Assurety Schemas are a special type of blockchain contract that conform to a pre-defined specification for the purposes of ensuring that all records (data) created using that schema (contract) adhere to the pre-defined specification. After creating an Assuror and a Wallet, the next step is usually to define specification to be used to assure future records and to create an Assurety Schema against your assuror, using the created wallet and your defined specification. Note that the specification must adhere to the [JSON Schema](http://json-schema.org/) standard. Also note that once an Assurety Schema is created, the "specification" and "wallet" parameters will no longer be able to be updated. Once an Assurer and Wallet have been created, a specification can then be defined and added to an Assurety Schema. An Assurety Schema is a special type of blockchain contract that conforms to the specification added to it. This Schema (contract) can then be used to assure that all Records created with the Schema adhere to its specification. Note that the specification added to an Assurety Schema must adhere to the [JSON Schema](http://json-schema.org/) standard. Also note that once an Assurety Schema is created, the "specification" and "wallet" parameters can not be updated afterwards.
[block:code] { "codes": [ { "code": "POST /assurety/assurors/:id/schemas\n PUT /assurety/schemas/:id\n GET /assurety/schemas/:id\n GET /assurety/assurors/:id/schemas\nPOST /assurety/schemas/:id/activate\nPOST /assurety/schemas/:id/deactivate", "language": "json", "name": "ENDPOINTS" } ], "sidebar": true } [/block] Assurety Schemas are a special type of blockchain contract that conform to a pre-defined specification for the purposes of ensuring that all records (data) created using that schema (contract) adhere to the pre-defined specification. After creating an Assuror and a Wallet, the next step is usually to define specification to be used to assure future records and to create an Assurety Schema against your assuror, using the created wallet and your defined specification. Note that the specification must adhere to the [JSON Schema](http://json-schema.org/) standard. Also note that once an Assurety Schema is created, the "specification" and "wallet" parameters will no longer be able to be updated. Once an Assurer and Wallet have been created, a specification can then be defined and added to an Assurety Schema. An Assurety Schema is a special type of blockchain contract that conforms to the specification added to it. This Schema (contract) can then be used to assure that all Records created with the Schema adhere to its specification. Note that the specification added to an Assurety Schema must adhere to the [JSON Schema](http://json-schema.org/) standard. Also note that once an Assurety Schema is created, the "specification" and "wallet" parameters can not be updated afterwards.
{"_id":"5d56fccfb1b7fc00334d19cf","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192c","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-04T17:29:35.292Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretySchema\\\",\\n  \\\"assuror\\\": \\\"30dd879cee2f11db83140800\\\",\\n  \\\"chain\\\": \\\"b2e849a26b3241fead1e744a\\\",\\n  \\\"contract\\\": \\\"437c364d41ef49fe8ded8f51\\\",\\n  \\\"wallet\\\": \\\"cbac9afb00bb4bcab86a8ad5\\\",\\n  \\\"address\\\": \\\"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\\\",\\n  \\\"specification\\\": {\\n    \\\"properties\\\": {\\n\\t\\t  \\\"@type\\\": {\\n        \\\"type\\\": \\\"string\\\"\\n      },\\n  \\t\\t\\\"hello\\\": {\\n      \\t\\\"type\\\": \\\"string\\\"\\n      }\\n  \\t},\\n    \\\"type\\\": \\\"object\\\"\\n  },\\n  \\\"name\\\": \\\"Generic Schema\\\",\\n  \\\"description\\\": \\\"A generic assurety schema.\\\",\\n  \\\"meta\\\": {},\\n  \\\"status\\\": \\\"active\\\",\\n  \\\"created\\\": \\\"2015-10-28T22:55:09.000Z\\\",\\n  \\\"lastUpdated\\\": \\\"2015-10-28T22:55:13.000Z\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"THE SCHEMA OBJECT\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**id** *string* \\nThe unique identifier of the schema.\",\n    \"1-0\": \"**object** *string, value is \\\"assuretySchema\\\"*\",\n    \"2-0\": \"**assuror** *string [expandable]* \\nThe assuror associated with the schema.\",\n    \"3-0\": \"**chain** *string [expandable]* \\nThe chain associated with the schema.\",\n    \"4-0\": \"**contract** *string [expandable]* \\nThe contract associated with the schema.\",\n    \"5-0\": \"**wallet** *string [expandable]* \\nThe wallet associated with the schema.\",\n    \"6-0\": \"**address** *string* \\nThe public blockchain address where the schema contract is deployed.\",\n    \"7-0\": \"**specification** *object/hash* \\nA JSON object representing the specification that all records created against this schema must comply with. The specification must conform to the  [JSON Schema](http://json-schema.org/) standard.\",\n    \"8-0\": \"**name** *string* \\nThe name of the schema.\",\n    \"9-0\": \"**description** *string* \\nA short description of the schema.\",\n    \"10-0\": \"**meta** *object/hash* \",\n    \"11-0\": \"**status** *string, possible values are: active, inactive* \\n\\n*active*\\nA schema starts out as active upon creation. In an active state, records can be created against the schema.\\n\\n*inactive*\\nA schema can become inactive by calling the [Deactivate a schema](doc:deactivate-a-schema) endpoint. In an inactive state, records can longer be created against the schema.\",\n    \"12-0\": \"**created** *datestring* \\nThe date the schema was created.\",\n    \"13-0\": \"**lastUpdated** *datestring* \\nThe date the schema was last updated.\"\n  },\n  \"cols\": 1,\n  \"rows\": 14\n}\n[/block]","excerpt":"","slug":"the-schema-object","type":"basic","title":"The assuretySchema Object","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

The assuretySchema Object


[block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretySchema\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"contract\": \"437c364d41ef49fe8ded8f51\",\n \"wallet\": \"cbac9afb00bb4bcab86a8ad5\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"specification\": {\n \"properties\": {\n\t\t \"@type\": {\n \"type\": \"string\"\n },\n \t\t\"hello\": {\n \t\"type\": \"string\"\n }\n \t},\n \"type\": \"object\"\n },\n \"name\": \"Generic Schema\",\n \"description\": \"A generic assurety schema.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "THE SCHEMA OBJECT" } ], "sidebar": true } [/block] [block:parameters] { "data": { "0-0": "**id** *string* \nThe unique identifier of the schema.", "1-0": "**object** *string, value is \"assuretySchema\"*", "2-0": "**assuror** *string [expandable]* \nThe assuror associated with the schema.", "3-0": "**chain** *string [expandable]* \nThe chain associated with the schema.", "4-0": "**contract** *string [expandable]* \nThe contract associated with the schema.", "5-0": "**wallet** *string [expandable]* \nThe wallet associated with the schema.", "6-0": "**address** *string* \nThe public blockchain address where the schema contract is deployed.", "7-0": "**specification** *object/hash* \nA JSON object representing the specification that all records created against this schema must comply with. The specification must conform to the [JSON Schema](http://json-schema.org/) standard.", "8-0": "**name** *string* \nThe name of the schema.", "9-0": "**description** *string* \nA short description of the schema.", "10-0": "**meta** *object/hash* ", "11-0": "**status** *string, possible values are: active, inactive* \n\n*active*\nA schema starts out as active upon creation. In an active state, records can be created against the schema.\n\n*inactive*\nA schema can become inactive by calling the [Deactivate a schema](doc:deactivate-a-schema) endpoint. In an inactive state, records can longer be created against the schema.", "12-0": "**created** *datestring* \nThe date the schema was created.", "13-0": "**lastUpdated** *datestring* \nThe date the schema was last updated." }, "cols": 1, "rows": 14 } [/block]
[block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretySchema\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"contract\": \"437c364d41ef49fe8ded8f51\",\n \"wallet\": \"cbac9afb00bb4bcab86a8ad5\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"specification\": {\n \"properties\": {\n\t\t \"@type\": {\n \"type\": \"string\"\n },\n \t\t\"hello\": {\n \t\"type\": \"string\"\n }\n \t},\n \"type\": \"object\"\n },\n \"name\": \"Generic Schema\",\n \"description\": \"A generic assurety schema.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "THE SCHEMA OBJECT" } ], "sidebar": true } [/block] [block:parameters] { "data": { "0-0": "**id** *string* \nThe unique identifier of the schema.", "1-0": "**object** *string, value is \"assuretySchema\"*", "2-0": "**assuror** *string [expandable]* \nThe assuror associated with the schema.", "3-0": "**chain** *string [expandable]* \nThe chain associated with the schema.", "4-0": "**contract** *string [expandable]* \nThe contract associated with the schema.", "5-0": "**wallet** *string [expandable]* \nThe wallet associated with the schema.", "6-0": "**address** *string* \nThe public blockchain address where the schema contract is deployed.", "7-0": "**specification** *object/hash* \nA JSON object representing the specification that all records created against this schema must comply with. The specification must conform to the [JSON Schema](http://json-schema.org/) standard.", "8-0": "**name** *string* \nThe name of the schema.", "9-0": "**description** *string* \nA short description of the schema.", "10-0": "**meta** *object/hash* ", "11-0": "**status** *string, possible values are: active, inactive* \n\n*active*\nA schema starts out as active upon creation. In an active state, records can be created against the schema.\n\n*inactive*\nA schema can become inactive by calling the [Deactivate a schema](doc:deactivate-a-schema) endpoint. In an inactive state, records can longer be created against the schema.", "12-0": "**created** *datestring* \nThe date the schema was created.", "13-0": "**lastUpdated** *datestring* \nThe date the schema was last updated." }, "cols": 1, "rows": 14 } [/block]
{"_id":"5d56fccfb1b7fc00334d19ab","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192c","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-01T22:58:00.015Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"5693eae65f1c951900644c21","results":{"codes":[{"language":"text","code":""}]},"method":"post","auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b7209f8c97b0039f7c1f9","ref":"","in":"path","required":false,"desc":"The is of the assuror","default":"required","type":"string","name":"id"},{"_id":"5d1ccf7defcc95006ce32d7f","ref":"","in":"query","required":false,"desc":"Comma separated list of parameters to expand","default":"optional","type":"string","name":"expand"},{"_id":"5d1cd005c66fea0048c8f82d","ref":"","in":"body","required":false,"desc":"A name for the schema","default":"required","type":"string","name":"name"},{"_id":"5d1cd005c66fea0048c8f82c","ref":"","in":"body","required":false,"desc":"A short description for the wallet","default":"required","type":"string","name":"description"},{"_id":"5d1cd005c66fea0048c8f82b","ref":"","in":"body","required":false,"desc":"Optional key/value store to link external data","default":"optional","type":"object","name":"meta"},{"_id":"5d1cd005c66fea0048c8f82a","ref":"","in":"body","required":false,"desc":"The schema object","default":"required","type":"object","name":"specification"},{"_id":"5d1cd005c66fea0048c8f829","ref":"","in":"body","required":false,"desc":"The walletId of the wallet to be used as the owner of the schema contract","default":"required","type":"string","name":"wallet"}],"url":"/assurety/assurors/:id/schemas?expand=:expand"},"isReference":false,"order":2,"body":"To create a Schema (smart contract) on a blockchain, supply a name, a short description, the schema specification itself, the wallet to be the owner of the schema, and optionally include meta parameters to link the Schema with external data.\n\nA created Schema, which must comply with the [JSON Schema](http://json-schema.org/) standard, is a template that all future Records created with the Schema must comply with.\n\nNote that once a Schema is created, the \"specification\" and the \"wallet\" parameters can no longer be updated.  Also note that chain and contract parameters are automatically assigned to a created Schema.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST: /assurety/assurors/c26c288cc9d8477eb58fe9c5/schemas\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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  \\\"name\\\": \\\"Generic Schema\\\",\\n  \\\"description\\\": \\\"A generic assurety schema.\\\",\\n  \\\"meta\\\": {},\\n  \\\"wallet\\\": \\\"cbac9afb00bb4bcab86a8ad5\\\",\\n  \\\"specification\\\": {\\n    \\\"properties\\\": {\\n\\t\\t  \\\"@type\\\": {\\n        \\\"type\\\": \\\"string\\\"\\n      },\\n  \\t\\t\\\"hello\\\": {\\n      \\t\\\"type\\\": \\\"string\\\"\\n      }\\n  \\t},\\n    \\\"type\\\": \\\"object\\\"\\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  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretySchema\\\",\\n  \\\"assuror\\\": \\\"30dd879cee2f11db83140800\\\",\\n  \\\"chain\\\": \\\"b2e849a26b3241fead1e744a\\\",\\n  \\\"contract\\\": \\\"437c364d41ef49fe8ded8f51\\\",\\n  \\\"wallet\\\": \\\"cbac9afb00bb4bcab86a8ad5\\\",\\n  \\\"address\\\": \\\"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\\\",\\n  \\\"specification\\\": {\\n    \\\"properties\\\": {\\n\\t\\t  \\\"@type\\\": {\\n        \\\"type\\\": \\\"string\\\"\\n      },\\n  \\t\\t\\\"hello\\\": {\\n      \\t\\\"type\\\": \\\"string\\\"\\n      }\\n  \\t},\\n    \\\"type\\\": \\\"object\\\"\\n  },\\n  \\\"name\\\": \\\"Generic Schema\\\",\\n  \\\"description\\\": \\\"A generic assurety schema.\\\",\\n  \\\"meta\\\": {},\\n  \\\"status\\\": \\\"active\\\",\\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":"","slug":"create-a-schema","type":"post","title":"Create a Schema","__v":28,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postCreate a Schema


Path Params

id:
stringrequired
The is of the assuror

Query Params

expand:
stringoptional
Comma separated list of parameters to expand

Body Params

name:
stringrequired
A name for the schema
description:
stringrequired
A short description for the wallet
meta:
objectoptional
Optional key/value store to link external data
specification:
objectrequired
The schema object
wallet:
stringrequired
The walletId of the wallet to be used as the owner of the schema contract

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
To create a Schema (smart contract) on a blockchain, supply a name, a short description, the schema specification itself, the wallet to be the owner of the schema, and optionally include meta parameters to link the Schema with external data. A created Schema, which must comply with the [JSON Schema](http://json-schema.org/) standard, is a template that all future Records created with the Schema must comply with. Note that once a Schema is created, the "specification" and the "wallet" parameters can no longer be updated. Also note that chain and contract parameters are automatically assigned to a created Schema. [block:code] { "codes": [ { "code": "POST: /assurety/assurors/c26c288cc9d8477eb58fe9c5/schemas", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Generic Schema\",\n \"description\": \"A generic assurety schema.\",\n \"meta\": {},\n \"wallet\": \"cbac9afb00bb4bcab86a8ad5\",\n \"specification\": {\n \"properties\": {\n\t\t \"@type\": {\n \"type\": \"string\"\n },\n \t\t\"hello\": {\n \t\"type\": \"string\"\n }\n \t},\n \"type\": \"object\"\n }\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretySchema\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"contract\": \"437c364d41ef49fe8ded8f51\",\n \"wallet\": \"cbac9afb00bb4bcab86a8ad5\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"specification\": {\n \"properties\": {\n\t\t \"@type\": {\n \"type\": \"string\"\n },\n \t\t\"hello\": {\n \t\"type\": \"string\"\n }\n \t},\n \"type\": \"object\"\n },\n \"name\": \"Generic Schema\",\n \"description\": \"A generic assurety schema.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


To create a Schema (smart contract) on a blockchain, supply a name, a short description, the schema specification itself, the wallet to be the owner of the schema, and optionally include meta parameters to link the Schema with external data. A created Schema, which must comply with the [JSON Schema](http://json-schema.org/) standard, is a template that all future Records created with the Schema must comply with. Note that once a Schema is created, the "specification" and the "wallet" parameters can no longer be updated. Also note that chain and contract parameters are automatically assigned to a created Schema. [block:code] { "codes": [ { "code": "POST: /assurety/assurors/c26c288cc9d8477eb58fe9c5/schemas", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Generic Schema\",\n \"description\": \"A generic assurety schema.\",\n \"meta\": {},\n \"wallet\": \"cbac9afb00bb4bcab86a8ad5\",\n \"specification\": {\n \"properties\": {\n\t\t \"@type\": {\n \"type\": \"string\"\n },\n \t\t\"hello\": {\n \t\"type\": \"string\"\n }\n \t},\n \"type\": \"object\"\n }\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretySchema\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"contract\": \"437c364d41ef49fe8ded8f51\",\n \"wallet\": \"cbac9afb00bb4bcab86a8ad5\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"specification\": {\n \"properties\": {\n\t\t \"@type\": {\n \"type\": \"string\"\n },\n \t\t\"hello\": {\n \t\"type\": \"string\"\n }\n \t},\n \"type\": \"object\"\n },\n \"name\": \"Generic Schema\",\n \"description\": \"A generic assurety schema.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19b4","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192c","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-01T23:37:47.966Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"put","results":{"codes":[{"language":"text","code":""}]},"settings":"5693eae65f1c951900644c21","examples":{"codes":[]},"auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b7305d2b3a600740fdb43","ref":"","in":"path","required":false,"desc":"The id of the assurety schema","default":"required","type":"string","name":"id"},{"_id":"5d1ccfb59cac56001c2f388c","ref":"","in":"query","required":false,"desc":"Comma separated list of parameters to expand","default":"optional","type":"string","name":"expand"},{"_id":"5d1cd052a393680375c83773","ref":"","in":"body","required":false,"desc":"A name for the schema","default":"optional","type":"string","name":"name"},{"_id":"5d1cd052a393680375c83772","ref":"","in":"body","required":false,"desc":"A short description for the wallet","default":"optional","type":"string","name":"description"},{"_id":"5d1cd052a393680375c83771","ref":"","in":"body","required":false,"desc":"Optional key/value store to link external data","default":"optional","type":"object","name":"meta"}],"url":"/assurety/schemas/:id?expand=:expand"},"isReference":false,"order":3,"body":"Specify new values for Schema name, description, and the optional meta parameters. Parameters that are not specified in the update request will be left unchanged.\n\nNote that the \"specification\" and the \"wallet\" parameters can not be updated.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"PUT: /assurety/schemas/c26c288cc9d8477eb58fe9c5\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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  \\\"name\\\": \\\"Generic Schema\\\",\\n  \\\"description\\\": \\\"A generic assurety schema.\\\",\\n  \\\"meta\\\": {}\\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  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretySchema\\\",\\n  \\\"assuror\\\": \\\"30dd879cee2f11db83140800\\\",\\n  \\\"chain\\\": \\\"b2e849a26b3241fead1e744a\\\",\\n  \\\"contract\\\": \\\"437c364d41ef49fe8ded8f51\\\",\\n  \\\"wallet\\\": \\\"cbac9afb00bb4bcab86a8ad5\\\",\\n  \\\"address\\\": \\\"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\\\",\\n  \\\"specification\\\": {\\n    \\\"properties\\\": {\\n\\t\\t  \\\"@type\\\": {\\n        \\\"type\\\": \\\"string\\\"\\n      },\\n  \\t\\t\\\"hello\\\": {\\n      \\t\\\"type\\\": \\\"string\\\"\\n      }\\n  \\t},\\n    \\\"type\\\": \\\"object\\\"\\n  },\\n  \\\"name\\\": \\\"Generic Schema\\\",\\n  \\\"description\\\": \\\"A generic assurety schema.\\\",\\n  \\\"meta\\\": {},\\n  \\\"status\\\": \\\"active\\\",\\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":"","slug":"upate-a-schema","type":"put","title":"Update a Schema","__v":19,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

putUpdate a Schema


Path Params

id:
stringrequired
The id of the assurety schema

Query Params

expand:
stringoptional
Comma separated list of parameters to expand

Body Params

name:
stringoptional
A name for the schema
description:
stringoptional
A short description for the wallet
meta:
objectoptional
Optional key/value store to link external data

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
Specify new values for Schema name, description, and the optional meta parameters. Parameters that are not specified in the update request will be left unchanged. Note that the "specification" and the "wallet" parameters can not be updated. [block:code] { "codes": [ { "code": "PUT: /assurety/schemas/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Generic Schema\",\n \"description\": \"A generic assurety schema.\",\n \"meta\": {}\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretySchema\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"contract\": \"437c364d41ef49fe8ded8f51\",\n \"wallet\": \"cbac9afb00bb4bcab86a8ad5\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"specification\": {\n \"properties\": {\n\t\t \"@type\": {\n \"type\": \"string\"\n },\n \t\t\"hello\": {\n \t\"type\": \"string\"\n }\n \t},\n \"type\": \"object\"\n },\n \"name\": \"Generic Schema\",\n \"description\": \"A generic assurety schema.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Specify new values for Schema name, description, and the optional meta parameters. Parameters that are not specified in the update request will be left unchanged. Note that the "specification" and the "wallet" parameters can not be updated. [block:code] { "codes": [ { "code": "PUT: /assurety/schemas/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Generic Schema\",\n \"description\": \"A generic assurety schema.\",\n \"meta\": {}\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretySchema\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"contract\": \"437c364d41ef49fe8ded8f51\",\n \"wallet\": \"cbac9afb00bb4bcab86a8ad5\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"specification\": {\n \"properties\": {\n\t\t \"@type\": {\n \"type\": \"string\"\n },\n \t\t\"hello\": {\n \t\"type\": \"string\"\n }\n \t},\n \"type\": \"object\"\n },\n \"name\": \"Generic Schema\",\n \"description\": \"A generic assurety schema.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19ac","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192c","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-01T22:58:17.612Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"language":"text","code":""}]},"settings":"5693eae65f1c951900644c21","examples":{"codes":[]},"auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b73555739d6012d2076bd","ref":"","in":"path","required":false,"desc":"The id of the assurety schema","default":"required","type":"string","name":"id"},{"_id":"5d1cca1c5b16130031b04efb","ref":"","in":"query","required":false,"desc":"Comma separated list of parameters to expand","default":"optional","type":"string","name":"expand"}],"url":"/assurety/schemas/:id?expand=:expand"},"isReference":false,"order":4,"body":"Retrieve Schema details.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET: /assurety/schemas/c26c288cc9d8477eb58fe9c5\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretySchema\\\",\\n  \\\"assuror\\\": \\\"30dd879cee2f11db83140800\\\",\\n  \\\"chain\\\": \\\"b2e849a26b3241fead1e744a\\\",\\n  \\\"contract\\\": \\\"437c364d41ef49fe8ded8f51\\\",\\n  \\\"wallet\\\": \\\"cbac9afb00bb4bcab86a8ad5\\\",\\n  \\\"address\\\": \\\"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\\\",\\n  \\\"specification\\\": {\\n    \\\"properties\\\": {\\n\\t\\t  \\\"@type\\\": {\\n        \\\"type\\\": \\\"string\\\"\\n      },\\n  \\t\\t\\\"hello\\\": {\\n      \\t\\\"type\\\": \\\"string\\\"\\n      }\\n  \\t},\\n    \\\"type\\\": \\\"object\\\"\\n  },\\n  \\\"name\\\": \\\"Generic Schema\\\",\\n  \\\"description\\\": \\\"A generic assurety schema.\\\",\\n  \\\"meta\\\": {},\\n  \\\"status\\\": \\\"active\\\",\\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":"","slug":"get-a-schema","type":"get","title":"Retrieve a Schema","__v":24,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getRetrieve a Schema


Path Params

id:
stringrequired
The id of the assurety schema

Query Params

expand:
stringoptional
Comma separated list of parameters to expand

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
Retrieve Schema details. [block:code] { "codes": [ { "code": "GET: /assurety/schemas/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretySchema\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"contract\": \"437c364d41ef49fe8ded8f51\",\n \"wallet\": \"cbac9afb00bb4bcab86a8ad5\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"specification\": {\n \"properties\": {\n\t\t \"@type\": {\n \"type\": \"string\"\n },\n \t\t\"hello\": {\n \t\"type\": \"string\"\n }\n \t},\n \"type\": \"object\"\n },\n \"name\": \"Generic Schema\",\n \"description\": \"A generic assurety schema.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Retrieve Schema details. [block:code] { "codes": [ { "code": "GET: /assurety/schemas/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretySchema\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"contract\": \"437c364d41ef49fe8ded8f51\",\n \"wallet\": \"cbac9afb00bb4bcab86a8ad5\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"specification\": {\n \"properties\": {\n\t\t \"@type\": {\n \"type\": \"string\"\n },\n \t\t\"hello\": {\n \t\"type\": \"string\"\n }\n \t},\n \"type\": \"object\"\n },\n \"name\": \"Generic Schema\",\n \"description\": \"A generic assurety schema.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19ad","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192c","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-01T22:58:25.001Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"5693eae65f1c951900644c21","results":{"codes":[{"language":"text","code":""}]},"method":"get","auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b73b488fc6400119d0edf","ref":"","in":"path","required":false,"desc":"The id of the assuror","default":"required","type":"string","name":"id"},{"_id":"5d1ccfa85ddbfd03c5098a3f","ref":"","in":"query","required":false,"desc":"Comma separated list of parameters to expand","default":"optional","type":"string","name":"expand"}],"url":"/assurety/assurors/:id/schemas?expand=:expand"},"isReference":false,"order":5,"body":"List all assuretySchema objects related to an Assuror.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET: /assurety/assurors/c26c288cc9d8477eb58fe9c5/schemas\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretySchema\\\",\\n  \\\"assuror\\\": \\\"30dd879cee2f11db83140800\\\",\\n  \\\"chain\\\": \\\"b2e849a26b3241fead1e744a\\\",\\n  \\\"contract\\\": \\\"437c364d41ef49fe8ded8f51\\\",\\n  \\\"wallet\\\": \\\"cbac9afb00bb4bcab86a8ad5\\\",\\n  \\\"address\\\": \\\"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\\\",\\n  \\\"specification\\\": {\\n    \\\"properties\\\": {\\n\\t\\t  \\\"@type\\\": {\\n        \\\"type\\\": \\\"string\\\"\\n      },\\n  \\t\\t\\\"hello\\\": {\\n      \\t\\\"type\\\": \\\"string\\\"\\n      }\\n  \\t},\\n    \\\"type\\\": \\\"object\\\"\\n  },\\n  \\\"name\\\": \\\"Generic Schema\\\",\\n  \\\"description\\\": \\\"A generic assurety schema.\\\",\\n  \\\"meta\\\": {},\\n  \\\"status\\\": \\\"active\\\",\\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":"","slug":"list-schemas","type":"get","title":"List all Schemas","__v":17,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getList all Schemas


Path Params

id:
stringrequired
The id of the assuror

Query Params

expand:
stringoptional
Comma separated list of parameters to expand

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
List all assuretySchema objects related to an Assuror. [block:code] { "codes": [ { "code": "GET: /assurety/assurors/c26c288cc9d8477eb58fe9c5/schemas", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "[{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretySchema\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"contract\": \"437c364d41ef49fe8ded8f51\",\n \"wallet\": \"cbac9afb00bb4bcab86a8ad5\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"specification\": {\n \"properties\": {\n\t\t \"@type\": {\n \"type\": \"string\"\n },\n \t\t\"hello\": {\n \t\"type\": \"string\"\n }\n \t},\n \"type\": \"object\"\n },\n \"name\": \"Generic Schema\",\n \"description\": \"A generic assurety schema.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}]", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


List all assuretySchema objects related to an Assuror. [block:code] { "codes": [ { "code": "GET: /assurety/assurors/c26c288cc9d8477eb58fe9c5/schemas", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "[{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretySchema\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"contract\": \"437c364d41ef49fe8ded8f51\",\n \"wallet\": \"cbac9afb00bb4bcab86a8ad5\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"specification\": {\n \"properties\": {\n\t\t \"@type\": {\n \"type\": \"string\"\n },\n \t\t\"hello\": {\n \t\"type\": \"string\"\n }\n \t},\n \"type\": \"object\"\n },\n \"name\": \"Generic Schema\",\n \"description\": \"A generic assurety schema.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}]", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19be","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192c","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-02T14:56:39.371Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"5693eae65f1c951900644c21","results":{"codes":[{"language":"text","code":""}]},"method":"post","auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b740491f04b00485c1097","ref":"","in":"path","required":false,"desc":"The id of the assurety schema","default":"required","type":"string","name":"id"},{"_id":"5d1ccf9f1608b9001228eb6a","ref":"","in":"query","required":false,"desc":"Comma separated list of parameters to expand","default":"optional","type":"string","name":"expand"}],"url":"/assurety/schemas/:id/activate?expand=:expand"},"isReference":false,"order":6,"body":"Provide the unique id of the Schema in the POST call to update a Schema with a status of “inactive” to be “active”. If the status of the Schema is already “active” then it will remain active.\n\nActive Schemas can have records created against them.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST: /assurety/schemas/c26c288cc9d8477eb58fe9c5/activate\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretySchema\\\",\\n  \\\"assuror\\\": \\\"30dd879cee2f11db83140800\\\",\\n  \\\"chain\\\": \\\"b2e849a26b3241fead1e744a\\\",\\n  \\\"contract\\\": \\\"437c364d41ef49fe8ded8f51\\\",\\n  \\\"wallet\\\": \\\"cbac9afb00bb4bcab86a8ad5\\\",\\n  \\\"address\\\": \\\"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\\\",\\n  \\\"specification\\\": {\\n    \\\"properties\\\": {\\n\\t\\t  \\\"@type\\\": {\\n        \\\"type\\\": \\\"string\\\"\\n      },\\n  \\t\\t\\\"hello\\\": {\\n      \\t\\\"type\\\": \\\"string\\\"\\n      }\\n  \\t},\\n    \\\"type\\\": \\\"object\\\"\\n  },\\n  \\\"name\\\": \\\"Generic Schema\\\",\\n  \\\"description\\\": \\\"A generic assurety schema.\\\",\\n  \\\"meta\\\": {},\\n  \\\"status\\\": \\\"active\\\",\\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":"","slug":"activate-a-schema","type":"post","title":"Activate a Schema","__v":18,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postActivate a Schema


Path Params

id:
stringrequired
The id of the assurety schema

Query Params

expand:
stringoptional
Comma separated list of parameters to expand

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
Provide the unique id of the Schema in the POST call to update a Schema with a status of “inactive” to be “active”. If the status of the Schema is already “active” then it will remain active. Active Schemas can have records created against them. [block:code] { "codes": [ { "code": "POST: /assurety/schemas/c26c288cc9d8477eb58fe9c5/activate", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretySchema\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"contract\": \"437c364d41ef49fe8ded8f51\",\n \"wallet\": \"cbac9afb00bb4bcab86a8ad5\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"specification\": {\n \"properties\": {\n\t\t \"@type\": {\n \"type\": \"string\"\n },\n \t\t\"hello\": {\n \t\"type\": \"string\"\n }\n \t},\n \"type\": \"object\"\n },\n \"name\": \"Generic Schema\",\n \"description\": \"A generic assurety schema.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Provide the unique id of the Schema in the POST call to update a Schema with a status of “inactive” to be “active”. If the status of the Schema is already “active” then it will remain active. Active Schemas can have records created against them. [block:code] { "codes": [ { "code": "POST: /assurety/schemas/c26c288cc9d8477eb58fe9c5/activate", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretySchema\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"contract\": \"437c364d41ef49fe8ded8f51\",\n \"wallet\": \"cbac9afb00bb4bcab86a8ad5\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"specification\": {\n \"properties\": {\n\t\t \"@type\": {\n \"type\": \"string\"\n },\n \t\t\"hello\": {\n \t\"type\": \"string\"\n }\n \t},\n \"type\": \"object\"\n },\n \"name\": \"Generic Schema\",\n \"description\": \"A generic assurety schema.\",\n \"meta\": {},\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19bf","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d192c","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-02T14:56:49.273Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"language":"text","code":""}]},"settings":"5693eae65f1c951900644c21","examples":{"codes":[]},"auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b743d9d26ea04d1296ed6","ref":"","in":"path","required":false,"desc":"The id of the assurety schema","default":"required","type":"string","name":"id"},{"_id":"5d1ccf96f7aae00023498e04","ref":"","in":"query","required":false,"desc":"Comma separated list of parameters to expand","default":"optional","type":"string","name":"expand"}],"url":"/assurety/schemas/:id/deactivate?expand=:expand"},"isReference":false,"order":7,"body":"Provide the unique id of the Schema in the POST call to update a Schema with a status of “active” to be “inactive”. If the status of the Schema is already “inactive” then it will remain inactive.\n\nAn inactive schema will no longer be able to have records created against them.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST: /assurety/schemas/c26c288cc9d8477eb58fe9c5/deactivate\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretySchema\\\",\\n  \\\"assuror\\\": \\\"30dd879cee2f11db83140800\\\",\\n  \\\"chain\\\": \\\"b2e849a26b3241fead1e744a\\\",\\n  \\\"contract\\\": \\\"437c364d41ef49fe8ded8f51\\\",\\n  \\\"wallet\\\": \\\"cbac9afb00bb4bcab86a8ad5\\\",\\n  \\\"address\\\": \\\"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\\\",\\n  \\\"specification\\\": {\\n    \\\"properties\\\": {\\n\\t\\t  \\\"@type\\\": {\\n        \\\"type\\\": \\\"string\\\"\\n      },\\n  \\t\\t\\\"hello\\\": {\\n      \\t\\\"type\\\": \\\"string\\\"\\n      }\\n  \\t},\\n    \\\"type\\\": \\\"object\\\"\\n  },\\n  \\\"name\\\": \\\"Generic Schema\\\",\\n  \\\"description\\\": \\\"A generic assurety schema.\\\",\\n  \\\"meta\\\": {},\\n  \\\"status\\\": \\\"inactive\\\",\\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":"","slug":"deactivate-a-schema","type":"post","title":"Deactivate a Schema","__v":18,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postDeactivate a Schema


Path Params

id:
stringrequired
The id of the assurety schema

Query Params

expand:
stringoptional
Comma separated list of parameters to expand

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
Provide the unique id of the Schema in the POST call to update a Schema with a status of “active” to be “inactive”. If the status of the Schema is already “inactive” then it will remain inactive. An inactive schema will no longer be able to have records created against them. [block:code] { "codes": [ { "code": "POST: /assurety/schemas/c26c288cc9d8477eb58fe9c5/deactivate", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretySchema\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"contract\": \"437c364d41ef49fe8ded8f51\",\n \"wallet\": \"cbac9afb00bb4bcab86a8ad5\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"specification\": {\n \"properties\": {\n\t\t \"@type\": {\n \"type\": \"string\"\n },\n \t\t\"hello\": {\n \t\"type\": \"string\"\n }\n \t},\n \"type\": \"object\"\n },\n \"name\": \"Generic Schema\",\n \"description\": \"A generic assurety schema.\",\n \"meta\": {},\n \"status\": \"inactive\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Provide the unique id of the Schema in the POST call to update a Schema with a status of “active” to be “inactive”. If the status of the Schema is already “inactive” then it will remain inactive. An inactive schema will no longer be able to have records created against them. [block:code] { "codes": [ { "code": "POST: /assurety/schemas/c26c288cc9d8477eb58fe9c5/deactivate", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretySchema\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"chain\": \"b2e849a26b3241fead1e744a\",\n \"contract\": \"437c364d41ef49fe8ded8f51\",\n \"wallet\": \"cbac9afb00bb4bcab86a8ad5\",\n \"address\": \"0x5c75E2EB5492aB808b29529e406F26F9CAD21fD2\",\n \"specification\": {\n \"properties\": {\n\t\t \"@type\": {\n \"type\": \"string\"\n },\n \t\t\"hello\": {\n \t\"type\": \"string\"\n }\n \t},\n \"type\": \"object\"\n },\n \"name\": \"Generic Schema\",\n \"description\": \"A generic assurety schema.\",\n \"meta\": {},\n \"status\": \"inactive\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19b7","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1927","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-02T13:50:10.502Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Assurety Wallets are used to store cryptographic private/public key pairs associated with a public blockchain address. Creating a Wallet will create a single private/public key pair and reveal its associated public address. The private/public key pair will be securely stored and will never be shared.\n\nAll transactions on a blockchain must be associated with a public address and must be signed using the private key associated with that address before they will be accepted on the blockchain.\n\nPaystand takes care of signing transactions on your behalf whenever an Assurety Schema or an Assurety Record is created. Simply create a Wallet and add it to an Assurety Schema during Schema creation. All records created using that Schema will be signed using the Wallet associated with the Schema.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /assurety/assurors/:id/wallets\\n PUT /assurety/wallets/:id\\n GET /assurety/wallets/:id\\n GET /assurety/assurors/:id/wallets\\nPOST /assurety/wallets/:id/activate\\nPOST /assurety/wallets/:id/deactivate\",\n      \"language\": \"json\",\n      \"name\": \"ENDPOINTS\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"manage-wallets","type":"basic","title":"Assurety Wallets","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Assurety Wallets


Assurety Wallets are used to store cryptographic private/public key pairs associated with a public blockchain address. Creating a Wallet will create a single private/public key pair and reveal its associated public address. The private/public key pair will be securely stored and will never be shared. All transactions on a blockchain must be associated with a public address and must be signed using the private key associated with that address before they will be accepted on the blockchain. Paystand takes care of signing transactions on your behalf whenever an Assurety Schema or an Assurety Record is created. Simply create a Wallet and add it to an Assurety Schema during Schema creation. All records created using that Schema will be signed using the Wallet associated with the Schema. [block:code] { "codes": [ { "code": "POST /assurety/assurors/:id/wallets\n PUT /assurety/wallets/:id\n GET /assurety/wallets/:id\n GET /assurety/assurors/:id/wallets\nPOST /assurety/wallets/:id/activate\nPOST /assurety/wallets/:id/deactivate", "language": "json", "name": "ENDPOINTS" } ], "sidebar": true } [/block]
Assurety Wallets are used to store cryptographic private/public key pairs associated with a public blockchain address. Creating a Wallet will create a single private/public key pair and reveal its associated public address. The private/public key pair will be securely stored and will never be shared. All transactions on a blockchain must be associated with a public address and must be signed using the private key associated with that address before they will be accepted on the blockchain. Paystand takes care of signing transactions on your behalf whenever an Assurety Schema or an Assurety Record is created. Simply create a Wallet and add it to an Assurety Schema during Schema creation. All records created using that Schema will be signed using the Wallet associated with the Schema. [block:code] { "codes": [ { "code": "POST /assurety/assurors/:id/wallets\n PUT /assurety/wallets/:id\n GET /assurety/wallets/:id\n GET /assurety/assurors/:id/wallets\nPOST /assurety/wallets/:id/activate\nPOST /assurety/wallets/:id/deactivate", "language": "json", "name": "ENDPOINTS" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19ca","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1927","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-04T14:45:26.163Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**id** *string*\\nThe unique identifier for the object.\",\n    \"1-0\": \"**object** *string, value is \\\"assuretyWallet\\\"*\",\n    \"2-0\": \"**address** *string* \\nThe 42 hex characters representing the public address for the wallet. The address is automatically generated upon creation of the wallet.\",\n    \"3-0\": \"**assuror** *string [expandable]*\\nThe unique identifier of the assuror that holds this wallet.\",\n    \"4-0\": \"**name** *string*\\nA short name to help identify the wallet in lists.\",\n    \"5-0\": \"**description** *string*\\nA short description to help identify the wallet in lists.\",\n    \"6-0\": \"**status** *possible values are: active, inactive*\\n*active*\\nThe Assurety Wallet is able to be used to manage Assurety Schemas and Assurety Records.\\n\\n*inactive*\\nThe Assurety Wallet is not able to be used to manage Assurety Schemas or Assurety Records. When an Assurety Schema is associated with an inactive Assurety Wallet, that Assurety Schema will no longer be able add or manage its underlying Assurety Records.\",\n    \"7-0\": \"**meta** *object/hash* \\nOptional key/value store to help link the wallet to external systems.\",\n    \"8-0\": \"**created** *datestring* \\nThe date the wallet was created.\",\n    \"9-0\": \"**lastUpdated** *datestring* \\nThe date the wallet was last updated.\"\n  },\n  \"cols\": 1,\n  \"rows\": 10\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretyWallet\\\",\\n  \\\"address\\\": \\\"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\\\",\\n  \\\"assuror\\\": \\\"30dd879cee2f11db83140800\\\",\\n  \\\"name\\\": \\\"Generic Wallet\\\",\\n  \\\"description\\\": \\\"A generic wallet.\\\",\\n  \\\"status\\\": \\\"active\\\",\\n  \\\"meta\\\": {},\\n  \\\"created\\\": \\\"2015-10-28T22:55:09.000Z\\\",\\n  \\\"lastUpdated\\\": \\\"2015-10-28T22:55:13.000Z\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"THE WALLET OBJECT\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"the-wallet-object","type":"basic","title":"The assuretyWallet Object","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

The assuretyWallet Object


[block:parameters] { "data": { "0-0": "**id** *string*\nThe unique identifier for the object.", "1-0": "**object** *string, value is \"assuretyWallet\"*", "2-0": "**address** *string* \nThe 42 hex characters representing the public address for the wallet. The address is automatically generated upon creation of the wallet.", "3-0": "**assuror** *string [expandable]*\nThe unique identifier of the assuror that holds this wallet.", "4-0": "**name** *string*\nA short name to help identify the wallet in lists.", "5-0": "**description** *string*\nA short description to help identify the wallet in lists.", "6-0": "**status** *possible values are: active, inactive*\n*active*\nThe Assurety Wallet is able to be used to manage Assurety Schemas and Assurety Records.\n\n*inactive*\nThe Assurety Wallet is not able to be used to manage Assurety Schemas or Assurety Records. When an Assurety Schema is associated with an inactive Assurety Wallet, that Assurety Schema will no longer be able add or manage its underlying Assurety Records.", "7-0": "**meta** *object/hash* \nOptional key/value store to help link the wallet to external systems.", "8-0": "**created** *datestring* \nThe date the wallet was created.", "9-0": "**lastUpdated** *datestring* \nThe date the wallet was last updated." }, "cols": 1, "rows": 10 } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyWallet\",\n \"address\": \"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"name\": \"Generic Wallet\",\n \"description\": \"A generic wallet.\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "THE WALLET OBJECT" } ], "sidebar": true } [/block]
[block:parameters] { "data": { "0-0": "**id** *string*\nThe unique identifier for the object.", "1-0": "**object** *string, value is \"assuretyWallet\"*", "2-0": "**address** *string* \nThe 42 hex characters representing the public address for the wallet. The address is automatically generated upon creation of the wallet.", "3-0": "**assuror** *string [expandable]*\nThe unique identifier of the assuror that holds this wallet.", "4-0": "**name** *string*\nA short name to help identify the wallet in lists.", "5-0": "**description** *string*\nA short description to help identify the wallet in lists.", "6-0": "**status** *possible values are: active, inactive*\n*active*\nThe Assurety Wallet is able to be used to manage Assurety Schemas and Assurety Records.\n\n*inactive*\nThe Assurety Wallet is not able to be used to manage Assurety Schemas or Assurety Records. When an Assurety Schema is associated with an inactive Assurety Wallet, that Assurety Schema will no longer be able add or manage its underlying Assurety Records.", "7-0": "**meta** *object/hash* \nOptional key/value store to help link the wallet to external systems.", "8-0": "**created** *datestring* \nThe date the wallet was created.", "9-0": "**lastUpdated** *datestring* \nThe date the wallet was last updated." }, "cols": 1, "rows": 10 } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyWallet\",\n \"address\": \"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"name\": \"Generic Wallet\",\n \"description\": \"A generic wallet.\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "THE WALLET OBJECT" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19a8","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1927","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-01T22:56:52.807Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"language":"text","code":""}]},"settings":"5693eae65f1c951900644c21","examples":{"codes":[]},"auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b6d8a323f41004f625b48","ref":"","in":"body","required":false,"desc":"A name for the wallet","default":"required","type":"string","name":"name"},{"_id":"5d1b6d8a323f41004f625b47","ref":"","in":"body","required":false,"desc":"A short description for the wallet","default":"optional","type":"string","name":"description"},{"_id":"5d1b6d8a323f41004f625b46","ref":"","in":"body","required":false,"desc":"Optional key/value store to link external data","default":"optinal","type":"object","name":"meta"},{"_id":"5d1b6d8a323f41004f625b45","ref":"","in":"path","required":false,"desc":"The id of the Assuror","default":"required","type":"string","name":"id"},{"_id":"5d1cd81f1608b9001228ec27","ref":"","in":"query","required":false,"desc":"Comma separated list of parameters to expand. Possible values: *assuror*","default":"optional","type":"string","name":"expand"}],"url":"/assurety/assurors/:id/wallets?expand=:expand"},"isReference":false,"order":2,"body":"To add a new blockchain address/account, create a Wallet. \n\nTo create a Wallet, supply a name, a description, and optionally include meta parameters to link the Wallet with external data.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST: /assurety/assurors/c26c288cc9d8477eb58fe9c5/wallets\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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  \\\"name\\\": \\\"Generic Wallet\\\",\\n  \\\"description\\\": \\\"A generic wallet.\\\",\\n  \\\"meta\\\": {}\\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  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretyWallet\\\",\\n  \\\"address\\\": \\\"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\\\",\\n  \\\"assuror\\\": \\\"30dd879cee2f11db83140800\\\",\\n  \\\"name\\\": \\\"Generic Wallet\\\",\\n  \\\"description\\\": \\\"A generic wallet.\\\",\\n  \\\"status\\\": \\\"active\\\",\\n  \\\"meta\\\": {},\\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":"","slug":"create-a-wallet","type":"post","title":"Create a Wallet","__v":21,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postCreate a Wallet


Path Params

id:
stringrequired
The id of the Assuror

Query Params

expand:
stringoptional
Comma separated list of parameters to expand. Possible values: *assuror*

Body Params

name:
stringrequired
A name for the wallet
description:
stringoptional
A short description for the wallet
meta:
objectoptinal
Optional key/value store to link external data

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
To add a new blockchain address/account, create a Wallet. To create a Wallet, supply a name, a description, and optionally include meta parameters to link the Wallet with external data. [block:code] { "codes": [ { "code": "POST: /assurety/assurors/c26c288cc9d8477eb58fe9c5/wallets", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Generic Wallet\",\n \"description\": \"A generic wallet.\",\n \"meta\": {}\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyWallet\",\n \"address\": \"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"name\": \"Generic Wallet\",\n \"description\": \"A generic wallet.\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


To add a new blockchain address/account, create a Wallet. To create a Wallet, supply a name, a description, and optionally include meta parameters to link the Wallet with external data. [block:code] { "codes": [ { "code": "POST: /assurety/assurors/c26c288cc9d8477eb58fe9c5/wallets", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Generic Wallet\",\n \"description\": \"A generic wallet.\",\n \"meta\": {}\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyWallet\",\n \"address\": \"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"name\": \"Generic Wallet\",\n \"description\": \"A generic wallet.\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19b3","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1927","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-01T23:37:19.609Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"5693eae65f1c951900644c21","results":{"codes":[{"language":"text","code":""}]},"method":"put","auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b6ec35739d6012d20763a","ref":"","in":"path","required":false,"desc":"The id of the Assurety Wallet","default":"required","type":"string","name":"id"},{"_id":"5d1cd80eea080a0011bfcd8a","ref":"","in":"body","required":false,"desc":"A name for the wallet","default":"optional","type":"string","name":"name"},{"_id":"5d1cd80eea080a0011bfcd89","ref":"","in":"body","required":false,"desc":"A short description for the wallet","default":"optional","type":"string","name":"description"},{"_id":"5d1cd80eea080a0011bfcd88","ref":"","in":"body","required":false,"desc":"Optional key/value store to link external data","default":"optional","type":"object","name":"meta"},{"_id":"5d1cd82aed32c30021405a83","ref":"","in":"query","required":false,"desc":"Comma separated list of parameters to expand. Possible values: *assuror*","default":"optional","type":"string","name":"expand"}],"url":"/assurety/wallets/:id?expand=:expand"},"isReference":false,"order":3,"body":"Specify new values for Wallet name, description, and the optional meta parameters. Parameters that are not specified in the update request will be left unchanged.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"PUT: /assurety/wallets/c26c288cc9d8477eb58fe9c5\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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  \\\"name\\\": \\\"Generic Wallet\\\",\\n  \\\"description\\\": \\\"A generic wallet.\\\",\\n  \\\"meta\\\": {}\\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  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretyWallet\\\",\\n  \\\"address\\\": \\\"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\\\",\\n  \\\"assuror\\\": \\\"30dd879cee2f11db83140800\\\",\\n  \\\"name\\\": \\\"Generic Wallet\\\",\\n  \\\"description\\\": \\\"A generic wallet.\\\",\\n  \\\"status\\\": \\\"active\\\",\\n  \\\"meta\\\": {},\\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":"","slug":"update-a-wallet","type":"put","title":"Update a Wallet","__v":14,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

putUpdate a Wallet


Path Params

id:
stringrequired
The id of the Assurety Wallet

Query Params

expand:
stringoptional
Comma separated list of parameters to expand. Possible values: *assuror*

Body Params

name:
stringoptional
A name for the wallet
description:
stringoptional
A short description for the wallet
meta:
objectoptional
Optional key/value store to link external data

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
Specify new values for Wallet name, description, and the optional meta parameters. Parameters that are not specified in the update request will be left unchanged. [block:code] { "codes": [ { "code": "PUT: /assurety/wallets/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Generic Wallet\",\n \"description\": \"A generic wallet.\",\n \"meta\": {}\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyWallet\",\n \"address\": \"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"name\": \"Generic Wallet\",\n \"description\": \"A generic wallet.\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Specify new values for Wallet name, description, and the optional meta parameters. Parameters that are not specified in the update request will be left unchanged. [block:code] { "codes": [ { "code": "PUT: /assurety/wallets/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Generic Wallet\",\n \"description\": \"A generic wallet.\",\n \"meta\": {}\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyWallet\",\n \"address\": \"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"name\": \"Generic Wallet\",\n \"description\": \"A generic wallet.\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19aa","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1927","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-01T22:57:38.863Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"language":"text","code":""}]},"settings":"5693eae65f1c951900644c21","examples":{"codes":[]},"auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b6f0e4307cb04b3233f17","ref":"","in":"path","required":false,"desc":"The id of the assurety wallet","default":"required","type":"string","name":"id"},{"_id":"5d1cd833e90840002bdbd2c8","ref":"","in":"query","required":false,"desc":"Comma separated list of parameters to expand. Possible values: *assuror*","default":"optional","type":"string","name":"expand"}],"url":"/assurety/wallets/:id?expand=:expand"},"isReference":false,"order":4,"body":"Retrieve Wallet details.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET: /assurety/wallets/c26c288cc9d8477eb58fe9c5\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretyWallet\\\",\\n  \\\"address\\\": \\\"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\\\",\\n  \\\"assuror\\\": \\\"30dd879cee2f11db83140800\\\",\\n  \\\"name\\\": \\\"Generic Wallet\\\",\\n  \\\"description\\\": \\\"A generic wallet.\\\",\\n  \\\"status\\\": \\\"active\\\",\\n  \\\"meta\\\": {},\\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":"","slug":"get-a-wallet","type":"get","title":"Retrieve a Wallet","__v":15,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getRetrieve a Wallet


Path Params

id:
stringrequired
The id of the assurety wallet

Query Params

expand:
stringoptional
Comma separated list of parameters to expand. Possible values: *assuror*

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
Retrieve Wallet details. [block:code] { "codes": [ { "code": "GET: /assurety/wallets/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyWallet\",\n \"address\": \"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"name\": \"Generic Wallet\",\n \"description\": \"A generic wallet.\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Retrieve Wallet details. [block:code] { "codes": [ { "code": "GET: /assurety/wallets/c26c288cc9d8477eb58fe9c5", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyWallet\",\n \"address\": \"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"name\": \"Generic Wallet\",\n \"description\": \"A generic wallet.\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19a9","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1927","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-01T22:57:13.786Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"5693eae65f1c951900644c21","results":{"codes":[{"language":"text","code":""}]},"method":"get","auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b6faaadc64d005d1c6b27","ref":"","in":"path","required":false,"desc":"The id of the assuror","default":"required","type":"string","name":"id"},{"_id":"5d1cd83b81113a00450de1ee","ref":"","in":"query","required":false,"desc":"Comma separated list of parameters to expand. Possible values: *assuror*","default":"optional","type":"string","name":"expand"}],"url":"/assurety/assurors/:id/wallets?expand=:expand"},"isReference":false,"order":5,"body":"List all assuretyWallet objects related to an Assuror.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET: /assurety/assurors/c26c288cc9d8477eb58fe9c5/wallets\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretyWallet\\\",\\n  \\\"address\\\": \\\"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\\\",\\n  \\\"assuror\\\": \\\"30dd879cee2f11db83140800\\\",\\n  \\\"name\\\": \\\"Generic Wallet\\\",\\n  \\\"description\\\": \\\"A generic wallet.\\\",\\n  \\\"status\\\": \\\"active\\\",\\n  \\\"meta\\\": {},\\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":"","slug":"list-wallets","type":"get","title":"List all Wallets","__v":12,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getList all Wallets


Path Params

id:
stringrequired
The id of the assuror

Query Params

expand:
stringoptional
Comma separated list of parameters to expand. Possible values: *assuror*

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
List all assuretyWallet objects related to an Assuror. [block:code] { "codes": [ { "code": "GET: /assurety/assurors/c26c288cc9d8477eb58fe9c5/wallets", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "[{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyWallet\",\n \"address\": \"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"name\": \"Generic Wallet\",\n \"description\": \"A generic wallet.\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}]", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


List all assuretyWallet objects related to an Assuror. [block:code] { "codes": [ { "code": "GET: /assurety/assurors/c26c288cc9d8477eb58fe9c5/wallets", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "[{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyWallet\",\n \"address\": \"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"name\": \"Generic Wallet\",\n \"description\": \"A generic wallet.\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}]", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19bc","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1927","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-02T14:53:46.451Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"5693eae65f1c951900644c21","results":{"codes":[{"language":"text","code":""}]},"method":"post","auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b6f0e4307cb04b3233f17","ref":"","in":"path","required":false,"desc":"The id of the assurety wallet","default":"required","type":"string","name":"id"},{"_id":"5d1cd844a67c370027d6b363","ref":"","in":"query","required":false,"desc":"Comma separated list of parameters to expand. Possible values: *assuror*","default":"optional","type":"string","name":"expand"}],"url":"/assurety/wallets/:id/activate?expand=:expand"},"isReference":false,"order":6,"body":"Provide the unique id of the Wallet in the POST call to update a Wallet with a status of “inactive” to be “active”. If the status of the Wallet is already “active” then it will remain active.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST: /assurety/wallets/c26c288cc9d8477eb58fe9c5/activate\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretyWallet\\\",\\n  \\\"address\\\": \\\"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\\\",\\n  \\\"assuror\\\": \\\"30dd879cee2f11db83140800\\\",\\n  \\\"name\\\": \\\"Generic Wallet\\\",\\n  \\\"description\\\": \\\"A generic wallet.\\\",\\n  \\\"status\\\": \\\"active\\\",\\n  \\\"meta\\\": {},\\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":"","slug":"activate-a-wallet","type":"post","title":"Activate a Wallet","__v":11,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postActivate a Wallet


Path Params

id:
stringrequired
The id of the assurety wallet

Query Params

expand:
stringoptional
Comma separated list of parameters to expand. Possible values: *assuror*

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
Provide the unique id of the Wallet in the POST call to update a Wallet with a status of “inactive” to be “active”. If the status of the Wallet is already “active” then it will remain active. [block:code] { "codes": [ { "code": "POST: /assurety/wallets/c26c288cc9d8477eb58fe9c5/activate", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyWallet\",\n \"address\": \"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"name\": \"Generic Wallet\",\n \"description\": \"A generic wallet.\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Provide the unique id of the Wallet in the POST call to update a Wallet with a status of “inactive” to be “active”. If the status of the Wallet is already “active” then it will remain active. [block:code] { "codes": [ { "code": "POST: /assurety/wallets/c26c288cc9d8477eb58fe9c5/activate", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyWallet\",\n \"address\": \"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"name\": \"Generic Wallet\",\n \"description\": \"A generic wallet.\",\n \"status\": \"active\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19bd","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1927","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-02T14:53:55.941Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"language":"text","code":""}]},"settings":"5693eae65f1c951900644c21","examples":{"codes":[]},"auth":"required","params":[{"_id":"5b5a52bfd6ba2f00037793e4","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b5a52bfd6ba2f00037793e3","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b5a52bfd6ba2f00037793e2","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b5a52bfd6ba2f00037793e1","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5d1b6f0e4307cb04b3233f17","ref":"","in":"path","required":false,"desc":"The id of the assurety wallet","default":"required","type":"string","name":"id"},{"_id":"5d1cd84b42c5f7005a8229e8","ref":"","in":"query","required":false,"desc":"Comma separated list of parameters to expand. Possible values: *assuror*","default":"optional","type":"string","name":"expand"}],"url":"/assurety/wallets/:id/deactivate?expand=:expand"},"isReference":false,"order":7,"body":"Provide the unique id of the Wallet in the POST call to update a Wallet with a status of “active” to be “inactive”. If the status of the Wallet is already “inactive” then it will remain active.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST: /assurety/wallets/c26c288cc9d8477eb58fe9c5/deactivate\",\n      \"language\": \"json\",\n      \"name\": \"URL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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      \"language\": \"json\",\n      \"name\": \"REQUEST\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"c26c288cc9d8477eb58fe9c5\\\",\\n  \\\"object\\\": \\\"assuretyWallet\\\",\\n  \\\"address\\\": \\\"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\\\",\\n  \\\"assuror\\\": \\\"30dd879cee2f11db83140800\\\",\\n  \\\"name\\\": \\\"Generic Wallet\\\",\\n  \\\"description\\\": \\\"A generic wallet.\\\",\\n  \\\"status\\\": \\\"inactive\\\",\\n  \\\"meta\\\": {},\\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":"","slug":"dectivate-a-wallet","type":"post","title":"Deactivate a Wallet","__v":12,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postDeactivate a Wallet


Path Params

id:
stringrequired
The id of the assurety wallet

Query Params

expand:
stringoptional
Comma separated list of parameters to expand. Possible values: *assuror*

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
Provide the unique id of the Wallet in the POST call to update a Wallet with a status of “active” to be “inactive”. If the status of the Wallet is already “inactive” then it will remain active. [block:code] { "codes": [ { "code": "POST: /assurety/wallets/c26c288cc9d8477eb58fe9c5/deactivate", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyWallet\",\n \"address\": \"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"name\": \"Generic Wallet\",\n \"description\": \"A generic wallet.\",\n \"status\": \"inactive\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Provide the unique id of the Wallet in the POST call to update a Wallet with a status of “active” to be “inactive”. If the status of the Wallet is already “inactive” then it will remain active. [block:code] { "codes": [ { "code": "POST: /assurety/wallets/c26c288cc9d8477eb58fe9c5/deactivate", "language": "json", "name": "URL" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"c26c288cc9d8477eb58fe9c5\",\n \"object\": \"assuretyWallet\",\n \"address\": \"0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413\",\n \"assuror\": \"30dd879cee2f11db83140800\",\n \"name\": \"Generic Wallet\",\n \"description\": \"A generic wallet.\",\n \"status\": \"inactive\",\n \"meta\": {},\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d19fc","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d193b","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-11T14:44:45.411Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"The checkout interface allows customers to provide a customized and branded payment experience for their payers.\n\n[Load as a billing portal](doc:portal-introduction)\nDedicated billing portal website. Send a link in an email to direct payers to the portal.\n\n[Embed on a website](doc:checkout-introduction) \nEmbed directly in the flow of your website. Customize the look and feel to match your designs.","excerpt":"","slug":"getting-started-4","type":"basic","title":"Getting Started","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Getting Started


The checkout interface allows customers to provide a customized and branded payment experience for their payers. [Load as a billing portal](doc:portal-introduction) Dedicated billing portal website. Send a link in an email to direct payers to the portal. [Embed on a website](doc:checkout-introduction) Embed directly in the flow of your website. Customize the look and feel to match your designs.
The checkout interface allows customers to provide a customized and branded payment experience for their payers. [Load as a billing portal](doc:portal-introduction) Dedicated billing portal website. Send a link in an email to direct payers to the portal. [Embed on a website](doc:checkout-introduction) Embed directly in the flow of your website. Customize the look and feel to match your designs.
{"_id":"5d56fccfb1b7fc00334d1974","isReference":false,"project":"55dd0853d2d97337001800e2","slug":"portal-introduction","version":"5d56fccfb1b7fc00334d1a04","api":{"url":"","auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":""},"body":"The Billing Portal allows Merchant Customers to collect payment information from their Payer Customers using a hosted version of checkout.\n\nThe Billing Portal's primary use cases are situations where the environment from which a payment, payment method or scheduled payment needs to be collected, is not an active website.\n\nExample use cases are payment or schedule buttons in an HTML email or PDF document.\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Billing Portal Unified Resource Locator (URL)\",\n  \"body\": \"The Billing Portal URL supports the same parameters as the checkout Init object described in [Init Object Reference](doc:checkout-init-object). These parameters can be passed along with the URL in 2 GET parameter formats:\\n  * 1 parameter called \\\"init\\\" with a **URL encoded json formatted** value (See: [Init JSON Parameter](doc:portal-init-json-parameter) \\n  * multiple single value parameters named using a [Flattened Dot Notation Parameters](doc:portal-flattened-dot-notation-parameters)  representing the hierarchy inside the Init object.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Billing Portal Base URL\",\n  \"body\": \"The Base URL for loading the **Production** Billing Portal is https://api.paystand.com/v3/plugins/paystand/checkout\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.paystand.co/v3/plugins/paystand/checkout\",\n      \"language\": \"http\",\n      \"name\": \"Sandbox Base Url\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.paystand.co/v3/plugins/paystand/checkout?init={\\\"publishableKey\\\":\\\"bkba5nienlzbnb6ub2chmcsp\\\", \\\"payment\\\": {\\\"amount\\\": \\\"1.00\\\"}, \\\"currency\\\": \\\"USD\\\"}\",\n      \"language\": \"http\",\n      \"name\": \"Init JSON Parameter\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.paystand.co/v3/plugins/paystand/checkout?k=bkba5nienlzbnb6ub2chmcsp&p.a=1.00&c=USD\",\n      \"language\": \"http\",\n      \"name\": \"Flattened Dot Notation Parameters\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Required Fields\",\n  \"body\": \"Whether using dot notation or a single init parameter, each Billing Portal URL must specify at a minimum publishableKey (k) and currency (c).  See [Init Object Reference](doc:checkout-init-object) and [Scheduled Payments](doc:checkout-scheduled-payments)  for details.\"\n}\n[/block]","hidden":false,"category":"5d56fccfb1b7fc00334d1920","link_url":"","title":"Introduction","type":"basic","updates":[],"user":"55dd080d0efd5821000d53b3","createdAt":"2016-05-06T00:16:44.844Z","excerpt":"The Billing Portal loads a prepopulated checkout from a simple URL","link_external":false,"order":0,"parentDoc":null,"sync_unique":"","__v":9,"githubsync":"","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Introduction

The Billing Portal loads a prepopulated checkout from a simple URL

The Billing Portal allows Merchant Customers to collect payment information from their Payer Customers using a hosted version of checkout. The Billing Portal's primary use cases are situations where the environment from which a payment, payment method or scheduled payment needs to be collected, is not an active website. Example use cases are payment or schedule buttons in an HTML email or PDF document. [block:callout] { "type": "success", "title": "Billing Portal Unified Resource Locator (URL)", "body": "The Billing Portal URL supports the same parameters as the checkout Init object described in [Init Object Reference](doc:checkout-init-object). These parameters can be passed along with the URL in 2 GET parameter formats:\n * 1 parameter called \"init\" with a **URL encoded json formatted** value (See: [Init JSON Parameter](doc:portal-init-json-parameter) \n * multiple single value parameters named using a [Flattened Dot Notation Parameters](doc:portal-flattened-dot-notation-parameters) representing the hierarchy inside the Init object." } [/block] [block:callout] { "type": "info", "title": "Billing Portal Base URL", "body": "The Base URL for loading the **Production** Billing Portal is https://api.paystand.com/v3/plugins/paystand/checkout" } [/block] [block:code] { "codes": [ { "code": "https://api.paystand.co/v3/plugins/paystand/checkout", "language": "http", "name": "Sandbox Base Url" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "https://api.paystand.co/v3/plugins/paystand/checkout?init={\"publishableKey\":\"bkba5nienlzbnb6ub2chmcsp\", \"payment\": {\"amount\": \"1.00\"}, \"currency\": \"USD\"}", "language": "http", "name": "Init JSON Parameter" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "https://api.paystand.co/v3/plugins/paystand/checkout?k=bkba5nienlzbnb6ub2chmcsp&p.a=1.00&c=USD", "language": "http", "name": "Flattened Dot Notation Parameters" } ], "sidebar": true } [/block] [block:callout] { "type": "danger", "title": "Required Fields", "body": "Whether using dot notation or a single init parameter, each Billing Portal URL must specify at a minimum publishableKey (k) and currency (c). See [Init Object Reference](doc:checkout-init-object) and [Scheduled Payments](doc:checkout-scheduled-payments) for details." } [/block]
The Billing Portal allows Merchant Customers to collect payment information from their Payer Customers using a hosted version of checkout. The Billing Portal's primary use cases are situations where the environment from which a payment, payment method or scheduled payment needs to be collected, is not an active website. Example use cases are payment or schedule buttons in an HTML email or PDF document. [block:callout] { "type": "success", "title": "Billing Portal Unified Resource Locator (URL)", "body": "The Billing Portal URL supports the same parameters as the checkout Init object described in [Init Object Reference](doc:checkout-init-object). These parameters can be passed along with the URL in 2 GET parameter formats:\n * 1 parameter called \"init\" with a **URL encoded json formatted** value (See: [Init JSON Parameter](doc:portal-init-json-parameter) \n * multiple single value parameters named using a [Flattened Dot Notation Parameters](doc:portal-flattened-dot-notation-parameters) representing the hierarchy inside the Init object." } [/block] [block:callout] { "type": "info", "title": "Billing Portal Base URL", "body": "The Base URL for loading the **Production** Billing Portal is https://api.paystand.com/v3/plugins/paystand/checkout" } [/block] [block:code] { "codes": [ { "code": "https://api.paystand.co/v3/plugins/paystand/checkout", "language": "http", "name": "Sandbox Base Url" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "https://api.paystand.co/v3/plugins/paystand/checkout?init={\"publishableKey\":\"bkba5nienlzbnb6ub2chmcsp\", \"payment\": {\"amount\": \"1.00\"}, \"currency\": \"USD\"}", "language": "http", "name": "Init JSON Parameter" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "https://api.paystand.co/v3/plugins/paystand/checkout?k=bkba5nienlzbnb6ub2chmcsp&p.a=1.00&c=USD", "language": "http", "name": "Flattened Dot Notation Parameters" } ], "sidebar": true } [/block] [block:callout] { "type": "danger", "title": "Required Fields", "body": "Whether using dot notation or a single init parameter, each Billing Portal URL must specify at a minimum publishableKey (k) and currency (c). See [Init Object Reference](doc:checkout-init-object) and [Scheduled Payments](doc:checkout-scheduled-payments) for details." } [/block]
{"_id":"5d56fccfb1b7fc00334d1975","body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"payment\\\" : {\\n    \\\"amount\\\" : 10.00\\n  },\\n  \\\"currency\\\" : \\\"USD\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Init JSON Parameter\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.paystand.co/v3/plugins/paystand/checkout?init={\\\"k\\\":\\\"0yqowfwfxb2vpnuv9ovpqvgt\\\",\\\"h\\\":\\\"https://checkout.paystand.co/v3/\\\",\\\"o\\\":\\\"https://api.paystand.co\\\",\\\"p\\\":{\\\"a\\\":\\\"5000.20\\\"},\\\"c\\\":\\\"USD\\\",\\\"m\\\":[\\\"echeck\\\", \\\"card\\\"],\\\"b\\\":{\\\"s\\\": \\\"41 Grandview St\\\",\\\"c\\\":\\\"Santa Cruz\\\",\\\"p\\\":\\\"95060\\\",\\\"d\\\":\\\"CA\\\",\\\"u\\\":\\\"USA\\\"},\\\"y\\\":{\\\"n\\\":\\\"Christina Chan\\\",\\\"e\\\":\\\"demo%2Bcchan@paystand.com\\\"},\\\"z\\\":{\\\"foo\\\":{\\\"bar\\\":\\\"quux\\\",\\\"baz\\\":\\\"norf\\\"}}}\\n\",\n      \"language\": \"http\",\n      \"name\": \"Payment\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.paystand.co/v3/plugins/paystand/checkout?init={\\\"k\\\":\\\"0yqowfwfxb2vpnuv9ovpqvgt\\\",\\\"h\\\":\\\"https://checkout.paystand.co/v3/\\\",\\\"o\\\":\\\"https://api.paystand.co\\\",\\\"c\\\":\\\"USD\\\",\\\"m\\\":[\\\"echeck\\\",\\\"card\\\"],\\\"b\\\":{\\\"s\\\":\\\"100 Bay St\\\",\\\"c\\\":\\\"Santa Cruz\\\",\\\"p\\\":\\\"95060\\\",\\\"d\\\":\\\"CA\\\",\\\"u\\\":\\\"USA\\\"},\\\"y\\\":{\\\"n\\\": \\\"Christina Chan\\\",\\\"e\\\":\\\"demo%2Bcchan@paystand.com\\\"},\\\"z\\\":{\\\"foo\\\":{\\\"bar\\\":\\\"quux\\\",\\\"baz\\\":\\\"norf\\\"}},\\\"r\\\":{\\\"n\\\":\\\"One year lease\\\",\\\"d\\\":\\\"120 Swift St. 12 Month Lease\\\",\\\"i\\\":[{\\\"n\\\":\\\"Monthly Rent\\\",\\\"d\\\":\\\"Rent of $1200 is due on the first of every month\\\",\\\"s\\\":{\\\"n\\\":\\\"Rent\\\",\\\"d\\\":\\\"Pay rent on the 1st of the month\\\",\\\"i\\\":\\\"month\\\",\\\"c\\\":\\\"1\\\",\\\"a\\\":\\\"start\\\",\\\"s\\\":\\\"2016-04-01T00:00\\\",\\\"t\\\":\\\"12\\\"},\\\"a\\\":\\\"1200.00\\\"},{\\\"n\\\":\\\"Application Fee\\\",\\\"d\\\":\\\"One time application fee of $150.00\\\",\\\"s\\\":{\\\"n\\\":\\\"Application Fee\\\",\\\"d\\\":\\\"Pay a one time non-refundable application fee\\\"},\\\"a\\\":\\\"150.00\\\"},{\\\"n\\\":\\\"Security Deposit\\\",\\\"d\\\":\\\"$2000 Refundable security deposit that can be used to cover damages\\\",\\\"s\\\":{\\\"n\\\":\\\"Deposit\\\",\\\"d\\\":\\\"Security deposit or the home\\\",\\\"s\\\":\\\"2016-04-01T00:00\\\"},\\\"a\\\":\\\"2000.00\\\"}]}}\\n\",\n      \"language\": \"http\",\n      \"name\": \"Scheduled Payment\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\nThe Billing Portal can be initialized by adding a parameter named \"init\" to the billing portal URL with a JSON formatted and URL encoded value representing a checkout [initialization object](doc:checkout-init-object).\n\nUsing a URL encoded, JSON formatted [initialization object](doc:checkout-init-object) in the URL is primarily useful when the object and URL are programmatically generated.\n\nAn example use case is an invoicing application which automatically generates the Billing Portal URL with an init parameter specifying the amount, currency, invoice number, customer, etc. and injects it in the emailed PDF invoice. JSON formatting and URL encoding an [initialization object](doc:checkout-init-object) in such an environment is typically very straightforward and concise.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"URL Encoding\",\n  \"body\": \"**All parameter values containing non-alphanumeric characters** passed in the URL need to be URL encoded regardless of which parameter format is being used.\"\n}\n[/block]","githubsync":"","isReference":false,"parentDoc":null,"type":"basic","user":"55dd080d0efd5821000d53b3","api":{"url":"","auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"link_external":false,"project":"55dd0853d2d97337001800e2","category":"5d56fccfb1b7fc00334d1920","createdAt":"2016-05-06T00:17:49.223Z","excerpt":"","order":1,"title":"Init JSON Parameter","updates":[],"__v":4,"hidden":false,"link_url":"","slug":"portal-init-json-parameter","sync_unique":"","version":"5d56fccfb1b7fc00334d1a04","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Init JSON Parameter


[block:code] { "codes": [ { "code": "{\n \"payment\" : {\n \"amount\" : 10.00\n },\n \"currency\" : \"USD\"\n}", "language": "json", "name": "Init JSON Parameter" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "https://api.paystand.co/v3/plugins/paystand/checkout?init={\"k\":\"0yqowfwfxb2vpnuv9ovpqvgt\",\"h\":\"https://checkout.paystand.co/v3/\",\"o\":\"https://api.paystand.co\",\"p\":{\"a\":\"5000.20\"},\"c\":\"USD\",\"m\":[\"echeck\", \"card\"],\"b\":{\"s\": \"41 Grandview St\",\"c\":\"Santa Cruz\",\"p\":\"95060\",\"d\":\"CA\",\"u\":\"USA\"},\"y\":{\"n\":\"Christina Chan\",\"e\":\"demo%2Bcchan@paystand.com\"},\"z\":{\"foo\":{\"bar\":\"quux\",\"baz\":\"norf\"}}}\n", "language": "http", "name": "Payment" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "https://api.paystand.co/v3/plugins/paystand/checkout?init={\"k\":\"0yqowfwfxb2vpnuv9ovpqvgt\",\"h\":\"https://checkout.paystand.co/v3/\",\"o\":\"https://api.paystand.co\",\"c\":\"USD\",\"m\":[\"echeck\",\"card\"],\"b\":{\"s\":\"100 Bay St\",\"c\":\"Santa Cruz\",\"p\":\"95060\",\"d\":\"CA\",\"u\":\"USA\"},\"y\":{\"n\": \"Christina Chan\",\"e\":\"demo%2Bcchan@paystand.com\"},\"z\":{\"foo\":{\"bar\":\"quux\",\"baz\":\"norf\"}},\"r\":{\"n\":\"One year lease\",\"d\":\"120 Swift St. 12 Month Lease\",\"i\":[{\"n\":\"Monthly Rent\",\"d\":\"Rent of $1200 is due on the first of every month\",\"s\":{\"n\":\"Rent\",\"d\":\"Pay rent on the 1st of the month\",\"i\":\"month\",\"c\":\"1\",\"a\":\"start\",\"s\":\"2016-04-01T00:00\",\"t\":\"12\"},\"a\":\"1200.00\"},{\"n\":\"Application Fee\",\"d\":\"One time application fee of $150.00\",\"s\":{\"n\":\"Application Fee\",\"d\":\"Pay a one time non-refundable application fee\"},\"a\":\"150.00\"},{\"n\":\"Security Deposit\",\"d\":\"$2000 Refundable security deposit that can be used to cover damages\",\"s\":{\"n\":\"Deposit\",\"d\":\"Security deposit or the home\",\"s\":\"2016-04-01T00:00\"},\"a\":\"2000.00\"}]}}\n", "language": "http", "name": "Scheduled Payment" } ], "sidebar": true } [/block] The Billing Portal can be initialized by adding a parameter named "init" to the billing portal URL with a JSON formatted and URL encoded value representing a checkout [initialization object](doc:checkout-init-object). Using a URL encoded, JSON formatted [initialization object](doc:checkout-init-object) in the URL is primarily useful when the object and URL are programmatically generated. An example use case is an invoicing application which automatically generates the Billing Portal URL with an init parameter specifying the amount, currency, invoice number, customer, etc. and injects it in the emailed PDF invoice. JSON formatting and URL encoding an [initialization object](doc:checkout-init-object) in such an environment is typically very straightforward and concise. [block:callout] { "type": "warning", "title": "URL Encoding", "body": "**All parameter values containing non-alphanumeric characters** passed in the URL need to be URL encoded regardless of which parameter format is being used." } [/block]
[block:code] { "codes": [ { "code": "{\n \"payment\" : {\n \"amount\" : 10.00\n },\n \"currency\" : \"USD\"\n}", "language": "json", "name": "Init JSON Parameter" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "https://api.paystand.co/v3/plugins/paystand/checkout?init={\"k\":\"0yqowfwfxb2vpnuv9ovpqvgt\",\"h\":\"https://checkout.paystand.co/v3/\",\"o\":\"https://api.paystand.co\",\"p\":{\"a\":\"5000.20\"},\"c\":\"USD\",\"m\":[\"echeck\", \"card\"],\"b\":{\"s\": \"41 Grandview St\",\"c\":\"Santa Cruz\",\"p\":\"95060\",\"d\":\"CA\",\"u\":\"USA\"},\"y\":{\"n\":\"Christina Chan\",\"e\":\"demo%2Bcchan@paystand.com\"},\"z\":{\"foo\":{\"bar\":\"quux\",\"baz\":\"norf\"}}}\n", "language": "http", "name": "Payment" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "https://api.paystand.co/v3/plugins/paystand/checkout?init={\"k\":\"0yqowfwfxb2vpnuv9ovpqvgt\",\"h\":\"https://checkout.paystand.co/v3/\",\"o\":\"https://api.paystand.co\",\"c\":\"USD\",\"m\":[\"echeck\",\"card\"],\"b\":{\"s\":\"100 Bay St\",\"c\":\"Santa Cruz\",\"p\":\"95060\",\"d\":\"CA\",\"u\":\"USA\"},\"y\":{\"n\": \"Christina Chan\",\"e\":\"demo%2Bcchan@paystand.com\"},\"z\":{\"foo\":{\"bar\":\"quux\",\"baz\":\"norf\"}},\"r\":{\"n\":\"One year lease\",\"d\":\"120 Swift St. 12 Month Lease\",\"i\":[{\"n\":\"Monthly Rent\",\"d\":\"Rent of $1200 is due on the first of every month\",\"s\":{\"n\":\"Rent\",\"d\":\"Pay rent on the 1st of the month\",\"i\":\"month\",\"c\":\"1\",\"a\":\"start\",\"s\":\"2016-04-01T00:00\",\"t\":\"12\"},\"a\":\"1200.00\"},{\"n\":\"Application Fee\",\"d\":\"One time application fee of $150.00\",\"s\":{\"n\":\"Application Fee\",\"d\":\"Pay a one time non-refundable application fee\"},\"a\":\"150.00\"},{\"n\":\"Security Deposit\",\"d\":\"$2000 Refundable security deposit that can be used to cover damages\",\"s\":{\"n\":\"Deposit\",\"d\":\"Security deposit or the home\",\"s\":\"2016-04-01T00:00\"},\"a\":\"2000.00\"}]}}\n", "language": "http", "name": "Scheduled Payment" } ], "sidebar": true } [/block] The Billing Portal can be initialized by adding a parameter named "init" to the billing portal URL with a JSON formatted and URL encoded value representing a checkout [initialization object](doc:checkout-init-object). Using a URL encoded, JSON formatted [initialization object](doc:checkout-init-object) in the URL is primarily useful when the object and URL are programmatically generated. An example use case is an invoicing application which automatically generates the Billing Portal URL with an init parameter specifying the amount, currency, invoice number, customer, etc. and injects it in the emailed PDF invoice. JSON formatting and URL encoding an [initialization object](doc:checkout-init-object) in such an environment is typically very straightforward and concise. [block:callout] { "type": "warning", "title": "URL Encoding", "body": "**All parameter values containing non-alphanumeric characters** passed in the URL need to be URL encoded regardless of which parameter format is being used." } [/block]
{"_id":"5d56fccfb1b7fc00334d1976","project":"55dd0853d2d97337001800e2","sync_unique":"","type":"basic","api":{"auth":"required","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"hidden":false,"parentDoc":null,"link_external":false,"slug":"portal-flattened-dot-notation-parameters","body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"payment.amount=10.00&currency=USD\",\n      \"language\": \"text\",\n      \"name\": \"Dot Notation Parameters\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.paystand.co/v3/plugins/paystand/checkout?k=0yqowfwfxb2vpnuv9ovpqvgt&t=classic&l=desktop&p.a=10.24&c=USD&b.s=41 Grandview St&b.c=Santa Cruz&b.p=95060&b.d=CA&b.u=USA&y.n=Christina Chan&y.e=demo%2Bcchan@paystand.com&z.foo.bar=quux&z.foo.baz=norf&m.0=echeck&m.1=card\",\n      \"language\": \"http\",\n      \"name\": \"Payment\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.paystand.co/v3/plugins/paystand/checkout?k=5xscm967dw77l5yhl641eqp9&c=USD&m.0=echeck&m.1=card&b.s=100 Bay St&b.c=Santa Cruz&b.p=95060&b.d=CA&b.u=USA&y.n=Christina Chan&y.e=demo%2Bcchan@paystand.com&z.foo.bar=quux&z.foo.baz=norf&r.n=One year lease&r.d=120 Swift St. 12 Month Lease&r.i.0.n=Monthly Rent&r.i.0.d=Rent of $1200 is due on the first of every month&r.i.0.s.n=Rent&r.i.0.s.d=Pay rent on the 1st of the month&r.i.0.s.i=month&r.i.0.s.c=1&r.i.0.s.a=start&r.i.0.s.s=2016-04-01T00:00&r.i.0.s.t=12&r.i.0.a=1200.00&r.i.1.n=Application Fee&r.i.1.d=One time application fee of $150.00&r.i.1.s.n=Application Fee&r.i.1.s.d=Pay a one time non-refundable application fee&r.i.1.a=150.00&r.i.2.n=Security Deposit&r.i.2.d=$2000 Refundable security deposit that can be used to cover damages&r.i.2.s.n=Deposit&r.i.2.s.d=Security deposit or the home&r.i.2.s.s=2016-04-01T00:00&r.i.2.a=2000.00\\n\",\n      \"language\": \"http\",\n      \"name\": \"Scheduled Payment\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\nFor use cases where the URL encoded, JSON formatted init parameter does not work well, the Billing Portal can alternatively be initialized by adding parameters to the URL. For each value in the init object that needs to be set, a URL parameter is added and named using the flattened dot-notation format.\n[flat\n\nThe Flattened Dot Notation Parameters is a concatenation of all the names for each level of the hierarchical object structure separated by a dot starting with the root all the way down to the targeted property.\n\nFor example, the payment amount of $100 can be specified by adding \"?payment.amount=100&currency=USD\" to the base url.\n\nWhen the init object includes an array, such as the array of scheduled items for a scheduled payment, each item in the array should be specified separately using the numerical index.  For example, r.i.0.n=Item One Name&r.i.0.d=Item One Description&r.i.1.n=Item Two Name&r.i.1.d=Item Two Description.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Shorthand using abbrevations\",\n  \"body\": \"Both Billing Portal initialization methods support the same parameter name abbreviations as checkout. This is especially important given that the total URL length is limited to 4 Kbyte and can get quickly inflated when metadata or a complex scheduled payment is added.\"\n}\n[/block]","createdAt":"2016-05-06T00:18:39.633Z","githubsync":"","title":"Flattened Dot Notation Parameters","user":"55dd080d0efd5821000d53b3","excerpt":"","isReference":false,"link_url":"","order":2,"updates":[],"__v":2,"category":"5d56fccfb1b7fc00334d1920","version":"5d56fccfb1b7fc00334d1a04","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Flattened Dot Notation Parameters


[block:code] { "codes": [ { "code": "payment.amount=10.00&currency=USD", "language": "text", "name": "Dot Notation Parameters" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "https://api.paystand.co/v3/plugins/paystand/checkout?k=0yqowfwfxb2vpnuv9ovpqvgt&t=classic&l=desktop&p.a=10.24&c=USD&b.s=41 Grandview St&b.c=Santa Cruz&b.p=95060&b.d=CA&b.u=USA&y.n=Christina Chan&y.e=demo%2Bcchan@paystand.com&z.foo.bar=quux&z.foo.baz=norf&m.0=echeck&m.1=card", "language": "http", "name": "Payment" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "https://api.paystand.co/v3/plugins/paystand/checkout?k=5xscm967dw77l5yhl641eqp9&c=USD&m.0=echeck&m.1=card&b.s=100 Bay St&b.c=Santa Cruz&b.p=95060&b.d=CA&b.u=USA&y.n=Christina Chan&y.e=demo%2Bcchan@paystand.com&z.foo.bar=quux&z.foo.baz=norf&r.n=One year lease&r.d=120 Swift St. 12 Month Lease&r.i.0.n=Monthly Rent&r.i.0.d=Rent of $1200 is due on the first of every month&r.i.0.s.n=Rent&r.i.0.s.d=Pay rent on the 1st of the month&r.i.0.s.i=month&r.i.0.s.c=1&r.i.0.s.a=start&r.i.0.s.s=2016-04-01T00:00&r.i.0.s.t=12&r.i.0.a=1200.00&r.i.1.n=Application Fee&r.i.1.d=One time application fee of $150.00&r.i.1.s.n=Application Fee&r.i.1.s.d=Pay a one time non-refundable application fee&r.i.1.a=150.00&r.i.2.n=Security Deposit&r.i.2.d=$2000 Refundable security deposit that can be used to cover damages&r.i.2.s.n=Deposit&r.i.2.s.d=Security deposit or the home&r.i.2.s.s=2016-04-01T00:00&r.i.2.a=2000.00\n", "language": "http", "name": "Scheduled Payment" } ], "sidebar": true } [/block] For use cases where the URL encoded, JSON formatted init parameter does not work well, the Billing Portal can alternatively be initialized by adding parameters to the URL. For each value in the init object that needs to be set, a URL parameter is added and named using the flattened dot-notation format. [flat The Flattened Dot Notation Parameters is a concatenation of all the names for each level of the hierarchical object structure separated by a dot starting with the root all the way down to the targeted property. For example, the payment amount of $100 can be specified by adding "?payment.amount=100&currency=USD" to the base url. When the init object includes an array, such as the array of scheduled items for a scheduled payment, each item in the array should be specified separately using the numerical index. For example, r.i.0.n=Item One Name&r.i.0.d=Item One Description&r.i.1.n=Item Two Name&r.i.1.d=Item Two Description. [block:callout] { "type": "info", "title": "Shorthand using abbrevations", "body": "Both Billing Portal initialization methods support the same parameter name abbreviations as checkout. This is especially important given that the total URL length is limited to 4 Kbyte and can get quickly inflated when metadata or a complex scheduled payment is added." } [/block]
[block:code] { "codes": [ { "code": "payment.amount=10.00&currency=USD", "language": "text", "name": "Dot Notation Parameters" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "https://api.paystand.co/v3/plugins/paystand/checkout?k=0yqowfwfxb2vpnuv9ovpqvgt&t=classic&l=desktop&p.a=10.24&c=USD&b.s=41 Grandview St&b.c=Santa Cruz&b.p=95060&b.d=CA&b.u=USA&y.n=Christina Chan&y.e=demo%2Bcchan@paystand.com&z.foo.bar=quux&z.foo.baz=norf&m.0=echeck&m.1=card", "language": "http", "name": "Payment" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "https://api.paystand.co/v3/plugins/paystand/checkout?k=5xscm967dw77l5yhl641eqp9&c=USD&m.0=echeck&m.1=card&b.s=100 Bay St&b.c=Santa Cruz&b.p=95060&b.d=CA&b.u=USA&y.n=Christina Chan&y.e=demo%2Bcchan@paystand.com&z.foo.bar=quux&z.foo.baz=norf&r.n=One year lease&r.d=120 Swift St. 12 Month Lease&r.i.0.n=Monthly Rent&r.i.0.d=Rent of $1200 is due on the first of every month&r.i.0.s.n=Rent&r.i.0.s.d=Pay rent on the 1st of the month&r.i.0.s.i=month&r.i.0.s.c=1&r.i.0.s.a=start&r.i.0.s.s=2016-04-01T00:00&r.i.0.s.t=12&r.i.0.a=1200.00&r.i.1.n=Application Fee&r.i.1.d=One time application fee of $150.00&r.i.1.s.n=Application Fee&r.i.1.s.d=Pay a one time non-refundable application fee&r.i.1.a=150.00&r.i.2.n=Security Deposit&r.i.2.d=$2000 Refundable security deposit that can be used to cover damages&r.i.2.s.n=Deposit&r.i.2.s.d=Security deposit or the home&r.i.2.s.s=2016-04-01T00:00&r.i.2.a=2000.00\n", "language": "http", "name": "Scheduled Payment" } ], "sidebar": true } [/block] For use cases where the URL encoded, JSON formatted init parameter does not work well, the Billing Portal can alternatively be initialized by adding parameters to the URL. For each value in the init object that needs to be set, a URL parameter is added and named using the flattened dot-notation format. [flat The Flattened Dot Notation Parameters is a concatenation of all the names for each level of the hierarchical object structure separated by a dot starting with the root all the way down to the targeted property. For example, the payment amount of $100 can be specified by adding "?payment.amount=100&currency=USD" to the base url. When the init object includes an array, such as the array of scheduled items for a scheduled payment, each item in the array should be specified separately using the numerical index. For example, r.i.0.n=Item One Name&r.i.0.d=Item One Description&r.i.1.n=Item Two Name&r.i.1.d=Item Two Description. [block:callout] { "type": "info", "title": "Shorthand using abbrevations", "body": "Both Billing Portal initialization methods support the same parameter name abbreviations as checkout. This is especially important given that the total URL length is limited to 4 Kbyte and can get quickly inflated when metadata or a complex scheduled payment is added." } [/block]
{"_id":"5d56fccfb1b7fc00334d1977","api":{"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"","auth":"required"},"body":"# Simple Link\n[block:html]\n{\n  \"html\": \"<a href='https://api.paystand.co/v3/plugins/paystand/checkout?data={\\\"publishableKey\\\":\\\"eml9jvz7dsbglwtx53xtu9tl\\\",\\\"amount\\\":5.55,\\\"currency\\\":\\\"usd\\\"}'>This is an email link to pay your bill</a>\\n\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<a href='https://api.paystand.co/v3/plugins/paystand/checkout?data={\\\"publishableKey\\\":\\\"eml9jvz7dsbglwtx53xtu9tl\\\",\\\"amount\\\":5.55,\\\"currency\\\":\\\"usd\\\"}'>\\n  This is an email link to pay your bill\\n</a>\",\n      \"language\": \"html\",\n      \"name\": \"\"\n    }\n  ]\n}\n[/block]\n# Pay Now by PayStand Button\n[block:html]\n{\n  \"html\": \"<a href='https://api.paystand.co/v3/plugins/paystand/checkout?data={\\\"publishableKey\\\":\\\"eml9jvz7dsbglwtx53xtu9tl\\\",\\\"amount\\\":12.12,\\\"currency\\\":\\\"usd\\\"}'><div style=\\\"background-image: url(https://dashboard.paystand.co/v2/images/integrations/ps-paynow.png); height: 100px; width: 200px; background-position:center;);\\\"></div></a>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<a href='https://api.paystand.co/v3/plugins/paystand/checkout?data={\\\"publishableKey\\\":\\\"eml9jvz7dsbglwtx53xtu9tl\\\",\\\"amount\\\":12.12,\\\"currency\\\":\\\"usd\\\"}'>\\n\\t<div style=\\\"background-image: url(https://dashboard.paystand.co/v2/images/integrations/ps-paynow.png); height: 100px; width: 200px; background-position:center;);\\\"></div>\\n</a>\",\n      \"language\": \"html\"\n    }\n  ]\n}\n[/block]\n# Custom Button\n[block:html]\n{\n  \"html\": \"<style>\\n.btn {\\n  background: #6fc3fc;\\n  background-image: -webkit-linear-gradient(top, #6fc3fc, #1b79b3);\\n  background-image: -moz-linear-gradient(top, #6fc3fc, #1b79b3);\\n  background-image: -ms-linear-gradient(top, #6fc3fc, #1b79b3);\\n  background-image: -o-linear-gradient(top, #6fc3fc, #1b79b3);\\n  background-image: linear-gradient(to bottom, #6fc3fc, #1b79b3);\\n  -webkit-border-radius: 16;\\n  -moz-border-radius: 16;\\n  border-radius: 16px;\\n  text-shadow: 1px 1px 3px #666666;\\n  font-family: Arial;\\n  color: #ffffff !important;;\\n  font-size: 35px;\\n  padding: 10px 20px 10px 20px;\\n  text-decoration: none;\\n}\\n\\n.btn:hover {\\n  background: #2a76a6;\\n  background-image: -webkit-linear-gradient(top, #2a76a6, #3498db);\\n  background-image: -moz-linear-gradient(top, #2a76a6, #3498db);\\n  background-image: -ms-linear-gradient(top, #2a76a6, #3498db);\\n  background-image: -o-linear-gradient(top, #2a76a6, #3498db);\\n  background-image: linear-gradient(to bottom, #2a76a6, #3498db);\\n  text-decoration: none;\\n}\\n</style>\\n<a class=\\\"btn\\\" href='https://api.paystand.co/v3/plugins/paystand/checkout?data={\\\"publishableKey\\\":\\\"eml9jvz7dsbglwtx53xtu9tl\\\",\\\"amount\\\":23.23,\\\"currency\\\":\\\"usd\\\"}'>Pay $23.23</a>\\n\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<style>\\n.btn {\\n  background: #6fc3fc;\\n  background-image: -webkit-linear-gradient(top, #6fc3fc, #1b79b3);\\n  background-image: -moz-linear-gradient(top, #6fc3fc, #1b79b3);\\n  background-image: -ms-linear-gradient(top, #6fc3fc, #1b79b3);\\n  background-image: -o-linear-gradient(top, #6fc3fc, #1b79b3);\\n  background-image: linear-gradient(to bottom, #6fc3fc, #1b79b3);\\n  -webkit-border-radius: 16;\\n  -moz-border-radius: 16;\\n  border-radius: 16px;\\n  text-shadow: 1px 1px 3px #666666;\\n  font-family: Arial;\\n  color: #ffffff;\\n  font-size: 35px;\\n  padding: 10px 20px 10px 20px;\\n  text-decoration: none;\\n}\\n\\n.btn:hover {\\n  background: #2a76a6;\\n  background-image: -webkit-linear-gradient(top, #2a76a6, #3498db);\\n  background-image: -moz-linear-gradient(top, #2a76a6, #3498db);\\n  background-image: -ms-linear-gradient(top, #2a76a6, #3498db);\\n  background-image: -o-linear-gradient(top, #2a76a6, #3498db);\\n  background-image: linear-gradient(to bottom, #2a76a6, #3498db);\\n  text-decoration: none;\\n}\\n</style>\\n<a class=\\\"btn\\\" href='https://api.paystand.co/v3/plugins/paystand/checkout?data={\\\"publishableKey\\\":\\\"eml9jvz7dsbglwtx53xtu9tl\\\",\\\"amount\\\":23.23,\\\"currency\\\":\\\"usd\\\"}'>\\n  Pay $23.23\\n</a>\\n\",\n      \"language\": \"html\"\n    }\n  ]\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"# Try it yourself on Codepen\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:embed]\n{\n  \"html\": \"<iframe height='350' scrolling='no' src='http://codepen.io/paystand/embed/aNvXzr' frameborder='no' allowtransparency='true' allowfullscreen='true' style='width: 100%;'></iframe>\",\n  \"url\": \"http://codepen.io/paystand/pen/aNvXzr\",\n  \"title\": \"Checkout 2 Email Link and Buttons (No JavaScript)\",\n  \"favicon\": \"http://codepen.io/favicon.ico\",\n  \"image\": \"https://s3-us-west-2.amazonaws.com/i.cdpn.io/524447.aNvXzr.small.d7b46d9f-6766-4ff7-ad54-de708a8550aa.png\",\n  \"sidebar\": true\n}\n[/block]","category":"5d56fccfb1b7fc00334d1920","hidden":false,"isReference":false,"link_external":false,"__v":3,"title":"Usage Examples","type":"basic","updates":[],"link_url":"","excerpt":"","parentDoc":null,"sync_unique":"","createdAt":"2016-05-06T21:19:18.915Z","user":"55dd080d0efd5821000d53b3","githubsync":"","project":"55dd0853d2d97337001800e2","slug":"portal-usage-examples","version":"5d56fccfb1b7fc00334d1a04","order":3,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Usage Examples


# Simple Link [block:html] { "html": "<a href='https://api.paystand.co/v3/plugins/paystand/checkout?data={\"publishableKey\":\"eml9jvz7dsbglwtx53xtu9tl\",\"amount\":5.55,\"currency\":\"usd\"}'>This is an email link to pay your bill</a>\n" } [/block] [block:code] { "codes": [ { "code": "<a href='https://api.paystand.co/v3/plugins/paystand/checkout?data={\"publishableKey\":\"eml9jvz7dsbglwtx53xtu9tl\",\"amount\":5.55,\"currency\":\"usd\"}'>\n This is an email link to pay your bill\n</a>", "language": "html", "name": "" } ] } [/block] # Pay Now by PayStand Button [block:html] { "html": "<a href='https://api.paystand.co/v3/plugins/paystand/checkout?data={\"publishableKey\":\"eml9jvz7dsbglwtx53xtu9tl\",\"amount\":12.12,\"currency\":\"usd\"}'><div style=\"background-image: url(https://dashboard.paystand.co/v2/images/integrations/ps-paynow.png); height: 100px; width: 200px; background-position:center;);\"></div></a>" } [/block] [block:code] { "codes": [ { "code": "<a href='https://api.paystand.co/v3/plugins/paystand/checkout?data={\"publishableKey\":\"eml9jvz7dsbglwtx53xtu9tl\",\"amount\":12.12,\"currency\":\"usd\"}'>\n\t<div style=\"background-image: url(https://dashboard.paystand.co/v2/images/integrations/ps-paynow.png); height: 100px; width: 200px; background-position:center;);\"></div>\n</a>", "language": "html" } ] } [/block] # Custom Button [block:html] { "html": "<style>\n.btn {\n background: #6fc3fc;\n background-image: -webkit-linear-gradient(top, #6fc3fc, #1b79b3);\n background-image: -moz-linear-gradient(top, #6fc3fc, #1b79b3);\n background-image: -ms-linear-gradient(top, #6fc3fc, #1b79b3);\n background-image: -o-linear-gradient(top, #6fc3fc, #1b79b3);\n background-image: linear-gradient(to bottom, #6fc3fc, #1b79b3);\n -webkit-border-radius: 16;\n -moz-border-radius: 16;\n border-radius: 16px;\n text-shadow: 1px 1px 3px #666666;\n font-family: Arial;\n color: #ffffff !important;;\n font-size: 35px;\n padding: 10px 20px 10px 20px;\n text-decoration: none;\n}\n\n.btn:hover {\n background: #2a76a6;\n background-image: -webkit-linear-gradient(top, #2a76a6, #3498db);\n background-image: -moz-linear-gradient(top, #2a76a6, #3498db);\n background-image: -ms-linear-gradient(top, #2a76a6, #3498db);\n background-image: -o-linear-gradient(top, #2a76a6, #3498db);\n background-image: linear-gradient(to bottom, #2a76a6, #3498db);\n text-decoration: none;\n}\n</style>\n<a class=\"btn\" href='https://api.paystand.co/v3/plugins/paystand/checkout?data={\"publishableKey\":\"eml9jvz7dsbglwtx53xtu9tl\",\"amount\":23.23,\"currency\":\"usd\"}'>Pay $23.23</a>\n" } [/block] [block:code] { "codes": [ { "code": "<style>\n.btn {\n background: #6fc3fc;\n background-image: -webkit-linear-gradient(top, #6fc3fc, #1b79b3);\n background-image: -moz-linear-gradient(top, #6fc3fc, #1b79b3);\n background-image: -ms-linear-gradient(top, #6fc3fc, #1b79b3);\n background-image: -o-linear-gradient(top, #6fc3fc, #1b79b3);\n background-image: linear-gradient(to bottom, #6fc3fc, #1b79b3);\n -webkit-border-radius: 16;\n -moz-border-radius: 16;\n border-radius: 16px;\n text-shadow: 1px 1px 3px #666666;\n font-family: Arial;\n color: #ffffff;\n font-size: 35px;\n padding: 10px 20px 10px 20px;\n text-decoration: none;\n}\n\n.btn:hover {\n background: #2a76a6;\n background-image: -webkit-linear-gradient(top, #2a76a6, #3498db);\n background-image: -moz-linear-gradient(top, #2a76a6, #3498db);\n background-image: -ms-linear-gradient(top, #2a76a6, #3498db);\n background-image: -o-linear-gradient(top, #2a76a6, #3498db);\n background-image: linear-gradient(to bottom, #2a76a6, #3498db);\n text-decoration: none;\n}\n</style>\n<a class=\"btn\" href='https://api.paystand.co/v3/plugins/paystand/checkout?data={\"publishableKey\":\"eml9jvz7dsbglwtx53xtu9tl\",\"amount\":23.23,\"currency\":\"usd\"}'>\n Pay $23.23\n</a>\n", "language": "html" } ] } [/block] [block:textarea] { "text": "# Try it yourself on Codepen", "sidebar": true } [/block] [block:embed] { "html": "<iframe height='350' scrolling='no' src='http://codepen.io/paystand/embed/aNvXzr' frameborder='no' allowtransparency='true' allowfullscreen='true' style='width: 100%;'></iframe>", "url": "http://codepen.io/paystand/pen/aNvXzr", "title": "Checkout 2 Email Link and Buttons (No JavaScript)", "favicon": "http://codepen.io/favicon.ico", "image": "https://s3-us-west-2.amazonaws.com/i.cdpn.io/524447.aNvXzr.small.d7b46d9f-6766-4ff7-ad54-de708a8550aa.png", "sidebar": true } [/block]
# Simple Link [block:html] { "html": "<a href='https://api.paystand.co/v3/plugins/paystand/checkout?data={\"publishableKey\":\"eml9jvz7dsbglwtx53xtu9tl\",\"amount\":5.55,\"currency\":\"usd\"}'>This is an email link to pay your bill</a>\n" } [/block] [block:code] { "codes": [ { "code": "<a href='https://api.paystand.co/v3/plugins/paystand/checkout?data={\"publishableKey\":\"eml9jvz7dsbglwtx53xtu9tl\",\"amount\":5.55,\"currency\":\"usd\"}'>\n This is an email link to pay your bill\n</a>", "language": "html", "name": "" } ] } [/block] # Pay Now by PayStand Button [block:html] { "html": "<a href='https://api.paystand.co/v3/plugins/paystand/checkout?data={\"publishableKey\":\"eml9jvz7dsbglwtx53xtu9tl\",\"amount\":12.12,\"currency\":\"usd\"}'><div style=\"background-image: url(https://dashboard.paystand.co/v2/images/integrations/ps-paynow.png); height: 100px; width: 200px; background-position:center;);\"></div></a>" } [/block] [block:code] { "codes": [ { "code": "<a href='https://api.paystand.co/v3/plugins/paystand/checkout?data={\"publishableKey\":\"eml9jvz7dsbglwtx53xtu9tl\",\"amount\":12.12,\"currency\":\"usd\"}'>\n\t<div style=\"background-image: url(https://dashboard.paystand.co/v2/images/integrations/ps-paynow.png); height: 100px; width: 200px; background-position:center;);\"></div>\n</a>", "language": "html" } ] } [/block] # Custom Button [block:html] { "html": "<style>\n.btn {\n background: #6fc3fc;\n background-image: -webkit-linear-gradient(top, #6fc3fc, #1b79b3);\n background-image: -moz-linear-gradient(top, #6fc3fc, #1b79b3);\n background-image: -ms-linear-gradient(top, #6fc3fc, #1b79b3);\n background-image: -o-linear-gradient(top, #6fc3fc, #1b79b3);\n background-image: linear-gradient(to bottom, #6fc3fc, #1b79b3);\n -webkit-border-radius: 16;\n -moz-border-radius: 16;\n border-radius: 16px;\n text-shadow: 1px 1px 3px #666666;\n font-family: Arial;\n color: #ffffff !important;;\n font-size: 35px;\n padding: 10px 20px 10px 20px;\n text-decoration: none;\n}\n\n.btn:hover {\n background: #2a76a6;\n background-image: -webkit-linear-gradient(top, #2a76a6, #3498db);\n background-image: -moz-linear-gradient(top, #2a76a6, #3498db);\n background-image: -ms-linear-gradient(top, #2a76a6, #3498db);\n background-image: -o-linear-gradient(top, #2a76a6, #3498db);\n background-image: linear-gradient(to bottom, #2a76a6, #3498db);\n text-decoration: none;\n}\n</style>\n<a class=\"btn\" href='https://api.paystand.co/v3/plugins/paystand/checkout?data={\"publishableKey\":\"eml9jvz7dsbglwtx53xtu9tl\",\"amount\":23.23,\"currency\":\"usd\"}'>Pay $23.23</a>\n" } [/block] [block:code] { "codes": [ { "code": "<style>\n.btn {\n background: #6fc3fc;\n background-image: -webkit-linear-gradient(top, #6fc3fc, #1b79b3);\n background-image: -moz-linear-gradient(top, #6fc3fc, #1b79b3);\n background-image: -ms-linear-gradient(top, #6fc3fc, #1b79b3);\n background-image: -o-linear-gradient(top, #6fc3fc, #1b79b3);\n background-image: linear-gradient(to bottom, #6fc3fc, #1b79b3);\n -webkit-border-radius: 16;\n -moz-border-radius: 16;\n border-radius: 16px;\n text-shadow: 1px 1px 3px #666666;\n font-family: Arial;\n color: #ffffff;\n font-size: 35px;\n padding: 10px 20px 10px 20px;\n text-decoration: none;\n}\n\n.btn:hover {\n background: #2a76a6;\n background-image: -webkit-linear-gradient(top, #2a76a6, #3498db);\n background-image: -moz-linear-gradient(top, #2a76a6, #3498db);\n background-image: -ms-linear-gradient(top, #2a76a6, #3498db);\n background-image: -o-linear-gradient(top, #2a76a6, #3498db);\n background-image: linear-gradient(to bottom, #2a76a6, #3498db);\n text-decoration: none;\n}\n</style>\n<a class=\"btn\" href='https://api.paystand.co/v3/plugins/paystand/checkout?data={\"publishableKey\":\"eml9jvz7dsbglwtx53xtu9tl\",\"amount\":23.23,\"currency\":\"usd\"}'>\n Pay $23.23\n</a>\n", "language": "html" } ] } [/block] [block:textarea] { "text": "# Try it yourself on Codepen", "sidebar": true } [/block] [block:embed] { "html": "<iframe height='350' scrolling='no' src='http://codepen.io/paystand/embed/aNvXzr' frameborder='no' allowtransparency='true' allowfullscreen='true' style='width: 100%;'></iframe>", "url": "http://codepen.io/paystand/pen/aNvXzr", "title": "Checkout 2 Email Link and Buttons (No JavaScript)", "favicon": "http://codepen.io/favicon.ico", "image": "https://s3-us-west-2.amazonaws.com/i.cdpn.io/524447.aNvXzr.small.d7b46d9f-6766-4ff7-ad54-de708a8550aa.png", "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d1979","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d191f","user":"55dd080d0efd5821000d53b3","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-02T23:05:08.236Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"PayStand Checkout is a JavaScript library which provides an easy way for PayStand merchant customers to collect payment information and initiate a payment or scheduled payment in a PCI-DSS compliant way.\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"PayStand Checkout facilitates 3 operational modes:\",\n  \"body\": \"1. **Payment** (Direct) - [Direct Payment Demo](https://checkout.paystand.co/v4/demo/payment.html)\\n2. **Scheduled Payment** - [Scheduled Payment Demo](https://checkout.paystand.co/v4/demo/scheduled-payment.html)\\n3. **Save Card or Bank** -  [Save Card or Bank Demo](https://checkout.paystand.co/v4/demo/tokenize.html)\"\n}\n[/block]\nIn (Direct) **Payment mode**, PayStand checkout allows the user to instantly pay a defined amount of money to merchant customer.\n\nThe **Scheduled Payment mode** enables the user to initiate a pre-defined set of scheduled payments with the merchant customer.\n\nLastly in the **Save Card or Bank mode**, the payment method (card or bank) will be tokenized and saved for future use by the merchant's or platform provider's system.\n\n## Checkout Environments\n\nCheckout operates in ```live``` mode or in ```sandbox``` mode. Attributes such as ```vanityName``` and ```publishableKey``` are often environment specific and often need to be changes when switching from one environment to another.\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Checkout modes\",\n  \"body\": \"1. **Live** - In live mode, all api requests will be made against the **production environment**.\\n2. **Sandbox** - In sandbox mode, all api request will be made against the **test environment**. You can use this environment to test your integrations code.\"\n}\n[/block]\n## Checkout Urls\n\nYou can access various checkout experiences directly via url. Urls can be used directly in a browser or used in an iframe to create an embedded experience.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Billing Portal\",\n  \"body\": \"When checkout is directly used in a browser using its URL, it is called a Billing Portal or for short a _**Portal**_. The use case for this type of checkout usage is typically to integrate checkout with environments that do not allow JavaScript code execution but do support URL references such as Emails, Invoices, etc.\\n\\nTo facilitate this type of usage PayStand provides a couple of useful features which can also be leveraged in non-portal checkout environments:\\n### Vanity Names\\nA Vanity Name is a unique, **human readable identification** that can take the place of a cryptic customer identifier such as the publishable key.\\n### Portal URL format\\nThe portal URL format is a **shorter and more pleasing** URL format which can be used when people see the checkout or portal URL, or when the length of the URL needs to be limited.\\n### View Portal\\nWhen the View Portal setting is active in the checkout configuration, checkout will render additional contextual HTML elements such as a separate header to **improve full page rendering**.\\n### Presets\\nPresets are pre-defined checkout configurations that can be used instead of, or in conjunction with a detailed checkout configuration.\\n\\nThis is in particularly useful when using a **direct URL for portal** purposes as checkout configurations through URL parameters can become complicated or impossible in hurry.\\n\\nPresets are configured via the merchant customer's dashboard or via the REST API.\\n\\nBesides their usage in direct Portal URls, presets can be also be used in button URLs, auto loading, or in the checkout API.\\n\\nNote: _Each merchant customer also has a **Default Preset** which can be configure through the dashboard and which will be loaded by default if no other preset has been specified._\"\n}\n[/block]\n### Url formats\n\nCheckouts can be accessed by using any of the following url formats:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://checkout.paystand.{envDomain}/v4/?publishableKey={publishableKey}\\nhttps://checkout.paystand.{envDomain}/v4/?vanity={vanityName}\",\n      \"language\": \"css\",\n      \"name\": \"Checkout URL formats\"\n    },\n    {\n      \"code\": \"https://{vanityName}-portal.paystand.{envDomain}\\nhttps://{publishableKey}-portal.paystand.{envDomain}\",\n      \"language\": \"css\",\n      \"name\": \"Portal URL Format\"\n    }\n  ]\n}\n[/block]\nThe ```envDomain``` for the ```live``` environment is ```com``` and for ```sandbox``` its ```co```.\n\n\n### Configure via presets\n\nTo access a particular checkout preset (defined below) you can use the following formats:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://checkout.paystand.{envDomain}/v4/?vanity={vanityName}&checkoutType={presetKey}\",\n      \"language\": \"css\",\n      \"name\": \"Checkout URL with Preset\"\n    },\n    {\n      \"code\": \"https://{vanityName}-portal.paystand.{envDomain}/{presetKey}\",\n      \"language\": \"css\",\n      \"name\": \"Portal URL with Preset\"\n    }\n  ]\n}\n[/block]\nIf no preset is given, then the ```default``` preset will be used. If you have not configured a ```default``` preset yet, a default payment checkout will be used.\n\n### Configure via url arguments\n\nAdditional url arguments allow further configuration of Checkout. Any valid checkout attribute or checkout abbreviation can be used as an url argument (see the associated reference sections for a list of available attributes and abbreviations).\n\nIf a preset is used, url arguments will override the specific preset values, leaving the rest of the preset settings as is.\n\n## API\n\nUrls are very flexible when it comes to customizing the checkout experience on your webpage but are not suitable when there is a need for custom business logic. This means that you can't listen to checkout events, react to a checkout completing, or interact with the checkout in anyway once it has been rendered.\n\nTo use the checkout API, you can use checkout buttons, autoloading, or you can use the checkout api directly for maximum control of the checkout experience.\n\n## Buttons\n\nCheckouts can be configured per button. When a user clicks on a button, the settings on the button are used (just as arguments in the urls above) to create a unique checkout experience. All buttons interact with the checkout api allowing you to listen to checkout events, react to status changes, and update checkout settings.\n\nButtons can render checkouts in two different modes:\n\n### Modals\n\nModals display a checkout that overlays the content of a webpage, focusing the user on the checkout experience.\n\n### Embeds\n\nEmbeds display a checkout in the flow of a webpage instead of overlaying the content. This can be useful if you want the user to interact with your website at the same time that the checkout is displayed.\n\n## Autoloading\n\nCheckouts can be auto loaded once a web page loads. This can be useful if you want to have checkout embedded on your page without the user interacting with a button first. Checkout can only auto load once instance of a checkout.\n\nCheckouts rendered via auto loading interact with the checkout api just as buttons do.\n\n## API\n\nCheckout has a javascript api that interacts with checkout instances in various ways. The api can listen for checkout events, listen for checkout status changes, update the mode/dimensions for checkout, reboot, and live update checkout. See the API example and API reference section for further details.\n\n## Checkout instance\n\nWhen using checkout using a url directly, the checkout instance is considered to be the webpage that renders directly. When using buttons, auto loading, or the API, the checkout instance is the iframe or window that displays the checkout experience.\n\nCheckout limits each page to only one checkout instance. If, for example, you have multiple buttons on a web page, then each button will render a checkout in the same checkout instance.","excerpt":"","slug":"checkout-introduction","type":"basic","title":"Introduction","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Introduction


PayStand Checkout is a JavaScript library which provides an easy way for PayStand merchant customers to collect payment information and initiate a payment or scheduled payment in a PCI-DSS compliant way. [block:callout] { "type": "success", "title": "PayStand Checkout facilitates 3 operational modes:", "body": "1. **Payment** (Direct) - [Direct Payment Demo](https://checkout.paystand.co/v4/demo/payment.html)\n2. **Scheduled Payment** - [Scheduled Payment Demo](https://checkout.paystand.co/v4/demo/scheduled-payment.html)\n3. **Save Card or Bank** - [Save Card or Bank Demo](https://checkout.paystand.co/v4/demo/tokenize.html)" } [/block] In (Direct) **Payment mode**, PayStand checkout allows the user to instantly pay a defined amount of money to merchant customer. The **Scheduled Payment mode** enables the user to initiate a pre-defined set of scheduled payments with the merchant customer. Lastly in the **Save Card or Bank mode**, the payment method (card or bank) will be tokenized and saved for future use by the merchant's or platform provider's system. ## Checkout Environments Checkout operates in ```live``` mode or in ```sandbox``` mode. Attributes such as ```vanityName``` and ```publishableKey``` are often environment specific and often need to be changes when switching from one environment to another. [block:callout] { "type": "success", "title": "Checkout modes", "body": "1. **Live** - In live mode, all api requests will be made against the **production environment**.\n2. **Sandbox** - In sandbox mode, all api request will be made against the **test environment**. You can use this environment to test your integrations code." } [/block] ## Checkout Urls You can access various checkout experiences directly via url. Urls can be used directly in a browser or used in an iframe to create an embedded experience. [block:callout] { "type": "info", "title": "Billing Portal", "body": "When checkout is directly used in a browser using its URL, it is called a Billing Portal or for short a _**Portal**_. The use case for this type of checkout usage is typically to integrate checkout with environments that do not allow JavaScript code execution but do support URL references such as Emails, Invoices, etc.\n\nTo facilitate this type of usage PayStand provides a couple of useful features which can also be leveraged in non-portal checkout environments:\n### Vanity Names\nA Vanity Name is a unique, **human readable identification** that can take the place of a cryptic customer identifier such as the publishable key.\n### Portal URL format\nThe portal URL format is a **shorter and more pleasing** URL format which can be used when people see the checkout or portal URL, or when the length of the URL needs to be limited.\n### View Portal\nWhen the View Portal setting is active in the checkout configuration, checkout will render additional contextual HTML elements such as a separate header to **improve full page rendering**.\n### Presets\nPresets are pre-defined checkout configurations that can be used instead of, or in conjunction with a detailed checkout configuration.\n\nThis is in particularly useful when using a **direct URL for portal** purposes as checkout configurations through URL parameters can become complicated or impossible in hurry.\n\nPresets are configured via the merchant customer's dashboard or via the REST API.\n\nBesides their usage in direct Portal URls, presets can be also be used in button URLs, auto loading, or in the checkout API.\n\nNote: _Each merchant customer also has a **Default Preset** which can be configure through the dashboard and which will be loaded by default if no other preset has been specified._" } [/block] ### Url formats Checkouts can be accessed by using any of the following url formats: [block:code] { "codes": [ { "code": "https://checkout.paystand.{envDomain}/v4/?publishableKey={publishableKey}\nhttps://checkout.paystand.{envDomain}/v4/?vanity={vanityName}", "language": "css", "name": "Checkout URL formats" }, { "code": "https://{vanityName}-portal.paystand.{envDomain}\nhttps://{publishableKey}-portal.paystand.{envDomain}", "language": "css", "name": "Portal URL Format" } ] } [/block] The ```envDomain``` for the ```live``` environment is ```com``` and for ```sandbox``` its ```co```. ### Configure via presets To access a particular checkout preset (defined below) you can use the following formats: [block:code] { "codes": [ { "code": "https://checkout.paystand.{envDomain}/v4/?vanity={vanityName}&checkoutType={presetKey}", "language": "css", "name": "Checkout URL with Preset" }, { "code": "https://{vanityName}-portal.paystand.{envDomain}/{presetKey}", "language": "css", "name": "Portal URL with Preset" } ] } [/block] If no preset is given, then the ```default``` preset will be used. If you have not configured a ```default``` preset yet, a default payment checkout will be used. ### Configure via url arguments Additional url arguments allow further configuration of Checkout. Any valid checkout attribute or checkout abbreviation can be used as an url argument (see the associated reference sections for a list of available attributes and abbreviations). If a preset is used, url arguments will override the specific preset values, leaving the rest of the preset settings as is. ## API Urls are very flexible when it comes to customizing the checkout experience on your webpage but are not suitable when there is a need for custom business logic. This means that you can't listen to checkout events, react to a checkout completing, or interact with the checkout in anyway once it has been rendered. To use the checkout API, you can use checkout buttons, autoloading, or you can use the checkout api directly for maximum control of the checkout experience. ## Buttons Checkouts can be configured per button. When a user clicks on a button, the settings on the button are used (just as arguments in the urls above) to create a unique checkout experience. All buttons interact with the checkout api allowing you to listen to checkout events, react to status changes, and update checkout settings. Buttons can render checkouts in two different modes: ### Modals Modals display a checkout that overlays the content of a webpage, focusing the user on the checkout experience. ### Embeds Embeds display a checkout in the flow of a webpage instead of overlaying the content. This can be useful if you want the user to interact with your website at the same time that the checkout is displayed. ## Autoloading Checkouts can be auto loaded once a web page loads. This can be useful if you want to have checkout embedded on your page without the user interacting with a button first. Checkout can only auto load once instance of a checkout. Checkouts rendered via auto loading interact with the checkout api just as buttons do. ## API Checkout has a javascript api that interacts with checkout instances in various ways. The api can listen for checkout events, listen for checkout status changes, update the mode/dimensions for checkout, reboot, and live update checkout. See the API example and API reference section for further details. ## Checkout instance When using checkout using a url directly, the checkout instance is considered to be the webpage that renders directly. When using buttons, auto loading, or the API, the checkout instance is the iframe or window that displays the checkout experience. Checkout limits each page to only one checkout instance. If, for example, you have multiple buttons on a web page, then each button will render a checkout in the same checkout instance.
PayStand Checkout is a JavaScript library which provides an easy way for PayStand merchant customers to collect payment information and initiate a payment or scheduled payment in a PCI-DSS compliant way. [block:callout] { "type": "success", "title": "PayStand Checkout facilitates 3 operational modes:", "body": "1. **Payment** (Direct) - [Direct Payment Demo](https://checkout.paystand.co/v4/demo/payment.html)\n2. **Scheduled Payment** - [Scheduled Payment Demo](https://checkout.paystand.co/v4/demo/scheduled-payment.html)\n3. **Save Card or Bank** - [Save Card or Bank Demo](https://checkout.paystand.co/v4/demo/tokenize.html)" } [/block] In (Direct) **Payment mode**, PayStand checkout allows the user to instantly pay a defined amount of money to merchant customer. The **Scheduled Payment mode** enables the user to initiate a pre-defined set of scheduled payments with the merchant customer. Lastly in the **Save Card or Bank mode**, the payment method (card or bank) will be tokenized and saved for future use by the merchant's or platform provider's system. ## Checkout Environments Checkout operates in ```live``` mode or in ```sandbox``` mode. Attributes such as ```vanityName``` and ```publishableKey``` are often environment specific and often need to be changes when switching from one environment to another. [block:callout] { "type": "success", "title": "Checkout modes", "body": "1. **Live** - In live mode, all api requests will be made against the **production environment**.\n2. **Sandbox** - In sandbox mode, all api request will be made against the **test environment**. You can use this environment to test your integrations code." } [/block] ## Checkout Urls You can access various checkout experiences directly via url. Urls can be used directly in a browser or used in an iframe to create an embedded experience. [block:callout] { "type": "info", "title": "Billing Portal", "body": "When checkout is directly used in a browser using its URL, it is called a Billing Portal or for short a _**Portal**_. The use case for this type of checkout usage is typically to integrate checkout with environments that do not allow JavaScript code execution but do support URL references such as Emails, Invoices, etc.\n\nTo facilitate this type of usage PayStand provides a couple of useful features which can also be leveraged in non-portal checkout environments:\n### Vanity Names\nA Vanity Name is a unique, **human readable identification** that can take the place of a cryptic customer identifier such as the publishable key.\n### Portal URL format\nThe portal URL format is a **shorter and more pleasing** URL format which can be used when people see the checkout or portal URL, or when the length of the URL needs to be limited.\n### View Portal\nWhen the View Portal setting is active in the checkout configuration, checkout will render additional contextual HTML elements such as a separate header to **improve full page rendering**.\n### Presets\nPresets are pre-defined checkout configurations that can be used instead of, or in conjunction with a detailed checkout configuration.\n\nThis is in particularly useful when using a **direct URL for portal** purposes as checkout configurations through URL parameters can become complicated or impossible in hurry.\n\nPresets are configured via the merchant customer's dashboard or via the REST API.\n\nBesides their usage in direct Portal URls, presets can be also be used in button URLs, auto loading, or in the checkout API.\n\nNote: _Each merchant customer also has a **Default Preset** which can be configure through the dashboard and which will be loaded by default if no other preset has been specified._" } [/block] ### Url formats Checkouts can be accessed by using any of the following url formats: [block:code] { "codes": [ { "code": "https://checkout.paystand.{envDomain}/v4/?publishableKey={publishableKey}\nhttps://checkout.paystand.{envDomain}/v4/?vanity={vanityName}", "language": "css", "name": "Checkout URL formats" }, { "code": "https://{vanityName}-portal.paystand.{envDomain}\nhttps://{publishableKey}-portal.paystand.{envDomain}", "language": "css", "name": "Portal URL Format" } ] } [/block] The ```envDomain``` for the ```live``` environment is ```com``` and for ```sandbox``` its ```co```. ### Configure via presets To access a particular checkout preset (defined below) you can use the following formats: [block:code] { "codes": [ { "code": "https://checkout.paystand.{envDomain}/v4/?vanity={vanityName}&checkoutType={presetKey}", "language": "css", "name": "Checkout URL with Preset" }, { "code": "https://{vanityName}-portal.paystand.{envDomain}/{presetKey}", "language": "css", "name": "Portal URL with Preset" } ] } [/block] If no preset is given, then the ```default``` preset will be used. If you have not configured a ```default``` preset yet, a default payment checkout will be used. ### Configure via url arguments Additional url arguments allow further configuration of Checkout. Any valid checkout attribute or checkout abbreviation can be used as an url argument (see the associated reference sections for a list of available attributes and abbreviations). If a preset is used, url arguments will override the specific preset values, leaving the rest of the preset settings as is. ## API Urls are very flexible when it comes to customizing the checkout experience on your webpage but are not suitable when there is a need for custom business logic. This means that you can't listen to checkout events, react to a checkout completing, or interact with the checkout in anyway once it has been rendered. To use the checkout API, you can use checkout buttons, autoloading, or you can use the checkout api directly for maximum control of the checkout experience. ## Buttons Checkouts can be configured per button. When a user clicks on a button, the settings on the button are used (just as arguments in the urls above) to create a unique checkout experience. All buttons interact with the checkout api allowing you to listen to checkout events, react to status changes, and update checkout settings. Buttons can render checkouts in two different modes: ### Modals Modals display a checkout that overlays the content of a webpage, focusing the user on the checkout experience. ### Embeds Embeds display a checkout in the flow of a webpage instead of overlaying the content. This can be useful if you want the user to interact with your website at the same time that the checkout is displayed. ## Autoloading Checkouts can be auto loaded once a web page loads. This can be useful if you want to have checkout embedded on your page without the user interacting with a button first. Checkout can only auto load once instance of a checkout. Checkouts rendered via auto loading interact with the checkout api just as buttons do. ## API Checkout has a javascript api that interacts with checkout instances in various ways. The api can listen for checkout events, listen for checkout status changes, update the mode/dimensions for checkout, reboot, and live update checkout. See the API example and API reference section for further details. ## Checkout instance When using checkout using a url directly, the checkout instance is considered to be the webpage that renders directly. When using buttons, auto loading, or the API, the checkout instance is the iframe or window that displays the checkout experience. Checkout limits each page to only one checkout instance. If, for example, you have multiple buttons on a web page, then each button will render a checkout in the same checkout instance.
{"_id":"5d56fccfb1b7fc00334d197c","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d191f","user":"55dd080d0efd5821000d53b3","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-14T04:57:11.104Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\n<!-- (required) init script tag -->\\n<script\\ntype=\\\"text/javscript\\\"\\nid=\\\"ps_checkout\\\"\\nsrc=\\\"https://checkout.paystand.co/v4/js/paystand.checkout.js\\\"\\nps-env=\\\"sandbox\\\"\\nps-publishableKey=\\\"{your_publishable_key}\\\"\\nps-containerId=\\\"{your_container_id}\\\"\\n...\\n>\\n</script>\\n\",\n      \"language\": \"html\",\n      \"name\": \"Initial Script Tag (required)\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\n<!-- (optional) styled payment button -->\\n<button\\nclass=\\\"ps-button ps-button-style\\\"\\nps-checkoutType=\\\"checkout_payment\\\"\\n...\\n>\\n</button>\\n\",\n      \"language\": \"html\",\n      \"name\": \"Styled Payment Button (optional)\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\n<!-- ADVANCED (optional) un-styled payment button -->\\n<!-- Use integration specific CSS to style the button -->\\n<button\\nclass=\\\"ps-button\\\"\\nps-checkoutType=\\\"checkout_payment\\\"\\n...\\n>\\n</button>\\n\",\n      \"language\": \"html\",\n      \"name\": \"Unstyled Payment Button (ADVANCED optional)\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\n<!-- ADVANCED (optional) auto load payment checkout -->\\n<div\\nid=\\\"ps_checkout_load\\\"\\nps-checkoutType=\\\"checkout_payment\\\"\\n...\\n></div>\\n\",\n      \"language\": \"html\",\n      \"name\": \"Auto Load Payment Checkout (ADVANCED optional)\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<!-- ADVANCED (optional) checkout container -->\\n<div id=\\\"{your_container_id}\\\"></div>\",\n      \"language\": \"html\",\n      \"name\": \"Checkout Container (ADVANCED optional)\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n## Init script tag\n\nThe initialization script tag sets up the initial checkout environment. The tag must contain the id attribute (set to ```ps_checkout```) and the src and ps-publishableKey attributes must be defined. It is recommended but optional to include the ps-env as well as the ps-containerId attributes.\n\nAny other ```ps-*``` attributes that are added to the init script tag will be used as default values for the checkout experience. As such, when using multiple buttons on a page, it is also recommended to add all common attributes to the script tag so that they are defined only once.\n\n## Buttons\n\nButtons are the easiest way to add a checkout experience. When a website user clicks on a button, a checkout experience will appear with the settings determined from the button element that was clicked as well as any default settings that are found on the init script.\n\nAll buttons must contain the class \"ps-button\". We recommend the element be of type ```<button>``` but that is not strictly required. You could, for example use a standard ```<div>``` attribute if that fits your requirements better.\n\nWe recommend adding the class ```ps-button-style```. This will add a default style to the button. Not adding this class will usually require the developer to add custom styling to the button.\n\nAny other ```ps-*``` attributes that are added to the button will be used to configure the checkout that is rendered upon the button being clicked.\n\n## Auto loading (Embedded Experience)\n\nThe auto load tag is used to render a checkout experience immediately upon page load. The auto load tag must contain the id attribute set to ```ps_checkout_load```.\n\nThe auto loading use-case is typically when the website or application design calls for a checkout experience embedded in the website or web application. Such as when checkout needs to be shown next to for instance the invoice that needs to be paid. \n\nAny other ```ps-*``` attributes that are added to the auto load tag will be used to configure the checkout that is rendered upon page load.\n\n## Checkout container\n\nThe checkout container is an html element that a developer designates as a container for the checkout element. If a containerId is supplied, checkout will attempt to inject its markup inside of the element containing that ```id``` attribute.\n\nThis can be useful to tightly control how the checkout renders on the page.\n\n## ps-* attributes\n\nAny checkout attribute (found in the Checkout Attributes reference section) can be added to the script/button elements by prefixing the attributes with ```ps-```. Adding attributes to an element will configure the elements related checkout according to the attribute definition found in the reference section.\n\n## Checkout listener api\n\nThe checkout listener api allows your application's front-end JavaScript to listen to Checkout events, actions, updates, flows, and status changes. This can be useful for making changes on your page based upon things that are happening in the checkout environment. For example, you could set a button to disable the checkout receipt, listen for the checkout ```loaded``` status, and then use the checkout actions api to hide the checkout and to show your own receipt on the page.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Checkout listeners are no replacement for backend event listeners\",\n  \"body\": \"Please note that checkout listeners are intended for streamlining the front-end user experience and are by no means a replacement for backend event listeners (i.e. webhooks). Backend events have a much more robust and reliable delivery mechanism as well as a means for 2-way authentication as they are intended to be used for business process integrations.\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\n/**\\n * ADVANCED (optional) Checkout Listener API\\n */\\n\\n// consume raw events\\npsCheckout.checkoutEvent = function (data) {...};\\npsCheckout.checkoutAction = function (data) {...};\\npsCheckout.checkoutUpdated = function (data) {...};\\npsCheckout.checkoutFlow = function (data) {...};\\n// persistently react to specific checkout status events\\npsCheckout.onCssLoad(function(){...});\\npsCheckout.onLoaded(function(){...});\\npsCheckout.onLoading(function(){...});\\npsCheckout.onReady(function(){...});\\npsCheckout.onComplete(function(){...});\\npsCheckout.onError(function(){...});\\n\\n// react to the next specific checkout status event\\npsCheckout.onceLoaded(function(){...});\\npsCheckout.onceLoading(function(){...});\\npsCheckout.onceComplete(function(){...});\\n                                   \",\n      \"language\": \"javascript\",\n      \"name\": \"Checkout Listener API (ADVANCED optional)\"\n    }\n  ]\n}\n[/block]\n\n## Checkout actions api\n\nThe checkout actions api allows front-end JavaScript to modify the checkout experience in various ways. It can modify how a checkout is displayed such as whether it displays in a modal or an embed, set its width and height, and if its shown or hidden. It can also modify the content of a checkout itself by sending an update, reload, or reset command. The update, reload, and reset command accepts any checkout attribute, not prefixed with ```ps-```.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\n/**\\n * ADVANCED (optional) Checkout Actions API\\n */\\n\\n// modify checkout display\\npsCheckout.showCheckout();\\npsCheckout.hideCheckout();\\npsCheckout.embed();\\npsCheckout.modal();\\npsCheckout.dimensions(width, height);\\n\\n// modify checkout content\\npsCheckout.reboot({...});\\npsCheckout.liveUpdate({...});\\n\",\n      \"language\": \"javascript\",\n      \"name\": \"Checkout Actions API (ADVANCED optional)\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"checkout-elements","type":"basic","title":"Elements","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Elements


[block:code] { "codes": [ { "code": "\n<!-- (required) init script tag -->\n<script\ntype=\"text/javscript\"\nid=\"ps_checkout\"\nsrc=\"https://checkout.paystand.co/v4/js/paystand.checkout.js\"\nps-env=\"sandbox\"\nps-publishableKey=\"{your_publishable_key}\"\nps-containerId=\"{your_container_id}\"\n...\n>\n</script>\n", "language": "html", "name": "Initial Script Tag (required)" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "\n<!-- (optional) styled payment button -->\n<button\nclass=\"ps-button ps-button-style\"\nps-checkoutType=\"checkout_payment\"\n...\n>\n</button>\n", "language": "html", "name": "Styled Payment Button (optional)" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "\n<!-- ADVANCED (optional) un-styled payment button -->\n<!-- Use integration specific CSS to style the button -->\n<button\nclass=\"ps-button\"\nps-checkoutType=\"checkout_payment\"\n...\n>\n</button>\n", "language": "html", "name": "Unstyled Payment Button (ADVANCED optional)" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "\n<!-- ADVANCED (optional) auto load payment checkout -->\n<div\nid=\"ps_checkout_load\"\nps-checkoutType=\"checkout_payment\"\n...\n></div>\n", "language": "html", "name": "Auto Load Payment Checkout (ADVANCED optional)" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "<!-- ADVANCED (optional) checkout container -->\n<div id=\"{your_container_id}\"></div>", "language": "html", "name": "Checkout Container (ADVANCED optional)" } ], "sidebar": true } [/block] ## Init script tag The initialization script tag sets up the initial checkout environment. The tag must contain the id attribute (set to ```ps_checkout```) and the src and ps-publishableKey attributes must be defined. It is recommended but optional to include the ps-env as well as the ps-containerId attributes. Any other ```ps-*``` attributes that are added to the init script tag will be used as default values for the checkout experience. As such, when using multiple buttons on a page, it is also recommended to add all common attributes to the script tag so that they are defined only once. ## Buttons Buttons are the easiest way to add a checkout experience. When a website user clicks on a button, a checkout experience will appear with the settings determined from the button element that was clicked as well as any default settings that are found on the init script. All buttons must contain the class "ps-button". We recommend the element be of type ```<button>``` but that is not strictly required. You could, for example use a standard ```<div>``` attribute if that fits your requirements better. We recommend adding the class ```ps-button-style```. This will add a default style to the button. Not adding this class will usually require the developer to add custom styling to the button. Any other ```ps-*``` attributes that are added to the button will be used to configure the checkout that is rendered upon the button being clicked. ## Auto loading (Embedded Experience) The auto load tag is used to render a checkout experience immediately upon page load. The auto load tag must contain the id attribute set to ```ps_checkout_load```. The auto loading use-case is typically when the website or application design calls for a checkout experience embedded in the website or web application. Such as when checkout needs to be shown next to for instance the invoice that needs to be paid. Any other ```ps-*``` attributes that are added to the auto load tag will be used to configure the checkout that is rendered upon page load. ## Checkout container The checkout container is an html element that a developer designates as a container for the checkout element. If a containerId is supplied, checkout will attempt to inject its markup inside of the element containing that ```id``` attribute. This can be useful to tightly control how the checkout renders on the page. ## ps-* attributes Any checkout attribute (found in the Checkout Attributes reference section) can be added to the script/button elements by prefixing the attributes with ```ps-```. Adding attributes to an element will configure the elements related checkout according to the attribute definition found in the reference section. ## Checkout listener api The checkout listener api allows your application's front-end JavaScript to listen to Checkout events, actions, updates, flows, and status changes. This can be useful for making changes on your page based upon things that are happening in the checkout environment. For example, you could set a button to disable the checkout receipt, listen for the checkout ```loaded``` status, and then use the checkout actions api to hide the checkout and to show your own receipt on the page. [block:callout] { "type": "warning", "title": "Checkout listeners are no replacement for backend event listeners", "body": "Please note that checkout listeners are intended for streamlining the front-end user experience and are by no means a replacement for backend event listeners (i.e. webhooks). Backend events have a much more robust and reliable delivery mechanism as well as a means for 2-way authentication as they are intended to be used for business process integrations." } [/block] [block:code] { "codes": [ { "code": "\n/**\n * ADVANCED (optional) Checkout Listener API\n */\n\n// consume raw events\npsCheckout.checkoutEvent = function (data) {...};\npsCheckout.checkoutAction = function (data) {...};\npsCheckout.checkoutUpdated = function (data) {...};\npsCheckout.checkoutFlow = function (data) {...};\n// persistently react to specific checkout status events\npsCheckout.onCssLoad(function(){...});\npsCheckout.onLoaded(function(){...});\npsCheckout.onLoading(function(){...});\npsCheckout.onReady(function(){...});\npsCheckout.onComplete(function(){...});\npsCheckout.onError(function(){...});\n\n// react to the next specific checkout status event\npsCheckout.onceLoaded(function(){...});\npsCheckout.onceLoading(function(){...});\npsCheckout.onceComplete(function(){...});\n ", "language": "javascript", "name": "Checkout Listener API (ADVANCED optional)" } ] } [/block] ## Checkout actions api The checkout actions api allows front-end JavaScript to modify the checkout experience in various ways. It can modify how a checkout is displayed such as whether it displays in a modal or an embed, set its width and height, and if its shown or hidden. It can also modify the content of a checkout itself by sending an update, reload, or reset command. The update, reload, and reset command accepts any checkout attribute, not prefixed with ```ps-```. [block:code] { "codes": [ { "code": "\n/**\n * ADVANCED (optional) Checkout Actions API\n */\n\n// modify checkout display\npsCheckout.showCheckout();\npsCheckout.hideCheckout();\npsCheckout.embed();\npsCheckout.modal();\npsCheckout.dimensions(width, height);\n\n// modify checkout content\npsCheckout.reboot({...});\npsCheckout.liveUpdate({...});\n", "language": "javascript", "name": "Checkout Actions API (ADVANCED optional)" } ] } [/block]
[block:code] { "codes": [ { "code": "\n<!-- (required) init script tag -->\n<script\ntype=\"text/javscript\"\nid=\"ps_checkout\"\nsrc=\"https://checkout.paystand.co/v4/js/paystand.checkout.js\"\nps-env=\"sandbox\"\nps-publishableKey=\"{your_publishable_key}\"\nps-containerId=\"{your_container_id}\"\n...\n>\n</script>\n", "language": "html", "name": "Initial Script Tag (required)" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "\n<!-- (optional) styled payment button -->\n<button\nclass=\"ps-button ps-button-style\"\nps-checkoutType=\"checkout_payment\"\n...\n>\n</button>\n", "language": "html", "name": "Styled Payment Button (optional)" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "\n<!-- ADVANCED (optional) un-styled payment button -->\n<!-- Use integration specific CSS to style the button -->\n<button\nclass=\"ps-button\"\nps-checkoutType=\"checkout_payment\"\n...\n>\n</button>\n", "language": "html", "name": "Unstyled Payment Button (ADVANCED optional)" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "\n<!-- ADVANCED (optional) auto load payment checkout -->\n<div\nid=\"ps_checkout_load\"\nps-checkoutType=\"checkout_payment\"\n...\n></div>\n", "language": "html", "name": "Auto Load Payment Checkout (ADVANCED optional)" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "<!-- ADVANCED (optional) checkout container -->\n<div id=\"{your_container_id}\"></div>", "language": "html", "name": "Checkout Container (ADVANCED optional)" } ], "sidebar": true } [/block] ## Init script tag The initialization script tag sets up the initial checkout environment. The tag must contain the id attribute (set to ```ps_checkout```) and the src and ps-publishableKey attributes must be defined. It is recommended but optional to include the ps-env as well as the ps-containerId attributes. Any other ```ps-*``` attributes that are added to the init script tag will be used as default values for the checkout experience. As such, when using multiple buttons on a page, it is also recommended to add all common attributes to the script tag so that they are defined only once. ## Buttons Buttons are the easiest way to add a checkout experience. When a website user clicks on a button, a checkout experience will appear with the settings determined from the button element that was clicked as well as any default settings that are found on the init script. All buttons must contain the class "ps-button". We recommend the element be of type ```<button>``` but that is not strictly required. You could, for example use a standard ```<div>``` attribute if that fits your requirements better. We recommend adding the class ```ps-button-style```. This will add a default style to the button. Not adding this class will usually require the developer to add custom styling to the button. Any other ```ps-*``` attributes that are added to the button will be used to configure the checkout that is rendered upon the button being clicked. ## Auto loading (Embedded Experience) The auto load tag is used to render a checkout experience immediately upon page load. The auto load tag must contain the id attribute set to ```ps_checkout_load```. The auto loading use-case is typically when the website or application design calls for a checkout experience embedded in the website or web application. Such as when checkout needs to be shown next to for instance the invoice that needs to be paid. Any other ```ps-*``` attributes that are added to the auto load tag will be used to configure the checkout that is rendered upon page load. ## Checkout container The checkout container is an html element that a developer designates as a container for the checkout element. If a containerId is supplied, checkout will attempt to inject its markup inside of the element containing that ```id``` attribute. This can be useful to tightly control how the checkout renders on the page. ## ps-* attributes Any checkout attribute (found in the Checkout Attributes reference section) can be added to the script/button elements by prefixing the attributes with ```ps-```. Adding attributes to an element will configure the elements related checkout according to the attribute definition found in the reference section. ## Checkout listener api The checkout listener api allows your application's front-end JavaScript to listen to Checkout events, actions, updates, flows, and status changes. This can be useful for making changes on your page based upon things that are happening in the checkout environment. For example, you could set a button to disable the checkout receipt, listen for the checkout ```loaded``` status, and then use the checkout actions api to hide the checkout and to show your own receipt on the page. [block:callout] { "type": "warning", "title": "Checkout listeners are no replacement for backend event listeners", "body": "Please note that checkout listeners are intended for streamlining the front-end user experience and are by no means a replacement for backend event listeners (i.e. webhooks). Backend events have a much more robust and reliable delivery mechanism as well as a means for 2-way authentication as they are intended to be used for business process integrations." } [/block] [block:code] { "codes": [ { "code": "\n/**\n * ADVANCED (optional) Checkout Listener API\n */\n\n// consume raw events\npsCheckout.checkoutEvent = function (data) {...};\npsCheckout.checkoutAction = function (data) {...};\npsCheckout.checkoutUpdated = function (data) {...};\npsCheckout.checkoutFlow = function (data) {...};\n// persistently react to specific checkout status events\npsCheckout.onCssLoad(function(){...});\npsCheckout.onLoaded(function(){...});\npsCheckout.onLoading(function(){...});\npsCheckout.onReady(function(){...});\npsCheckout.onComplete(function(){...});\npsCheckout.onError(function(){...});\n\n// react to the next specific checkout status event\npsCheckout.onceLoaded(function(){...});\npsCheckout.onceLoading(function(){...});\npsCheckout.onceComplete(function(){...});\n ", "language": "javascript", "name": "Checkout Listener API (ADVANCED optional)" } ] } [/block] ## Checkout actions api The checkout actions api allows front-end JavaScript to modify the checkout experience in various ways. It can modify how a checkout is displayed such as whether it displays in a modal or an embed, set its width and height, and if its shown or hidden. It can also modify the content of a checkout itself by sending an update, reload, or reset command. The update, reload, and reset command accepts any checkout attribute, not prefixed with ```ps-```. [block:code] { "codes": [ { "code": "\n/**\n * ADVANCED (optional) Checkout Actions API\n */\n\n// modify checkout display\npsCheckout.showCheckout();\npsCheckout.hideCheckout();\npsCheckout.embed();\npsCheckout.modal();\npsCheckout.dimensions(width, height);\n\n// modify checkout content\npsCheckout.reboot({...});\npsCheckout.liveUpdate({...});\n", "language": "javascript", "name": "Checkout Actions API (ADVANCED optional)" } ] } [/block]
{"_id":"5d56fccfb1b7fc00334d197d","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d191f","user":"55dd080d0efd5821000d53b3","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-14T05:57:07.056Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<div id=\\\"ps_container_id\\\"></div>\\n<script\\n  type=\\\"text/javascript\\\"\\n  id=\\\"ps_checkout\\\"\\n  src=\\\"https://checkout.paystand.co/v4/js/paystand.checkout.js\\\"\\n  ps-env=\\\"sandbox\\\"\\n  ps-publishableKey=\\\"1noqhele1yjgieoi8aqe4n8i\\\"\\n  ps-containerId=\\\"ps_container_id\\\"\\n></script>\",\n      \"language\": \"html\",\n      \"name\": \"Script tag for button examples\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n## Button styles\n\n### Styled\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n\\tclass=\\\"ps-button ps-button-style\\\"\\n>\\n  Pay Now - Styled\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Styled\"\n    }\n  ]\n}\n[/block]\n### Unstyled\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n\\tclass=\\\"ps-button\\\"\\n>\\n  Pay Now - Unstyled\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Unstyled\"\n    }\n  ]\n}\n[/block]\n## Checkout types\n\n### Payment\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n>\\n  Pay Now\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now\"\n    }\n  ]\n}\n[/block]\n### Tokenize\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_token\\\"\\n>\\n  Save Payment Method\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Save Payment Method\"\n    }\n  ]\n}\n[/block]\n### Scheduled Payment\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_scheduled_payment\\\"\\n  ps-spName=\\\"Monthly Rent\\\"\\n  ps-spDescription=\\\"For apartment 201B\\\"\\n  ps-spExtId=\\\"apt201b\\\"\\n  ps-spAmount=\\\"1900\\\"\\n  ps-spCurrency=\\\"USD\\\"\\n  ps-spInterval=\\\"monthly\\\"\\n  ps-spIntervalCount=\\\"1\\\"\\n  ps-spAnchor=\\\"start\\\"\\n  ps-spTimesToRun=\\\"12\\\"\\n>\\n  Schedule Payment\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Schedule Payment\"\n    }\n  ]\n}\n[/block]\n### Custom Preset\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"pay2\\\"\\n  ps-viewCheckout=\\\"mobile\\\"\\n>\\n  Pay Now\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now\"\n    }\n  ]\n}\n[/block]\n## Payment amount\n\n### Editable amount\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.25\\\"\\n>\\n  Pay Now - $20.25\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - $20.25\"\n    }\n  ]\n}\n[/block]\n### Fixed amount\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-fixedAmount=\\\"true\\\"\\n  ps-paymentAmount=\\\"20.59\\\"\\n>\\n  Pay Now - $20.59\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - $20.59\"\n    }\n  ]\n}\n[/block]\n## Checkout display\n\n### Width/height\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.13\\\"\\n  ps-width=\\\"700px\\\"\\n  ps-height=\\\"700px\\\"\\n>\\n  Pay Now - 700px x 700x\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - $20.13\"\n    }\n  ]\n}\n[/block]\n### Close button\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.97\\\"\\n  ps-viewClose=\\\"hide\\\"\\n>\\n  Pay Now - No close button\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - No close button\"\n    }\n  ]\n}\n[/block]\n### Portal view\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.23\\\"\\n  ps-width=\\\"900px\\\"\\n  ps-height=\\\"700px\\\"\\n  ps-viewCheckout=\\\"portal\\\"\\n  ps-viewClose=\\\"show\\\"\\n>\\n  Pay Now - Portal view\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Portal view\"\n    }\n  ]\n}\n[/block]\n### Mobile view\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.97\\\"\\n  ps-viewCheckout=\\\"mobile\\\"\\n  ps-viewClose=\\\"show\\\"\\n>\\n  Pay Now - Mobile view\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Mobile view\"\n    }\n  ]\n}\n[/block]\n## Resource data\n\n### Payer data\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"50.00\\\"\\n  ps-payerName=\\\"John Doe Payer\\\"\\n  ps-payerEmail=\\\"john.doe@paystand.com\\\"\\n  ps-payerAddressStreet=\\\"123 Alliance Ln\\\"\\n  ps-payerAddressCity=\\\"Santa Cruz\\\"\\n  ps-payerAddressState=\\\"CA\\\"\\n  ps-payerAddressCountry=\\\"USA\\\"\\n  ps-payerAddressPostal=\\\"95060\\\"\\n  ps-payerExternalId=\\\"payer_external_id\\\"\\n  ps-payerMeta='{\\\"payer\\\": \\\"meta\\\"}'\\n>\\n  Pay Now - Payer data\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Payer data\"\n    }\n  ]\n}\n[/block]\n### Card data\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"50.00\\\"\\n  ps-cardName=\\\"John Doe - Card\\\"\\n  ps-cardNumber=\\\"4242424242424242\\\"\\n  ps-cardMonth=\\\"10\\\"\\n  ps-cardYear=\\\"20\\\"\\n  ps-cardCode=\\\"123\\\"\\n  ps-cardExternalId=\\\"card_external_id\\\"\\n  ps-cardMeta='{\\\"card\\\": \\\"meta\\\"}'\\n>\\n  Pay Now - Card data\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Card data\"\n    }\n  ]\n}\n[/block]\n### Bank data\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"50.00\\\"\\n  ps-bankNameOnAccount=\\\"John Doe - Bank\\\"\\n  ps-bankAccountType=\\\"checking\\\"\\n  ps-bankAccountHolderType=\\\"company\\\"\\n  ps-bankRouting=\\\"110000000\\\"\\n  ps-bankAccount=\\\"000123456789\\\"\\n  ps-bankAccountRepeat=\\\"000123456789\\\"\\n  ps-bankExternalId=\\\"bank_external_id\\\"\\n  ps-bankMeta='{\\\"bank\\\": \\\"meta\\\"}'\\n>\\n  Pay Now - Bank data\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Bank data\"\n    }\n  ]\n}\n[/block]\n### Custom field data\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"50.00\\\"\\n  ps-cf_first_name=\\\"First Name Custom Field\\\"\\n>\\n  Pay Now - Custom field data\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Custom field data\"\n    }\n  ]\n}\n[/block]\n## Embed/Modal mode\n\n### Embed\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.98\\\"\\n  ps-mode=\\\"embed\\\"\\n>\\n  Pay Now - Embed\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Embed\"\n    }\n  ]\n}\n[/block]\n### Modal\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.98\\\"\\n  ps-mode=\\\"modal\\\"\\n>\\n  Pay Now - Modal\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Modal\"\n    }\n  ]\n}\n[/block]\n## Header\n\n### Header color\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.24\\\"\\n  ps-headerColor=\\\"darkred\\\"\\n>\\n  Pay Now - Header color\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Header color\"\n    }\n  ]\n}\n[/block]\n### Hide logo\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.77\\\"\\n  ps-viewLogo=\\\"hide\\\"\\n>\\n  Pay Now - Hide logo\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Hide logo\"\n    }\n  ]\n}\n[/block]\n### Custom logo\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.19\\\"\\n  ps-logoUrl=\\\"http://www.image360.com/assets/live/0/34/59/115/118/design-output-services-logo-creation-national-log001.jpg?width=330&height=290&mode=crop&scale=both\\\"\\n  ps-logoBdColor=\\\"#555\\\"\\n  ps-logoBgColor=\\\"#000\\\"\\n  ps-logoWidth=\\\"90px\\\"\\n  ps-logoHeight=\\\"100px\\\"\\n>\\n  Pay Now - Custom logo\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Custom logo\"\n    }\n  ]\n}\n[/block]\n## Custom css\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.19\\\"\\n  ps-externalCss=\\\"../js/paystand.checkout.external.css\\\"\\n>\\n  Pay Now - Custom css\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Custom css\"\n    }\n  ]\n}\n[/block]\n## Payment methods\n\n### Ordering\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.95\\\"\\n  ps-viewFunds=\\\"card,ach,echeck\\\"\\n>\\n  Pay Now - Payment methods - ordering\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Payment methods - ordering\"\n    }\n  ]\n}\n[/block]\n### Removing\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.46\\\"\\n  ps-viewFunds=\\\"card,echeck\\\"\\n>\\n  Pay Now - Payment methods - removing\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Payment methods - removing\"\n    }\n  ]\n}\n[/block]\n### Labels\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.33\\\"\\n  ps-setFundSelector_bankSessionTabText=\\\"1. eCheck\\\"\\n  ps-setFundSelector_cardTabText=\\\"2. Card\\\"\\n  ps-setFundSelector_bankTabText=\\\"3. Bank\\\"\\n>\\n  Pay Now - Payment methods - labels\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Payment methods - labels\"\n    }\n  ]\n}\n[/block]\n### Layout\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.97\\\"\\n  ps-setLayout_fundSelect=\\\"tabs\\\"\\n>\\n  Pay Now - Payment methods - layout\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Payment methods - layout\"\n    }\n  ]\n}\n[/block]\n## Labels and fields\n\n### Section headers\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.03\\\"\\n  ps-showHeader_cardHeader=\\\"show\\\"\\n  ps-setHeader_cardHeader=\\\"Card Details\\\"\\n  ps-showHeader_bankHeader=\\\"show\\\"\\n  ps-setHeader_bankHeader=\\\"Bank Details\\\"\\n  ps-showHeader_payerHeader=\\\"show\\\"\\n  ps-setHeader_payerHeader=\\\"Payer Details\\\"\\n>\\n  Pay Now - Section headers\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Section headers\"\n    }\n  ]\n}\n[/block]\n### Show External Id fields\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.99\\\"\\n  ps-viewExtIds=\\\"card,bank,payer\\\"\\n>\\n  Pay Now - Show External Id fields\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Show External Id fields\"\n    }\n  ]\n}\n[/block]\n### Show field labels\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.21\\\"\\n  ps-viewLabels=\\\"show\\\"\\n>\\n  Pay Now - Show field labels\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Show field labels\"\n    }\n  ]\n}\n[/block]\n### Set field placeholders\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.22\\\"\\n  ps-viewPlaceholders=\\\"show\\\"\\n  ps-setPlaceholder_cardExternalId=\\\"Card external id placeholder\\\"\\n  ps-setPlaceholder_cardName=\\\"Name on card placeholder\\\"\\n  ps-setPlaceholder_cardNumber=\\\"Card number placeholder\\\"\\n  ps-setPlaceholder_cardExpiry=\\\"Card expiry placeholder\\\"\\n  ps-setPlaceholder_cardSecurityCode=\\\"Card security code placeholder\\\"\\n  ps-setPlaceholder_bankNameOnAccount=\\\"Name on account placeholder\\\"\\n  ps-setPlaceholder_bankAccountHolderType=\\\"Account holder type placeholder\\\"\\n  ps-setPlaceholder_bankRouting=\\\"Routing placeholder\\\"\\n  ps-setPlaceholder_bankAccount=\\\"Account placeholder\\\"\\n  ps-setPlaceholder_bankName=\\\"Bank name placeholder\\\"\\n  ps-setPlaceholder_bankAccountRepeat=\\\"Account repeat placeholder\\\"\\n  ps-setPlaceholder_bankExternalId=\\\"External Id placeholder\\\"\\n  ps-setPlaceholder_payerEmail=\\\"Payer email placeholder\\\"\\n  ps-setPlaceholder_payerAddressStreet=\\\"Street placeholder\\\"\\n  ps-setPlaceholder_payerAddressCity=\\\"City placeholder\\\"\\n  ps-setPlaceholder_payerAddressPostal=\\\"Postal placeholder\\\"\\n  ps-setPlaceholder_payerAddressState=\\\"State placeholder\\\"\\n  ps-setPlaceholder_payerAddressCountry=\\\"Country placeholder\\\"\\n>\\n  Pay Now - Set field placeholders\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Set field placeholders\"\n    }\n  ]\n}\n[/block]\n### Set field labels\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.22\\\"\\n  ps-viewLabels=\\\"show\\\"\\n  ps-setLabel_cardExternalId=\\\"Card external id label\\\"\\n  ps-setLabel_cardName=\\\"Name on card label\\\"\\n  ps-setLabel_cardNumber=\\\"Card number label\\\"\\n  ps-setLabel_cardExpiry=\\\"Card expiry label\\\"\\n  ps-setLabel_cardSecurityCode=\\\"Card security code label\\\"\\n  ps-setLabel_bankNameOnAccount=\\\"Name on account label\\\"\\n  ps-setLabel_bankAccountHolderType=\\\"Account holder type label\\\"\\n  ps-setLabel_bankRouting=\\\"Routing label\\\"\\n  ps-setLabel_bankAccount=\\\"Account label\\\"\\n  ps-setLabel_bankName=\\\"Bank name label\\\"\\n  ps-setLabel_bankAccountRepeat=\\\"Account repeat label\\\"\\n  ps-setLabel_bankExternalId=\\\"External Id label\\\"\\n  ps-setLabel_payerEmail=\\\"Payer email label\\\"\\n  ps-setLabel_payerAddressStreet=\\\"Street label\\\"\\n  ps-setLabel_payerAddressCity=\\\"City label\\\"\\n  ps-setLabel_payerAddressPostal=\\\"Postal label\\\"\\n  ps-setLabel_payerAddressState=\\\"State label\\\"\\n  ps-setLabel_payerAddressCountry=\\\"Country label\\\"\\n>\\n  Pay Now - Set field labels\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Set field labels\"\n    }\n  ]\n}\n[/block]\n### Set field icon\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.22\\\"\\n  ps-setFieldIcon_payerEmail=\\\"done\\\"\\n  ps-setFieldIcon_payerAddressStreet=\\\"done\\\"\\n  ps-setFieldIcon_payerAddressCity=\\\"done\\\"\\n  ps-setFieldIcon_payerAddressPostal=\\\"done\\\"\\n  ps-setFieldIcon_payerAddressState=\\\"done\\\"\\n  ps-setFieldIcon_payerAddressCountry=\\\"done\\\"\\n  ps-setFieldIcon_cardExternalId=\\\"done\\\"\\n  ps-setFieldIcon_cardName=\\\"done\\\"\\n  ps-setFieldIcon_cardNumber=\\\"done\\\"\\n  ps-setFieldIcon_cardExpiry=\\\"done\\\"\\n  ps-setFieldIcon_cardSecurityCode=\\\"done\\\"\\n  ps-setFieldIcon_bankNameOnAccount=\\\"done\\\"\\n  ps-setFieldIcon_bankAccountHolderType=\\\"done\\\"\\n  ps-setFieldIcon_bankRouting=\\\"done\\\"\\n  ps-setFieldIcon_bankAccount=\\\"done\\\"\\n  ps-setFieldIcon_bankName=\\\"done\\\"\\n  ps-setFieldIcon_bankAccountRepeat=\\\"done\\\"\\n  ps-setFieldIcon_bankExternalId=\\\"done\\\"\\n>\\n  Pay Now - Set field icons\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Set field icons\"\n    }\n  ]\n}\n[/block]\n### Show fields\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.22\\\"\\n  ps-showField_payerEmail=\\\"show\\\"\\n  ps-showField_payerAddressStreet=\\\"show\\\"\\n  ps-showField_payerAddressCity=\\\"show\\\"\\n  ps-showField_payerAddressPostal=\\\"show\\\"\\n  ps-showField_payerAddressState=\\\"show\\\"\\n  ps-showField_payerAddressCountry=\\\"show\\\"\\n  ps-showField_cardExternalId=\\\"show\\\"\\n  ps-showField_cardName=\\\"show\\\"\\n  ps-showField_cardNumber=\\\"show\\\"\\n  ps-showField_cardExpiry=\\\"show\\\"\\n  ps-showField_cardSecurityCode=\\\"show\\\"\\n  ps-showField_bankNameOnAccount=\\\"show\\\"\\n  ps-showField_bankAccountHolderType=\\\"show\\\"\\n  ps-showField_bankRouting=\\\"show\\\"\\n  ps-showField_bankAccount=\\\"show\\\"\\n  ps-showField_bankName=\\\"show\\\"\\n  ps-showField_bankAccountRepeat=\\\"show\\\"\\n  ps-showField_bankExternalId=\\\"show\\\"\\n>\\n  Pay Now - Show fields\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Show fields\"\n    }\n  ]\n}\n[/block]\n### Show field icons\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.22\\\"\\n  ps-showFieldIcon_payerEmail=\\\"show\\\"\\n  ps-showFieldIcon_payerAddressStreet=\\\"show\\\"\\n  ps-showFieldIcon_payerAddressCity=\\\"show\\\"\\n  ps-showFieldIcon_payerAddressPostal=\\\"show\\\"\\n  ps-showFieldIcon_payerAddressState=\\\"show\\\"\\n  ps-showFieldIcon_payerAddressCountry=\\\"show\\\"\\n  ps-showFieldIcon_cardExternalId=\\\"show\\\"\\n  ps-showFieldIcon_cardName=\\\"show\\\"\\n  ps-showFieldIcon_cardNumber=\\\"show\\\"\\n  ps-showFieldIcon_cardExpiry=\\\"show\\\"\\n  ps-showFieldIcon_cardSecurityCode=\\\"show\\\"\\n  ps-showFieldIcon_bankNameOnAccount=\\\"show\\\"\\n  ps-showFieldIcon_bankAccountHolderType=\\\"show\\\"\\n  ps-showFieldIcon_bankRouting=\\\"show\\\"\\n  ps-showFieldIcon_bankAccount=\\\"show\\\"\\n  ps-showFieldIcon_bankName=\\\"show\\\"\\n  ps-showFieldIcon_bankAccountRepeat=\\\"show\\\"\\n  ps-showFieldIcon_bankExternalId=\\\"show\\\"\\n>\\n  Pay Now - Show field icons\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Show field icons\"\n    }\n  ]\n}\n[/block]\n## Misc\n\n### Click event\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-click=\\\"onButtonClick('some_data')\\\"\\n>\\n  Pay Now - Click event\\n</button>\\n\\n<script type=\\\"text/javascript\\\">\\n  \\n  // example function\\n  function onButtonClick(value) {\\n    return {\\n      \\\"paymentAmount\\\": \\\"20.43\\\"\\n    }\\n  }\\n  \\n</script>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Click event\"\n    }\n  ]\n}\n[/block]\n### Close on receipt\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.01\\\"\\n  ps-viewReceipt=\\\"close\\\"\\n>\\n  Pay Now - Close on receipt\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Close on receipt\"\n    }\n  ]\n}\n[/block]\n### Hide security notice\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button\\n  class=\\\"ps-button ps-button-style\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-paymentAmount=\\\"20.76\\\"\\n  ps-viewSecure=\\\"hide\\\"\\n>\\n  Pay Now - Hide security notice\\n</button>\",\n      \"language\": \"html\",\n      \"name\": \"Pay Now - Hide security notice\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"checkout-button-examples","type":"basic","title":"Button Examples","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Button Examples


[block:code] { "codes": [ { "code": "<div id=\"ps_container_id\"></div>\n<script\n type=\"text/javascript\"\n id=\"ps_checkout\"\n src=\"https://checkout.paystand.co/v4/js/paystand.checkout.js\"\n ps-env=\"sandbox\"\n ps-publishableKey=\"1noqhele1yjgieoi8aqe4n8i\"\n ps-containerId=\"ps_container_id\"\n></script>", "language": "html", "name": "Script tag for button examples" } ], "sidebar": true } [/block] ## Button styles ### Styled [block:code] { "codes": [ { "code": "<button\n\tclass=\"ps-button ps-button-style\"\n>\n Pay Now - Styled\n</button>", "language": "html", "name": "Pay Now - Styled" } ] } [/block] ### Unstyled [block:code] { "codes": [ { "code": "<button\n\tclass=\"ps-button\"\n>\n Pay Now - Unstyled\n</button>", "language": "html", "name": "Pay Now - Unstyled" } ] } [/block] ## Checkout types ### Payment [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n>\n Pay Now\n</button>", "language": "html", "name": "Pay Now" } ] } [/block] ### Tokenize [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_token\"\n>\n Save Payment Method\n</button>", "language": "html", "name": "Save Payment Method" } ] } [/block] ### Scheduled Payment [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_scheduled_payment\"\n ps-spName=\"Monthly Rent\"\n ps-spDescription=\"For apartment 201B\"\n ps-spExtId=\"apt201b\"\n ps-spAmount=\"1900\"\n ps-spCurrency=\"USD\"\n ps-spInterval=\"monthly\"\n ps-spIntervalCount=\"1\"\n ps-spAnchor=\"start\"\n ps-spTimesToRun=\"12\"\n>\n Schedule Payment\n</button>", "language": "html", "name": "Schedule Payment" } ] } [/block] ### Custom Preset [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"pay2\"\n ps-viewCheckout=\"mobile\"\n>\n Pay Now\n</button>", "language": "html", "name": "Pay Now" } ] } [/block] ## Payment amount ### Editable amount [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.25\"\n>\n Pay Now - $20.25\n</button>", "language": "html", "name": "Pay Now - $20.25" } ] } [/block] ### Fixed amount [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-fixedAmount=\"true\"\n ps-paymentAmount=\"20.59\"\n>\n Pay Now - $20.59\n</button>", "language": "html", "name": "Pay Now - $20.59" } ] } [/block] ## Checkout display ### Width/height [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.13\"\n ps-width=\"700px\"\n ps-height=\"700px\"\n>\n Pay Now - 700px x 700x\n</button>", "language": "html", "name": "Pay Now - $20.13" } ] } [/block] ### Close button [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.97\"\n ps-viewClose=\"hide\"\n>\n Pay Now - No close button\n</button>", "language": "html", "name": "Pay Now - No close button" } ] } [/block] ### Portal view [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.23\"\n ps-width=\"900px\"\n ps-height=\"700px\"\n ps-viewCheckout=\"portal\"\n ps-viewClose=\"show\"\n>\n Pay Now - Portal view\n</button>", "language": "html", "name": "Pay Now - Portal view" } ] } [/block] ### Mobile view [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.97\"\n ps-viewCheckout=\"mobile\"\n ps-viewClose=\"show\"\n>\n Pay Now - Mobile view\n</button>", "language": "html", "name": "Pay Now - Mobile view" } ] } [/block] ## Resource data ### Payer data [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"50.00\"\n ps-payerName=\"John Doe Payer\"\n ps-payerEmail=\"john.doe@paystand.com\"\n ps-payerAddressStreet=\"123 Alliance Ln\"\n ps-payerAddressCity=\"Santa Cruz\"\n ps-payerAddressState=\"CA\"\n ps-payerAddressCountry=\"USA\"\n ps-payerAddressPostal=\"95060\"\n ps-payerExternalId=\"payer_external_id\"\n ps-payerMeta='{\"payer\": \"meta\"}'\n>\n Pay Now - Payer data\n</button>", "language": "html", "name": "Pay Now - Payer data" } ] } [/block] ### Card data [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"50.00\"\n ps-cardName=\"John Doe - Card\"\n ps-cardNumber=\"4242424242424242\"\n ps-cardMonth=\"10\"\n ps-cardYear=\"20\"\n ps-cardCode=\"123\"\n ps-cardExternalId=\"card_external_id\"\n ps-cardMeta='{\"card\": \"meta\"}'\n>\n Pay Now - Card data\n</button>", "language": "html", "name": "Pay Now - Card data" } ] } [/block] ### Bank data [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"50.00\"\n ps-bankNameOnAccount=\"John Doe - Bank\"\n ps-bankAccountType=\"checking\"\n ps-bankAccountHolderType=\"company\"\n ps-bankRouting=\"110000000\"\n ps-bankAccount=\"000123456789\"\n ps-bankAccountRepeat=\"000123456789\"\n ps-bankExternalId=\"bank_external_id\"\n ps-bankMeta='{\"bank\": \"meta\"}'\n>\n Pay Now - Bank data\n</button>", "language": "html", "name": "Pay Now - Bank data" } ] } [/block] ### Custom field data [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"50.00\"\n ps-cf_first_name=\"First Name Custom Field\"\n>\n Pay Now - Custom field data\n</button>", "language": "html", "name": "Pay Now - Custom field data" } ] } [/block] ## Embed/Modal mode ### Embed [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.98\"\n ps-mode=\"embed\"\n>\n Pay Now - Embed\n</button>", "language": "html", "name": "Pay Now - Embed" } ] } [/block] ### Modal [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.98\"\n ps-mode=\"modal\"\n>\n Pay Now - Modal\n</button>", "language": "html", "name": "Pay Now - Modal" } ] } [/block] ## Header ### Header color [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.24\"\n ps-headerColor=\"darkred\"\n>\n Pay Now - Header color\n</button>", "language": "html", "name": "Pay Now - Header color" } ] } [/block] ### Hide logo [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.77\"\n ps-viewLogo=\"hide\"\n>\n Pay Now - Hide logo\n</button>", "language": "html", "name": "Pay Now - Hide logo" } ] } [/block] ### Custom logo [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.19\"\n ps-logoUrl=\"http://www.image360.com/assets/live/0/34/59/115/118/design-output-services-logo-creation-national-log001.jpg?width=330&height=290&mode=crop&scale=both\"\n ps-logoBdColor=\"#555\"\n ps-logoBgColor=\"#000\"\n ps-logoWidth=\"90px\"\n ps-logoHeight=\"100px\"\n>\n Pay Now - Custom logo\n</button>", "language": "html", "name": "Pay Now - Custom logo" } ] } [/block] ## Custom css [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.19\"\n ps-externalCss=\"../js/paystand.checkout.external.css\"\n>\n Pay Now - Custom css\n</button>", "language": "html", "name": "Pay Now - Custom css" } ] } [/block] ## Payment methods ### Ordering [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.95\"\n ps-viewFunds=\"card,ach,echeck\"\n>\n Pay Now - Payment methods - ordering\n</button>", "language": "html", "name": "Pay Now - Payment methods - ordering" } ] } [/block] ### Removing [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.46\"\n ps-viewFunds=\"card,echeck\"\n>\n Pay Now - Payment methods - removing\n</button>", "language": "html", "name": "Pay Now - Payment methods - removing" } ] } [/block] ### Labels [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.33\"\n ps-setFundSelector_bankSessionTabText=\"1. eCheck\"\n ps-setFundSelector_cardTabText=\"2. Card\"\n ps-setFundSelector_bankTabText=\"3. Bank\"\n>\n Pay Now - Payment methods - labels\n</button>", "language": "html", "name": "Pay Now - Payment methods - labels" } ] } [/block] ### Layout [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.97\"\n ps-setLayout_fundSelect=\"tabs\"\n>\n Pay Now - Payment methods - layout\n</button>", "language": "html", "name": "Pay Now - Payment methods - layout" } ] } [/block] ## Labels and fields ### Section headers [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.03\"\n ps-showHeader_cardHeader=\"show\"\n ps-setHeader_cardHeader=\"Card Details\"\n ps-showHeader_bankHeader=\"show\"\n ps-setHeader_bankHeader=\"Bank Details\"\n ps-showHeader_payerHeader=\"show\"\n ps-setHeader_payerHeader=\"Payer Details\"\n>\n Pay Now - Section headers\n</button>", "language": "html", "name": "Pay Now - Section headers" } ] } [/block] ### Show External Id fields [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.99\"\n ps-viewExtIds=\"card,bank,payer\"\n>\n Pay Now - Show External Id fields\n</button>", "language": "html", "name": "Pay Now - Show External Id fields" } ] } [/block] ### Show field labels [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.21\"\n ps-viewLabels=\"show\"\n>\n Pay Now - Show field labels\n</button>", "language": "html", "name": "Pay Now - Show field labels" } ] } [/block] ### Set field placeholders [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.22\"\n ps-viewPlaceholders=\"show\"\n ps-setPlaceholder_cardExternalId=\"Card external id placeholder\"\n ps-setPlaceholder_cardName=\"Name on card placeholder\"\n ps-setPlaceholder_cardNumber=\"Card number placeholder\"\n ps-setPlaceholder_cardExpiry=\"Card expiry placeholder\"\n ps-setPlaceholder_cardSecurityCode=\"Card security code placeholder\"\n ps-setPlaceholder_bankNameOnAccount=\"Name on account placeholder\"\n ps-setPlaceholder_bankAccountHolderType=\"Account holder type placeholder\"\n ps-setPlaceholder_bankRouting=\"Routing placeholder\"\n ps-setPlaceholder_bankAccount=\"Account placeholder\"\n ps-setPlaceholder_bankName=\"Bank name placeholder\"\n ps-setPlaceholder_bankAccountRepeat=\"Account repeat placeholder\"\n ps-setPlaceholder_bankExternalId=\"External Id placeholder\"\n ps-setPlaceholder_payerEmail=\"Payer email placeholder\"\n ps-setPlaceholder_payerAddressStreet=\"Street placeholder\"\n ps-setPlaceholder_payerAddressCity=\"City placeholder\"\n ps-setPlaceholder_payerAddressPostal=\"Postal placeholder\"\n ps-setPlaceholder_payerAddressState=\"State placeholder\"\n ps-setPlaceholder_payerAddressCountry=\"Country placeholder\"\n>\n Pay Now - Set field placeholders\n</button>", "language": "html", "name": "Pay Now - Set field placeholders" } ] } [/block] ### Set field labels [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.22\"\n ps-viewLabels=\"show\"\n ps-setLabel_cardExternalId=\"Card external id label\"\n ps-setLabel_cardName=\"Name on card label\"\n ps-setLabel_cardNumber=\"Card number label\"\n ps-setLabel_cardExpiry=\"Card expiry label\"\n ps-setLabel_cardSecurityCode=\"Card security code label\"\n ps-setLabel_bankNameOnAccount=\"Name on account label\"\n ps-setLabel_bankAccountHolderType=\"Account holder type label\"\n ps-setLabel_bankRouting=\"Routing label\"\n ps-setLabel_bankAccount=\"Account label\"\n ps-setLabel_bankName=\"Bank name label\"\n ps-setLabel_bankAccountRepeat=\"Account repeat label\"\n ps-setLabel_bankExternalId=\"External Id label\"\n ps-setLabel_payerEmail=\"Payer email label\"\n ps-setLabel_payerAddressStreet=\"Street label\"\n ps-setLabel_payerAddressCity=\"City label\"\n ps-setLabel_payerAddressPostal=\"Postal label\"\n ps-setLabel_payerAddressState=\"State label\"\n ps-setLabel_payerAddressCountry=\"Country label\"\n>\n Pay Now - Set field labels\n</button>", "language": "html", "name": "Pay Now - Set field labels" } ] } [/block] ### Set field icon [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.22\"\n ps-setFieldIcon_payerEmail=\"done\"\n ps-setFieldIcon_payerAddressStreet=\"done\"\n ps-setFieldIcon_payerAddressCity=\"done\"\n ps-setFieldIcon_payerAddressPostal=\"done\"\n ps-setFieldIcon_payerAddressState=\"done\"\n ps-setFieldIcon_payerAddressCountry=\"done\"\n ps-setFieldIcon_cardExternalId=\"done\"\n ps-setFieldIcon_cardName=\"done\"\n ps-setFieldIcon_cardNumber=\"done\"\n ps-setFieldIcon_cardExpiry=\"done\"\n ps-setFieldIcon_cardSecurityCode=\"done\"\n ps-setFieldIcon_bankNameOnAccount=\"done\"\n ps-setFieldIcon_bankAccountHolderType=\"done\"\n ps-setFieldIcon_bankRouting=\"done\"\n ps-setFieldIcon_bankAccount=\"done\"\n ps-setFieldIcon_bankName=\"done\"\n ps-setFieldIcon_bankAccountRepeat=\"done\"\n ps-setFieldIcon_bankExternalId=\"done\"\n>\n Pay Now - Set field icons\n</button>", "language": "html", "name": "Pay Now - Set field icons" } ] } [/block] ### Show fields [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.22\"\n ps-showField_payerEmail=\"show\"\n ps-showField_payerAddressStreet=\"show\"\n ps-showField_payerAddressCity=\"show\"\n ps-showField_payerAddressPostal=\"show\"\n ps-showField_payerAddressState=\"show\"\n ps-showField_payerAddressCountry=\"show\"\n ps-showField_cardExternalId=\"show\"\n ps-showField_cardName=\"show\"\n ps-showField_cardNumber=\"show\"\n ps-showField_cardExpiry=\"show\"\n ps-showField_cardSecurityCode=\"show\"\n ps-showField_bankNameOnAccount=\"show\"\n ps-showField_bankAccountHolderType=\"show\"\n ps-showField_bankRouting=\"show\"\n ps-showField_bankAccount=\"show\"\n ps-showField_bankName=\"show\"\n ps-showField_bankAccountRepeat=\"show\"\n ps-showField_bankExternalId=\"show\"\n>\n Pay Now - Show fields\n</button>", "language": "html", "name": "Pay Now - Show fields" } ] } [/block] ### Show field icons [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.22\"\n ps-showFieldIcon_payerEmail=\"show\"\n ps-showFieldIcon_payerAddressStreet=\"show\"\n ps-showFieldIcon_payerAddressCity=\"show\"\n ps-showFieldIcon_payerAddressPostal=\"show\"\n ps-showFieldIcon_payerAddressState=\"show\"\n ps-showFieldIcon_payerAddressCountry=\"show\"\n ps-showFieldIcon_cardExternalId=\"show\"\n ps-showFieldIcon_cardName=\"show\"\n ps-showFieldIcon_cardNumber=\"show\"\n ps-showFieldIcon_cardExpiry=\"show\"\n ps-showFieldIcon_cardSecurityCode=\"show\"\n ps-showFieldIcon_bankNameOnAccount=\"show\"\n ps-showFieldIcon_bankAccountHolderType=\"show\"\n ps-showFieldIcon_bankRouting=\"show\"\n ps-showFieldIcon_bankAccount=\"show\"\n ps-showFieldIcon_bankName=\"show\"\n ps-showFieldIcon_bankAccountRepeat=\"show\"\n ps-showFieldIcon_bankExternalId=\"show\"\n>\n Pay Now - Show field icons\n</button>", "language": "html", "name": "Pay Now - Show field icons" } ] } [/block] ## Misc ### Click event [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-click=\"onButtonClick('some_data')\"\n>\n Pay Now - Click event\n</button>\n\n<script type=\"text/javascript\">\n \n // example function\n function onButtonClick(value) {\n return {\n \"paymentAmount\": \"20.43\"\n }\n }\n \n</script>", "language": "html", "name": "Pay Now - Click event" } ] } [/block] ### Close on receipt [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.01\"\n ps-viewReceipt=\"close\"\n>\n Pay Now - Close on receipt\n</button>", "language": "html", "name": "Pay Now - Close on receipt" } ] } [/block] ### Hide security notice [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.76\"\n ps-viewSecure=\"hide\"\n>\n Pay Now - Hide security notice\n</button>", "language": "html", "name": "Pay Now - Hide security notice" } ] } [/block]
[block:code] { "codes": [ { "code": "<div id=\"ps_container_id\"></div>\n<script\n type=\"text/javascript\"\n id=\"ps_checkout\"\n src=\"https://checkout.paystand.co/v4/js/paystand.checkout.js\"\n ps-env=\"sandbox\"\n ps-publishableKey=\"1noqhele1yjgieoi8aqe4n8i\"\n ps-containerId=\"ps_container_id\"\n></script>", "language": "html", "name": "Script tag for button examples" } ], "sidebar": true } [/block] ## Button styles ### Styled [block:code] { "codes": [ { "code": "<button\n\tclass=\"ps-button ps-button-style\"\n>\n Pay Now - Styled\n</button>", "language": "html", "name": "Pay Now - Styled" } ] } [/block] ### Unstyled [block:code] { "codes": [ { "code": "<button\n\tclass=\"ps-button\"\n>\n Pay Now - Unstyled\n</button>", "language": "html", "name": "Pay Now - Unstyled" } ] } [/block] ## Checkout types ### Payment [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n>\n Pay Now\n</button>", "language": "html", "name": "Pay Now" } ] } [/block] ### Tokenize [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_token\"\n>\n Save Payment Method\n</button>", "language": "html", "name": "Save Payment Method" } ] } [/block] ### Scheduled Payment [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_scheduled_payment\"\n ps-spName=\"Monthly Rent\"\n ps-spDescription=\"For apartment 201B\"\n ps-spExtId=\"apt201b\"\n ps-spAmount=\"1900\"\n ps-spCurrency=\"USD\"\n ps-spInterval=\"monthly\"\n ps-spIntervalCount=\"1\"\n ps-spAnchor=\"start\"\n ps-spTimesToRun=\"12\"\n>\n Schedule Payment\n</button>", "language": "html", "name": "Schedule Payment" } ] } [/block] ### Custom Preset [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"pay2\"\n ps-viewCheckout=\"mobile\"\n>\n Pay Now\n</button>", "language": "html", "name": "Pay Now" } ] } [/block] ## Payment amount ### Editable amount [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.25\"\n>\n Pay Now - $20.25\n</button>", "language": "html", "name": "Pay Now - $20.25" } ] } [/block] ### Fixed amount [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-fixedAmount=\"true\"\n ps-paymentAmount=\"20.59\"\n>\n Pay Now - $20.59\n</button>", "language": "html", "name": "Pay Now - $20.59" } ] } [/block] ## Checkout display ### Width/height [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.13\"\n ps-width=\"700px\"\n ps-height=\"700px\"\n>\n Pay Now - 700px x 700x\n</button>", "language": "html", "name": "Pay Now - $20.13" } ] } [/block] ### Close button [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.97\"\n ps-viewClose=\"hide\"\n>\n Pay Now - No close button\n</button>", "language": "html", "name": "Pay Now - No close button" } ] } [/block] ### Portal view [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.23\"\n ps-width=\"900px\"\n ps-height=\"700px\"\n ps-viewCheckout=\"portal\"\n ps-viewClose=\"show\"\n>\n Pay Now - Portal view\n</button>", "language": "html", "name": "Pay Now - Portal view" } ] } [/block] ### Mobile view [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.97\"\n ps-viewCheckout=\"mobile\"\n ps-viewClose=\"show\"\n>\n Pay Now - Mobile view\n</button>", "language": "html", "name": "Pay Now - Mobile view" } ] } [/block] ## Resource data ### Payer data [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"50.00\"\n ps-payerName=\"John Doe Payer\"\n ps-payerEmail=\"john.doe@paystand.com\"\n ps-payerAddressStreet=\"123 Alliance Ln\"\n ps-payerAddressCity=\"Santa Cruz\"\n ps-payerAddressState=\"CA\"\n ps-payerAddressCountry=\"USA\"\n ps-payerAddressPostal=\"95060\"\n ps-payerExternalId=\"payer_external_id\"\n ps-payerMeta='{\"payer\": \"meta\"}'\n>\n Pay Now - Payer data\n</button>", "language": "html", "name": "Pay Now - Payer data" } ] } [/block] ### Card data [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"50.00\"\n ps-cardName=\"John Doe - Card\"\n ps-cardNumber=\"4242424242424242\"\n ps-cardMonth=\"10\"\n ps-cardYear=\"20\"\n ps-cardCode=\"123\"\n ps-cardExternalId=\"card_external_id\"\n ps-cardMeta='{\"card\": \"meta\"}'\n>\n Pay Now - Card data\n</button>", "language": "html", "name": "Pay Now - Card data" } ] } [/block] ### Bank data [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"50.00\"\n ps-bankNameOnAccount=\"John Doe - Bank\"\n ps-bankAccountType=\"checking\"\n ps-bankAccountHolderType=\"company\"\n ps-bankRouting=\"110000000\"\n ps-bankAccount=\"000123456789\"\n ps-bankAccountRepeat=\"000123456789\"\n ps-bankExternalId=\"bank_external_id\"\n ps-bankMeta='{\"bank\": \"meta\"}'\n>\n Pay Now - Bank data\n</button>", "language": "html", "name": "Pay Now - Bank data" } ] } [/block] ### Custom field data [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"50.00\"\n ps-cf_first_name=\"First Name Custom Field\"\n>\n Pay Now - Custom field data\n</button>", "language": "html", "name": "Pay Now - Custom field data" } ] } [/block] ## Embed/Modal mode ### Embed [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.98\"\n ps-mode=\"embed\"\n>\n Pay Now - Embed\n</button>", "language": "html", "name": "Pay Now - Embed" } ] } [/block] ### Modal [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.98\"\n ps-mode=\"modal\"\n>\n Pay Now - Modal\n</button>", "language": "html", "name": "Pay Now - Modal" } ] } [/block] ## Header ### Header color [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.24\"\n ps-headerColor=\"darkred\"\n>\n Pay Now - Header color\n</button>", "language": "html", "name": "Pay Now - Header color" } ] } [/block] ### Hide logo [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.77\"\n ps-viewLogo=\"hide\"\n>\n Pay Now - Hide logo\n</button>", "language": "html", "name": "Pay Now - Hide logo" } ] } [/block] ### Custom logo [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.19\"\n ps-logoUrl=\"http://www.image360.com/assets/live/0/34/59/115/118/design-output-services-logo-creation-national-log001.jpg?width=330&height=290&mode=crop&scale=both\"\n ps-logoBdColor=\"#555\"\n ps-logoBgColor=\"#000\"\n ps-logoWidth=\"90px\"\n ps-logoHeight=\"100px\"\n>\n Pay Now - Custom logo\n</button>", "language": "html", "name": "Pay Now - Custom logo" } ] } [/block] ## Custom css [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.19\"\n ps-externalCss=\"../js/paystand.checkout.external.css\"\n>\n Pay Now - Custom css\n</button>", "language": "html", "name": "Pay Now - Custom css" } ] } [/block] ## Payment methods ### Ordering [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.95\"\n ps-viewFunds=\"card,ach,echeck\"\n>\n Pay Now - Payment methods - ordering\n</button>", "language": "html", "name": "Pay Now - Payment methods - ordering" } ] } [/block] ### Removing [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.46\"\n ps-viewFunds=\"card,echeck\"\n>\n Pay Now - Payment methods - removing\n</button>", "language": "html", "name": "Pay Now - Payment methods - removing" } ] } [/block] ### Labels [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.33\"\n ps-setFundSelector_bankSessionTabText=\"1. eCheck\"\n ps-setFundSelector_cardTabText=\"2. Card\"\n ps-setFundSelector_bankTabText=\"3. Bank\"\n>\n Pay Now - Payment methods - labels\n</button>", "language": "html", "name": "Pay Now - Payment methods - labels" } ] } [/block] ### Layout [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.97\"\n ps-setLayout_fundSelect=\"tabs\"\n>\n Pay Now - Payment methods - layout\n</button>", "language": "html", "name": "Pay Now - Payment methods - layout" } ] } [/block] ## Labels and fields ### Section headers [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.03\"\n ps-showHeader_cardHeader=\"show\"\n ps-setHeader_cardHeader=\"Card Details\"\n ps-showHeader_bankHeader=\"show\"\n ps-setHeader_bankHeader=\"Bank Details\"\n ps-showHeader_payerHeader=\"show\"\n ps-setHeader_payerHeader=\"Payer Details\"\n>\n Pay Now - Section headers\n</button>", "language": "html", "name": "Pay Now - Section headers" } ] } [/block] ### Show External Id fields [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.99\"\n ps-viewExtIds=\"card,bank,payer\"\n>\n Pay Now - Show External Id fields\n</button>", "language": "html", "name": "Pay Now - Show External Id fields" } ] } [/block] ### Show field labels [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.21\"\n ps-viewLabels=\"show\"\n>\n Pay Now - Show field labels\n</button>", "language": "html", "name": "Pay Now - Show field labels" } ] } [/block] ### Set field placeholders [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.22\"\n ps-viewPlaceholders=\"show\"\n ps-setPlaceholder_cardExternalId=\"Card external id placeholder\"\n ps-setPlaceholder_cardName=\"Name on card placeholder\"\n ps-setPlaceholder_cardNumber=\"Card number placeholder\"\n ps-setPlaceholder_cardExpiry=\"Card expiry placeholder\"\n ps-setPlaceholder_cardSecurityCode=\"Card security code placeholder\"\n ps-setPlaceholder_bankNameOnAccount=\"Name on account placeholder\"\n ps-setPlaceholder_bankAccountHolderType=\"Account holder type placeholder\"\n ps-setPlaceholder_bankRouting=\"Routing placeholder\"\n ps-setPlaceholder_bankAccount=\"Account placeholder\"\n ps-setPlaceholder_bankName=\"Bank name placeholder\"\n ps-setPlaceholder_bankAccountRepeat=\"Account repeat placeholder\"\n ps-setPlaceholder_bankExternalId=\"External Id placeholder\"\n ps-setPlaceholder_payerEmail=\"Payer email placeholder\"\n ps-setPlaceholder_payerAddressStreet=\"Street placeholder\"\n ps-setPlaceholder_payerAddressCity=\"City placeholder\"\n ps-setPlaceholder_payerAddressPostal=\"Postal placeholder\"\n ps-setPlaceholder_payerAddressState=\"State placeholder\"\n ps-setPlaceholder_payerAddressCountry=\"Country placeholder\"\n>\n Pay Now - Set field placeholders\n</button>", "language": "html", "name": "Pay Now - Set field placeholders" } ] } [/block] ### Set field labels [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.22\"\n ps-viewLabels=\"show\"\n ps-setLabel_cardExternalId=\"Card external id label\"\n ps-setLabel_cardName=\"Name on card label\"\n ps-setLabel_cardNumber=\"Card number label\"\n ps-setLabel_cardExpiry=\"Card expiry label\"\n ps-setLabel_cardSecurityCode=\"Card security code label\"\n ps-setLabel_bankNameOnAccount=\"Name on account label\"\n ps-setLabel_bankAccountHolderType=\"Account holder type label\"\n ps-setLabel_bankRouting=\"Routing label\"\n ps-setLabel_bankAccount=\"Account label\"\n ps-setLabel_bankName=\"Bank name label\"\n ps-setLabel_bankAccountRepeat=\"Account repeat label\"\n ps-setLabel_bankExternalId=\"External Id label\"\n ps-setLabel_payerEmail=\"Payer email label\"\n ps-setLabel_payerAddressStreet=\"Street label\"\n ps-setLabel_payerAddressCity=\"City label\"\n ps-setLabel_payerAddressPostal=\"Postal label\"\n ps-setLabel_payerAddressState=\"State label\"\n ps-setLabel_payerAddressCountry=\"Country label\"\n>\n Pay Now - Set field labels\n</button>", "language": "html", "name": "Pay Now - Set field labels" } ] } [/block] ### Set field icon [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.22\"\n ps-setFieldIcon_payerEmail=\"done\"\n ps-setFieldIcon_payerAddressStreet=\"done\"\n ps-setFieldIcon_payerAddressCity=\"done\"\n ps-setFieldIcon_payerAddressPostal=\"done\"\n ps-setFieldIcon_payerAddressState=\"done\"\n ps-setFieldIcon_payerAddressCountry=\"done\"\n ps-setFieldIcon_cardExternalId=\"done\"\n ps-setFieldIcon_cardName=\"done\"\n ps-setFieldIcon_cardNumber=\"done\"\n ps-setFieldIcon_cardExpiry=\"done\"\n ps-setFieldIcon_cardSecurityCode=\"done\"\n ps-setFieldIcon_bankNameOnAccount=\"done\"\n ps-setFieldIcon_bankAccountHolderType=\"done\"\n ps-setFieldIcon_bankRouting=\"done\"\n ps-setFieldIcon_bankAccount=\"done\"\n ps-setFieldIcon_bankName=\"done\"\n ps-setFieldIcon_bankAccountRepeat=\"done\"\n ps-setFieldIcon_bankExternalId=\"done\"\n>\n Pay Now - Set field icons\n</button>", "language": "html", "name": "Pay Now - Set field icons" } ] } [/block] ### Show fields [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.22\"\n ps-showField_payerEmail=\"show\"\n ps-showField_payerAddressStreet=\"show\"\n ps-showField_payerAddressCity=\"show\"\n ps-showField_payerAddressPostal=\"show\"\n ps-showField_payerAddressState=\"show\"\n ps-showField_payerAddressCountry=\"show\"\n ps-showField_cardExternalId=\"show\"\n ps-showField_cardName=\"show\"\n ps-showField_cardNumber=\"show\"\n ps-showField_cardExpiry=\"show\"\n ps-showField_cardSecurityCode=\"show\"\n ps-showField_bankNameOnAccount=\"show\"\n ps-showField_bankAccountHolderType=\"show\"\n ps-showField_bankRouting=\"show\"\n ps-showField_bankAccount=\"show\"\n ps-showField_bankName=\"show\"\n ps-showField_bankAccountRepeat=\"show\"\n ps-showField_bankExternalId=\"show\"\n>\n Pay Now - Show fields\n</button>", "language": "html", "name": "Pay Now - Show fields" } ] } [/block] ### Show field icons [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.22\"\n ps-showFieldIcon_payerEmail=\"show\"\n ps-showFieldIcon_payerAddressStreet=\"show\"\n ps-showFieldIcon_payerAddressCity=\"show\"\n ps-showFieldIcon_payerAddressPostal=\"show\"\n ps-showFieldIcon_payerAddressState=\"show\"\n ps-showFieldIcon_payerAddressCountry=\"show\"\n ps-showFieldIcon_cardExternalId=\"show\"\n ps-showFieldIcon_cardName=\"show\"\n ps-showFieldIcon_cardNumber=\"show\"\n ps-showFieldIcon_cardExpiry=\"show\"\n ps-showFieldIcon_cardSecurityCode=\"show\"\n ps-showFieldIcon_bankNameOnAccount=\"show\"\n ps-showFieldIcon_bankAccountHolderType=\"show\"\n ps-showFieldIcon_bankRouting=\"show\"\n ps-showFieldIcon_bankAccount=\"show\"\n ps-showFieldIcon_bankName=\"show\"\n ps-showFieldIcon_bankAccountRepeat=\"show\"\n ps-showFieldIcon_bankExternalId=\"show\"\n>\n Pay Now - Show field icons\n</button>", "language": "html", "name": "Pay Now - Show field icons" } ] } [/block] ## Misc ### Click event [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-click=\"onButtonClick('some_data')\"\n>\n Pay Now - Click event\n</button>\n\n<script type=\"text/javascript\">\n \n // example function\n function onButtonClick(value) {\n return {\n \"paymentAmount\": \"20.43\"\n }\n }\n \n</script>", "language": "html", "name": "Pay Now - Click event" } ] } [/block] ### Close on receipt [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.01\"\n ps-viewReceipt=\"close\"\n>\n Pay Now - Close on receipt\n</button>", "language": "html", "name": "Pay Now - Close on receipt" } ] } [/block] ### Hide security notice [block:code] { "codes": [ { "code": "<button\n class=\"ps-button ps-button-style\"\n ps-checkoutType=\"checkout_payment\"\n ps-paymentAmount=\"20.76\"\n ps-viewSecure=\"hide\"\n>\n Pay Now - Hide security notice\n</button>", "language": "html", "name": "Pay Now - Hide security notice" } ] } [/block]
{"_id":"5d56fccfb1b7fc00334d197e","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d191f","user":"55dd080d0efd5821000d53b3","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-14T06:42:20.196Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"To autoload a checkout once a page loads, add an element containing ```id=\"ps_checkout_load\"```. Most attributes that are available to be added to buttons can also be added to the autoload element. Upon a page loading, a checkout will render with the configuration specified on the autoload element.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<div id=\\\"ps_container_id\\\"></div>\\n\\n<div\\n  id=\\\"ps_checkout_load\\\"\\n  ps-checkoutType=\\\"checkout_payment\\\"\\n  ps-mode=\\\"embed\\\"\\n></div>\\n\\n<script\\n  type=\\\"text/javascript\\\"\\n  id=\\\"ps_checkout\\\"\\n  src=\\\"https://checkout.paystand.co/v4/js/paystand.checkout.js\\\"\\n  ps-env=\\\"sandbox\\\"\\n  ps-publishableKey=\\\"1noqhele1yjgieoi8aqe4n8i\\\"\\n  ps-containerId=\\\"ps_container_id\\\"\\n></script>\",\n      \"language\": \"html\",\n      \"name\": \"Embed example\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Autoloading Embed vs Modal Checkout\",\n  \"body\": \"Though the main use case for the Autoloading feature is an embedded checkout, which you most likely would like to show up immediately when the page loads, it can also be used in modal mode. The autoloading modal experience is similar a browser application printer dialog when it generates an HTML or PDF to print in a different tab or window.\"\n}\n[/block]","excerpt":"","slug":"checkout-autoloading-example","type":"basic","title":"Autoloading Example","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Autoloading Example


To autoload a checkout once a page loads, add an element containing ```id="ps_checkout_load"```. Most attributes that are available to be added to buttons can also be added to the autoload element. Upon a page loading, a checkout will render with the configuration specified on the autoload element. [block:code] { "codes": [ { "code": "<div id=\"ps_container_id\"></div>\n\n<div\n id=\"ps_checkout_load\"\n ps-checkoutType=\"checkout_payment\"\n ps-mode=\"embed\"\n></div>\n\n<script\n type=\"text/javascript\"\n id=\"ps_checkout\"\n src=\"https://checkout.paystand.co/v4/js/paystand.checkout.js\"\n ps-env=\"sandbox\"\n ps-publishableKey=\"1noqhele1yjgieoi8aqe4n8i\"\n ps-containerId=\"ps_container_id\"\n></script>", "language": "html", "name": "Embed example" } ] } [/block] [block:callout] { "type": "info", "title": "Autoloading Embed vs Modal Checkout", "body": "Though the main use case for the Autoloading feature is an embedded checkout, which you most likely would like to show up immediately when the page loads, it can also be used in modal mode. The autoloading modal experience is similar a browser application printer dialog when it generates an HTML or PDF to print in a different tab or window." } [/block]
To autoload a checkout once a page loads, add an element containing ```id="ps_checkout_load"```. Most attributes that are available to be added to buttons can also be added to the autoload element. Upon a page loading, a checkout will render with the configuration specified on the autoload element. [block:code] { "codes": [ { "code": "<div id=\"ps_container_id\"></div>\n\n<div\n id=\"ps_checkout_load\"\n ps-checkoutType=\"checkout_payment\"\n ps-mode=\"embed\"\n></div>\n\n<script\n type=\"text/javascript\"\n id=\"ps_checkout\"\n src=\"https://checkout.paystand.co/v4/js/paystand.checkout.js\"\n ps-env=\"sandbox\"\n ps-publishableKey=\"1noqhele1yjgieoi8aqe4n8i\"\n ps-containerId=\"ps_container_id\"\n></script>", "language": "html", "name": "Embed example" } ] } [/block] [block:callout] { "type": "info", "title": "Autoloading Embed vs Modal Checkout", "body": "Though the main use case for the Autoloading feature is an embedded checkout, which you most likely would like to show up immediately when the page loads, it can also be used in modal mode. The autoloading modal experience is similar a browser application printer dialog when it generates an HTML or PDF to print in a different tab or window." } [/block]
{"_id":"5d56fccfb1b7fc00334d197f","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d191f","user":"55dd080d0efd5821000d53b3","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-14T06:43:04.395Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"## Load checkout\n\nIts important to wait for the ```onReady``` event before attempting to modify checkout so that the checkout client code has an opportunity to connect to the checkout instance in order to open a line of communication. Once checkout is ready, we can send ```reboot``` checkout with a new config. Here, we reboot checkout as a payment modal checkout with a fixed amount of ```$25.34```.\n\nNotice the ```.showCheckout()``` at the end of the ```reboot``` statement. We are telling checkout to show itself. The ```showCheckout``` command does not wait for the ```reboot``` command to complete. The ```reboot``` command gets sent to the checkout instance, the checkout instance will begin to reboot, and while it is rebooting the ```showCheckout``` command is also sent. The result will be checkout immediately being displayed with a progress bar indicating that it is rebooting.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\n// checkout is ready\\npsCheckout.onReady(function () {\\n\\n  // reboot checkout with a new config\\n  psCheckout.reboot({\\n    \\\"checkoutType\\\": \\\"checkout_payment\\\",\\n    \\\"mode\\\": \\\"modal\\\",\\n    \\\"paymentAmount\\\": \\\"25.34\\\",\\n    \\\"fixedAmount\\\": \\\"true\\\"\\n  }).showCheckout();\\n\\n});\\n\",\n      \"language\": \"javascript\",\n      \"name\": \"Chaining Commands Example\"\n    }\n  ]\n}\n[/block]\nMost checkout commands can be chained together, as ```showCheckout``` was chained to the ```reboot``` command above. Chaining is optional. An alternative way to write the above code would be:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\n// checkout is ready\\npsCheckout.onReady(function () {\\n\\n  // reboot checkout with a new config\\n  psCheckout.reboot({\\n    \\\"checkoutType\\\": \\\"checkout_payment\\\",\\n    \\\"mode\\\": \\\"modal\\\",\\n    \\\"paymentAmount\\\": \\\"25.34\\\",\\n    \\\"fixedAmount\\\": \\\"true\\\"\\n  })\\n  // show checkout\\n  psCheckout.showCheckout();\\n\\n});\\n\",\n      \"language\": \"javascript\",\n      \"name\": \"Individual Commands Example\"\n    }\n  ]\n}\n[/block]\n## Wait for checkout to load\n\nIt is nice to see a loading bar while the checkout is loading but sometimes finer control over what a user sees during the reboot process is needed. Below, the showing of checkout is delayed until checkout has fully loaded.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\n// checkout is ready\\npsCheckout.onReady(function () {\\n\\n  // wait for reboot to complete before showing checkout\\n  psCheckout.onceLoaded(function (data) {\\n  psCheckout.showCheckout();\\n  });\\n\\n  // reboot checkout with a new config\\n  psCheckout.reboot({\\n    \\\"checkoutType\\\": \\\"checkout_payment\\\",\\n    \\\"mode\\\": \\\"modal\\\",\\n    \\\"paymentAmount\\\": \\\"25.34\\\",\\n    \\\"fixedAmount\\\": \\\"true\\\"\\n  });\\n\\n});\\n\",\n      \"language\": \"javascript\",\n      \"name\": \"onceLoaded Example\"\n    }\n  ]\n}\n[/block]\nThe code above listens for the ```onceLoaded``` event to fire before showing checkout. Notice that the listener is added to the top of the ```onReady``` callback function. It is imperative that it is defined before the ```reboot``` command is called to avoid a possible race condition. The ```onceLoaded``` method is used just in case there is code elsewhere that may not want to show the checkout during later reboots. If this is not a concern and checkout should always be shown each time a checkout reboots, the following code can be used:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\n// checkout is ready\\npsCheckout.onReady(function () {\\n  \\n  // reboot checkout with a new config\\n  psCheckout.reboot({\\n  \\\"checkoutType\\\": \\\"checkout_payment\\\",\\n  \\\"mode\\\": \\\"modal\\\",\\n  \\\"paymentAmount\\\": \\\"25.34\\\",\\n  \\\"fixedAmount\\\": \\\"true\\\"\\n  });\\n\\n});\\n\\n// wait for reboot to complete before showing checkout\\npsCheckout.onLoaded(function (data) {\\n\\tpsCheckout.showCheckout();\\n});\\n\",\n      \"language\": \"javascript\",\n      \"name\": \"onLoaded Example\"\n    }\n  ]\n}\n[/block]\n## Hide checkout on complete\n\nThe ```onComplete``` command can be used to react to a checkout completing successfully. This can be useful when a user needs to be directed to their next step or when they need to be shown a custom receipt. The example below shows a checkout automatically being hidden on completion.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\n// checkout is ready\\npsCheckout.onReady(function () {\\n  // reboot checkout with a new config\\n  psCheckout.reboot({\\n    \\\"checkoutType\\\": \\\"checkout_payment\\\",\\n    \\\"mode\\\": \\\"modal\\\",\\n    \\\"paymentAmount\\\": \\\"25.34\\\",\\n    \\\"fixedAmount\\\": \\\"true\\\"\\n  });\\n\\n});\\n\\n// wait for reboot to complete before showing checkout\\npsCheckout.onLoaded(function (data) {\\n\\tpsCheckout.showCheckout();\\n});\\n\\n// hide checkout on complete\\npsCheckout.onComplete(function(data){\\n\\tpsCheckout.hideCheckout();\\n});\\n\",\n      \"language\": \"javascript\",\n      \"name\": \"onComplete Example\"\n    }\n  ]\n}\n[/block]\n## Live updates\n\nUnder certain circumstances it may be useful to alter a checkout instance after it has already been booted.\n\nFor instance a checkout may already have been booted based on values in a form on the page in which it has been embedded. When the user updates those values, it would be nice to update checkout without performing an entire reboot.  The ```liveUpdate``` command has been created for exactly such a use case.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\n// checkout is ready\\npsCheckout.onReady(function () {\\n  \\n  // reboot checkout with a new config\\n  psCheckout.reboot({\\n    \\\"checkoutType\\\": \\\"checkout_payment\\\",\\n    \\\"mode\\\": \\\"modal\\\",\\n    \\\"paymentAmount\\\": \\\"25.34\\\",\\n    \\\"fixedAmount\\\": \\\"true\\\"\\n  });\\n\\n});\\n\\n// wait for reboot to complete before showing checkout\\npsCheckout.onLoaded(function () {\\n\\tpsCheckout.showCheckout();\\n});\\n\\n// called from your code on a form update\\nfunction onFormUpdate (data) {\\n  psCheckout.liveUpdate({\\n    \\\"paymentAmount\\\": data.amount,\\n    \\\"payerName\\\": data.name,\\n    \\\"payerEmail\\\": data.email\\n  });\\n}\\n\\n\",\n      \"language\": \"javascript\",\n      \"name\": \"liveUpdate Example\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Most resource related attributes can be updated via a live update. Some, but not all, non-resource related attributes can also be updated via a live update. However some attributes, especially those that require significant changes across the checkout experience, cannot be used in a live update scenario.\",\n  \"title\": \"Not all attributes are available for Live Update\"\n}\n[/block]","excerpt":"","slug":"checkout-api-examples","type":"basic","title":"API Examples","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

API Examples


## Load checkout Its important to wait for the ```onReady``` event before attempting to modify checkout so that the checkout client code has an opportunity to connect to the checkout instance in order to open a line of communication. Once checkout is ready, we can send ```reboot``` checkout with a new config. Here, we reboot checkout as a payment modal checkout with a fixed amount of ```$25.34```. Notice the ```.showCheckout()``` at the end of the ```reboot``` statement. We are telling checkout to show itself. The ```showCheckout``` command does not wait for the ```reboot``` command to complete. The ```reboot``` command gets sent to the checkout instance, the checkout instance will begin to reboot, and while it is rebooting the ```showCheckout``` command is also sent. The result will be checkout immediately being displayed with a progress bar indicating that it is rebooting. [block:code] { "codes": [ { "code": "\n// checkout is ready\npsCheckout.onReady(function () {\n\n // reboot checkout with a new config\n psCheckout.reboot({\n \"checkoutType\": \"checkout_payment\",\n \"mode\": \"modal\",\n \"paymentAmount\": \"25.34\",\n \"fixedAmount\": \"true\"\n }).showCheckout();\n\n});\n", "language": "javascript", "name": "Chaining Commands Example" } ] } [/block] Most checkout commands can be chained together, as ```showCheckout``` was chained to the ```reboot``` command above. Chaining is optional. An alternative way to write the above code would be: [block:code] { "codes": [ { "code": "\n// checkout is ready\npsCheckout.onReady(function () {\n\n // reboot checkout with a new config\n psCheckout.reboot({\n \"checkoutType\": \"checkout_payment\",\n \"mode\": \"modal\",\n \"paymentAmount\": \"25.34\",\n \"fixedAmount\": \"true\"\n })\n // show checkout\n psCheckout.showCheckout();\n\n});\n", "language": "javascript", "name": "Individual Commands Example" } ] } [/block] ## Wait for checkout to load It is nice to see a loading bar while the checkout is loading but sometimes finer control over what a user sees during the reboot process is needed. Below, the showing of checkout is delayed until checkout has fully loaded. [block:code] { "codes": [ { "code": "\n// checkout is ready\npsCheckout.onReady(function () {\n\n // wait for reboot to complete before showing checkout\n psCheckout.onceLoaded(function (data) {\n psCheckout.showCheckout();\n });\n\n // reboot checkout with a new config\n psCheckout.reboot({\n \"checkoutType\": \"checkout_payment\",\n \"mode\": \"modal\",\n \"paymentAmount\": \"25.34\",\n \"fixedAmount\": \"true\"\n });\n\n});\n", "language": "javascript", "name": "onceLoaded Example" } ] } [/block] The code above listens for the ```onceLoaded``` event to fire before showing checkout. Notice that the listener is added to the top of the ```onReady``` callback function. It is imperative that it is defined before the ```reboot``` command is called to avoid a possible race condition. The ```onceLoaded``` method is used just in case there is code elsewhere that may not want to show the checkout during later reboots. If this is not a concern and checkout should always be shown each time a checkout reboots, the following code can be used: [block:code] { "codes": [ { "code": "\n// checkout is ready\npsCheckout.onReady(function () {\n \n // reboot checkout with a new config\n psCheckout.reboot({\n \"checkoutType\": \"checkout_payment\",\n \"mode\": \"modal\",\n \"paymentAmount\": \"25.34\",\n \"fixedAmount\": \"true\"\n });\n\n});\n\n// wait for reboot to complete before showing checkout\npsCheckout.onLoaded(function (data) {\n\tpsCheckout.showCheckout();\n});\n", "language": "javascript", "name": "onLoaded Example" } ] } [/block] ## Hide checkout on complete The ```onComplete``` command can be used to react to a checkout completing successfully. This can be useful when a user needs to be directed to their next step or when they need to be shown a custom receipt. The example below shows a checkout automatically being hidden on completion. [block:code] { "codes": [ { "code": "\n// checkout is ready\npsCheckout.onReady(function () {\n // reboot checkout with a new config\n psCheckout.reboot({\n \"checkoutType\": \"checkout_payment\",\n \"mode\": \"modal\",\n \"paymentAmount\": \"25.34\",\n \"fixedAmount\": \"true\"\n });\n\n});\n\n// wait for reboot to complete before showing checkout\npsCheckout.onLoaded(function (data) {\n\tpsCheckout.showCheckout();\n});\n\n// hide checkout on complete\npsCheckout.onComplete(function(data){\n\tpsCheckout.hideCheckout();\n});\n", "language": "javascript", "name": "onComplete Example" } ] } [/block] ## Live updates Under certain circumstances it may be useful to alter a checkout instance after it has already been booted. For instance a checkout may already have been booted based on values in a form on the page in which it has been embedded. When the user updates those values, it would be nice to update checkout without performing an entire reboot. The ```liveUpdate``` command has been created for exactly such a use case. [block:code] { "codes": [ { "code": "\n// checkout is ready\npsCheckout.onReady(function () {\n \n // reboot checkout with a new config\n psCheckout.reboot({\n \"checkoutType\": \"checkout_payment\",\n \"mode\": \"modal\",\n \"paymentAmount\": \"25.34\",\n \"fixedAmount\": \"true\"\n });\n\n});\n\n// wait for reboot to complete before showing checkout\npsCheckout.onLoaded(function () {\n\tpsCheckout.showCheckout();\n});\n\n// called from your code on a form update\nfunction onFormUpdate (data) {\n psCheckout.liveUpdate({\n \"paymentAmount\": data.amount,\n \"payerName\": data.name,\n \"payerEmail\": data.email\n });\n}\n\n", "language": "javascript", "name": "liveUpdate Example" } ] } [/block] [block:callout] { "type": "warning", "body": "Most resource related attributes can be updated via a live update. Some, but not all, non-resource related attributes can also be updated via a live update. However some attributes, especially those that require significant changes across the checkout experience, cannot be used in a live update scenario.", "title": "Not all attributes are available for Live Update" } [/block]
## Load checkout Its important to wait for the ```onReady``` event before attempting to modify checkout so that the checkout client code has an opportunity to connect to the checkout instance in order to open a line of communication. Once checkout is ready, we can send ```reboot``` checkout with a new config. Here, we reboot checkout as a payment modal checkout with a fixed amount of ```$25.34```. Notice the ```.showCheckout()``` at the end of the ```reboot``` statement. We are telling checkout to show itself. The ```showCheckout``` command does not wait for the ```reboot``` command to complete. The ```reboot``` command gets sent to the checkout instance, the checkout instance will begin to reboot, and while it is rebooting the ```showCheckout``` command is also sent. The result will be checkout immediately being displayed with a progress bar indicating that it is rebooting. [block:code] { "codes": [ { "code": "\n// checkout is ready\npsCheckout.onReady(function () {\n\n // reboot checkout with a new config\n psCheckout.reboot({\n \"checkoutType\": \"checkout_payment\",\n \"mode\": \"modal\",\n \"paymentAmount\": \"25.34\",\n \"fixedAmount\": \"true\"\n }).showCheckout();\n\n});\n", "language": "javascript", "name": "Chaining Commands Example" } ] } [/block] Most checkout commands can be chained together, as ```showCheckout``` was chained to the ```reboot``` command above. Chaining is optional. An alternative way to write the above code would be: [block:code] { "codes": [ { "code": "\n// checkout is ready\npsCheckout.onReady(function () {\n\n // reboot checkout with a new config\n psCheckout.reboot({\n \"checkoutType\": \"checkout_payment\",\n \"mode\": \"modal\",\n \"paymentAmount\": \"25.34\",\n \"fixedAmount\": \"true\"\n })\n // show checkout\n psCheckout.showCheckout();\n\n});\n", "language": "javascript", "name": "Individual Commands Example" } ] } [/block] ## Wait for checkout to load It is nice to see a loading bar while the checkout is loading but sometimes finer control over what a user sees during the reboot process is needed. Below, the showing of checkout is delayed until checkout has fully loaded. [block:code] { "codes": [ { "code": "\n// checkout is ready\npsCheckout.onReady(function () {\n\n // wait for reboot to complete before showing checkout\n psCheckout.onceLoaded(function (data) {\n psCheckout.showCheckout();\n });\n\n // reboot checkout with a new config\n psCheckout.reboot({\n \"checkoutType\": \"checkout_payment\",\n \"mode\": \"modal\",\n \"paymentAmount\": \"25.34\",\n \"fixedAmount\": \"true\"\n });\n\n});\n", "language": "javascript", "name": "onceLoaded Example" } ] } [/block] The code above listens for the ```onceLoaded``` event to fire before showing checkout. Notice that the listener is added to the top of the ```onReady``` callback function. It is imperative that it is defined before the ```reboot``` command is called to avoid a possible race condition. The ```onceLoaded``` method is used just in case there is code elsewhere that may not want to show the checkout during later reboots. If this is not a concern and checkout should always be shown each time a checkout reboots, the following code can be used: [block:code] { "codes": [ { "code": "\n// checkout is ready\npsCheckout.onReady(function () {\n \n // reboot checkout with a new config\n psCheckout.reboot({\n \"checkoutType\": \"checkout_payment\",\n \"mode\": \"modal\",\n \"paymentAmount\": \"25.34\",\n \"fixedAmount\": \"true\"\n });\n\n});\n\n// wait for reboot to complete before showing checkout\npsCheckout.onLoaded(function (data) {\n\tpsCheckout.showCheckout();\n});\n", "language": "javascript", "name": "onLoaded Example" } ] } [/block] ## Hide checkout on complete The ```onComplete``` command can be used to react to a checkout completing successfully. This can be useful when a user needs to be directed to their next step or when they need to be shown a custom receipt. The example below shows a checkout automatically being hidden on completion. [block:code] { "codes": [ { "code": "\n// checkout is ready\npsCheckout.onReady(function () {\n // reboot checkout with a new config\n psCheckout.reboot({\n \"checkoutType\": \"checkout_payment\",\n \"mode\": \"modal\",\n \"paymentAmount\": \"25.34\",\n \"fixedAmount\": \"true\"\n });\n\n});\n\n// wait for reboot to complete before showing checkout\npsCheckout.onLoaded(function (data) {\n\tpsCheckout.showCheckout();\n});\n\n// hide checkout on complete\npsCheckout.onComplete(function(data){\n\tpsCheckout.hideCheckout();\n});\n", "language": "javascript", "name": "onComplete Example" } ] } [/block] ## Live updates Under certain circumstances it may be useful to alter a checkout instance after it has already been booted. For instance a checkout may already have been booted based on values in a form on the page in which it has been embedded. When the user updates those values, it would be nice to update checkout without performing an entire reboot. The ```liveUpdate``` command has been created for exactly such a use case. [block:code] { "codes": [ { "code": "\n// checkout is ready\npsCheckout.onReady(function () {\n \n // reboot checkout with a new config\n psCheckout.reboot({\n \"checkoutType\": \"checkout_payment\",\n \"mode\": \"modal\",\n \"paymentAmount\": \"25.34\",\n \"fixedAmount\": \"true\"\n });\n\n});\n\n// wait for reboot to complete before showing checkout\npsCheckout.onLoaded(function () {\n\tpsCheckout.showCheckout();\n});\n\n// called from your code on a form update\nfunction onFormUpdate (data) {\n psCheckout.liveUpdate({\n \"paymentAmount\": data.amount,\n \"payerName\": data.name,\n \"payerEmail\": data.email\n });\n}\n\n", "language": "javascript", "name": "liveUpdate Example" } ] } [/block] [block:callout] { "type": "warning", "body": "Most resource related attributes can be updated via a live update. Some, but not all, non-resource related attributes can also be updated via a live update. However some attributes, especially those that require significant changes across the checkout experience, cannot be used in a live update scenario.", "title": "Not all attributes are available for Live Update" } [/block]
{"_id":"5d56fccfb1b7fc00334d1981","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d191f","user":"55dd080d0efd5821000d53b3","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-14T23:24:40.787Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"## Listener API\n\n### Overview\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\n// listen to all events\\npsCheckout.checkoutEvent = function (data) {...};\\n                                          \\n// listen to all action events\\npsCheckout.checkoutAction = function (data) {...};\\n                                             \\n// listen to all update events\\npsCheckout.checkoutUpdated = function (data) {...};\\n                                              \\n// listen to all flow events\\npsCheckout.checkoutFlow = function (data) {...};\\n                                           \\n                                           \\n// fires each time checkoutJS client has connected with the checkout instance\\npsCheckout.onReady(function(){...});\\n                              \\n// fires each time checkout is rebooting\\npsCheckout.onLoading(function(data){...});\\n                                    \\n// fires each time checkout has completed rebooting\\npsCheckout.onLoaded(function(data){...});\\n                                   \\n// fires each time checkout has completed a flow\\npsCheckout.onComplete(function(data){...});\\n                                     \\n// fires each time checkout encounters an error\\npsCheckout.onError(function(data){...});\\n\\n                                  \\n// fires the next time checkout begins rebooting\\npsCheckout.onceLoading(function(data){...});\\n                                      \\n// fires the next time checkout has completed rebooting\\npsCheckout.onceLoaded(function(data){...});\\n\\n// fires the next time checkout completes a flow\\npsCheckout.onceComplete(function(data){...});\\n\\n\",\n      \"language\": \"javascript\",\n      \"name\": \"Listener API methods\"\n    }\n  ]\n}\n[/block]\n### Event Listeners\n\npsCheckout provides the methods that can be overridden to help filter various incoming Checkout events.\n\n* **psCheckout.checkoutEvent:** This method will capture all incoming events.\n* **psCheckout.checkoutAction:** This method will capture all event actions such as the closeDialog action.\n* **psCheckout.checkoutUpdated:** This method will capture all update events.\n* **psCheckout.checkoutFlow:** This method will capture all flow related events.\n\n\n### Event types\n\n\n1. **Actions:** Actions are commands that are communicated between CheckoutJS and the Checkout window to perform a specific action. An example would be Checkout sending the ```closeDialog``` command to CheckoutJS so that CheckoutJS will know to hide the Checkout iframe.\n\n2. **Updates:** Some modifications to checkout will update core parts of the checkout experience such as the theme or css. When these sorts of updates are detected, events of type \"update\" are sent.\n\n3. **Flows:** Checkouts are configured with an end goal in mind. This is usually to perform a payment, tokenize a card, or scheduled a payment. Each of these is a \"flow\". When a payment, for example, is completed, an event of type \"flow\" is sent indicating that the flow has completed. This specific example would trigger the onComplete listener to fire as well.\n\n\n### Event Data Object\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\n{\\n  \\\"from\\\": \\\"paystand\\\",\\n  \\\"type\\\": \\\"checkoutEvent\\\", // checkoutEvent, checkoutAction, or checkoutFlow\\n  \\\"response\\\": {\\n    \\\"type\\\": \\\"\\\", // various\\n    \\\"flow\\\": \\\"\\\", // payment, tokenize, scheduledPayment\\n    \\\"object\\\": \\\"\\\", // payment, token, scheduledPayment\\n    \\\"data\\\": {}, // data associated with the event\\n    \\\"event\\\": {}, // the event details\\n    \\\"action\\\": \\\"\\\" // the action command\\n  }\\n}\\n\",\n      \"language\": \"javascript\",\n      \"name\": \"Event Data Object Structure\"\n    }\n  ]\n}\n[/block]\n\n### Status Listeners\n\nWhen a checkout renders it goes through a series of status transitions. These different status transitions can be detected through the listener api allowing you to react to these status events.\n\n**statuses:** cssLoaded, checkoutLoaded, checkoutLoading, checkoutReady, checkoutComplete, checkoutError\n\nThere are two types of listeners:\n\n1. **\"on\" listeners:** These listeners will persistently monitor the status of checkout and will capture a status event each time checkout transitions to that particular status.\n\n2. **\"once\" listeners:** These listeners will only capture a checkout status event on the very next occurrence of checkout transitioning to a particular status.\n\n## Checkout Actions API\n\n### Overview\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\n// show checkout\\npsCheckout.showCheckout();\\n\\n// hide checkout\\npsCheckout.hideCheckout();\\n\\n// display checkout as an embed\\npsCheckout.embed();\\n\\n// display checkout as a modal\\npsCheckout.modal();\\n\\n// update checkout width/height\\npsCheckout.dimensions(width, height);\\n\\n\\n// clear current checkout settings/data and reset with provided config settings\\npsCheckout.reboot({...});\\n\\n// keep current checkout settings/data and only update specific config settings\\npsCheckout.liveUpdate({...});\\n\",\n      \"language\": \"javascript\",\n      \"name\": \"Checkout Actions API Methods\"\n    }\n  ]\n}\n[/block]\n### psCheckout.reboot\nThe ```reboot``` method will clear all of the current settings and data inside the checkout instance and replace it with the settings passed into the method. The final settings that the checkout instance will receive will be the merged values from the passed in settings and the settings found the the initialization ```<script>``` tag. If you require different values than those found on the script tag, then you must explicitly override them in the hash passed to the ```reboot``` method.\n\nOnce the ```reboot``` method is called, the checkout will go through the ```loading``` where the checkout loading progress bar will appear until the reboot is complete and the checkout changes to the ```loaded``` status.\n\n\n### psCheckout.liveUpdate\nThe **liveUpdate** method will update data in the checkout instance directly without causing the checkout instance to go through a reboot process. No status transitions will occur, no progress loading bars will appear, and no status listeners will fire. Depending on what settings are updated during the live update command, one or more event listeners may fire.","excerpt":"","slug":"checkout-api-reference","type":"basic","title":"API Reference","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

API Reference


## Listener API ### Overview [block:code] { "codes": [ { "code": "\n// listen to all events\npsCheckout.checkoutEvent = function (data) {...};\n \n// listen to all action events\npsCheckout.checkoutAction = function (data) {...};\n \n// listen to all update events\npsCheckout.checkoutUpdated = function (data) {...};\n \n// listen to all flow events\npsCheckout.checkoutFlow = function (data) {...};\n \n \n// fires each time checkoutJS client has connected with the checkout instance\npsCheckout.onReady(function(){...});\n \n// fires each time checkout is rebooting\npsCheckout.onLoading(function(data){...});\n \n// fires each time checkout has completed rebooting\npsCheckout.onLoaded(function(data){...});\n \n// fires each time checkout has completed a flow\npsCheckout.onComplete(function(data){...});\n \n// fires each time checkout encounters an error\npsCheckout.onError(function(data){...});\n\n \n// fires the next time checkout begins rebooting\npsCheckout.onceLoading(function(data){...});\n \n// fires the next time checkout has completed rebooting\npsCheckout.onceLoaded(function(data){...});\n\n// fires the next time checkout completes a flow\npsCheckout.onceComplete(function(data){...});\n\n", "language": "javascript", "name": "Listener API methods" } ] } [/block] ### Event Listeners psCheckout provides the methods that can be overridden to help filter various incoming Checkout events. * **psCheckout.checkoutEvent:** This method will capture all incoming events. * **psCheckout.checkoutAction:** This method will capture all event actions such as the closeDialog action. * **psCheckout.checkoutUpdated:** This method will capture all update events. * **psCheckout.checkoutFlow:** This method will capture all flow related events. ### Event types 1. **Actions:** Actions are commands that are communicated between CheckoutJS and the Checkout window to perform a specific action. An example would be Checkout sending the ```closeDialog``` command to CheckoutJS so that CheckoutJS will know to hide the Checkout iframe. 2. **Updates:** Some modifications to checkout will update core parts of the checkout experience such as the theme or css. When these sorts of updates are detected, events of type "update" are sent. 3. **Flows:** Checkouts are configured with an end goal in mind. This is usually to perform a payment, tokenize a card, or scheduled a payment. Each of these is a "flow". When a payment, for example, is completed, an event of type "flow" is sent indicating that the flow has completed. This specific example would trigger the onComplete listener to fire as well. ### Event Data Object [block:code] { "codes": [ { "code": "\n{\n \"from\": \"paystand\",\n \"type\": \"checkoutEvent\", // checkoutEvent, checkoutAction, or checkoutFlow\n \"response\": {\n \"type\": \"\", // various\n \"flow\": \"\", // payment, tokenize, scheduledPayment\n \"object\": \"\", // payment, token, scheduledPayment\n \"data\": {}, // data associated with the event\n \"event\": {}, // the event details\n \"action\": \"\" // the action command\n }\n}\n", "language": "javascript", "name": "Event Data Object Structure" } ] } [/block] ### Status Listeners When a checkout renders it goes through a series of status transitions. These different status transitions can be detected through the listener api allowing you to react to these status events. **statuses:** cssLoaded, checkoutLoaded, checkoutLoading, checkoutReady, checkoutComplete, checkoutError There are two types of listeners: 1. **"on" listeners:** These listeners will persistently monitor the status of checkout and will capture a status event each time checkout transitions to that particular status. 2. **"once" listeners:** These listeners will only capture a checkout status event on the very next occurrence of checkout transitioning to a particular status. ## Checkout Actions API ### Overview [block:code] { "codes": [ { "code": "\n// show checkout\npsCheckout.showCheckout();\n\n// hide checkout\npsCheckout.hideCheckout();\n\n// display checkout as an embed\npsCheckout.embed();\n\n// display checkout as a modal\npsCheckout.modal();\n\n// update checkout width/height\npsCheckout.dimensions(width, height);\n\n\n// clear current checkout settings/data and reset with provided config settings\npsCheckout.reboot({...});\n\n// keep current checkout settings/data and only update specific config settings\npsCheckout.liveUpdate({...});\n", "language": "javascript", "name": "Checkout Actions API Methods" } ] } [/block] ### psCheckout.reboot The ```reboot``` method will clear all of the current settings and data inside the checkout instance and replace it with the settings passed into the method. The final settings that the checkout instance will receive will be the merged values from the passed in settings and the settings found the the initialization ```<script>``` tag. If you require different values than those found on the script tag, then you must explicitly override them in the hash passed to the ```reboot``` method. Once the ```reboot``` method is called, the checkout will go through the ```loading``` where the checkout loading progress bar will appear until the reboot is complete and the checkout changes to the ```loaded``` status. ### psCheckout.liveUpdate The **liveUpdate** method will update data in the checkout instance directly without causing the checkout instance to go through a reboot process. No status transitions will occur, no progress loading bars will appear, and no status listeners will fire. Depending on what settings are updated during the live update command, one or more event listeners may fire.
## Listener API ### Overview [block:code] { "codes": [ { "code": "\n// listen to all events\npsCheckout.checkoutEvent = function (data) {...};\n \n// listen to all action events\npsCheckout.checkoutAction = function (data) {...};\n \n// listen to all update events\npsCheckout.checkoutUpdated = function (data) {...};\n \n// listen to all flow events\npsCheckout.checkoutFlow = function (data) {...};\n \n \n// fires each time checkoutJS client has connected with the checkout instance\npsCheckout.onReady(function(){...});\n \n// fires each time checkout is rebooting\npsCheckout.onLoading(function(data){...});\n \n// fires each time checkout has completed rebooting\npsCheckout.onLoaded(function(data){...});\n \n// fires each time checkout has completed a flow\npsCheckout.onComplete(function(data){...});\n \n// fires each time checkout encounters an error\npsCheckout.onError(function(data){...});\n\n \n// fires the next time checkout begins rebooting\npsCheckout.onceLoading(function(data){...});\n \n// fires the next time checkout has completed rebooting\npsCheckout.onceLoaded(function(data){...});\n\n// fires the next time checkout completes a flow\npsCheckout.onceComplete(function(data){...});\n\n", "language": "javascript", "name": "Listener API methods" } ] } [/block] ### Event Listeners psCheckout provides the methods that can be overridden to help filter various incoming Checkout events. * **psCheckout.checkoutEvent:** This method will capture all incoming events. * **psCheckout.checkoutAction:** This method will capture all event actions such as the closeDialog action. * **psCheckout.checkoutUpdated:** This method will capture all update events. * **psCheckout.checkoutFlow:** This method will capture all flow related events. ### Event types 1. **Actions:** Actions are commands that are communicated between CheckoutJS and the Checkout window to perform a specific action. An example would be Checkout sending the ```closeDialog``` command to CheckoutJS so that CheckoutJS will know to hide the Checkout iframe. 2. **Updates:** Some modifications to checkout will update core parts of the checkout experience such as the theme or css. When these sorts of updates are detected, events of type "update" are sent. 3. **Flows:** Checkouts are configured with an end goal in mind. This is usually to perform a payment, tokenize a card, or scheduled a payment. Each of these is a "flow". When a payment, for example, is completed, an event of type "flow" is sent indicating that the flow has completed. This specific example would trigger the onComplete listener to fire as well. ### Event Data Object [block:code] { "codes": [ { "code": "\n{\n \"from\": \"paystand\",\n \"type\": \"checkoutEvent\", // checkoutEvent, checkoutAction, or checkoutFlow\n \"response\": {\n \"type\": \"\", // various\n \"flow\": \"\", // payment, tokenize, scheduledPayment\n \"object\": \"\", // payment, token, scheduledPayment\n \"data\": {}, // data associated with the event\n \"event\": {}, // the event details\n \"action\": \"\" // the action command\n }\n}\n", "language": "javascript", "name": "Event Data Object Structure" } ] } [/block] ### Status Listeners When a checkout renders it goes through a series of status transitions. These different status transitions can be detected through the listener api allowing you to react to these status events. **statuses:** cssLoaded, checkoutLoaded, checkoutLoading, checkoutReady, checkoutComplete, checkoutError There are two types of listeners: 1. **"on" listeners:** These listeners will persistently monitor the status of checkout and will capture a status event each time checkout transitions to that particular status. 2. **"once" listeners:** These listeners will only capture a checkout status event on the very next occurrence of checkout transitioning to a particular status. ## Checkout Actions API ### Overview [block:code] { "codes": [ { "code": "\n// show checkout\npsCheckout.showCheckout();\n\n// hide checkout\npsCheckout.hideCheckout();\n\n// display checkout as an embed\npsCheckout.embed();\n\n// display checkout as a modal\npsCheckout.modal();\n\n// update checkout width/height\npsCheckout.dimensions(width, height);\n\n\n// clear current checkout settings/data and reset with provided config settings\npsCheckout.reboot({...});\n\n// keep current checkout settings/data and only update specific config settings\npsCheckout.liveUpdate({...});\n", "language": "javascript", "name": "Checkout Actions API Methods" } ] } [/block] ### psCheckout.reboot The ```reboot``` method will clear all of the current settings and data inside the checkout instance and replace it with the settings passed into the method. The final settings that the checkout instance will receive will be the merged values from the passed in settings and the settings found the the initialization ```<script>``` tag. If you require different values than those found on the script tag, then you must explicitly override them in the hash passed to the ```reboot``` method. Once the ```reboot``` method is called, the checkout will go through the ```loading``` where the checkout loading progress bar will appear until the reboot is complete and the checkout changes to the ```loaded``` status. ### psCheckout.liveUpdate The **liveUpdate** method will update data in the checkout instance directly without causing the checkout instance to go through a reboot process. No status transitions will occur, no progress loading bars will appear, and no status listeners will fire. Depending on what settings are updated during the live update command, one or more event listeners may fire.
{"_id":"5d56fccfb1b7fc00334d197a","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d191f","user":"57432cc3583f470e000a7784","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-10T22:53:23.465Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"Abbreviations can be added to the checkout url to pass various configuration parameters to render checkout in its own (portal) webpage. For example, here is a basic checkout for $1.00, set with the value \"p.a=1\". This is useful for integration that do not support embedding JavaScript code such as an HTML email, PDF invoices, or integrations with certain third party services.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://checkout.paystand.co/v4/?a.k=5csyxqnc417ao15u24p93fo0&r.p.a=1.00&r.p.u=USD\",\n      \"language\": \"css\",\n      \"name\": \"Example Checkout Portal URL\"\n    }\n  ]\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"Parameter\",\n    \"h-2\": \"Description\",\n    \"h-3\": \"Abbreviation\",\n    \"0-0\": \"access\",\n    \"1-0\": \"access\",\n    \"2-0\": \"access\",\n    \"0-1\": \"vanity\",\n    \"1-1\": \"publishableKey\",\n    \"2-1\": \"env\",\n    \"0-3\": \"a.v\",\n    \"1-3\": \"a.k\",\n    \"2-3\": \"a.e\",\n    \"3-0\": \"checkout type\",\n    \"3-1\": \"checkoutType\",\n    \"3-3\": \"v.t\",\n    \"4-0\": \"views\",\n    \"5-0\": \"views\",\n    \"6-0\": \"views\",\n    \"7-0\": \"views\",\n    \"8-0\": \"views\",\n    \"9-0\": \"views\",\n    \"10-0\": \"views\",\n    \"11-0\": \"views\",\n    \"12-0\": \"views\",\n    \"13-0\": \"views\",\n    \"4-1\": \"viewClose\",\n    \"5-1\": \"viewLogo\",\n    \"6-1\": \"viewExtIds\",\n    \"7-1\": \"viewReceipt\",\n    \"8-1\": \"viewFunds\",\n    \"9-1\": \"viewClose\",\n    \"10-1\": \"viewCheckout\",\n    \"11-1\": \"viewLabels\",\n    \"12-1\": \"viewHeader\",\n    \"13-1\": \"viewSecure\",\n    \"4-2\": \"Set the visibility of the close button inside the checkout instance.\",\n    \"4-3\": \"s.p.b\",\n    \"5-3\": \"v.l\",\n    \"6-3\": \"v.e\",\n    \"7-3\": \"v.r\",\n    \"8-3\": \"v.f\",\n    \"9-3\": \"v.c\",\n    \"10-3\": \"v.h\",\n    \"11-3\": \"v.a\",\n    \"12-3\": \"v.hr\",\n    \"13-3\": \"v.s\",\n    \"14-0\": \"misc\",\n    \"15-0\": \"misc\",\n    \"16-0\": \"misc\",\n    \"17-0\": \"misc\",\n    \"14-1\": \"customReceipt\",\n    \"15-1\": \"logoUrl\",\n    \"16-1\": \"externalCss\",\n    \"17-1\": \"fixedAmount\",\n    \"14-3\": \"s.o.r\",\n    \"15-3\": \"s.t.l.u\",\n    \"16-3\": \"s.t.e\",\n    \"17-3\": \"v.x\",\n    \"18-0\": \"payer\",\n    \"19-0\": \"payer\",\n    \"20-0\": \"payer\",\n    \"21-0\": \"payer\",\n    \"22-0\": \"payer\",\n    \"23-0\": \"payer\",\n    \"24-0\": \"payer\",\n    \"25-0\": \"payer\",\n    \"26-0\": \"payer\",\n    \"18-1\": \"payerName\",\n    \"19-1\": \"payerEmail\",\n    \"20-1\": \"payerExtId\",\n    \"21-1\": \"payerAddressStreet\",\n    \"22-1\": \"payerAddressCity\",\n    \"23-1\": \"payerAddressPostal\",\n    \"24-1\": \"payerAddressState\",\n    \"25-1\": \"payerAddressCountry\",\n    \"26-1\": \"payerMeta\",\n    \"18-3\": \"y.n\",\n    \"19-3\": \"y.e\",\n    \"20-3\": \"y.x\",\n    \"21-3\": \"y.a.s\",\n    \"22-3\": \"y.a.c\",\n    \"23-3\": \"y.a.p\",\n    \"24-3\": \"y.a.d\",\n    \"25-3\": \"y.a.u\",\n    \"26-3\": \"y.a.m\",\n    \"27-1\": \"cardName\",\n    \"28-1\": \"cardNumber\",\n    \"29-1\": \"cardMonth\",\n    \"30-1\": \"cardYear\",\n    \"31-1\": \"cardCode\",\n    \"32-1\": \"cardExtId\",\n    \"33-1\": \"cardAddressStreet\",\n    \"34-1\": \"cardAddressCity\",\n    \"35-1\": \"cardAddressPostal\",\n    \"36-1\": \"cardAddressState\",\n    \"37-1\": \"cardAddressCountry\",\n    \"38-1\": \"cardMeta\",\n    \"27-0\": \"card\",\n    \"28-0\": \"card\",\n    \"29-0\": \"card\",\n    \"30-0\": \"card\",\n    \"31-0\": \"card\",\n    \"32-0\": \"card\",\n    \"33-0\": \"card\",\n    \"34-0\": \"card\",\n    \"35-0\": \"card\",\n    \"36-0\": \"card\",\n    \"37-0\": \"card\",\n    \"38-0\": \"card\",\n    \"38-3\": \"r.c.a.m\",\n    \"37-3\": \"r.c.a.u\",\n    \"27-3\": \"r.c.o\",\n    \"28-3\": \"r.c.n\",\n    \"29-3\": \"r.c.m\",\n    \"30-3\": \"r.c.y\",\n    \"31-3\": \"r.c.c\",\n    \"32-3\": \"r.c.x\",\n    \"33-3\": \"r.c.a.s\",\n    \"34-3\": \"r.c.a.c\",\n    \"35-3\": \"r.c.a.p\",\n    \"36-3\": \"r.c.a.d\",\n    \"39-1\": \"bankNameOnAccount\",\n    \"40-1\": \"bankAccountType\",\n    \"41-1\": \"bankAccountHolderType\",\n    \"42-1\": \"bankRouting\",\n    \"43-1\": \"bankAccount\",\n    \"44-1\": \"bankAccountRepeat\",\n    \"45-1\": \"bankExtId\",\n    \"46-1\": \"bankAddressStreet\",\n    \"47-1\": \"bankAddressCity\",\n    \"48-1\": \"bankAddressPostal\",\n    \"49-1\": \"bankAddressState\",\n    \"50-1\": \"bankAddressCountry\",\n    \"51-1\": \"bankMeta\",\n    \"39-0\": \"bank\",\n    \"40-0\": \"bank\",\n    \"41-0\": \"bank\",\n    \"42-0\": \"bank\",\n    \"43-0\": \"bank\",\n    \"44-0\": \"bank\",\n    \"45-0\": \"bank\",\n    \"46-0\": \"bank\",\n    \"47-0\": \"bank\",\n    \"48-0\": \"bank\",\n    \"49-0\": \"bank\",\n    \"50-0\": \"bank\",\n    \"51-0\": \"bank\",\n    \"39-3\": \"r.b.n\",\n    \"40-3\": \"r.b.t\",\n    \"41-3\": \"r.b.h\",\n    \"42-3\": \"r.b.r\",\n    \"43-3\": \"r.b.c\",\n    \"44-3\": \"r.b.cr\",\n    \"45-3\": \"r.b.x\",\n    \"46-3\": \"r.b.a.s\",\n    \"47-3\": \"r.b.a.c\",\n    \"48-3\": \"r.b.a.p\",\n    \"49-3\": \"r.b.a.d\",\n    \"50-3\": \"r.b.a.u\",\n    \"51-3\": \"r.b.a.m\",\n    \"52-1\": \"paymentAmount\",\n    \"53-1\": \"paymentCurrency\",\n    \"54-1\": \"paymentDescription\",\n    \"55-1\": \"paymentExtId\",\n    \"56-1\": \"paymentMeta\",\n    \"52-3\": \"r.p.a\",\n    \"53-3\": \"r.p.u\",\n    \"54-3\": \"r.p.d\",\n    \"55-3\": \"r.p.x\",\n    \"56-3\": \"r.p.m\",\n    \"52-0\": \"payment\",\n    \"53-0\": \"payment\",\n    \"54-0\": \"payment\",\n    \"55-0\": \"payment\",\n    \"56-0\": \"payment\",\n    \"57-1\": \"spName\",\n    \"58-1\": \"spDescription\",\n    \"59-1\": \"spExtId\",\n    \"60-1\": \"spAmount\",\n    \"61-1\": \"spCurrency\",\n    \"62-1\": \"spInterval\",\n    \"63-1\": \"spIntervalCount\",\n    \"64-1\": \"spAnchor\",\n    \"65-1\": \"spTimesToRun\",\n    \"66-1\": \"spAtDay\",\n    \"67-1\": \"spMeta\",\n    \"57-3\": \"r.sp.n\",\n    \"58-3\": \"r.sp.d\",\n    \"59-3\": \"r.sp.x\",\n    \"60-3\": \"r.sp.a\",\n    \"61-3\": \"r.sp.u\",\n    \"62-3\": \"r.sp.i\",\n    \"63-3\": \"r.sp.c\",\n    \"64-3\": \"r.sp.r\",\n    \"65-3\": \"r.sp.t\",\n    \"66-3\": \".sp.ad\",\n    \"67-3\": \"r.sp.m\",\n    \"57-0\": \"scheduled payment\",\n    \"58-0\": \"scheduled payment\",\n    \"59-0\": \"scheduled payment\",\n    \"60-0\": \"scheduled payment\",\n    \"61-0\": \"scheduled payment\",\n    \"62-0\": \"scheduled payment\",\n    \"63-0\": \"scheduled payment\",\n    \"64-0\": \"scheduled payment\",\n    \"65-0\": \"scheduled payment\",\n    \"66-0\": \"scheduled payment\",\n    \"67-0\": \"scheduled payment\",\n    \"1-2\": \"Your publishable key.\",\n    \"0-2\": \"Your vanity url.\",\n    \"2-2\": \"The environment mode the checkout instance should operate in.\",\n    \"3-2\": \"The type of checkout to render. The checkout type largely determines the overall type of flow the checkout will perform.\",\n    \"5-2\": \"Sets the visibility of the header logo.\",\n    \"6-2\": \"Set the visibility of various resource external ids.\",\n    \"7-2\": \"Set what should happen once a flow completes.\",\n    \"8-2\": \"Sets the payment methods available in the checkout instance as well as the order in which they will appear.\",\n    \"9-2\": \"Set the visibility of the close button inside the checkout instance.\",\n    \"10-2\": \"Set whether the checkout displays the the billing portal chrome layout or the more compact mobile layout.\",\n    \"11-2\": \"Set the visibility of field labels globally.\",\n    \"12-2\": \"Set the visibility of the checkout instance header section.\",\n    \"13-2\": \"Set the visibility of the security notice. This is usually the 'lock' symbol in the bottom right hand corner of the checkout instance.\",\n    \"14-2\": \"Set a custom message on the receipt page.\",\n    \"15-2\": \"Load an external image url to display as the header logo.\",\n    \"16-2\": \"Load an external css file to alter the look and feel of the checkout instance.\",\n    \"17-2\": \"Set the payment amount to be editable or fixed.\",\n    \"18-2\": \"The payer name.\",\n    \"19-2\": \"The payer email.\",\n    \"20-2\": \"The payer external id.\",\n    \"26-2\": \"The payer meta data.\",\n    \"21-2\": \"The payer street address.\",\n    \"22-2\": \"The payer city address.\",\n    \"23-2\": \"The payer postal address.\",\n    \"24-2\": \"The payer state address.\",\n    \"25-2\": \"The payer country address.\",\n    \"27-2\": \"The name on the card.\",\n    \"28-2\": \"The card number.\",\n    \"29-2\": \"The card expiry month.\",\n    \"30-2\": \"The card expiry year.\",\n    \"31-2\": \"The card security code.\",\n    \"32-2\": \"The card external id.\",\n    \"33-2\": \"The card street address.\",\n    \"34-2\": \"The card city address.\",\n    \"35-2\": \"The card postal address.\",\n    \"36-2\": \"The card state address.\",\n    \"37-2\": \"The card country address.\",\n    \"38-2\": \"The card meta data.\",\n    \"39-2\": \"The name on the bank account.\",\n    \"40-2\": \"The bank account type.\",\n    \"41-2\": \"The bank account holder type.\",\n    \"42-2\": \"The bank routing number.\",\n    \"43-2\": \"The bank account number.\",\n    \"44-2\": \"The bank account repeat number.\",\n    \"45-2\": \"The bank external id.\",\n    \"51-2\": \"The bank meta data.\",\n    \"46-2\": \"The bank street address.\",\n    \"47-2\": \"The bank city address.\",\n    \"48-2\": \"The bank postal address.\",\n    \"49-2\": \"The bank state address.\",\n    \"50-2\": \"The bank country address.\",\n    \"52-2\": \"The payment amount.\",\n    \"53-2\": \"The payment currency.\\nSupported currencies [ \\\"USD\\\", \\\"CAD\\\", \\\"EUR\\\", \\\"MXN\\\", \\\"AUD\\\", \\\"GBP\\\" ]\",\n    \"54-2\": \"The payment description.\",\n    \"55-2\": \"The payment external id.\",\n    \"56-2\": \"The payment meta.\",\n    \"57-2\": \"The scheduled payment name.\",\n    \"58-2\": \"The scheduled payment description.\",\n    \"59-2\": \"The scheduled payment external id.\",\n    \"67-2\": \"The scheduled payment meta data.\",\n    \"60-2\": \"The scheduled payment amount.\",\n    \"61-2\": \"The scheduled payment currency.\\nSupported currencies [ \\\"USD\\\", \\\"CAD\\\", \\\"EUR\\\", \\\"MXN\\\", \\\"AUD\\\", \\\"GBP\\\" ]\",\n    \"62-2\": \"The scheduled payment interval.\",\n    \"63-2\": \"The scheduled payment interval count.\",\n    \"64-2\": \"The scheduled payment anchor.\",\n    \"65-2\": \"The scheduled payment times to run.\",\n    \"66-2\": \"The scheduled payment day to run.\"\n  },\n  \"cols\": 4,\n  \"rows\": 68\n}\n[/block]","excerpt":"","slug":"checkout-abbreviations","type":"basic","title":"Abbreviations","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Abbreviations


Abbreviations can be added to the checkout url to pass various configuration parameters to render checkout in its own (portal) webpage. For example, here is a basic checkout for $1.00, set with the value "p.a=1". This is useful for integration that do not support embedding JavaScript code such as an HTML email, PDF invoices, or integrations with certain third party services. [block:code] { "codes": [ { "code": "https://checkout.paystand.co/v4/?a.k=5csyxqnc417ao15u24p93fo0&r.p.a=1.00&r.p.u=USD", "language": "css", "name": "Example Checkout Portal URL" } ] } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Parameter", "h-2": "Description", "h-3": "Abbreviation", "0-0": "access", "1-0": "access", "2-0": "access", "0-1": "vanity", "1-1": "publishableKey", "2-1": "env", "0-3": "a.v", "1-3": "a.k", "2-3": "a.e", "3-0": "checkout type", "3-1": "checkoutType", "3-3": "v.t", "4-0": "views", "5-0": "views", "6-0": "views", "7-0": "views", "8-0": "views", "9-0": "views", "10-0": "views", "11-0": "views", "12-0": "views", "13-0": "views", "4-1": "viewClose", "5-1": "viewLogo", "6-1": "viewExtIds", "7-1": "viewReceipt", "8-1": "viewFunds", "9-1": "viewClose", "10-1": "viewCheckout", "11-1": "viewLabels", "12-1": "viewHeader", "13-1": "viewSecure", "4-2": "Set the visibility of the close button inside the checkout instance.", "4-3": "s.p.b", "5-3": "v.l", "6-3": "v.e", "7-3": "v.r", "8-3": "v.f", "9-3": "v.c", "10-3": "v.h", "11-3": "v.a", "12-3": "v.hr", "13-3": "v.s", "14-0": "misc", "15-0": "misc", "16-0": "misc", "17-0": "misc", "14-1": "customReceipt", "15-1": "logoUrl", "16-1": "externalCss", "17-1": "fixedAmount", "14-3": "s.o.r", "15-3": "s.t.l.u", "16-3": "s.t.e", "17-3": "v.x", "18-0": "payer", "19-0": "payer", "20-0": "payer", "21-0": "payer", "22-0": "payer", "23-0": "payer", "24-0": "payer", "25-0": "payer", "26-0": "payer", "18-1": "payerName", "19-1": "payerEmail", "20-1": "payerExtId", "21-1": "payerAddressStreet", "22-1": "payerAddressCity", "23-1": "payerAddressPostal", "24-1": "payerAddressState", "25-1": "payerAddressCountry", "26-1": "payerMeta", "18-3": "y.n", "19-3": "y.e", "20-3": "y.x", "21-3": "y.a.s", "22-3": "y.a.c", "23-3": "y.a.p", "24-3": "y.a.d", "25-3": "y.a.u", "26-3": "y.a.m", "27-1": "cardName", "28-1": "cardNumber", "29-1": "cardMonth", "30-1": "cardYear", "31-1": "cardCode", "32-1": "cardExtId", "33-1": "cardAddressStreet", "34-1": "cardAddressCity", "35-1": "cardAddressPostal", "36-1": "cardAddressState", "37-1": "cardAddressCountry", "38-1": "cardMeta", "27-0": "card", "28-0": "card", "29-0": "card", "30-0": "card", "31-0": "card", "32-0": "card", "33-0": "card", "34-0": "card", "35-0": "card", "36-0": "card", "37-0": "card", "38-0": "card", "38-3": "r.c.a.m", "37-3": "r.c.a.u", "27-3": "r.c.o", "28-3": "r.c.n", "29-3": "r.c.m", "30-3": "r.c.y", "31-3": "r.c.c", "32-3": "r.c.x", "33-3": "r.c.a.s", "34-3": "r.c.a.c", "35-3": "r.c.a.p", "36-3": "r.c.a.d", "39-1": "bankNameOnAccount", "40-1": "bankAccountType", "41-1": "bankAccountHolderType", "42-1": "bankRouting", "43-1": "bankAccount", "44-1": "bankAccountRepeat", "45-1": "bankExtId", "46-1": "bankAddressStreet", "47-1": "bankAddressCity", "48-1": "bankAddressPostal", "49-1": "bankAddressState", "50-1": "bankAddressCountry", "51-1": "bankMeta", "39-0": "bank", "40-0": "bank", "41-0": "bank", "42-0": "bank", "43-0": "bank", "44-0": "bank", "45-0": "bank", "46-0": "bank", "47-0": "bank", "48-0": "bank", "49-0": "bank", "50-0": "bank", "51-0": "bank", "39-3": "r.b.n", "40-3": "r.b.t", "41-3": "r.b.h", "42-3": "r.b.r", "43-3": "r.b.c", "44-3": "r.b.cr", "45-3": "r.b.x", "46-3": "r.b.a.s", "47-3": "r.b.a.c", "48-3": "r.b.a.p", "49-3": "r.b.a.d", "50-3": "r.b.a.u", "51-3": "r.b.a.m", "52-1": "paymentAmount", "53-1": "paymentCurrency", "54-1": "paymentDescription", "55-1": "paymentExtId", "56-1": "paymentMeta", "52-3": "r.p.a", "53-3": "r.p.u", "54-3": "r.p.d", "55-3": "r.p.x", "56-3": "r.p.m", "52-0": "payment", "53-0": "payment", "54-0": "payment", "55-0": "payment", "56-0": "payment", "57-1": "spName", "58-1": "spDescription", "59-1": "spExtId", "60-1": "spAmount", "61-1": "spCurrency", "62-1": "spInterval", "63-1": "spIntervalCount", "64-1": "spAnchor", "65-1": "spTimesToRun", "66-1": "spAtDay", "67-1": "spMeta", "57-3": "r.sp.n", "58-3": "r.sp.d", "59-3": "r.sp.x", "60-3": "r.sp.a", "61-3": "r.sp.u", "62-3": "r.sp.i", "63-3": "r.sp.c", "64-3": "r.sp.r", "65-3": "r.sp.t", "66-3": ".sp.ad", "67-3": "r.sp.m", "57-0": "scheduled payment", "58-0": "scheduled payment", "59-0": "scheduled payment", "60-0": "scheduled payment", "61-0": "scheduled payment", "62-0": "scheduled payment", "63-0": "scheduled payment", "64-0": "scheduled payment", "65-0": "scheduled payment", "66-0": "scheduled payment", "67-0": "scheduled payment", "1-2": "Your publishable key.", "0-2": "Your vanity url.", "2-2": "The environment mode the checkout instance should operate in.", "3-2": "The type of checkout to render. The checkout type largely determines the overall type of flow the checkout will perform.", "5-2": "Sets the visibility of the header logo.", "6-2": "Set the visibility of various resource external ids.", "7-2": "Set what should happen once a flow completes.", "8-2": "Sets the payment methods available in the checkout instance as well as the order in which they will appear.", "9-2": "Set the visibility of the close button inside the checkout instance.", "10-2": "Set whether the checkout displays the the billing portal chrome layout or the more compact mobile layout.", "11-2": "Set the visibility of field labels globally.", "12-2": "Set the visibility of the checkout instance header section.", "13-2": "Set the visibility of the security notice. This is usually the 'lock' symbol in the bottom right hand corner of the checkout instance.", "14-2": "Set a custom message on the receipt page.", "15-2": "Load an external image url to display as the header logo.", "16-2": "Load an external css file to alter the look and feel of the checkout instance.", "17-2": "Set the payment amount to be editable or fixed.", "18-2": "The payer name.", "19-2": "The payer email.", "20-2": "The payer external id.", "26-2": "The payer meta data.", "21-2": "The payer street address.", "22-2": "The payer city address.", "23-2": "The payer postal address.", "24-2": "The payer state address.", "25-2": "The payer country address.", "27-2": "The name on the card.", "28-2": "The card number.", "29-2": "The card expiry month.", "30-2": "The card expiry year.", "31-2": "The card security code.", "32-2": "The card external id.", "33-2": "The card street address.", "34-2": "The card city address.", "35-2": "The card postal address.", "36-2": "The card state address.", "37-2": "The card country address.", "38-2": "The card meta data.", "39-2": "The name on the bank account.", "40-2": "The bank account type.", "41-2": "The bank account holder type.", "42-2": "The bank routing number.", "43-2": "The bank account number.", "44-2": "The bank account repeat number.", "45-2": "The bank external id.", "51-2": "The bank meta data.", "46-2": "The bank street address.", "47-2": "The bank city address.", "48-2": "The bank postal address.", "49-2": "The bank state address.", "50-2": "The bank country address.", "52-2": "The payment amount.", "53-2": "The payment currency.\nSupported currencies [ \"USD\", \"CAD\", \"EUR\", \"MXN\", \"AUD\", \"GBP\" ]", "54-2": "The payment description.", "55-2": "The payment external id.", "56-2": "The payment meta.", "57-2": "The scheduled payment name.", "58-2": "The scheduled payment description.", "59-2": "The scheduled payment external id.", "67-2": "The scheduled payment meta data.", "60-2": "The scheduled payment amount.", "61-2": "The scheduled payment currency.\nSupported currencies [ \"USD\", \"CAD\", \"EUR\", \"MXN\", \"AUD\", \"GBP\" ]", "62-2": "The scheduled payment interval.", "63-2": "The scheduled payment interval count.", "64-2": "The scheduled payment anchor.", "65-2": "The scheduled payment times to run.", "66-2": "The scheduled payment day to run." }, "cols": 4, "rows": 68 } [/block]
Abbreviations can be added to the checkout url to pass various configuration parameters to render checkout in its own (portal) webpage. For example, here is a basic checkout for $1.00, set with the value "p.a=1". This is useful for integration that do not support embedding JavaScript code such as an HTML email, PDF invoices, or integrations with certain third party services. [block:code] { "codes": [ { "code": "https://checkout.paystand.co/v4/?a.k=5csyxqnc417ao15u24p93fo0&r.p.a=1.00&r.p.u=USD", "language": "css", "name": "Example Checkout Portal URL" } ] } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Parameter", "h-2": "Description", "h-3": "Abbreviation", "0-0": "access", "1-0": "access", "2-0": "access", "0-1": "vanity", "1-1": "publishableKey", "2-1": "env", "0-3": "a.v", "1-3": "a.k", "2-3": "a.e", "3-0": "checkout type", "3-1": "checkoutType", "3-3": "v.t", "4-0": "views", "5-0": "views", "6-0": "views", "7-0": "views", "8-0": "views", "9-0": "views", "10-0": "views", "11-0": "views", "12-0": "views", "13-0": "views", "4-1": "viewClose", "5-1": "viewLogo", "6-1": "viewExtIds", "7-1": "viewReceipt", "8-1": "viewFunds", "9-1": "viewClose", "10-1": "viewCheckout", "11-1": "viewLabels", "12-1": "viewHeader", "13-1": "viewSecure", "4-2": "Set the visibility of the close button inside the checkout instance.", "4-3": "s.p.b", "5-3": "v.l", "6-3": "v.e", "7-3": "v.r", "8-3": "v.f", "9-3": "v.c", "10-3": "v.h", "11-3": "v.a", "12-3": "v.hr", "13-3": "v.s", "14-0": "misc", "15-0": "misc", "16-0": "misc", "17-0": "misc", "14-1": "customReceipt", "15-1": "logoUrl", "16-1": "externalCss", "17-1": "fixedAmount", "14-3": "s.o.r", "15-3": "s.t.l.u", "16-3": "s.t.e", "17-3": "v.x", "18-0": "payer", "19-0": "payer", "20-0": "payer", "21-0": "payer", "22-0": "payer", "23-0": "payer", "24-0": "payer", "25-0": "payer", "26-0": "payer", "18-1": "payerName", "19-1": "payerEmail", "20-1": "payerExtId", "21-1": "payerAddressStreet", "22-1": "payerAddressCity", "23-1": "payerAddressPostal", "24-1": "payerAddressState", "25-1": "payerAddressCountry", "26-1": "payerMeta", "18-3": "y.n", "19-3": "y.e", "20-3": "y.x", "21-3": "y.a.s", "22-3": "y.a.c", "23-3": "y.a.p", "24-3": "y.a.d", "25-3": "y.a.u", "26-3": "y.a.m", "27-1": "cardName", "28-1": "cardNumber", "29-1": "cardMonth", "30-1": "cardYear", "31-1": "cardCode", "32-1": "cardExtId", "33-1": "cardAddressStreet", "34-1": "cardAddressCity", "35-1": "cardAddressPostal", "36-1": "cardAddressState", "37-1": "cardAddressCountry", "38-1": "cardMeta", "27-0": "card", "28-0": "card", "29-0": "card", "30-0": "card", "31-0": "card", "32-0": "card", "33-0": "card", "34-0": "card", "35-0": "card", "36-0": "card", "37-0": "card", "38-0": "card", "38-3": "r.c.a.m", "37-3": "r.c.a.u", "27-3": "r.c.o", "28-3": "r.c.n", "29-3": "r.c.m", "30-3": "r.c.y", "31-3": "r.c.c", "32-3": "r.c.x", "33-3": "r.c.a.s", "34-3": "r.c.a.c", "35-3": "r.c.a.p", "36-3": "r.c.a.d", "39-1": "bankNameOnAccount", "40-1": "bankAccountType", "41-1": "bankAccountHolderType", "42-1": "bankRouting", "43-1": "bankAccount", "44-1": "bankAccountRepeat", "45-1": "bankExtId", "46-1": "bankAddressStreet", "47-1": "bankAddressCity", "48-1": "bankAddressPostal", "49-1": "bankAddressState", "50-1": "bankAddressCountry", "51-1": "bankMeta", "39-0": "bank", "40-0": "bank", "41-0": "bank", "42-0": "bank", "43-0": "bank", "44-0": "bank", "45-0": "bank", "46-0": "bank", "47-0": "bank", "48-0": "bank", "49-0": "bank", "50-0": "bank", "51-0": "bank", "39-3": "r.b.n", "40-3": "r.b.t", "41-3": "r.b.h", "42-3": "r.b.r", "43-3": "r.b.c", "44-3": "r.b.cr", "45-3": "r.b.x", "46-3": "r.b.a.s", "47-3": "r.b.a.c", "48-3": "r.b.a.p", "49-3": "r.b.a.d", "50-3": "r.b.a.u", "51-3": "r.b.a.m", "52-1": "paymentAmount", "53-1": "paymentCurrency", "54-1": "paymentDescription", "55-1": "paymentExtId", "56-1": "paymentMeta", "52-3": "r.p.a", "53-3": "r.p.u", "54-3": "r.p.d", "55-3": "r.p.x", "56-3": "r.p.m", "52-0": "payment", "53-0": "payment", "54-0": "payment", "55-0": "payment", "56-0": "payment", "57-1": "spName", "58-1": "spDescription", "59-1": "spExtId", "60-1": "spAmount", "61-1": "spCurrency", "62-1": "spInterval", "63-1": "spIntervalCount", "64-1": "spAnchor", "65-1": "spTimesToRun", "66-1": "spAtDay", "67-1": "spMeta", "57-3": "r.sp.n", "58-3": "r.sp.d", "59-3": "r.sp.x", "60-3": "r.sp.a", "61-3": "r.sp.u", "62-3": "r.sp.i", "63-3": "r.sp.c", "64-3": "r.sp.r", "65-3": "r.sp.t", "66-3": ".sp.ad", "67-3": "r.sp.m", "57-0": "scheduled payment", "58-0": "scheduled payment", "59-0": "scheduled payment", "60-0": "scheduled payment", "61-0": "scheduled payment", "62-0": "scheduled payment", "63-0": "scheduled payment", "64-0": "scheduled payment", "65-0": "scheduled payment", "66-0": "scheduled payment", "67-0": "scheduled payment", "1-2": "Your publishable key.", "0-2": "Your vanity url.", "2-2": "The environment mode the checkout instance should operate in.", "3-2": "The type of checkout to render. The checkout type largely determines the overall type of flow the checkout will perform.", "5-2": "Sets the visibility of the header logo.", "6-2": "Set the visibility of various resource external ids.", "7-2": "Set what should happen once a flow completes.", "8-2": "Sets the payment methods available in the checkout instance as well as the order in which they will appear.", "9-2": "Set the visibility of the close button inside the checkout instance.", "10-2": "Set whether the checkout displays the the billing portal chrome layout or the more compact mobile layout.", "11-2": "Set the visibility of field labels globally.", "12-2": "Set the visibility of the checkout instance header section.", "13-2": "Set the visibility of the security notice. This is usually the 'lock' symbol in the bottom right hand corner of the checkout instance.", "14-2": "Set a custom message on the receipt page.", "15-2": "Load an external image url to display as the header logo.", "16-2": "Load an external css file to alter the look and feel of the checkout instance.", "17-2": "Set the payment amount to be editable or fixed.", "18-2": "The payer name.", "19-2": "The payer email.", "20-2": "The payer external id.", "26-2": "The payer meta data.", "21-2": "The payer street address.", "22-2": "The payer city address.", "23-2": "The payer postal address.", "24-2": "The payer state address.", "25-2": "The payer country address.", "27-2": "The name on the card.", "28-2": "The card number.", "29-2": "The card expiry month.", "30-2": "The card expiry year.", "31-2": "The card security code.", "32-2": "The card external id.", "33-2": "The card street address.", "34-2": "The card city address.", "35-2": "The card postal address.", "36-2": "The card state address.", "37-2": "The card country address.", "38-2": "The card meta data.", "39-2": "The name on the bank account.", "40-2": "The bank account type.", "41-2": "The bank account holder type.", "42-2": "The bank routing number.", "43-2": "The bank account number.", "44-2": "The bank account repeat number.", "45-2": "The bank external id.", "51-2": "The bank meta data.", "46-2": "The bank street address.", "47-2": "The bank city address.", "48-2": "The bank postal address.", "49-2": "The bank state address.", "50-2": "The bank country address.", "52-2": "The payment amount.", "53-2": "The payment currency.\nSupported currencies [ \"USD\", \"CAD\", \"EUR\", \"MXN\", \"AUD\", \"GBP\" ]", "54-2": "The payment description.", "55-2": "The payment external id.", "56-2": "The payment meta.", "57-2": "The scheduled payment name.", "58-2": "The scheduled payment description.", "59-2": "The scheduled payment external id.", "67-2": "The scheduled payment meta data.", "60-2": "The scheduled payment amount.", "61-2": "The scheduled payment currency.\nSupported currencies [ \"USD\", \"CAD\", \"EUR\", \"MXN\", \"AUD\", \"GBP\" ]", "62-2": "The scheduled payment interval.", "63-2": "The scheduled payment interval count.", "64-2": "The scheduled payment anchor.", "65-2": "The scheduled payment times to run.", "66-2": "The scheduled payment day to run." }, "cols": 4, "rows": 68 } [/block]
{"_id":"5d56fccfb1b7fc00334d197b","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d191f","user":"57432cc3583f470e000a7784","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-10T23:51:10.384Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"Attributes can be added to the checkout script tag and HTML buttons to configure checkout. For example, here is a scheduled payment monthly checkout for $100.00, embedded, with an email passed in which will only accept cards as payment method.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<script\\n  type=\\\"text/javascript\\\"\\n  id=\\\"paystand_checkout\\\"\\n  src=\\\"https://checkout.paystand.co/v4/js/paystand.checkout.js\\\"\\n  ps-env=\\\"sandbox\\\" \\n  ps-publishableKey=\\\"1noqhele1yjgieoi8aqe4n8i\\\"\\n  ps-mode=\\\"embed\\\"\\n  ps-show=\\\"true\\\"\\n  ps-spAmount=\\\"100.00\\\"\\n  ps-spCurrency=\\\"USD\\\"\\n  ps-fixedAmount=\\\"true\\\"\\n  ps-payerEmail=\\\"email@paystand.com\\\"\\n  ps-checkoutType=\\\"checkout_scheduled_payment\\\"\\n  ps-spInterval=\\\"month\\\"\\n  ps-viewFunds=\\\"card\\\"\\n  ps-viewClose=\\\"hide\\\"\\n></script>\\n\",\n      \"language\": \"javascript\",\n      \"name\": \"Scheduled Payment Example using Attributes for its configuration\"\n    }\n  ]\n}\n[/block]\n\n## General Attributes\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"attribute\",\n    \"h-1\": \"details\",\n    \"h-2\": \"description\",\n    \"0-0\": \"publishableKey\",\n    \"0-1\": \"**type**: *string*\\n**elements**: init_script\\n*(required)* \",\n    \"0-2\": \"The customer's publishableKey\",\n    \"1-0\": \"containerId\",\n    \"1-1\": \"**type**: *string*\\n**example**: my_checkout_container\\n**elements**: init_script\\n*(optional)* \",\n    \"1-2\": \"An html element id, whose element checkout should be injected into.\",\n    \"2-0\": \"env\",\n    \"2-1\": \"**type**: *enum_string*\\n**enum**: sandbox|live|default\\n**default**: live\\n**elements**: init_script\\n*(optional)* \",\n    \"2-2\": \"The environment mode the checkout instance should operate in.\",\n    \"3-0\": \"debug\",\n    \"3-1\": \"**type**: *enum_string*\\n**enum**: true|false\\n**default**: false\\n**elements**: init_script\\n*(optional)* \",\n    \"3-2\": \"When set to 'true', extra logs will be output to the console.\",\n    \"4-0\": \"mode\",\n    \"5-0\": \"width\",\n    \"6-0\": \"height\",\n    \"7-0\": \"ps-click\",\n    \"4-1\": \"**type**: *enum_string*\\n**enum**: modal|embed\\n**default**: modal\\n**elements**: any\\n*(optional)* \",\n    \"5-1\": \"**type**: *string*\\n**examples**: 100px|100%\\n**default**: 400px\\n**elements**: any\\n*(optional)* \",\n    \"6-1\": \"**type**: *string*\\n**examples**: 100px|100%\\n**default**: 700px\\n**elements**: any\\n*(optional)* \",\n    \"7-1\": \"**type**: *js_string*\\n**examples**: \\\"getDetails();\\\"\\n**elements**: buttons\\n*(optional)* \",\n    \"7-2\": \"Similar to the javascript onClick event. Fires once per click. Can contain arbitrary javascript statements. The final result of the statements should be a valid checkout settings hash that will be used to configure the checkout instance.\",\n    \"6-2\": \"The height of the checkout frame.\",\n    \"5-2\": \"The width of the checkout frame.\",\n    \"4-2\": \"Whether checkout should render as a modal popup or an embedded checkout.\",\n    \"8-0\": \"drawerType\",\n    \"8-1\": \"**type**: *string* (3 values req.)\\n**examples**: open_displaced_fixed\\n**default**: closed_overlay_toggle\\n**elements**: open/closed|displaced/overlay|fixed/toggle\\n*(optional)*\",\n    \"8-2\": \"This is used to change the payor pays fee drawer in your checkout.\\n  * Open/Closed: Open **OR** close drawer.\\n  * Displaced/Overlay: In open drawer, move content down **OR **have drawer on top of content.\\n  * Fixed/Toggle: User cannot open/close drawer by clicking **OR** User can open/close drawer by clicking.\\nSupported combinations:\\n  * open_displaced_fixed\\n  * open_displaced_toggle\\n  * closed_displaced_toggle\\n  * closed_overlay_fixed\\n  * closed_overlay_toggle\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]\n\n## General display attributes\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"attribute\",\n    \"h-1\": \"details\",\n    \"h-2\": \"description\",\n    \"0-0\": \"checkoutType\",\n    \"0-1\": \"**type**: *enum_string*\\n**enum**: checkout_payment|checkout_token|\\ncheckout_scheduled_payment|checkout_token2col||checkout_bank_enrollment\\n**default**: checkout_payment\\n**elements**: any\\n*(optional)*\",\n    \"0-2\": \"The type of checkout to render. The checkout type largly determines the overall type of flow the checkout will perform.\",\n    \"1-0\": \"viewFunds\",\n    \"1-1\": \"**type**: *ordered_comma_separated_enum_string *\\n**enum**: card|ach|echeck|default\\n**default**: echeck,card,ach\\n**example**: echeck,ach,card\\n**elements**: any\\n*(optional)* \",\n    \"1-2\": \"Sets the payment methods available in the checkout instance as well as the order in which they will appear.\",\n    \"2-0\": \"viewLogo\",\n    \"2-1\": \"**type**: *enum_string *\\n**enum**: hide|show|ps|default\\n**default**: ps\\n**elements**: any\\n*(optional)* \",\n    \"2-2\": \"Sets the visibility of the header logo.\",\n    \"3-0\": \"viewClose\",\n    \"3-1\": \"**type**:* enum_string*\\n**enum**: hide|show|default\\n**default**: show\\n**elements**: any\\n*(optional)* \",\n    \"3-2\": \"Set the visibility of the close button inside the checkout instance.\",\n    \"4-0\": \"viewCheckout\",\n    \"4-1\": \"**type**: *enum_string*\\n**enum**: portal-xlarge|portal-large|portal-medium|\\nportal-small|portal|mobile|default\\n**default**: mobile\\n**elements**: any\\n*(optional)* \",\n    \"4-2\": \"Set whether the checkout displays the the billing portal chrome layout or the more compact mobile layout.\",\n    \"5-0\": \"viewReceipt\",\n    \"5-1\": \"**type**: *enum_string*\\n**enum**: hide|show|close|default\\n**default**: show\\n**elements**: any\\n*(optional)* \",\n    \"5-2\": \"Set what should happen once a flow completes.\",\n    \"6-0\": \"viewLabels\",\n    \"6-1\": \"**type**: *enum_string*\\n**enum**: hide|show|default\\n**default**: show\\n**elements**: any\\n*(optional)* \",\n    \"6-2\": \"Set the visibility of field labels globally.\",\n    \"7-0\": \"viewHeader\",\n    \"7-1\": \"**type**:**** *enum_string*\\n**enum**: hide|show|default\\n**default**: show\\n**elements**: any\\n*(optional)* \",\n    \"7-2\": \"Set the visibility of the checkout instance header section.\",\n    \"8-0\": \"viewSecure\",\n    \"8-1\": \"**type**: *enum_string*\\n**enum**: hide|show|default\\n**default**: show\\n**elements**: any\\n*(optional)* \",\n    \"8-2\": \"Set the visibility of the security notice. This is usually the 'lock' symbol in the bottom right hand corner of the checkout instance.\",\n    \"9-0\": \"viewExtIds\",\n    \"9-1\": \"**type**: *ordered_comma_separated_enum_string *\\n**enum**: card|bank|payer\\n**default**: none\\n**example**: card,bank\\n**elements**: any\\n*(optional)* \",\n    \"9-2\": \"Set the visibility of various resource external ids.\",\n    \"12-0\": \"fixedAmount\",\n    \"12-1\": \"**type**: *boolean_string*\\n**default**: false\\n**elements**: any\\n*(optional)* \",\n    \"12-2\": \"Set the payment amount to be editable or fixed.\",\n    \"13-0\": \"customReceipt\",\n    \"13-1\": \"**type**: *html_string*\\n**elements**: any\\n*(optional)* \",\n    \"13-2\": \"Set a custom message on the receipt page.\",\n    \"14-0\": \"headerColor\",\n    \"14-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"14-2\": \"Set the header color. Can be any valid css color.\",\n    \"15-0\": \"externalCss\",\n    \"15-1\": \"**type**: *css_url_string*\\n**elements**: any\\n*(optional)* \",\n    \"15-2\": \"Load an external css file to alter the look and feel of the checkout instance.\",\n    \"16-0\": \"logoUrl\",\n    \"16-1\": \"**type**: image_url_string\\n**elements**: any\\n(optional)\",\n    \"16-2\": \"Load an external image url to display as the header logo.\",\n    \"11-0\": \"viewSupportInfo\",\n    \"11-1\": \"**type**: *boolean_string*\\n**default**: true\\n**elements**: any\\n*(optional)*\",\n    \"11-2\": \"Set the visibility of the PayStand support content in the portal view's footer.\",\n    \"10-0\": \"viewPoweredBy\",\n    \"10-1\": \"**type**: *boolean_string*\\n**default**: true\\n**elements**: any\\n*(optional)*\",\n    \"10-2\": \"Set the visibility of the \\\"Powered by: PayStand\\\" logo in the portal view's footer.\",\n    \"17-0\": \"hideCf\",\n    \"17-1\": \"**type**:*string*\\n**elements**:any\\n*(optional)*\",\n    \"17-2\": \"Comma separated list of custom field keys. Hide custom fields that have been enabled in the dashboard or per billing portal.\"\n  },\n  \"cols\": 3,\n  \"rows\": 18\n}\n[/block]\n\n## Resource attributes\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"cardExtId\",\n    \"0-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"0-2\": \"The card external id.\",\n    \"1-0\": \"cardMeta\",\n    \"1-1\": \"**type**: *json_string*\\n**elements**: any\\n*(optional)* \",\n    \"1-2\": \"The card meta data.\",\n    \"2-0\": \"cardAddressStreet\",\n    \"2-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"2-2\": \"The card street address.\",\n    \"3-0\": \"cardAddressCity\",\n    \"3-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"3-2\": \"The card city address.\",\n    \"4-0\": \"cardAddressPostal\",\n    \"4-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"4-2\": \"The card postal address.\",\n    \"5-0\": \"cardAddressState\",\n    \"5-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"5-2\": \"The card state address.\",\n    \"6-0\": \"cardAddressCountry\",\n    \"6-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"6-2\": \"The card country address.\",\n    \"7-0\": \"bankNameOnAccount\",\n    \"7-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"7-2\": \"The name on the bank account.\",\n    \"8-0\": \"bankAccountType\",\n    \"8-1\": \"**type**: *enum_string*\\n**enum**: checking|savings\\n**elements**: any\\n*(optional)* \",\n    \"8-2\": \"The bank account type.\",\n    \"9-0\": \"bankAccountHolderType\",\n    \"9-1\": \"**type**: *enum_string*\\n**enum**: individual|corporate\\n**elements**: any\\n*(optional)* \",\n    \"9-2\": \"The bank account holder type.\",\n    \"10-0\": \"bankRouting\",\n    \"10-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"10-2\": \"The bank routing number.\",\n    \"11-0\": \"bankAccount\",\n    \"11-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"11-2\": \"The bank account number.\",\n    \"12-0\": \"bankAccountRepeat\",\n    \"12-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"12-2\": \"The bank account repeat number.\",\n    \"13-0\": \"bankExtId\",\n    \"13-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"13-2\": \"The bank external id.\",\n    \"14-0\": \"bankMeta\",\n    \"14-1\": \"**type**: *json_string*\\n**elements**: any\\n*(optional)* \",\n    \"14-2\": \"The bank meta data.\",\n    \"15-0\": \"bankAddressStreet\",\n    \"15-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"15-2\": \"The bank street address.\",\n    \"16-0\": \"bankAddressCity\",\n    \"16-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)\\t* \",\n    \"16-2\": \"The bank city address.\",\n    \"17-0\": \"bankAddressPostal\",\n    \"17-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"17-2\": \"The bank postal address.\",\n    \"18-0\": \"bankAddressState\",\n    \"18-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"18-2\": \"The bank state address.\",\n    \"19-0\": \"bankAddressCountry\",\n    \"19-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"19-2\": \"The bank country address.\",\n    \"20-0\": \"payerName\",\n    \"20-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"20-2\": \"The payer name.\",\n    \"21-0\": \"payerEmail\",\n    \"21-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)*\",\n    \"21-2\": \"The payer email.\",\n    \"23-0\": \"payerExtId\",\n    \"23-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"23-2\": \"The payer external id.\",\n    \"24-0\": \"payerMeta\",\n    \"24-1\": \"**type**: *json_string*\\n**elements**: any\\n*(optional)* \",\n    \"24-2\": \"The payer meta data.\",\n    \"25-0\": \"payerAddressStreet\",\n    \"25-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"25-2\": \"The payer street address.\",\n    \"26-0\": \"payerAddressCity\",\n    \"26-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"26-2\": \"The payer city address.\",\n    \"27-0\": \"payerAddressPostal\",\n    \"27-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"27-2\": \"The payer postal address.\",\n    \"28-0\": \"payerAddressState\",\n    \"28-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"28-2\": \"The payer state address.\",\n    \"29-0\": \"payerAddressCountry\",\n    \"29-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"29-2\": \"The payer country address.\",\n    \"30-0\": \"paymentAmount\",\n    \"30-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"30-2\": \"The payment amount.\",\n    \"31-0\": \"paymentCurrency\",\n    \"31-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"31-2\": \"The payment currency. Supported currencies [ \\\"USD\\\", \\\"CAD\\\", \\\"EUR\\\", \\\"MXN\\\", \\\"AUD\\\", \\\"GBP\\\" ]\",\n    \"32-0\": \"paymentDescription\",\n    \"32-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"32-2\": \"The payment description.\",\n    \"33-0\": \"paymentExtId\",\n    \"33-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"33-2\": \"The payment external id.\",\n    \"34-0\": \"paymentMeta\",\n    \"34-1\": \"**type**: *json_string*\\n**elements**: any\\n*(optional)* \",\n    \"34-2\": \"The payment meta.\",\n    \"35-0\": \"spName\",\n    \"35-1\": \"**type**:* string*\\n**elements**: any\\n*(optional)* \",\n    \"35-2\": \"The scheduled payment name.\",\n    \"36-0\": \"spDescription\",\n    \"36-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"36-2\": \"The scheduled payment description.\",\n    \"37-0\": \"spExtId\",\n    \"37-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"37-2\": \"The scheduled payment external id.\",\n    \"38-0\": \"spMeta\",\n    \"38-1\": \"**type**: *json_string*\\n**elements**: any\\n*(optional)* \",\n    \"38-2\": \"The scheduled payment meta data.\",\n    \"39-0\": \"spAmount\",\n    \"39-1\": \"**type**: * integer_string*\\n**elements**: any\\n*(optional)*\",\n    \"39-2\": \"The scheduled payment amount.\",\n    \"40-0\": \"spCurrency\",\n    \"40-1\": \"**type**: *enum_string*\\n**elements**: any\\n**default**: USD\\n*(optional)*\",\n    \"40-2\": \"The scheduled payment currency. \\nSupported currencies [ \\\"USD\\\", \\\"CAD\\\", \\\"EUR\\\", \\\"MXN\\\", \\\"AUD\\\", \\\"GBP\\\" ]\",\n    \"41-0\": \"spInterval\",\n    \"41-1\": \"**type**: *enum_string*\\n**enum**: week|month|year|day\\n**elements**: any\\n**default**: week\\n*(optional)*\",\n    \"41-2\": \"The scheduled payment interval.\",\n    \"42-0\": \"spIntervalCount\",\n    \"42-1\": \"**type**: *integer_string*\\n**elements**: any\\n*(optional)* \",\n    \"42-2\": \"The scheduled payment interval count.\",\n    \"43-0\": \"spAnchor\",\n    \"43-1\": \"**type**: *enum_string*\\n**enum**: start|end\\nelements: any\\n*(optional)*\",\n    \"43-2\": \"The scheduled payment anchor.\",\n    \"44-0\": \"spTimesToRun\",\n    \"44-1\": \"**type**:* integer_string*\\n**elements**: any\\n*(optional)* \",\n    \"44-2\": \"The scheduled payment times to run.\",\n    \"45-0\": \"spAtDay\",\n    \"45-1\": \"**type**:* integer_string*\\n**elements**: any\\n*(optional)* \",\n    \"45-2\": \"The scheduled payment day to run.\",\n    \"46-0\": \"cf_*\",\n    \"46-1\": \"*: any valid custom field key\\n**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"46-2\": \"Custom field resource data. If a custom field has a key such as someCustomFieldKey, then the attribute should be cf_some_custom_field_key.\",\n    \"22-0\": \"payerId\",\n    \"22-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)*\",\n    \"22-2\": \"The payer id.\"\n  },\n  \"cols\": 3,\n  \"rows\": 47\n}\n[/block]\n\n## Resource display attributes\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"showHeader_*\",\n    \"0-1\": \"\\\\*: cardHeader | bankHeader | payerHeader\\n**type**: *enum_string*\\n**enum**: hide|show|default\\n**default**: show\\n**elements**: any\\n*(optional)\\t*\",\n    \"0-2\": \"Set the visibility of a section header.\",\n    \"1-0\": \"setHeader_*\",\n    \"1-1\": \"\\\\*: cardHeader | bankHeader | payerHeader\\n**type**: *string*\\n**elements**: any\\n*(optional)*\",\n    \"1-2\": \"Set the text for a section header.\",\n    \"2-0\": \"showField_*\",\n    \"2-1\": \"\\\\*: any card, bank, or payer resource field above\\n**type**: *enum_string*\\n**enum**: hide|show|default\\n**default**: varies\\n**elements**: any\\n*(optional)*\",\n    \"2-2\": \"Set the visibility of a field.\",\n    \"3-0\": \"showFieldIcon_*\",\n    \"3-1\": \"\\\\*: any card, bank, or payer resource field above\\n**type**: *enum_string*\\n**enum**: hide|show|default\\n**default**: varies\\n**elements**: any\\n*(optional)*\",\n    \"3-2\": \"Set the visibility of a field's icon.\",\n    \"4-0\": \"setPlaceholder_*\",\n    \"4-1\": \"\\\\*: any card, bank, or payer resource field above\\n**type**: *string*\\n**elements**: any\\n*(optional)*\",\n    \"4-2\": \"Set the placeholder text for a field.\",\n    \"5-0\": \"setFieldIcon_*\",\n    \"5-1\": \"\\\\*: any card, bank, or payer resource field above\\n**type**: *material_icon_string*\\n**elements**: any\\n*(optional)\\t*\",\n    \"5-2\": \"Set a fields icon.\",\n    \"6-0\": \"setLabel_*\",\n    \"6-1\": \"\\\\*: any card, bank, or payer resource field above\\n**type**: *string*\\n**elements**: any\\n*(optional)\\t*\",\n    \"6-2\": \"Set a field's label.\",\n    \"7-0\": \"setLayout_fundSelect\",\n    \"7-1\": \"**type**: *enum_string*\\n**enum**: tabs|buttons\\n**elements**: any\\n*(optional)* \",\n    \"7-2\": \"Set the layout for the payment method select buttons/tabs.\",\n    \"8-0\": \"setFundSelector_cardTabText\",\n    \"8-1\": \"**type**: *string*\\nb: any\\n*(optional)*\",\n    \"8-2\": \"Set the card payment method selector text.\",\n    \"9-0\": \"setFundSelector_bankTabText\",\n    \"9-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)\\t* \",\n    \"9-2\": \"Set the ach payment method selector text.\",\n    \"10-0\": \"setFundSelector_bankSessionTabText\",\n    \"10-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"10-2\": \"Set the echeck payment method selector text.\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]\n## Behavior Attributes\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"disableRecoupFees\",\n    \"1-0\": \"disableBankRecoupFees\",\n    \"2-0\": \"disableCardRecoupFees\",\n    \"0-1\": \"**type**:*boolean*\\n**elements**: any\\n*(optional)*\",\n    \"0-2\": \"Disable recoup fees for all payment rails (if you have it enabled in the dashboard).\",\n    \"1-2\": \"Disable recoup fees for bank payments (if you have it enabled in the dashboard).\",\n    \"2-2\": \"Disable recoup fees for card payments (if you have it enabled in the dashboard).\",\n    \"1-1\": \"**type**:*boolean*\\n**elements**: any\\n*(optional)*\",\n    \"2-1\": \"**type**:*boolean*\\n**elements**: any\\n*(optional)*\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","excerpt":"A list of all the allowed attributes in checkout.","slug":"checkout-attributes","type":"basic","title":"Attributes","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Attributes

A list of all the allowed attributes in checkout.

Attributes can be added to the checkout script tag and HTML buttons to configure checkout. For example, here is a scheduled payment monthly checkout for $100.00, embedded, with an email passed in which will only accept cards as payment method. [block:code] { "codes": [ { "code": "<script\n type=\"text/javascript\"\n id=\"paystand_checkout\"\n src=\"https://checkout.paystand.co/v4/js/paystand.checkout.js\"\n ps-env=\"sandbox\" \n ps-publishableKey=\"1noqhele1yjgieoi8aqe4n8i\"\n ps-mode=\"embed\"\n ps-show=\"true\"\n ps-spAmount=\"100.00\"\n ps-spCurrency=\"USD\"\n ps-fixedAmount=\"true\"\n ps-payerEmail=\"email@paystand.com\"\n ps-checkoutType=\"checkout_scheduled_payment\"\n ps-spInterval=\"month\"\n ps-viewFunds=\"card\"\n ps-viewClose=\"hide\"\n></script>\n", "language": "javascript", "name": "Scheduled Payment Example using Attributes for its configuration" } ] } [/block] ## General Attributes [block:parameters] { "data": { "h-0": "attribute", "h-1": "details", "h-2": "description", "0-0": "publishableKey", "0-1": "**type**: *string*\n**elements**: init_script\n*(required)* ", "0-2": "The customer's publishableKey", "1-0": "containerId", "1-1": "**type**: *string*\n**example**: my_checkout_container\n**elements**: init_script\n*(optional)* ", "1-2": "An html element id, whose element checkout should be injected into.", "2-0": "env", "2-1": "**type**: *enum_string*\n**enum**: sandbox|live|default\n**default**: live\n**elements**: init_script\n*(optional)* ", "2-2": "The environment mode the checkout instance should operate in.", "3-0": "debug", "3-1": "**type**: *enum_string*\n**enum**: true|false\n**default**: false\n**elements**: init_script\n*(optional)* ", "3-2": "When set to 'true', extra logs will be output to the console.", "4-0": "mode", "5-0": "width", "6-0": "height", "7-0": "ps-click", "4-1": "**type**: *enum_string*\n**enum**: modal|embed\n**default**: modal\n**elements**: any\n*(optional)* ", "5-1": "**type**: *string*\n**examples**: 100px|100%\n**default**: 400px\n**elements**: any\n*(optional)* ", "6-1": "**type**: *string*\n**examples**: 100px|100%\n**default**: 700px\n**elements**: any\n*(optional)* ", "7-1": "**type**: *js_string*\n**examples**: \"getDetails();\"\n**elements**: buttons\n*(optional)* ", "7-2": "Similar to the javascript onClick event. Fires once per click. Can contain arbitrary javascript statements. The final result of the statements should be a valid checkout settings hash that will be used to configure the checkout instance.", "6-2": "The height of the checkout frame.", "5-2": "The width of the checkout frame.", "4-2": "Whether checkout should render as a modal popup or an embedded checkout.", "8-0": "drawerType", "8-1": "**type**: *string* (3 values req.)\n**examples**: open_displaced_fixed\n**default**: closed_overlay_toggle\n**elements**: open/closed|displaced/overlay|fixed/toggle\n*(optional)*", "8-2": "This is used to change the payor pays fee drawer in your checkout.\n * Open/Closed: Open **OR** close drawer.\n * Displaced/Overlay: In open drawer, move content down **OR **have drawer on top of content.\n * Fixed/Toggle: User cannot open/close drawer by clicking **OR** User can open/close drawer by clicking.\nSupported combinations:\n * open_displaced_fixed\n * open_displaced_toggle\n * closed_displaced_toggle\n * closed_overlay_fixed\n * closed_overlay_toggle" }, "cols": 3, "rows": 9 } [/block] ## General display attributes [block:parameters] { "data": { "h-0": "attribute", "h-1": "details", "h-2": "description", "0-0": "checkoutType", "0-1": "**type**: *enum_string*\n**enum**: checkout_payment|checkout_token|\ncheckout_scheduled_payment|checkout_token2col||checkout_bank_enrollment\n**default**: checkout_payment\n**elements**: any\n*(optional)*", "0-2": "The type of checkout to render. The checkout type largly determines the overall type of flow the checkout will perform.", "1-0": "viewFunds", "1-1": "**type**: *ordered_comma_separated_enum_string *\n**enum**: card|ach|echeck|default\n**default**: echeck,card,ach\n**example**: echeck,ach,card\n**elements**: any\n*(optional)* ", "1-2": "Sets the payment methods available in the checkout instance as well as the order in which they will appear.", "2-0": "viewLogo", "2-1": "**type**: *enum_string *\n**enum**: hide|show|ps|default\n**default**: ps\n**elements**: any\n*(optional)* ", "2-2": "Sets the visibility of the header logo.", "3-0": "viewClose", "3-1": "**type**:* enum_string*\n**enum**: hide|show|default\n**default**: show\n**elements**: any\n*(optional)* ", "3-2": "Set the visibility of the close button inside the checkout instance.", "4-0": "viewCheckout", "4-1": "**type**: *enum_string*\n**enum**: portal-xlarge|portal-large|portal-medium|\nportal-small|portal|mobile|default\n**default**: mobile\n**elements**: any\n*(optional)* ", "4-2": "Set whether the checkout displays the the billing portal chrome layout or the more compact mobile layout.", "5-0": "viewReceipt", "5-1": "**type**: *enum_string*\n**enum**: hide|show|close|default\n**default**: show\n**elements**: any\n*(optional)* ", "5-2": "Set what should happen once a flow completes.", "6-0": "viewLabels", "6-1": "**type**: *enum_string*\n**enum**: hide|show|default\n**default**: show\n**elements**: any\n*(optional)* ", "6-2": "Set the visibility of field labels globally.", "7-0": "viewHeader", "7-1": "**type**:**** *enum_string*\n**enum**: hide|show|default\n**default**: show\n**elements**: any\n*(optional)* ", "7-2": "Set the visibility of the checkout instance header section.", "8-0": "viewSecure", "8-1": "**type**: *enum_string*\n**enum**: hide|show|default\n**default**: show\n**elements**: any\n*(optional)* ", "8-2": "Set the visibility of the security notice. This is usually the 'lock' symbol in the bottom right hand corner of the checkout instance.", "9-0": "viewExtIds", "9-1": "**type**: *ordered_comma_separated_enum_string *\n**enum**: card|bank|payer\n**default**: none\n**example**: card,bank\n**elements**: any\n*(optional)* ", "9-2": "Set the visibility of various resource external ids.", "12-0": "fixedAmount", "12-1": "**type**: *boolean_string*\n**default**: false\n**elements**: any\n*(optional)* ", "12-2": "Set the payment amount to be editable or fixed.", "13-0": "customReceipt", "13-1": "**type**: *html_string*\n**elements**: any\n*(optional)* ", "13-2": "Set a custom message on the receipt page.", "14-0": "headerColor", "14-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "14-2": "Set the header color. Can be any valid css color.", "15-0": "externalCss", "15-1": "**type**: *css_url_string*\n**elements**: any\n*(optional)* ", "15-2": "Load an external css file to alter the look and feel of the checkout instance.", "16-0": "logoUrl", "16-1": "**type**: image_url_string\n**elements**: any\n(optional)", "16-2": "Load an external image url to display as the header logo.", "11-0": "viewSupportInfo", "11-1": "**type**: *boolean_string*\n**default**: true\n**elements**: any\n*(optional)*", "11-2": "Set the visibility of the PayStand support content in the portal view's footer.", "10-0": "viewPoweredBy", "10-1": "**type**: *boolean_string*\n**default**: true\n**elements**: any\n*(optional)*", "10-2": "Set the visibility of the \"Powered by: PayStand\" logo in the portal view's footer.", "17-0": "hideCf", "17-1": "**type**:*string*\n**elements**:any\n*(optional)*", "17-2": "Comma separated list of custom field keys. Hide custom fields that have been enabled in the dashboard or per billing portal." }, "cols": 3, "rows": 18 } [/block] ## Resource attributes [block:parameters] { "data": { "0-0": "cardExtId", "0-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "0-2": "The card external id.", "1-0": "cardMeta", "1-1": "**type**: *json_string*\n**elements**: any\n*(optional)* ", "1-2": "The card meta data.", "2-0": "cardAddressStreet", "2-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "2-2": "The card street address.", "3-0": "cardAddressCity", "3-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "3-2": "The card city address.", "4-0": "cardAddressPostal", "4-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "4-2": "The card postal address.", "5-0": "cardAddressState", "5-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "5-2": "The card state address.", "6-0": "cardAddressCountry", "6-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "6-2": "The card country address.", "7-0": "bankNameOnAccount", "7-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "7-2": "The name on the bank account.", "8-0": "bankAccountType", "8-1": "**type**: *enum_string*\n**enum**: checking|savings\n**elements**: any\n*(optional)* ", "8-2": "The bank account type.", "9-0": "bankAccountHolderType", "9-1": "**type**: *enum_string*\n**enum**: individual|corporate\n**elements**: any\n*(optional)* ", "9-2": "The bank account holder type.", "10-0": "bankRouting", "10-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "10-2": "The bank routing number.", "11-0": "bankAccount", "11-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "11-2": "The bank account number.", "12-0": "bankAccountRepeat", "12-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "12-2": "The bank account repeat number.", "13-0": "bankExtId", "13-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "13-2": "The bank external id.", "14-0": "bankMeta", "14-1": "**type**: *json_string*\n**elements**: any\n*(optional)* ", "14-2": "The bank meta data.", "15-0": "bankAddressStreet", "15-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "15-2": "The bank street address.", "16-0": "bankAddressCity", "16-1": "**type**: *string*\n**elements**: any\n*(optional)\t* ", "16-2": "The bank city address.", "17-0": "bankAddressPostal", "17-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "17-2": "The bank postal address.", "18-0": "bankAddressState", "18-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "18-2": "The bank state address.", "19-0": "bankAddressCountry", "19-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "19-2": "The bank country address.", "20-0": "payerName", "20-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "20-2": "The payer name.", "21-0": "payerEmail", "21-1": "**type**: *string*\n**elements**: any\n*(optional)*", "21-2": "The payer email.", "23-0": "payerExtId", "23-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "23-2": "The payer external id.", "24-0": "payerMeta", "24-1": "**type**: *json_string*\n**elements**: any\n*(optional)* ", "24-2": "The payer meta data.", "25-0": "payerAddressStreet", "25-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "25-2": "The payer street address.", "26-0": "payerAddressCity", "26-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "26-2": "The payer city address.", "27-0": "payerAddressPostal", "27-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "27-2": "The payer postal address.", "28-0": "payerAddressState", "28-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "28-2": "The payer state address.", "29-0": "payerAddressCountry", "29-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "29-2": "The payer country address.", "30-0": "paymentAmount", "30-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "30-2": "The payment amount.", "31-0": "paymentCurrency", "31-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "31-2": "The payment currency. Supported currencies [ \"USD\", \"CAD\", \"EUR\", \"MXN\", \"AUD\", \"GBP\" ]", "32-0": "paymentDescription", "32-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "32-2": "The payment description.", "33-0": "paymentExtId", "33-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "33-2": "The payment external id.", "34-0": "paymentMeta", "34-1": "**type**: *json_string*\n**elements**: any\n*(optional)* ", "34-2": "The payment meta.", "35-0": "spName", "35-1": "**type**:* string*\n**elements**: any\n*(optional)* ", "35-2": "The scheduled payment name.", "36-0": "spDescription", "36-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "36-2": "The scheduled payment description.", "37-0": "spExtId", "37-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "37-2": "The scheduled payment external id.", "38-0": "spMeta", "38-1": "**type**: *json_string*\n**elements**: any\n*(optional)* ", "38-2": "The scheduled payment meta data.", "39-0": "spAmount", "39-1": "**type**: * integer_string*\n**elements**: any\n*(optional)*", "39-2": "The scheduled payment amount.", "40-0": "spCurrency", "40-1": "**type**: *enum_string*\n**elements**: any\n**default**: USD\n*(optional)*", "40-2": "The scheduled payment currency. \nSupported currencies [ \"USD\", \"CAD\", \"EUR\", \"MXN\", \"AUD\", \"GBP\" ]", "41-0": "spInterval", "41-1": "**type**: *enum_string*\n**enum**: week|month|year|day\n**elements**: any\n**default**: week\n*(optional)*", "41-2": "The scheduled payment interval.", "42-0": "spIntervalCount", "42-1": "**type**: *integer_string*\n**elements**: any\n*(optional)* ", "42-2": "The scheduled payment interval count.", "43-0": "spAnchor", "43-1": "**type**: *enum_string*\n**enum**: start|end\nelements: any\n*(optional)*", "43-2": "The scheduled payment anchor.", "44-0": "spTimesToRun", "44-1": "**type**:* integer_string*\n**elements**: any\n*(optional)* ", "44-2": "The scheduled payment times to run.", "45-0": "spAtDay", "45-1": "**type**:* integer_string*\n**elements**: any\n*(optional)* ", "45-2": "The scheduled payment day to run.", "46-0": "cf_*", "46-1": "*: any valid custom field key\n**type**: *string*\n**elements**: any\n*(optional)* ", "46-2": "Custom field resource data. If a custom field has a key such as someCustomFieldKey, then the attribute should be cf_some_custom_field_key.", "22-0": "payerId", "22-1": "**type**: *string*\n**elements**: any\n*(optional)*", "22-2": "The payer id." }, "cols": 3, "rows": 47 } [/block] ## Resource display attributes [block:parameters] { "data": { "0-0": "showHeader_*", "0-1": "\\*: cardHeader | bankHeader | payerHeader\n**type**: *enum_string*\n**enum**: hide|show|default\n**default**: show\n**elements**: any\n*(optional)\t*", "0-2": "Set the visibility of a section header.", "1-0": "setHeader_*", "1-1": "\\*: cardHeader | bankHeader | payerHeader\n**type**: *string*\n**elements**: any\n*(optional)*", "1-2": "Set the text for a section header.", "2-0": "showField_*", "2-1": "\\*: any card, bank, or payer resource field above\n**type**: *enum_string*\n**enum**: hide|show|default\n**default**: varies\n**elements**: any\n*(optional)*", "2-2": "Set the visibility of a field.", "3-0": "showFieldIcon_*", "3-1": "\\*: any card, bank, or payer resource field above\n**type**: *enum_string*\n**enum**: hide|show|default\n**default**: varies\n**elements**: any\n*(optional)*", "3-2": "Set the visibility of a field's icon.", "4-0": "setPlaceholder_*", "4-1": "\\*: any card, bank, or payer resource field above\n**type**: *string*\n**elements**: any\n*(optional)*", "4-2": "Set the placeholder text for a field.", "5-0": "setFieldIcon_*", "5-1": "\\*: any card, bank, or payer resource field above\n**type**: *material_icon_string*\n**elements**: any\n*(optional)\t*", "5-2": "Set a fields icon.", "6-0": "setLabel_*", "6-1": "\\*: any card, bank, or payer resource field above\n**type**: *string*\n**elements**: any\n*(optional)\t*", "6-2": "Set a field's label.", "7-0": "setLayout_fundSelect", "7-1": "**type**: *enum_string*\n**enum**: tabs|buttons\n**elements**: any\n*(optional)* ", "7-2": "Set the layout for the payment method select buttons/tabs.", "8-0": "setFundSelector_cardTabText", "8-1": "**type**: *string*\nb: any\n*(optional)*", "8-2": "Set the card payment method selector text.", "9-0": "setFundSelector_bankTabText", "9-1": "**type**: *string*\n**elements**: any\n*(optional)\t* ", "9-2": "Set the ach payment method selector text.", "10-0": "setFundSelector_bankSessionTabText", "10-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "10-2": "Set the echeck payment method selector text." }, "cols": 3, "rows": 11 } [/block] ## Behavior Attributes [block:parameters] { "data": { "0-0": "disableRecoupFees", "1-0": "disableBankRecoupFees", "2-0": "disableCardRecoupFees", "0-1": "**type**:*boolean*\n**elements**: any\n*(optional)*", "0-2": "Disable recoup fees for all payment rails (if you have it enabled in the dashboard).", "1-2": "Disable recoup fees for bank payments (if you have it enabled in the dashboard).", "2-2": "Disable recoup fees for card payments (if you have it enabled in the dashboard).", "1-1": "**type**:*boolean*\n**elements**: any\n*(optional)*", "2-1": "**type**:*boolean*\n**elements**: any\n*(optional)*" }, "cols": 3, "rows": 3 } [/block]
Attributes can be added to the checkout script tag and HTML buttons to configure checkout. For example, here is a scheduled payment monthly checkout for $100.00, embedded, with an email passed in which will only accept cards as payment method. [block:code] { "codes": [ { "code": "<script\n type=\"text/javascript\"\n id=\"paystand_checkout\"\n src=\"https://checkout.paystand.co/v4/js/paystand.checkout.js\"\n ps-env=\"sandbox\" \n ps-publishableKey=\"1noqhele1yjgieoi8aqe4n8i\"\n ps-mode=\"embed\"\n ps-show=\"true\"\n ps-spAmount=\"100.00\"\n ps-spCurrency=\"USD\"\n ps-fixedAmount=\"true\"\n ps-payerEmail=\"email@paystand.com\"\n ps-checkoutType=\"checkout_scheduled_payment\"\n ps-spInterval=\"month\"\n ps-viewFunds=\"card\"\n ps-viewClose=\"hide\"\n></script>\n", "language": "javascript", "name": "Scheduled Payment Example using Attributes for its configuration" } ] } [/block] ## General Attributes [block:parameters] { "data": { "h-0": "attribute", "h-1": "details", "h-2": "description", "0-0": "publishableKey", "0-1": "**type**: *string*\n**elements**: init_script\n*(required)* ", "0-2": "The customer's publishableKey", "1-0": "containerId", "1-1": "**type**: *string*\n**example**: my_checkout_container\n**elements**: init_script\n*(optional)* ", "1-2": "An html element id, whose element checkout should be injected into.", "2-0": "env", "2-1": "**type**: *enum_string*\n**enum**: sandbox|live|default\n**default**: live\n**elements**: init_script\n*(optional)* ", "2-2": "The environment mode the checkout instance should operate in.", "3-0": "debug", "3-1": "**type**: *enum_string*\n**enum**: true|false\n**default**: false\n**elements**: init_script\n*(optional)* ", "3-2": "When set to 'true', extra logs will be output to the console.", "4-0": "mode", "5-0": "width", "6-0": "height", "7-0": "ps-click", "4-1": "**type**: *enum_string*\n**enum**: modal|embed\n**default**: modal\n**elements**: any\n*(optional)* ", "5-1": "**type**: *string*\n**examples**: 100px|100%\n**default**: 400px\n**elements**: any\n*(optional)* ", "6-1": "**type**: *string*\n**examples**: 100px|100%\n**default**: 700px\n**elements**: any\n*(optional)* ", "7-1": "**type**: *js_string*\n**examples**: \"getDetails();\"\n**elements**: buttons\n*(optional)* ", "7-2": "Similar to the javascript onClick event. Fires once per click. Can contain arbitrary javascript statements. The final result of the statements should be a valid checkout settings hash that will be used to configure the checkout instance.", "6-2": "The height of the checkout frame.", "5-2": "The width of the checkout frame.", "4-2": "Whether checkout should render as a modal popup or an embedded checkout.", "8-0": "drawerType", "8-1": "**type**: *string* (3 values req.)\n**examples**: open_displaced_fixed\n**default**: closed_overlay_toggle\n**elements**: open/closed|displaced/overlay|fixed/toggle\n*(optional)*", "8-2": "This is used to change the payor pays fee drawer in your checkout.\n * Open/Closed: Open **OR** close drawer.\n * Displaced/Overlay: In open drawer, move content down **OR **have drawer on top of content.\n * Fixed/Toggle: User cannot open/close drawer by clicking **OR** User can open/close drawer by clicking.\nSupported combinations:\n * open_displaced_fixed\n * open_displaced_toggle\n * closed_displaced_toggle\n * closed_overlay_fixed\n * closed_overlay_toggle" }, "cols": 3, "rows": 9 } [/block] ## General display attributes [block:parameters] { "data": { "h-0": "attribute", "h-1": "details", "h-2": "description", "0-0": "checkoutType", "0-1": "**type**: *enum_string*\n**enum**: checkout_payment|checkout_token|\ncheckout_scheduled_payment|checkout_token2col||checkout_bank_enrollment\n**default**: checkout_payment\n**elements**: any\n*(optional)*", "0-2": "The type of checkout to render. The checkout type largly determines the overall type of flow the checkout will perform.", "1-0": "viewFunds", "1-1": "**type**: *ordered_comma_separated_enum_string *\n**enum**: card|ach|echeck|default\n**default**: echeck,card,ach\n**example**: echeck,ach,card\n**elements**: any\n*(optional)* ", "1-2": "Sets the payment methods available in the checkout instance as well as the order in which they will appear.", "2-0": "viewLogo", "2-1": "**type**: *enum_string *\n**enum**: hide|show|ps|default\n**default**: ps\n**elements**: any\n*(optional)* ", "2-2": "Sets the visibility of the header logo.", "3-0": "viewClose", "3-1": "**type**:* enum_string*\n**enum**: hide|show|default\n**default**: show\n**elements**: any\n*(optional)* ", "3-2": "Set the visibility of the close button inside the checkout instance.", "4-0": "viewCheckout", "4-1": "**type**: *enum_string*\n**enum**: portal-xlarge|portal-large|portal-medium|\nportal-small|portal|mobile|default\n**default**: mobile\n**elements**: any\n*(optional)* ", "4-2": "Set whether the checkout displays the the billing portal chrome layout or the more compact mobile layout.", "5-0": "viewReceipt", "5-1": "**type**: *enum_string*\n**enum**: hide|show|close|default\n**default**: show\n**elements**: any\n*(optional)* ", "5-2": "Set what should happen once a flow completes.", "6-0": "viewLabels", "6-1": "**type**: *enum_string*\n**enum**: hide|show|default\n**default**: show\n**elements**: any\n*(optional)* ", "6-2": "Set the visibility of field labels globally.", "7-0": "viewHeader", "7-1": "**type**:**** *enum_string*\n**enum**: hide|show|default\n**default**: show\n**elements**: any\n*(optional)* ", "7-2": "Set the visibility of the checkout instance header section.", "8-0": "viewSecure", "8-1": "**type**: *enum_string*\n**enum**: hide|show|default\n**default**: show\n**elements**: any\n*(optional)* ", "8-2": "Set the visibility of the security notice. This is usually the 'lock' symbol in the bottom right hand corner of the checkout instance.", "9-0": "viewExtIds", "9-1": "**type**: *ordered_comma_separated_enum_string *\n**enum**: card|bank|payer\n**default**: none\n**example**: card,bank\n**elements**: any\n*(optional)* ", "9-2": "Set the visibility of various resource external ids.", "12-0": "fixedAmount", "12-1": "**type**: *boolean_string*\n**default**: false\n**elements**: any\n*(optional)* ", "12-2": "Set the payment amount to be editable or fixed.", "13-0": "customReceipt", "13-1": "**type**: *html_string*\n**elements**: any\n*(optional)* ", "13-2": "Set a custom message on the receipt page.", "14-0": "headerColor", "14-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "14-2": "Set the header color. Can be any valid css color.", "15-0": "externalCss", "15-1": "**type**: *css_url_string*\n**elements**: any\n*(optional)* ", "15-2": "Load an external css file to alter the look and feel of the checkout instance.", "16-0": "logoUrl", "16-1": "**type**: image_url_string\n**elements**: any\n(optional)", "16-2": "Load an external image url to display as the header logo.", "11-0": "viewSupportInfo", "11-1": "**type**: *boolean_string*\n**default**: true\n**elements**: any\n*(optional)*", "11-2": "Set the visibility of the PayStand support content in the portal view's footer.", "10-0": "viewPoweredBy", "10-1": "**type**: *boolean_string*\n**default**: true\n**elements**: any\n*(optional)*", "10-2": "Set the visibility of the \"Powered by: PayStand\" logo in the portal view's footer.", "17-0": "hideCf", "17-1": "**type**:*string*\n**elements**:any\n*(optional)*", "17-2": "Comma separated list of custom field keys. Hide custom fields that have been enabled in the dashboard or per billing portal." }, "cols": 3, "rows": 18 } [/block] ## Resource attributes [block:parameters] { "data": { "0-0": "cardExtId", "0-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "0-2": "The card external id.", "1-0": "cardMeta", "1-1": "**type**: *json_string*\n**elements**: any\n*(optional)* ", "1-2": "The card meta data.", "2-0": "cardAddressStreet", "2-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "2-2": "The card street address.", "3-0": "cardAddressCity", "3-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "3-2": "The card city address.", "4-0": "cardAddressPostal", "4-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "4-2": "The card postal address.", "5-0": "cardAddressState", "5-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "5-2": "The card state address.", "6-0": "cardAddressCountry", "6-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "6-2": "The card country address.", "7-0": "bankNameOnAccount", "7-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "7-2": "The name on the bank account.", "8-0": "bankAccountType", "8-1": "**type**: *enum_string*\n**enum**: checking|savings\n**elements**: any\n*(optional)* ", "8-2": "The bank account type.", "9-0": "bankAccountHolderType", "9-1": "**type**: *enum_string*\n**enum**: individual|corporate\n**elements**: any\n*(optional)* ", "9-2": "The bank account holder type.", "10-0": "bankRouting", "10-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "10-2": "The bank routing number.", "11-0": "bankAccount", "11-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "11-2": "The bank account number.", "12-0": "bankAccountRepeat", "12-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "12-2": "The bank account repeat number.", "13-0": "bankExtId", "13-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "13-2": "The bank external id.", "14-0": "bankMeta", "14-1": "**type**: *json_string*\n**elements**: any\n*(optional)* ", "14-2": "The bank meta data.", "15-0": "bankAddressStreet", "15-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "15-2": "The bank street address.", "16-0": "bankAddressCity", "16-1": "**type**: *string*\n**elements**: any\n*(optional)\t* ", "16-2": "The bank city address.", "17-0": "bankAddressPostal", "17-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "17-2": "The bank postal address.", "18-0": "bankAddressState", "18-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "18-2": "The bank state address.", "19-0": "bankAddressCountry", "19-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "19-2": "The bank country address.", "20-0": "payerName", "20-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "20-2": "The payer name.", "21-0": "payerEmail", "21-1": "**type**: *string*\n**elements**: any\n*(optional)*", "21-2": "The payer email.", "23-0": "payerExtId", "23-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "23-2": "The payer external id.", "24-0": "payerMeta", "24-1": "**type**: *json_string*\n**elements**: any\n*(optional)* ", "24-2": "The payer meta data.", "25-0": "payerAddressStreet", "25-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "25-2": "The payer street address.", "26-0": "payerAddressCity", "26-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "26-2": "The payer city address.", "27-0": "payerAddressPostal", "27-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "27-2": "The payer postal address.", "28-0": "payerAddressState", "28-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "28-2": "The payer state address.", "29-0": "payerAddressCountry", "29-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "29-2": "The payer country address.", "30-0": "paymentAmount", "30-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "30-2": "The payment amount.", "31-0": "paymentCurrency", "31-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "31-2": "The payment currency. Supported currencies [ \"USD\", \"CAD\", \"EUR\", \"MXN\", \"AUD\", \"GBP\" ]", "32-0": "paymentDescription", "32-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "32-2": "The payment description.", "33-0": "paymentExtId", "33-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "33-2": "The payment external id.", "34-0": "paymentMeta", "34-1": "**type**: *json_string*\n**elements**: any\n*(optional)* ", "34-2": "The payment meta.", "35-0": "spName", "35-1": "**type**:* string*\n**elements**: any\n*(optional)* ", "35-2": "The scheduled payment name.", "36-0": "spDescription", "36-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "36-2": "The scheduled payment description.", "37-0": "spExtId", "37-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "37-2": "The scheduled payment external id.", "38-0": "spMeta", "38-1": "**type**: *json_string*\n**elements**: any\n*(optional)* ", "38-2": "The scheduled payment meta data.", "39-0": "spAmount", "39-1": "**type**: * integer_string*\n**elements**: any\n*(optional)*", "39-2": "The scheduled payment amount.", "40-0": "spCurrency", "40-1": "**type**: *enum_string*\n**elements**: any\n**default**: USD\n*(optional)*", "40-2": "The scheduled payment currency. \nSupported currencies [ \"USD\", \"CAD\", \"EUR\", \"MXN\", \"AUD\", \"GBP\" ]", "41-0": "spInterval", "41-1": "**type**: *enum_string*\n**enum**: week|month|year|day\n**elements**: any\n**default**: week\n*(optional)*", "41-2": "The scheduled payment interval.", "42-0": "spIntervalCount", "42-1": "**type**: *integer_string*\n**elements**: any\n*(optional)* ", "42-2": "The scheduled payment interval count.", "43-0": "spAnchor", "43-1": "**type**: *enum_string*\n**enum**: start|end\nelements: any\n*(optional)*", "43-2": "The scheduled payment anchor.", "44-0": "spTimesToRun", "44-1": "**type**:* integer_string*\n**elements**: any\n*(optional)* ", "44-2": "The scheduled payment times to run.", "45-0": "spAtDay", "45-1": "**type**:* integer_string*\n**elements**: any\n*(optional)* ", "45-2": "The scheduled payment day to run.", "46-0": "cf_*", "46-1": "*: any valid custom field key\n**type**: *string*\n**elements**: any\n*(optional)* ", "46-2": "Custom field resource data. If a custom field has a key such as someCustomFieldKey, then the attribute should be cf_some_custom_field_key.", "22-0": "payerId", "22-1": "**type**: *string*\n**elements**: any\n*(optional)*", "22-2": "The payer id." }, "cols": 3, "rows": 47 } [/block] ## Resource display attributes [block:parameters] { "data": { "0-0": "showHeader_*", "0-1": "\\*: cardHeader | bankHeader | payerHeader\n**type**: *enum_string*\n**enum**: hide|show|default\n**default**: show\n**elements**: any\n*(optional)\t*", "0-2": "Set the visibility of a section header.", "1-0": "setHeader_*", "1-1": "\\*: cardHeader | bankHeader | payerHeader\n**type**: *string*\n**elements**: any\n*(optional)*", "1-2": "Set the text for a section header.", "2-0": "showField_*", "2-1": "\\*: any card, bank, or payer resource field above\n**type**: *enum_string*\n**enum**: hide|show|default\n**default**: varies\n**elements**: any\n*(optional)*", "2-2": "Set the visibility of a field.", "3-0": "showFieldIcon_*", "3-1": "\\*: any card, bank, or payer resource field above\n**type**: *enum_string*\n**enum**: hide|show|default\n**default**: varies\n**elements**: any\n*(optional)*", "3-2": "Set the visibility of a field's icon.", "4-0": "setPlaceholder_*", "4-1": "\\*: any card, bank, or payer resource field above\n**type**: *string*\n**elements**: any\n*(optional)*", "4-2": "Set the placeholder text for a field.", "5-0": "setFieldIcon_*", "5-1": "\\*: any card, bank, or payer resource field above\n**type**: *material_icon_string*\n**elements**: any\n*(optional)\t*", "5-2": "Set a fields icon.", "6-0": "setLabel_*", "6-1": "\\*: any card, bank, or payer resource field above\n**type**: *string*\n**elements**: any\n*(optional)\t*", "6-2": "Set a field's label.", "7-0": "setLayout_fundSelect", "7-1": "**type**: *enum_string*\n**enum**: tabs|buttons\n**elements**: any\n*(optional)* ", "7-2": "Set the layout for the payment method select buttons/tabs.", "8-0": "setFundSelector_cardTabText", "8-1": "**type**: *string*\nb: any\n*(optional)*", "8-2": "Set the card payment method selector text.", "9-0": "setFundSelector_bankTabText", "9-1": "**type**: *string*\n**elements**: any\n*(optional)\t* ", "9-2": "Set the ach payment method selector text.", "10-0": "setFundSelector_bankSessionTabText", "10-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "10-2": "Set the echeck payment method selector text." }, "cols": 3, "rows": 11 } [/block] ## Behavior Attributes [block:parameters] { "data": { "0-0": "disableRecoupFees", "1-0": "disableBankRecoupFees", "2-0": "disableCardRecoupFees", "0-1": "**type**:*boolean*\n**elements**: any\n*(optional)*", "0-2": "Disable recoup fees for all payment rails (if you have it enabled in the dashboard).", "1-2": "Disable recoup fees for bank payments (if you have it enabled in the dashboard).", "2-2": "Disable recoup fees for card payments (if you have it enabled in the dashboard).", "1-1": "**type**:*boolean*\n**elements**: any\n*(optional)*", "2-1": "**type**:*boolean*\n**elements**: any\n*(optional)*" }, "cols": 3, "rows": 3 } [/block]
{"_id":"5d56fccfb1b7fc00334d19fa","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1939","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-11T14:35:45.935Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"A customer represents a person or a business that can use the Paystand network. A customer can send and receive payments, create and track receivables, manage their accounts, withdrawal funds, and much more. To get started **Signup with Paystand** to get access to your customer.\n\n## For direct and platform customers\n\n[Update your customer](doc:update-a-customer)\nProvide all required customer information to verify the customer.\n\n[Verify a bank account](doc:verify-bank-drop-amounts)\nCheck your bank statement after a few days of adding a bank account to retrieve the two amounts that Paystand deposited into the account.\n\n[Add an additional owner](doc:create-additional-owner)\nAdd or manage additional owners to help verify the customer.\n\n[Add another bank account](doc:create-bank)\nAdd an additional bank account to withdrawal funds to.\n\n[Add an extra account](doc:create-an-account)\nAccept payments on different accounts to keep funds from various sources separate. Automate withdrawal schedules per account.\n\n[Retrieve the balance](doc:retrieve-a-balance)\nSee the current balance for an account.\n\n[Register to get a bank's history](doc:bank-history)\nLogin to your bank to register a bank account to retrieve ongoing bank history transactions.\n\n## For platform customers\n\n[Create a customer](doc:create-customer)\nOnboard a new customer to your platform.","excerpt":"","slug":"getting-started-2","type":"basic","title":"Getting Started","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Getting Started


A customer represents a person or a business that can use the Paystand network. A customer can send and receive payments, create and track receivables, manage their accounts, withdrawal funds, and much more. To get started **Signup with Paystand** to get access to your customer. ## For direct and platform customers [Update your customer](doc:update-a-customer) Provide all required customer information to verify the customer. [Verify a bank account](doc:verify-bank-drop-amounts) Check your bank statement after a few days of adding a bank account to retrieve the two amounts that Paystand deposited into the account. [Add an additional owner](doc:create-additional-owner) Add or manage additional owners to help verify the customer. [Add another bank account](doc:create-bank) Add an additional bank account to withdrawal funds to. [Add an extra account](doc:create-an-account) Accept payments on different accounts to keep funds from various sources separate. Automate withdrawal schedules per account. [Retrieve the balance](doc:retrieve-a-balance) See the current balance for an account. [Register to get a bank's history](doc:bank-history) Login to your bank to register a bank account to retrieve ongoing bank history transactions. ## For platform customers [Create a customer](doc:create-customer) Onboard a new customer to your platform.
A customer represents a person or a business that can use the Paystand network. A customer can send and receive payments, create and track receivables, manage their accounts, withdrawal funds, and much more. To get started **Signup with Paystand** to get access to your customer. ## For direct and platform customers [Update your customer](doc:update-a-customer) Provide all required customer information to verify the customer. [Verify a bank account](doc:verify-bank-drop-amounts) Check your bank statement after a few days of adding a bank account to retrieve the two amounts that Paystand deposited into the account. [Add an additional owner](doc:create-additional-owner) Add or manage additional owners to help verify the customer. [Add another bank account](doc:create-bank) Add an additional bank account to withdrawal funds to. [Add an extra account](doc:create-an-account) Accept payments on different accounts to keep funds from various sources separate. Automate withdrawal schedules per account. [Retrieve the balance](doc:retrieve-a-balance) See the current balance for an account. [Register to get a bank's history](doc:bank-history) Login to your bank to register a bank account to retrieve ongoing bank history transactions. ## For platform customers [Create a customer](doc:create-customer) Onboard a new customer to your platform.
{"_id":"5d56fccfb1b7fc00334d198b","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1921","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-26T15:50:18.377Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Accounts allow you to separate funds on your escrow. You may want to do this so that certain funds never mix for accounting or business reasons.  Every customer starts off with one account, called the `default` account. A customer can create any number of accounts. Each account must have a unique \"key\" often referred to as the \"accountKey\". Once set, this key cannot be updated. Once an account is created, it cannot be deleted. Funds are withdrawn to a customer's bank account per account. So, if you have funds spread over several accounts, several withdrawals will need to be created to withdrawal all of the funds.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /balances/accounts\\n PUT /balances/accounts/:accountId\\n GET /balances/accounts/:accountId\\n GET /balances/summary\",\n      \"language\": \"json\",\n      \"name\": \"ENDPOINTS\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"account","type":"basic","title":"Accounts","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Accounts


Accounts allow you to separate funds on your escrow. You may want to do this so that certain funds never mix for accounting or business reasons. Every customer starts off with one account, called the `default` account. A customer can create any number of accounts. Each account must have a unique "key" often referred to as the "accountKey". Once set, this key cannot be updated. Once an account is created, it cannot be deleted. Funds are withdrawn to a customer's bank account per account. So, if you have funds spread over several accounts, several withdrawals will need to be created to withdrawal all of the funds. [block:code] { "codes": [ { "code": "POST /balances/accounts\n PUT /balances/accounts/:accountId\n GET /balances/accounts/:accountId\n GET /balances/summary", "language": "json", "name": "ENDPOINTS" } ], "sidebar": true } [/block]
Accounts allow you to separate funds on your escrow. You may want to do this so that certain funds never mix for accounting or business reasons. Every customer starts off with one account, called the `default` account. A customer can create any number of accounts. Each account must have a unique "key" often referred to as the "accountKey". Once set, this key cannot be updated. Once an account is created, it cannot be deleted. Funds are withdrawn to a customer's bank account per account. So, if you have funds spread over several accounts, several withdrawals will need to be created to withdrawal all of the funds. [block:code] { "codes": [ { "code": "POST /balances/accounts\n PUT /balances/accounts/:accountId\n GET /balances/accounts/:accountId\n GET /balances/summary", "language": "json", "name": "ENDPOINTS" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d1a00","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1921","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-15T17:35:25.316Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\":\\\"h3qo5rine8itrr43wfen2356\\\",\\n  \\\"object\\\":\\\"balanceAccount\\\",\\n  \\\"name\\\": \\\"California Funds Account\\\",\\n  \\\"key\\\": \\\"california_account\\\",\\n  \\\"status\\\": \\\"active\\\",\\n  \\\"created\\\": \\\"2015-10-28T22:55:09.000Z\\\",\\n  \\\"lastUpdated\\\": \\\"2015-10-28T22:55:13.000Z\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"THE ACCOUNT OBJECT\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**id** *string*\\nThe unique identifier for the account.\",\n    \"1-0\": \"**object** *string, value is \\\"balanceAccount\\\"* \",\n    \"2-0\": \"**name** *string*\\nThe name of the account.\",\n    \"3-0\": \"**key** *string* \\nA key for the account (default, owner, payer, origin, merchant, customer, platform are all disallowed)\",\n    \"4-0\": \"**status** *string, possible values: active, inactive*\\n\\n*active*\\nThe account is active and able to be used for payments and transfers.\\n\\n*inactive* \\nThe account is inactive and is not able to be used for payments and transfers.\",\n    \"5-0\": \"**created** *datestring* \\nThe date the account was created.\",\n    \"6-0\": \"**lastUpdate** *datestring* \\nThe date the account was last updated.\"\n  },\n  \"cols\": 1,\n  \"rows\": 7\n}\n[/block]","excerpt":"","slug":"the-account-object","type":"basic","title":"The account object","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

The account object


[block:code] { "codes": [ { "code": "{\n \"id\":\"h3qo5rine8itrr43wfen2356\",\n \"object\":\"balanceAccount\",\n \"name\": \"California Funds Account\",\n \"key\": \"california_account\",\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "THE ACCOUNT OBJECT" } ], "sidebar": true } [/block] [block:parameters] { "data": { "0-0": "**id** *string*\nThe unique identifier for the account.", "1-0": "**object** *string, value is \"balanceAccount\"* ", "2-0": "**name** *string*\nThe name of the account.", "3-0": "**key** *string* \nA key for the account (default, owner, payer, origin, merchant, customer, platform are all disallowed)", "4-0": "**status** *string, possible values: active, inactive*\n\n*active*\nThe account is active and able to be used for payments and transfers.\n\n*inactive* \nThe account is inactive and is not able to be used for payments and transfers.", "5-0": "**created** *datestring* \nThe date the account was created.", "6-0": "**lastUpdate** *datestring* \nThe date the account was last updated." }, "cols": 1, "rows": 7 } [/block]
[block:code] { "codes": [ { "code": "{\n \"id\":\"h3qo5rine8itrr43wfen2356\",\n \"object\":\"balanceAccount\",\n \"name\": \"California Funds Account\",\n \"key\": \"california_account\",\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "THE ACCOUNT OBJECT" } ], "sidebar": true } [/block] [block:parameters] { "data": { "0-0": "**id** *string*\nThe unique identifier for the account.", "1-0": "**object** *string, value is \"balanceAccount\"* ", "2-0": "**name** *string*\nThe name of the account.", "3-0": "**key** *string* \nA key for the account (default, owner, payer, origin, merchant, customer, platform are all disallowed)", "4-0": "**status** *string, possible values: active, inactive*\n\n*active*\nThe account is active and able to be used for payments and transfers.\n\n*inactive* \nThe account is inactive and is not able to be used for payments and transfers.", "5-0": "**created** *datestring* \nThe date the account was created.", "6-0": "**lastUpdate** *datestring* \nThe date the account was last updated." }, "cols": 1, "rows": 7 } [/block]
{"_id":"5d56fccfb1b7fc00334d198d","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1921","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-26T15:53:34.252Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"The balance summary gives an overview of the \"available\", \"pending\", and \"current\" balances for various accounts a customer has. By default, it will only return the \"default\" account for each currency a customer holds. To return other accounts, include an \"accounts\" query parameter to the request containing a comma-separated list of account you would like balance summaries for.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"usd\\\": {\\n    \\\"default\\\": {\\n      \\\"available\\\": \\\"20.00\\\",\\n      \\\"pending\\\": \\\"80.00\\\",\\n      \\\"current\\\": \\\"100.00\\\"\\n    },\\n    \\\"california_funds\\\": {\\n      \\\"available\\\": \\\"10.00\\\",\\n      \\\"pending\\\": \\\"0.00\\\",\\n      \\\"current\\\": \\\"10.00\\\" \\n    }\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"THE BALANCES OBJECT\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"balance","type":"basic","title":"The balances object","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

The balances object


The balance summary gives an overview of the "available", "pending", and "current" balances for various accounts a customer has. By default, it will only return the "default" account for each currency a customer holds. To return other accounts, include an "accounts" query parameter to the request containing a comma-separated list of account you would like balance summaries for. [block:code] { "codes": [ { "code": "{\n \"usd\": {\n \"default\": {\n \"available\": \"20.00\",\n \"pending\": \"80.00\",\n \"current\": \"100.00\"\n },\n \"california_funds\": {\n \"available\": \"10.00\",\n \"pending\": \"0.00\",\n \"current\": \"10.00\" \n }\n }\n}", "language": "json", "name": "THE BALANCES OBJECT" } ], "sidebar": true } [/block]
The balance summary gives an overview of the "available", "pending", and "current" balances for various accounts a customer has. By default, it will only return the "default" account for each currency a customer holds. To return other accounts, include an "accounts" query parameter to the request containing a comma-separated list of account you would like balance summaries for. [block:code] { "codes": [ { "code": "{\n \"usd\": {\n \"default\": {\n \"available\": \"20.00\",\n \"pending\": \"80.00\",\n \"current\": \"100.00\"\n },\n \"california_funds\": {\n \"available\": \"10.00\",\n \"pending\": \"0.00\",\n \"current\": \"10.00\" \n }\n }\n}", "language": "json", "name": "THE BALANCES OBJECT" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d1984","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1921","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-26T15:16:06.995Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"5693eae65f1c951900644c21","results":{"codes":[{"language":"text","code":""}]},"method":"post","examples":{"codes":[]},"auth":"required","params":[{"_id":"5b59e0ad5c632d0003412145","ref":"","in":"body","required":false,"desc":"The name of the account","default":"required","type":"string","name":"name"},{"_id":"5b59e0ad5c632d000341213a","ref":"","in":"body","required":false,"desc":"A key for the account.","default":"required","type":"string","name":"key"},{"_id":"5b59e1377f39c90003a97260","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b59e1377f39c90003a9725f","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b59e1377f39c90003a9725e","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b59e1377f39c90003a9725d","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"}],"url":"/balances/accounts"},"isReference":false,"order":3,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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  \\\"name\\\": \\\"California Funds Account\\\",\\n  \\\"key\\\": \\\"california_account\\\"\\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  \\\"id\\\":\\\"h3qo5rine8itrr43wfen2356\\\",\\n  \\\"object\\\":\\\"balanceAccount\\\",\\n  \\\"name\\\": \\\"California Funds Account\\\",\\n  \\\"key\\\": \\\"california_account\\\",\\n  \\\"status\\\": \\\"active\\\",\\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":"","slug":"create-an-account","type":"post","title":"Create an account","__v":5,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postCreate an account


Body Params

name:
stringrequired
The name of the account
key:
stringrequired
A key for the account.

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
[block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"California Funds Account\",\n \"key\": \"california_account\"\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\":\"h3qo5rine8itrr43wfen2356\",\n \"object\":\"balanceAccount\",\n \"name\": \"California Funds Account\",\n \"key\": \"california_account\",\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


[block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"California Funds Account\",\n \"key\": \"california_account\"\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\":\"h3qo5rine8itrr43wfen2356\",\n \"object\":\"balanceAccount\",\n \"name\": \"California Funds Account\",\n \"key\": \"california_account\",\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d1985","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1921","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-26T15:20:14.634Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"put","results":{"codes":[{"language":"text","code":""}]},"settings":"5693eae65f1c951900644c21","auth":"required","params":[{"_id":"5b59e0ad5c632d0003412145","ref":"","in":"body","required":false,"desc":"The name of the account.","default":"required","type":"string","name":"name"},{"_id":"5b59e1377f39c90003a97260","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b59e1377f39c90003a9725f","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b59e1377f39c90003a9725e","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Content-Type"},{"_id":"5b59e1377f39c90003a9725d","ref":"","in":"header","required":false,"desc":"","default":"{customerId}","type":"string","name":"X-CUSTOMER-ID"},{"_id":"5b59e6dc7f39c90003a97334","ref":"","in":"path","required":false,"desc":"The id of the account.","default":"required","type":"string","name":"accountId"}],"url":"/balances/accounts/:accountId"},"isReference":false,"order":4,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"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  \\\"name\\\": \\\"California Funds Account\\\"\\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  \\\"id\\\":\\\"h3qo5rine8itrr43wfen2356\\\",\\n  \\\"object\\\":\\\"balanceAccount\\\",\\n  \\\"name\\\": \\\"California Funds Account\\\",\\n  \\\"key\\\": \\\"california_account\\\",\\n  \\\"status\\\": \\\"active\\\",\\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":"","slug":"update-an-account","type":"put","title":"Update an account","__v":6,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

putUpdate an account


Path Params

accountId:
stringrequired
The id of the account.

Body Params

name:
stringrequired
The name of the account.

Headers

Authorization:
stringBearer
Accept:
stringapplication/json
Content-Type:
stringapplication/json
X-CUSTOMER-ID:
string{customerId}
[block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"California Funds Account\"\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\":\"h3qo5rine8itrr43wfen2356\",\n \"object\":\"balanceAccount\",\n \"name\": \"California Funds Account\",\n \"key\": \"california_account\",\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


[block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "HEADERS" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"California Funds Account\"\n}", "language": "json", "name": "REQUEST" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\":\"h3qo5rine8itrr43wfen2356\",\n \"object\":\"balanceAccount\",\n \"name\": \"California Funds Account\",\n \"key\": \"california_account\",\n \"status\": \"active\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "RESPONSE" } ], "sidebar": true } [/block]
{"_id":"5d56fccfb1b7fc00334d1986","project":"55dd0853d2d97337001800e2","version":"5d56fccfb1b7fc00334d1a04","category":"5d56fccfb1b7fc00334d1921","user":"55f8467359eace0d0087db7e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-26T15:21:13.130Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"5693eae65f1c951900644c21","results":{"codes":[{"language":"text","code":""}]},"method":"get","examples":{"codes":[]},"auth":"required","params":[{"_id":"5b59e1377f39c90003a97260","ref":"","in":"header","required":false,"desc":"","default":"Bearer","type":"string","name":"Authorization"},{"_id":"5b59e1377f39c90003a9725f","ref":"","in":"header","required":false,"desc":"","default":"application/json","type":"string","name":"Accept"},{"_id":"5b59e1377f39c90003a9725e&quo