Welcome to the Consumer Experience (CX) API Documentation! If you're here, it means you're ready to take your software to the next level by offering world-class consumer experiences through seamless integrations with our robust APIs.
\nOur suite of APIs has been designed to help you create, manage, and optimize consumer interactions. With these APIs, you can:
\nWhether you're a small startup or an enterprise, our APIs provide you with the flexibility to design consumer interactions that are customized to your specific needs.
\nThis documentation is aimed at developers who are responsible for integrating CX functionalities into their software products. We provide detailed technical instructions, including the types of API calls you can make, the required fields, and structure for each call, along with example code to get you started.
\nTo kick-start your integration, you'll need:
\nThank you for considering Global Payments Integrated for enhancing your consumer experiences. We are excited to see what you will build!
\nIf you have any questions, feel free to reach out to our dedicated support team at CX-Support@openedgepay.com or consult our FAQs.
\nHappy Coding!
\nThe CX Team.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10238133","collectionId":"f5312aeb-537f-4100-9e28-5c0587044e37","publishedId":"UV5f8txV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-10-29T19:12:20.000Z"},"item":[{"name":"Authentication","item":[],"id":"bb88c4b5-c586-4a24-8792-e499d283013e","description":"Note: We provide you with the credentials you need to create the AuthTokenV2. If you haven’t received your credentials, contact our Integrations Services team.
\nAn AuthTokenV2 is a unique token that we use to verify requests to our gateway. When you send a request to our gateway, you must generate a unique AuthTokenV2 and send it in the header of your request along with your unique API Key. Because your system uniquely generates each token based on your unique credentials, your requests are more secure.
\nThe AuthTokenV2 is based on the JSON Web Token (JWT) standard, for more information about JWT, see https://jwt.io/introduction/.
\nCreating an AuthTokenV2
\nThe AuthTokenV2 has a header.payload.signature format. To create the token:
\nCreating the Header for the AuthTokenV2
\nExample header
\n{\n \"alg\":\"HS256\",\n \"typ\":\"JWT\"\n}\n\nCreating the payload for the AuthTokenV2
\nExample payload for US region
\n{\n \"type\":\"AuthTokenV2\",\n \"region\":\"US\",\n \"account_credential\":\"8000000XXXXX:800XXXXX:xcviSXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"ts\": 1521839766066\n}\n\nCreating the signature for the AuthTokenV2
\nExample signature
\n HMACSHA256( base64UrlEncode(header) + \".\" + base64UrlEncode(payload), apiSecret)\n\nCode samples for creating an AuthTokenV2
\nJava
\n /**\n** AuthTokenV2 GENERATION SAMPLE CODE FOR REFERENCE ONLY.\n** Exception Handling, Data Validations are NOT considered in this sample\n** json-simple JAR is required for successful BUILD.\n** <h2 class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>GenerateToken.java</h2>\n**/\npackage authtokenv2;\nimport java.io.UnsupportedEncodingException;\nimport java.nio.charset.Charset;\nimport java.security.InvalidKeyException;\nimport java.security.NoSuchAlgorithmException;\nimport java.util.Base64;\nimport javax.crypto.Mac;\nimport javax.crypto.spec.SecretKeySpec;\nimport org.json.simple.JSONObject;\npublic class GenerateToken {\n private final static Charset UTF8_CHARSET = Charset.forName(\"UTF-8\");\n public static void main(String args[]) throws NoSuchAlgorithmException, InvalidKeyException, IllegalStateException, UnsupportedEncodingException {\n // Merchant account details\n String accountCredential= \"Qsfe9sGnqj6vuDhsoDezPuMRg7awDYmfSRs5UCM\";\n String region= \"US\";\n String apiSecret = \" W9dlVYgcfRkdIckJkNdFydiJdf3Kdge2\";\n // Creating JSON object for Header , json-simple JAR is required.\n JSONObject jwtHeaderObj = new JSONObject();\n jwtHeaderObj.put(\"alg\", \"HS256\");\n jwtHeaderObj.put(\"typ\", \"JWT\");\n // Base64 encoding of Header\n String jwtHeaderATBase64 = Base64.getUrlEncoder().encodeToString(jwtHeaderObj.toString().getBytes(UTF8_CHARSET));\n // Creating JSON object for Payload\n JSONObject jwtPayloadObj = new JSONObject();\n jwtPayloadObj.put(\"type\", \"AuthTokenV2\");\n jwtPayloadObj.put(\"account_credential\", accountCredential);\n jwtPayloadObj.put(\"region\", region);\n jwtPayloadObj.put(\"ts\", System.currentTimeMillis());\n // Base64 encoding of Payload\n String jwtPayloadATBase64 = Base64.getUrlEncoder().encodeToString(jwtPayloadObj.toString().getBytes(UTF8_CHARSET));\n // Concatenating encoded Header and Payload with \".\"\n String jwtMessage = jwtHeaderATBase64 + \".\" + jwtPayloadATBase64;\n // Create Signature using HMAC-SH256 algorithm and apiSecret as the secret\n Mac sha256_HMAC = Mac.getInstance(\"HmacSHA256\");\n SecretKeySpec secret_key = new SecretKeySpec(String.valueOf(apiSecret).getBytes(), \"HmacSHA256\");\n sha256_HMAC.init(secret_key);\n String hashSignature = Base64.getUrlEncoder().encodeToString(sha256_HMAC.doFinal(jwtMessage.getBytes(UTF8_CHARSET)));\n // Create the JWT AuthTokenV2 by concatenating Base64 URL encoded header, payload and signature\n String AuthTokenV2 = jwtHeaderATBase64 + \".\" + jwtPayloadATBase64 + \".\" + hashSignature;\n System.out.println(\"Generated AuthtokenV2: \" + AuthTokenV2);\n }\n}\n\nJavaScript
\n<comment class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> Include of hmac-sha256 library, App team has to ensure compliance and any other aspect while using external library -->\n<script src=\"https://cdnjs.cloudflare.com/ajax/libs/crypto-js/3.1.2/rollups/hmac-sha256.js\"></script>\n<comment class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> Include of enc-base64 library, App team has to ensure compliance and any other aspect while using external library -->\n<script src=\"https://cdnjs.cloudflare.com/ajax/libs/crypto-js/3.1.2/components/enc-base64-min.js\"></script>\n<script> \n // This JS method takes accountCredential,region and apiSecret to generate sample AuthTokenV2\n function generateAuthTokenV2(accountCredential, region, apiSecret) {\n if (accountCredential == null || accountCredential == \"\" || region == null || region == \"\" || apiSecret== null || apiSecret== \"\") {\n throw \"Mandatory input data is missing\";\n }\n try {\n var encodedHeaderJSON = encodeURL(generateEncodedJSONHeader());\n var encodedPayLoadJSON = encodeURL(generateEncodedPayloadJSON(accountCredential, region));\n var encodedSignature = encodeURL(generateHashSignature(encodedHeaderJSON, encodedPayLoadJSON, apiSecret));\n return encodedHeaderJSON + \".\" + encodedPayLoadJSON + \".\" + encodedSignature;\n } catch (err) {\n var errorMsg = \"Error While Generating AuthTokenV2 : \" + err;\n throw errorMsg;\n }\n }\n // Generates JWT Signature\n function generateHashSignature(encodedHeaderJSON, encodedPayLoadJSON, apiSecret) {\n var data = encodedHeaderJSON + \".\" + encodedPayLoadJSON;\n var hash = CryptoJS.HmacSHA256(data, apiSecret);\n return CryptoJS.enc.Base64.stringify(hash);\n }\n // Generates JWT Payload\n function generateEncodedPayloadJSON(accountCredential, region) {\n var payLoadObj = new Object();\n payLoadObj.account_credential = accountCredential;\n payLoadObj.region = region;\n payLoadObj.type = \"AuthTokenV2\";\n payLoadObj.ts = new Date().getTime();\n return CryptoJS.enc.Base64.stringify(CryptoJS.enc.Utf8.parse(JSON.stringify(payLoadObj)));\n }\n // Generates JWT Header\n function generateEncodedJSONHeader() {\n var headerObj = new Object();\n headerObj.alg = \"HS256\";\n headerObj.typ = \"JWT\";\n return CryptoJS.enc.Base64.stringify(CryptoJS.enc.Utf8.parse(JSON.stringify(headerObj)));\n }\n function encodeURL(encodedSource){\n //Making Base64 URL Safe\n encodedSource = encodedSource.replace(/\\+/g, '-');\n encodedSource = encodedSource.replace(/\\//g, '_');\n return encodedSource;\n }\n</script>\n\nC# .NET
\n /** ** AuthTokenV2 GENERATION SAMPLE CODE FOR REFERENCE.\n** Exception Handling, Data Validations are NOT considered in this sample\n** Newtonsoft.Json is required for successful BUILD.\n**/\nusing System;\nusing System.Collections.Generic;\nusing System.Security.Cryptography;\nusing Newtonsoft.Json;\nnamespace JWTSharpConsoleApplication\n{\n public class AuthTokenV2\n {\n static readonly char[] padding = { '=' };\n public static void Main(string[] args)\n {\n string accountCredential= \"Qsfe9sGnqj6vuDhsoDezPuMRg7awDYmfSRs5UCM\";\n string region= \"US\";\n string apiSecret= \"secret\";\n try\n {\n generateEncodedAuthTokenV2(accountCredential, region, apiSecret);\n }\n catch (Exception ex)\n {\n Console.Out.WriteLine(\"ex = {0}\", ex);\n }\n }\n public static void generateEncodedAuthTokenV2(string accountCredential, string region, string apiSecret)\n {\n if ( accountCredential== null || region== null ||string.IsNullOrEmpty(apiSecret))\n {\n throw new Exception(\"Mandatory input data is missing\");\n }\n try\n {\n string encodedHeaderJSON = generateEncodedJSONHeader();\n string encodedPayLoadJSON = generateEncodedPayloadJSON(accountCredential, region);\n string encodedSignature = generateHashSignature(encodedHeaderJSON, encodedPayLoadJSON, apiSecret);\n string GeneratedAuthTokenV2 = encodedHeaderJSON + \".\" + encodedPayLoadJSON + \".\" + encodedSignature;\n System.Console.WriteLine(string.Format(\"Generated AuthTokenV2:{0}\", GeneratedAuthTokenV2));\n return ;\n }\n catch (Exception err)\n {\n Console.Out.WriteLine(\"Error While Generating AuthTokenV2\");\n }\n }\n public static string generateHashSignature(string encodedHeaderJSON, string encodedPayLoadJSON, string apiSecret)\n {\n string data = encodedHeaderJSON + \".\" + encodedPayLoadJSON;\n byte[] hash = new HMACSHA256(System.Text.Encoding.UTF8.GetBytes(apiSecret)).ComputeHash(System.Text.Encoding.UTF8.GetBytes(data));\n return UrlSafe(Convert.ToBase64String(hash));\n }\n public static string generateEncodedPayloadJSON(string accountCredential, string region)\n {\n object payLoadObj = new\n {\n account_credential= accountCredential,\n region = region,\n type = \"AuthTokenV2\",\n ts = new DateTimeOffset(DateTime.UtcNow).ToUnixTimeMilliseconds()\n };\n return objectToString(payLoadObj);\n }\n public static string UrlSafe(string input)\n {\n return input.Replace('+', '-').Replace('/', '_');\n }\n public static string objectToString(object obj)\n {\n return UrlSafe(Convert.ToBase64String(System.Text.Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(obj))));\n }\n public static string generateEncodedJSONHeader()\n {\n object headerObj = new\n {\n alg = \"HS256\",\n typ = \"JWT\"\n };\n return objectToString(headerObj);\n }\n }\n}\n\nPHP v7
\n <comment class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>AuthTokenV2 GENERATION SAMPLE CODE FOR REFERENCE. Exception Handling, Data Validations are NOT considered in this sample. -->\n function generateAuthTokenV2($accountCredential, $region, $apiSecret) {\n $headerObj = new stdClass();\n $headerObj->alg = \"HS256\";\n $headerObj->typ = \"JWT\";\n $headerJSON = base64url_encode(json_encode($headerObj));\n $microseconds = round(microtime(true) * 1000);\n $jwtPayloadObj = new stdClass();\n $jwtPayloadObj->account_credential = $accountCredential;\n $jwtPayloadObj->region = $region;\n $jwtPayloadObj->type = \"AuthTokenV2\";\n $jwtPayloadObj->ts = $microseconds;\n $payloadJSON = base64url_encode(json_encode($jwtPayloadObj));\n $signature = base64url_encode(hash_hmac('sha256', \"{$headerJSON}.{$payloadJSON}\", $apiSecret, true));\n echo \"Generated AuthTokenV2 : \\r\\n\";\n $authToken = \"{$headerJSON}.{$payloadJSON}.{$signature}\";\n echo $authToken;\n }\n function base64url_encode($data) {\n return strtr(base64_encode($data), '+/', '-_');\n }\n $accountCredential = \"\"; //accountCredential to be input, sample used here\n $region = \"US\"; // region to be input, sample used here\n $apiSecret = \"cS4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\"; // Sample apiSecret used \n generateAuthTokenV2($accountCredential, $region, $apiSecret); // call the function with required inputs to generate AuthToken\n?>\n\nTo create/update a Service Location, issue a POST request to the setServiceLocation endpoint. A successful request will yield a response containing the details of your newly created/updated Service Location. In case of any issues, an error message will be returned to indicate what needs to be addressed.
\nIt is advisable to store the servicelocation ID that is returned in the response for subsequent Updates and other API Calls such as the Configuration.
\nField requirements are noted below and examples are found to the right (with different payloads in the dropdown):
\n","urlObject":{"path":["customer_experience","action","setServiceLocation"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"d8a2311d-907f-4e46-9ecd-c91601530524","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Bob Service Location\",\n\t\"locale\": \"en\",\n\t\"primary_website\": \"https://www.google.com\",\n\t\"time_zone\": \"America/Denver\",\n\t\"primary_phone\": {\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_sms\": false,\n\t\t\t\"supports_mms\": false,\n\t\t\t\"supports_fax\": false,\n\t\t\t\"supports_voice\": false\n\t\t},\n\t\t\"value\": \"+18015555555\"\n\t},\n\t\"primary_email\": {\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false\n\t\t},\n\t\t\"value\": \"test@openedgepay.com\"\n\t},\n\t\"primary_address\": {\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_signature\": false\n\t\t},\n\t\t\"country\": \"US\",\n\t\t\"street_address1\": \"123 Easy Street\",\n\t\t\"street_address2\": \"suite #3\",\n\t\t\"street_address3\": \"Testington, Alabama\",\n\t\t\"postal_code\": \"55555\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/setServiceLocation"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"id\": \"{{serviceLocationId}}\",\r\n\t\"name\": \"Bob Service Location\",\r\n\t\"locale\": \"en\",\r\n\t\"primary_website\": \"https://www.google.com\",\r\n\t\"time_zone\": \"America/Denver\",\r\n\t\"primary_phone\": {\r\n\t\t\"value\": \"+18015555555\",\r\n\t\t\"verified_by_cx\": {\r\n\t\t\t\"verified\": false,\r\n\t\t\t\"supports_sms\": false,\r\n\t\t\t\"supports_mms\": false,\r\n\t\t\t\"supports_fax\": false,\r\n\t\t\t\"supports_voice\": false\r\n\t\t},\r\n\t\t\"verified_by_management_system\": {\r\n\t\t\t\"verified\": false,\r\n\t\t\t\"supports_sms\": false,\r\n\t\t\t\"supports_mms\": false,\r\n\t\t\t\"supports_fax\": false,\r\n\t\t\t\"supports_voice\": false\r\n\t\t}\r\n\t},\r\n\t\"primary_email\": {\r\n\t\t\"value\": \"test@openedgepay.com\",\r\n\t\t\"verified_by_cx\": {\r\n\t\t\t\"verified\": false\r\n\t\t},\r\n\t\t\"verified_by_management_system\": {\r\n\t\t\t\"verified\": false\r\n\t\t}\r\n\t},\r\n\t\"primary_address\": {\r\n\t\t\"value\": \"1234 Testington, suite #3, Testington, Alabama US\",\r\n\t\t\"verified_by_management_system\": {\r\n\t\t\t\"verified\": false,\r\n\t\t\t\"supports_signature\": false\r\n\t\t},\r\n\t\t\"verified_by_cx\": {\r\n\t\t\t\"verified\": false,\r\n\t\t\t\"supports_signature\": false\r\n\t\t},\r\n\t\t\"country\": \"US\",\r\n\t\t\"street_address1\": \"123 Easy Street\",\r\n\t\t\"street_address2\": \"suite #3\",\r\n\t\t\"street_address3\": \"Testington, Alabama\",\r\n\t\t\"postal_code\": \"5555\",\r\n\t\t\"poBox\": null\r\n\t}\r\n}"},{"id":"3ee855ea-5a06-4bea-aa86-84a59112bc1c","name":"201 Created with myMetadata","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Bob Service Location\",\n\t\"locale\": \"en\",\n\t\"primary_website\": \"https://www.google.com\",\n\t\"time_zone\": \"America/Denver\",\n\t\"primary_phone\": {\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_sms\": false,\n\t\t\t\"supports_mms\": false,\n\t\t\t\"supports_fax\": false,\n\t\t\t\"supports_voice\": false\n\t\t},\n\t\t\"value\": \"+18015555555\"\n\t},\n\t\"primary_email\": {\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false\n\t\t},\n\t\t\"value\": \"test@openedgepay.com\"\n\t},\n\t\"primary_address\": {\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_signature\": false\n\t\t},\n\t\t\"country\": \"US\",\n\t\t\"street_address1\": \"123 Easy Street\",\n\t\t\"street_address2\": \"suite #3\",\n\t\t\"street_address3\": \"Testington, Alabama\",\n\t\t\"postal_code\": \"55555\"\n\t},\n\t\"my_metadata\": {\n\t\t\"external_id\": \"{{serviceLocationExternalId}}\",\n\t\t\"data\": {\n\t\t\t\"region\": \"northwest\"\n\t\t}\n\t}\n}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/setServiceLocation"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"id\": \"{{serviceLocationId}}\",\n\t\"name\": \"Bob Service Location\",\n\t\"locale\": \"en\",\n\t\"primary_website\": \"https://www.google.com\",\n\t\"time_zone\": \"America/Denver\",\n\t\"primary_phone\": {\n\t\t\"value\": \"+18015555555\",\n\t\t\"verified_by_cx\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_sms\": false,\n\t\t\t\"supports_mms\": false,\n\t\t\t\"supports_fax\": false,\n\t\t\t\"supports_voice\": false\n\t\t},\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_sms\": false,\n\t\t\t\"supports_mms\": false,\n\t\t\t\"supports_fax\": false,\n\t\t\t\"supports_voice\": false\n\t\t}\n\t},\n\t\"primary_email\": {\n\t\t\"value\": \"test@openedgepay.com\",\n\t\t\"verified_by_cx\": {\n\t\t\t\"verified\": false\n\t\t},\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false\n\t\t}\n\t},\n\t\"primary_address\": {\n\t\t\"value\": \"1234 Testington, suite #3, Testington, Alabama US\",\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_signature\": false\n\t\t},\n\t\t\"verified_by_cx\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_signature\": false\n\t\t},\n\t\t\"country\": \"US\",\n\t\t\"street_address1\": \"123 Easy Street\",\n\t\t\"street_address2\": \"suite #3\",\n\t\t\"street_address3\": \"Testington, Alabama\",\n\t\t\"postal_code\": \"5555\",\n\t\t\"poBox\": null\n\t},\n\t\"my_metadata\": {\n\t\t\"external_id\": \"{{serviceLocationExternalId}}\",\n\t\t\"data\": {\n\t\t\t\"region\": \"northwest\"\n\t\t}\n\t}\n}"},{"id":"abafcb75-a7f3-4096-809e-873d8dbbd20d","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"locale\": \"en\",\n\t\"primary_website\": \"https://www.google.com\",\n\t\"time_zone\": \"America/Denver\",\n\t\"primary_phone\": {\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_sms\": false,\n\t\t\t\"supports_mms\": false,\n\t\t\t\"supports_fax\": false,\n\t\t\t\"supports_voice\": false\n\t\t},\n\t\t\"value\": \"+18015555555\"\n\t},\n\t\"primary_email\": {\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false\n\t\t},\n\t\t\"value\": \"test@openedgepay.com\"\n\t},\n\t\"primary_address\": {\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_signature\": false\n\t\t},\n\t\t\"country\": \"US\",\n\t\t\"street_address1\": \"123 Easy Street\",\n\t\t\"street_address2\": \"suite #3\",\n\t\t\"street_address3\": \"Testington, Alabama\",\n\t\t\"postal_code\": \"55555\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/setServiceLocation"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"message\": \"value:null | field:ServiceLocation.name, error:Field is required | |\"\n}"},{"id":"2c4c375f-4424-4c8c-8249-eae58cb3b57b","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Bob Service Location\",\n\t\"locale\": \"en\",\n\t\"primary_website\": \"https://www.google.com\",\n\t\"time_zone\": \"America/Denver\",\n\t\"primary_phone\": {\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_sms\": false,\n\t\t\t\"supports_mms\": false,\n\t\t\t\"supports_fax\": false,\n\t\t\t\"supports_voice\": false\n\t\t},\n\t\t\"value\": \"+18015555555\"\n\t},\n\t\"primary_email\": {\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false\n\t\t},\n\t\t\"value\": \"test@openedgepay.com\"\n\t},\n\t\"primary_address\": {\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_signature\": false\n\t\t},\n\t\t\"country\": \"US\",\n\t\t\"street_address1\": \"123 Easy Street\",\n\t\t\"street_address2\": \"suite #3\",\n\t\t\"street_address3\": \"Testington, Alabama\",\n\t\t\"postal_code\": \"55555\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/setServiceLocation"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"message\": \"No api key to onboard, or service location to update\"\n}"}],"_postman_id":"3d74f7a4-f411-48d9-91b4-c2a4f4687820"},{"name":"Create / Update Customer","event":[{"listen":"test","script":{"id":"9f884268-861e-404a-a284-92d5fe01880a","exec":["pm.environment.set(\"customerId\", JSON.parse(responseBody).id);"],"type":"text/javascript"}}],"id":"c83e2ee5-5926-4977-9d72-f26eb9b5314b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"locale\": \"en\",\r\n\t\"family_name\": \"Smith\",\r\n\t\"given_name\": \"John\",\r\n\t\"sex\": \"MALE\",\r\n \"display_customer_id\":\"Customer-12345\",\r\n\t\"date_of_birth\": \"1988-12-14\",\r\n\t\"primary_phone\": {\r\n\t\t\"value\": \"+18016361933\",\r\n\t\t\"verified_by_management_system\": {\r\n\t\t\t\"verified\": false,\r\n\t\t\t\"supports_sms\": false,\r\n\t\t\t\"supports_mms\": false,\r\n\t\t\t\"supports_fax\": false,\r\n\t\t\t\"supports_voice\": true\r\n\t\t}\r\n\t},\r\n\t\"primary_email\": {\r\n\t\t\"value\": \"jsmith@example.com\",\r\n\t\t\"verified_by_management_system\": {\r\n\t\t\t\"verified\": true\r\n\t\t}\r\n\t},\r\n\t\"primary_address\": {\r\n\t\t\"verified_by_management_system\": {\r\n\t\t\t\"verified\": false,\r\n\t\t\t\"supports_signature\": false\r\n\t\t},\r\n\t\t\"country\": \"US\",\r\n\t\t\"street_address1\": \"123 Easy Street\",\r\n\t\t\"street_address2\": \"\",\r\n\t\t\"street_address3\": \"Testington, Alabama\",\r\n\t\t\"postal_code\": \"55555\"\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/setCustomer","description":"Next, you'll want to associate your Merchants Consumers to their Service Location. This is done via the setCustomer API.
\nTo Add a New Customer: Make a POST request to the setCustomer endpoint. A successful call will return a response containing the ID for the newly created Customer and an echo of the data provided by you.
\nPlease note a customer must have either a mobile number or email to create a record.
\nTo Update any Customer data: Make a POST request to the setCustomer endpoint including the id that was generated when creating the customer.
\n","urlObject":{"path":["customer_experience","action","setCustomer"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"412ea14d-4a53-4782-bf74-d15c1f821371","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"locale\": \"en\",\n\t\"family_name\": \"Robertson\",\n\t\"given_name\": \"Robert\",\n\t\"sex\": \"MALE\",\n\t\"date_of_birth\": \"1988-12-14\",\n\t\"primary_phone\": {\n\t\t\"value\": \"+18016361933\",\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_sms\": false,\n\t\t\t\"supports_mms\": false,\n\t\t\t\"supports_fax\": false,\n\t\t\t\"supports_voice\": true\n\t\t}\n\t},\n\t\"primary_email\": {\n\t\t\"value\": \"test@openedgepay.com\",\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": true\n\t\t}\n\t},\n\t\"primary_address\": {\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_signature\": false\n\t\t},\n\t\t\"country\": \"US\",\n\t\t\"street_address1\": \"123 Easy Street\",\n\t\t\"street_address2\": \"\",\n\t\t\"street_address3\": \"Testington, Alabama\",\n\t\t\"postal_code\": \"55555\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/setCustomer"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"id\": \"{{customerId}}\",\r\n\t\"locale\": \"en\",\r\n\t\"family_name\": \"Robertson\",\r\n\t\"given_name\": \"Robert\",\r\n\t\"sex\": \"MALE\",\r\n\t\"date_of_birth\": \"1988-12-14\",\r\n\t\"primary_phone\": {\r\n\t\t\"value\": \"+18016361933\",\r\n\t\t\"verified_by_management_system\": {\r\n\t\t\t\"verified\": false,\r\n\t\t\t\"supports_sms\": false,\r\n\t\t\t\"supports_mms\": false,\r\n\t\t\t\"supports_fax\": false,\r\n\t\t\t\"supports_voice\": true\r\n\t\t}\r\n\t},\r\n\t\"primary_email\": {\r\n\t\t\"value\": \"test@openedgepay.com\",\r\n\t\t\"verified_by_management_system\": {\r\n\t\t\t\"verified\": true\r\n\t\t}\r\n\t},\r\n\t\"primary_address\": {\r\n\t\t\"value\": \"123 Easy Street, Apartment 8206, Testington, Alabama 55555 US\",\r\n\t\t\"verified_by_management_system\": {\r\n\t\t\t\"verified\": false,\r\n\t\t\t\"supports_signature\": false\r\n\t\t},\r\n\t\t\"country\": \"US\",\r\n\t\t\"street_address1\": \"123 Easy Street\",\r\n\t\t\"street_address2\": \"\",\r\n\t\t\"street_address3\": \"Testington, Alabama\",\r\n\t\t\"postal_code\": \"55555\"\r\n\t},\r\n\t\"_embedded\": {\r\n\t\t\"service_location\": {\r\n\t\t\t\"id\": \"{{serviceLocationId}}\"\r\n\t\t}\r\n\t}\r\n}"},{"id":"91c3f6c2-c8fc-4eb7-a4a8-a61f6f1f9514","name":"201 Created with myMetadata","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"locale\": \"en\",\n\t\"family_name\": \"Robertson\",\n\t\"given_name\": \"Robert\",\n\t\"sex\": \"MALE\",\n\t\"date_of_birth\": \"1988-12-14\",\n\t\"primary_phone\": {\n\t\t\"value\": \"+18016361933\",\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_sms\": false,\n\t\t\t\"supports_mms\": false,\n\t\t\t\"supports_fax\": false,\n\t\t\t\"supports_voice\": true\n\t\t}\n\t},\n\t\"primary_email\": {\n\t\t\"value\": \"test@openedgepay.com\",\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": true\n\t\t}\n\t},\n\t\"primary_address\": {\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_signature\": false\n\t\t},\n\t\t\"country\": \"US\",\n\t\t\"street_address1\": \"123 Easy Street\",\n\t\t\"street_address2\": \"\",\n\t\t\"street_address3\": \"Testington, Alabama\",\n\t\t\"postal_code\": \"55555\"\n\t},\n\t\"my_metadata\": {\n\t\t\"external_id\": \"{{customerExternalId}}\",\n\t\t\"data\": {\n\t\t\t\"middle_name\": \"Joe\"\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/setCustomer"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"id\": \"{{customerId}}\",\n\t\"locale\": \"en\",\n\t\"family_name\": \"Robertson\",\n\t\"given_name\": \"Robert\",\n\t\"sex\": \"MALE\",\n\t\"date_of_birth\": \"1988-12-14\",\n\t\"primary_phone\": {\n\t\t\"value\": \"+18016361933\",\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_sms\": false,\n\t\t\t\"supports_mms\": false,\n\t\t\t\"supports_fax\": false,\n\t\t\t\"supports_voice\": true\n\t\t}\n\t},\n\t\"primary_email\": {\n\t\t\"value\": \"test@openedgepay.com\",\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": true\n\t\t}\n\t},\n\t\"primary_address\": {\n\t\t\"value\": \"123 Easy Street, Apartment 8206, Testington, Alabama 55555 US\",\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_signature\": false\n\t\t},\n\t\t\"country\": \"US\",\n\t\t\"street_address1\": \"123 Easy Street\",\n\t\t\"street_address2\": \"\",\n\t\t\"street_address3\": \"Testington, Alabama\",\n\t\t\"postal_code\": \"55555\"\n\t},\n\t\"my_metadata\": {\n\t\t\"external_id\": \"{{customerExternalId}}\",\n\t\t\"data\": {\n\t\t\t\"middle_name\": \"Joe\"\n\t\t}\n\t},\n\t\"_embedded\": {\n\t\t\"service_location\": {\n\t\t\t\"id\": \"{{serviceLocationId}}\",\n\t\t\t\"my_metadata\": {\n\t\t\t\t\"external_id\": \"{{serviceLocationExternalId}}\",\n\t\t\t\t\"data\": {\n\t\t\t\t\t\"region\": \"northwest\"\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}"},{"id":"b8489272-83c8-4d9f-8b52-345396622137","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text","description":"(Required) CX Api key for the Service Location"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"locale\": \"en\",\n\t\"family_name\": \"Robertson\",\n\t\"given_name\": \"Robert\",\n\t\"sex\": \"MALE\",\n\t\"date_of_birth\": \"1988-12-14\",\n\t\"primary_phone\": {\n\t\t\"value\": \"+18016361933\",\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_sms\": false,\n\t\t\t\"supports_mms\": false,\n\t\t\t\"supports_fax\": false,\n\t\t\t\"supports_voice\": true\n\t\t}\n\t},\n\t\"primary_address\": {\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_signature\": false\n\t\t},\n\t\t\"country\": \"US\",\n\t\t\"street_address1\": \"123 Easy Street\",\n\t\t\"street_address2\": \"\",\n\t\t\"street_address3\": \"Testington, Alabama\",\n\t\t\"postal_code\": \"55555\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/setCustomer"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Date","value":"Mon, 24 Feb 2020 17:29:29 GMT"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"nginx/1.14.1"},{"key":"vary","value":"accept-encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n\t\"message\": \"value:null | field:primaryEmail, error:An email address is required | |\"\n}"},{"id":"549b98c6-f0bf-4aec-9b23-84c8202d5ac8","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"locale\": \"en\",\n\t\"family_name\": \"Robertson\",\n\t\"given_name\": \"Robert\",\n\t\"sex\": \"MALE\",\n\t\"date_of_birth\": \"1988-12-14\",\n\t\"primary_phone\": {\n\t\t\"value\": \"+18016361933\",\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_sms\": false,\n\t\t\t\"supports_mms\": false,\n\t\t\t\"supports_fax\": false,\n\t\t\t\"supports_voice\": true\n\t\t}\n\t},\n\t\"primary_email\": {\n\t\t\"value\": \"test@openedgepay.com\",\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": true\n\t\t}\n\t},\n\t\"primary_address\": {\n\t\t\"verified_by_management_system\": {\n\t\t\t\"verified\": false,\n\t\t\t\"supports_signature\": false\n\t\t},\n\t\t\"country\": \"US\",\n\t\t\"street_address1\": \"123 Easy Street\",\n\t\t\"street_address2\": \"\",\n\t\t\"street_address3\": \"Testington, Alabama\",\n\t\t\"postal_code\": \"55555\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/setCustomer"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Date","value":"Mon, 24 Feb 2020 17:29:54 GMT"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"nginx/1.14.1"},{"key":"vary","value":"accept-encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n\t\"message\": \"Not authorized for this service location\"\n}"}],"_postman_id":"c83e2ee5-5926-4977-9d72-f26eb9b5314b"},{"name":"Create Link for Configuration UI","id":"a48d5eeb-80a1-48b6-a6df-0712f458ec46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"action\": \"{{actionDescriptor}}\",\n\t\"context\": {\n\t\t\"_embedded\": {\n\t\t\t\"service_location\": {\n\t\t\t\t\"id\": \"{{serviceLocationId}}\"\n\t\t\t}\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/ui/instances","description":"This API call allows you to create a tiny URL to our Configuration Page. The configuration page allows the user to set up different features and functions for the CX product suite. A full list of items that can be configured can be found in our FAQ's.
\nThis feature offers an efficient way to engage with users while keeping them within the context of your platform. Additional instructions and code examples for implementing this feature will be covered in subsequent sections.
\nFor some specific configurations (such as credentials) we offer a direct API for setting these
\n","urlObject":{"path":["customer_experience","ui","instances"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"403c2c61-e362-4c3a-a1c8-f2d88bccce4a","name":"200 OK - Administer Service Location","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Api-Key","value":"{{ApigeeApiKey}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"action\": \"{{actionDescriptor}}\",\n\t\"context\": {\n\t\t\"_embedded\": {\n\t\t\t\"service_location\": {\n\t\t\t\t\"id\": \"{{serviceLocationId}}\"\n\t\t\t}\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/ui/instances"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 23 Apr 2021 16:28:37 GMT"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"nginx/1.18.0"},{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n\t\"tinyLink\": \"https://c.rt2.me/175WRHDSjf\"\n}"},{"id":"1088049f-ce18-4df2-89f7-d84393d2fa02","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Api-Key","value":"{{ApigeeApiKey}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"action\": \"{{actionDescriptor}}\",\n\t\"context\": {\n\t\t\"_embedded\": {\n\t\t\t\"service_location\": {\n\t\t\t\t\"id\": \"{{serviceLocationId}}\"\n\t\t\t}\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/ui/instances"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 23 Apr 2021 16:23:00 GMT"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"nginx/1.18.0"},{"key":"Set-Cookie","value":"CX2SESSIONID=FF97E0ED67E2890C7AE619F493C755C6; Path=/; SameSite=None; Secure; HttpOnly"},{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n\t\"message\": \"value:null | field:action, error:Not a valid action | |\"\n}"},{"id":"c90c81ab-bf73-46a1-92c2-b3b0a8ee7026","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"action\": \"{{actionDescriptor}}\",\n\t\"context\": {\n\t\t\"_embedded\": {\n\t\t\t\"service_location\": {\n\t\t\t\t\"id\": \"{{serviceLocationId}}\"\n\t\t\t}\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/ui/instances"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 23 Apr 2021 16:25:44 GMT"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"nginx/1.18.0"},{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n\t\"message\": \"Not authenticated to create tiny link for this service location\"\n}"}],"_postman_id":"a48d5eeb-80a1-48b6-a6df-0712f458ec46"}],"id":"c99eeb5b-3910-4d34-a55c-759b913c24f7","description":"This section provides an overview of the foundational API requests that are relevant across all our Consumer Experience (CX) products. These include:
\nsetServiceLocation.setCustomer endpoint.setCustomer endpoint.These common requests form the building blocks for integrating various functionalities into your software, ensuring a comprehensive and seamless consumer experience. Detailed examples and further explanations for each are provided in subsequent sections.
\n","_postman_id":"c99eeb5b-3910-4d34-a55c-759b913c24f7"},{"name":"Receiving Completed Actions","item":[{"name":"PUSH - Your System's Completed Action Webhook","id":"a38cb71c-ec43-4d20-b7df-2e76e5fc756b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"EXAMPLE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"id\": \"{{paymentId}}\",\n\t\"chargeId\": \"00000000456\",\n\t\"capturedCurrency\": \"USD\",\n\t\"capturedAmount\": 10000,\n\t\"capturedDate\": \"2020-04-20T15:35:38.73Z\",\n\t\"cardLast4\": \"1234\",\n\t\"cardBrand\": \"VISA\", \n\t\"cardExpireMonth\": \"12\",\t\n\t\"cardExpireYear\": \"2023\",\n\t\"paymentType\": \"CARD\",\n\t\"approvalCode\": \"ABC123\",\n\t\"pickupDateTime\": \"2020-04-20T15:00\",\n\t\"paymentOnFileToken\": \"AbCdEf1357\",\n\t\"paidLineItemReferences\": [\"{{lineItemRef1}}\",\"{{lineItemRef2}}\"],\n\t\"_embedded\": {\n\t\t\"customer\": {\n\t\t\t\"id\": \"{{customerId}}\"\n\t\t},\n\t\t\"serviceLocation\": {\n\t\t\t\"id\": \"{{serviceLocationId}}\"\n\t\t},\n\t\t\"itemsPaid\": [\n\t\t\t{\n\t\t\t\t\"id\": \"{{itemPaidId}}\"\n\t\t\t}\n\t\t]\n\t}\n}"},"url":"{{YourURL}}","description":"This section details the webhook mechanism that is triggered when a payment or other action is completed by the consumer within the Consumer Experience (CX) platform.
\nThe primary function of this webhook is to enable real-time notifications or actions to your system as soon as a payment is initiated in the CX platform.
\nThis webhook serves as a vital mechanism for enabling real-time updates and seamless interactions between the CX platform and other integrated systems. For a comprehensive setup guide and payload examples, refer to subsequent sections of this documentation. If you are unable to create a webhook for your system we also offer a queuing solution that you can poll to get action results
\n| Field | Notes | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
cardLast4 cardBrand cardExpireMonth cardExpireYear | These elements will only be included when `paymentType` is `CARD` | ||||||||||
checkRoutingNumber checkAccountNumber checkAccountType | These elements will only be included when `paymentType` is `ACH` | ||||||||||
paymentType | The type of payment that was made. Possible values include `CARD`, `ACH`, `ACF` | ||||||||||
pickupDateTime | If configured, this value indicates the pickup date and an unzoned timestamp that the Customer selected before the Payment.
| ||||||||||
paymentOnFileToken | If configured, this payment on file token can be used for subsequent payments to this method. | ||||||||||
paidLineItemReferences | A list of the line item references from the Statement that were selected to be paid by the Customer. This field will only be included if the Statement included line items. | ||||||||||
_embedded | The _embedded structure contains object references related to the Payment. | ||||||||||
_embedded.statement | This object is being deprecated Use _embedded.itemsPaid to obtain the Statement id and myMetadata values for a Statement. | ||||||||||
_embedded.itemsPaid | A collection of items that the payment applies to. For Customer Statements, an item could include the id and myMetadata values of the Statement that was paid. |
This section details the queue mechanism that can be polled to gather new payments or other actions when they are completed by the consumer within the Consumer Experience (CX) platform.
\nThis API is used to query information about the Queue Package. It will return the number of items in the queue and the URLs to work with the queue. This URL can be persisted and called on an interval. Do not persist the \"queuePackagePickupUrl\" url.
\n","urlObject":{"path":["customer_experience","queuepackage","home"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"6ade909d-e959-4a84-a2e5-1997e786275d","name":"Home: 200 - with urls","originalRequest":{"method":"GET","header":[{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"}],"url":"{{queuPackageHomeUrl}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"number_of_items_in_queue\": 1,\n\t\"queue_package_pickup_url\": {{queuePackagePickupUrl}},\n\t\"queue_package_post_url\": {{queuePackagePostUrl}},\n\t\"items\": [],\n\t\"action_responses\": []\n}"}],"_postman_id":"104b2bf7-8c92-4109-adef-a87cd523906d"},{"name":"PULL Queue Package pickup","id":"6e5e9602-5f91-414c-b274-8dad6f18e5ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"}],"url":"{{queuePackagePickupUrl}}","description":"Used to pickup the items in the queue. This URL can change. Always go back to the Home URL to get the latest pickup URL.
\nThis API will return an array of items (limited to first 10) for you to receive the objects completed by the consumers.
\nEach object will have an __objectType with its object data.
\nAfter you have completed your processing of each object you can make them using the POST Package Action API
\n","urlObject":{"host":["{{queuePackagePickupUrl}}"],"query":[],"variable":[]}},"response":[{"id":"662051da-6f34-4bc1-a181-966509d3e135","name":"Pickup: 200 - with items (Payments)","originalRequest":{"method":"GET","header":[{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"}],"url":"{{queuePackagePickupUrl}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"number_of_items_in_queue\": 1,\n\t\"queue_package_pickup_url\": {{queuePackagePickupUrl}},\n\t\"queue_package_post_url\": {{queuePackagePostUrl}},\n\t\"items\": [\n\t\t{\n\t\t\t\"id\": \"{{item_id}}\",\n\t\t\t\"name\": \"onSetPayment\",\n\t\t\t\"payload_type\": \"ENTITY\",\n\t\t\t\"order\": 0,\n\t\t\t\"payload\": {\n\t\t\t\t\"id\": \"{{payment_id}}\",\n\t\t\t\t\"charge_id\": \"12345\",\n\t\t\t\t\"_embedded\": {\n\t\t\t\t\t\"customer\": {\n\t\t\t\t\t\t\"id\": \"_83_20d3c8e82992414b99ecf5f78397dcb8\",\n\t\t\t\t\t\t\"my_metadata\": {\n\t\t\t\t\t\t\t\"external_id\": \"Test_5f7f7477-ed0c-4add-9e17-9f23fa31e029\"\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\t\"items_paid\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"id\": \"_83_7403bcf4d8c9463b956698c7c83826a2\",\n\t\t\t\t\t\t\t\"my_metadata\": {\n\t\t\t\t\t\t\t\t\"data\": {\n\t\t\t\t\t\t\t\t\t\"my_key\": \"myData\",\n\t\t\t\t\t\t\t\t\t\"this_key\": \"thatData\",\n\t\t\t\t\t\t\t\t\t\"statement_data\": \"MyData\",\n\t\t\t\t\t\t\t\t\t\"this_is_anew_key\": \"thisIsANewValue\"\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t],\n\t\t\t\t\t\"statement\": {\n\t\t\t\t\t\t\"id\": \"_83_7403bcf4d8c9463b956698c7c83826a2\",\n\t\t\t\t\t\t\"external_id\": null,\n\t\t\t\t\t\t\"my_metadata\": {\n\t\t\t\t\t\t\t\"data\": {\n\t\t\t\t\t\t\t\t\"my_key\": \"myData\",\n\t\t\t\t\t\t\t\t\"this_key\": \"thatData\",\n\t\t\t\t\t\t\t\t\"statement_data\": \"MyData\",\n\t\t\t\t\t\t\t\t\"this_is_anew_key\": \"thisIsANewValue\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\t\"service_location\": {\n\t\t\t\t\t\t\"id\": \"_78_9d56ac594f5b4e1cbdcac3c32a8c6050\",\n\t\t\t\t\t\t\"my_metadata\": {\n\t\t\t\t\t\t\t\"external_id\": \"external_id\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"card_brand\": \"VISA\",\n\t\t\t\t\"card_last4\": \"4568\",\n\t\t\t\t\"payment_type\": \"CARD\",\n\t\t\t\t\"approval_code\": \"1234\",\n\t\t\t\t\"captured_date\": \"2022-01-14T19:36:00.972Z\",\n\t\t\t\t\"pretty_amount\": \"1642.00\",\n\t\t\t\t\"captured_amount\": 164200,\n\t\t\t\t\"card_expire_year\": \"2023\",\n\t\t\t\t\"card_expire_month\": \"10\",\n\t\t\t\t\"captured_currency\": \"USD\"\n\t\t\t}\n\t\t}\n\t],\n\t\"action_responses\": []\n}"},{"id":"2932cdc1-0247-49f8-b27c-a54cc7acfd9c","name":"Pickup: 200 - with items (Forms)","originalRequest":{"method":"GET","header":[{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"}],"url":"{{queuePackagePickupUrl}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n\t\"number_of_items_in_queue\": 1,\n\t\"queue_package_pickup_url\": {{queuePackagePickupUrl}},\n\t\"queue_package_post_url\": {{queuePackagePostUrl}},\n\t\"items\": [\n\t\t{\n\t\t\t\"id\": \"{{item_id}}\",\n\t\t\t\"name\": \"onSaveForm\",\n\t\t\t\"payload_type\": \"ENTITY\",\n\t\t\t\"order\": 0,\n\t\t\t\"payload\": {\n\t\t\t\t\"id\": \"{{form_id}}\",\n \"data\":{\n \"form_field_name\":\"{{form_field_value}}\",\n \"form_field_name_2\":\"{{form_field_value_2}}\"\n },\n \"form_type_id\":\"{{form_type_id}}\",\n \"form_finished\":\"2022-02-14T01:44:12.711Z\",\n\t\t\t\t\"_embedded\": {\n\t\t\t\t\t\"customer\": {\n\t\t\t\t\t\t\"id\": \"_83_20d3c8e82992414b99ecf5f78397dcb8\",\n\t\t\t\t\t\t\"my_metadata\": {\n\t\t\t\t\t\t\t\"external_id\": \"Test_5f7f7477-ed0c-4add-9e17-9f23fa31e029\"\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\t\"form_type\":{\n \"form_type_identifier\":\"{{form_type_identifier}}\"\n }\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t],\n\t\"action_responses\": []\n}"},{"id":"ea2333ef-bb9b-4b2d-87aa-1155031207e9","name":"Pickup: 200 - with items (Presence Status)","originalRequest":{"method":"GET","header":[{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"}],"url":"{{queuePackagePickupUrl}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n\t\"number_of_items_in_queue\": 1,\n\t\"queue_package_pickup_url\": {{queuePackagePickupUrl}},\n\t\"queue_package_post_url\": {{queuePackagePostUrl}},\n\t\"items\": [\n\t\t{\n\t\t\t\"id\": \"{{item_id}}\",\n\t\t\t\"name\": \"onUpdatePresenceStatus\",\n\t\t\t\"payload\": {\n\t\t\t\t\"id\": \"{{presence_status_id}}\",\n \"updated\":\"2023-01-05T23:17:11.157Z\",\n\t\t\t\t\"_embedded\": {\n\t\t\t\t\t\"customer\": {\n\t\t\t\t\t\t\"id\": \"_83_20d3c8e82992414b99ecf5f78397dcb8\",\n\t\t\t\t\t\t\"my_metadata\": {\n\t\t\t\t\t\t\t\"external_id\": \"Test_5f7f7477-ed0c-4add-9e17-9f23fa31e029\"\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n \"service_location\": {\n\t\t\t\t\t\t\"id\": \"_78_9d56ac594f5b4e1cbdcac3c32a8c6050\",\n\t\t\t\t\t\t\"my_metadata\": {\n\t\t\t\t\t\t\t\"external_id\": \"external_id\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t],\n\t\"action_responses\": []\n}"}],"_postman_id":"6e5e9602-5f91-414c-b274-8dad6f18e5ac"},{"name":"PULL Queue Package action","id":"e07a73af-2b06-4194-a48c-a967017a7830","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"actions\": [\n\t\t{\n\t\t\t\"name\": \"updateQueue\",\n\t\t\t\"version\": \"1\",\n\t\t\t\"body\": {\n\t\t\t\t\"item_id\": \"123abc\",\n\t\t\t\t\"status\": \"HANDLED\"\n\t\t\t}\n\t\t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"{{queuePackagePostUrl}}","description":"This API is used for updating objects in the queue. The main function is to mark an item as HANDLED once you no longer need it in the queue.
\n","urlObject":{"host":["{{queuePackagePostUrl}}"],"query":[],"variable":[]}},"response":[{"id":"f5750f1a-1243-41e0-9b0d-66c1cafc76d3","name":"Action: 200 - with items","originalRequest":{"method":"POST","header":[{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"}],"body":{"mode":"raw","raw":"{\n\t\"actions\": [\n\t\t{\n\t\t\t\"name\": \"updateQueue\",\n\t\t\t\"version\": \"1\",\n\t\t\t\"body\": {\n\t\t\t\t\"item_id\": \"SDSDFTh45o48ioemvomr\",\n\t\t\t\t\"status\": \"HANDLED\"\n\t\t\t}\n\t\t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"{{queuePackagePostUrl}}"},"_postman_previewlanguage":"json","header":[{"description":"","key":"Content-Type","type":"text","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"number_of_items_in_queue\": 1,\n\t\"queue_package_pickup_url\": {{queuePackagePickupUrl}},\n\t\"queue_package_post_url\": {{queuePackagePostUrl}},\n\t\"items\": [\n\t\t{\n\t\t\t\"id\": \"{{item_id}}\",\n\t\t\t\"name\": \"onSetPayment\",\n\t\t\t\"payload_type\": \"ENTITY\",\n\t\t\t\"order\": 0,\n\t\t\t\"payload\": {\n\t\t\t\t\"id\": \"{{payment_id}}\",\n\t\t\t\t\"charge_id\": \"12345\",\n\t\t\t\t\"_embedded\": {\n\t\t\t\t\t\"customer\": {\n\t\t\t\t\t\t\"id\": \"_83_20d3c8e82992414b99ecf5f78397dcb8\",\n\t\t\t\t\t\t\"my_metadata\": {\n\t\t\t\t\t\t\t\"external_id\": \"Test_5f7f7477-ed0c-4add-9e17-9f23fa31e029\"\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\t\"items_paid\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"id\": \"_83_7403bcf4d8c9463b956698c7c83826a2\",\n\t\t\t\t\t\t\t\"my_metadata\": {\n\t\t\t\t\t\t\t\t\"data\": {\n\t\t\t\t\t\t\t\t\t\"my_key\": \"myData\",\n\t\t\t\t\t\t\t\t\t\"this_key\": \"thatData\",\n\t\t\t\t\t\t\t\t\t\"statement_data\": \"MyData\",\n\t\t\t\t\t\t\t\t\t\"this_is_a_new_key\": \"thisIsANewValue\"\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t],\n\t\t\t\t\t\"statement\": {\n\t\t\t\t\t\t\"id\": \"_83_7403bcf4d8c9463b956698c7c83826a2\",\n\t\t\t\t\t\t\"my_metadata\": {\n\t\t\t\t\t\t\t\"data\": {\n\t\t\t\t\t\t\t\t\"my_key\": \"myData\",\n\t\t\t\t\t\t\t\t\"this_key\": \"thatData\",\n\t\t\t\t\t\t\t\t\"statement_data\": \"MyData\",\n\t\t\t\t\t\t\t\t\"this_is_a_new_key\": \"thisIsANewValue\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\t\"service_location\": {\n\t\t\t\t\t\t\"id\": \"_78_9d56ac594f5b4e1cbdcac3c32a8c6050\",\n\t\t\t\t\t\t\"my_metadata\": {\n\t\t\t\t\t\t\t\"external_id\": \"external_id\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"card_brand\": \"VISA\",\n\t\t\t\t\"card_last4\": \"4568\",\n\t\t\t\t\"payment_type\": \"CARD\",\n\t\t\t\t\"approval_code\": \"1234\",\n\t\t\t\t\"captured_date\": \"2022-01-14T19:36:00.972Z\",\n\t\t\t\t\"pretty_amount\": \"1642.00\",\n\t\t\t\t\"captured_amount\": 164200,\n\t\t\t\t\"card_expire_year\": \"2023\",\n\t\t\t\t\"card_expire_month\": \"10\",\n\t\t\t\t\"captured_currency\": \"USD\"\n\t\t\t}\n\t\t}\n\t],\n\t\"action_responses\": [\n\t\t{\n\t\t\t\"name\": \"updateQueue\",\n\t\t\t\"id\": \"76f7d6b4-ff63-4730-a807-0beef938d93b\",\n\t\t\t\"version\": \"1\",\n\t\t\t\"order\": 1,\n\t\t\t\"status_code\": 200,\n\t\t\t\"body\": {\n\t\t\t\t\"item_id\": \"7945e0c3-ef91-49e7-9916-587999db5a12\",\n\t\t\t\t\"status\": \"HANDLED\"\n\t\t\t}\n\t\t}\n\t]\n}"},{"id":"52ea6c5f-d31f-4b80-aafc-d8b2636268f0","name":"Action: 404 - with error","originalRequest":{"method":"POST","header":[{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"actions\": [\n\t\t{\n\t\t\t\"name\": \"updateQueue\",\n\t\t\t\"version\": \"1\",\n\t\t\t\"body\": {\n\t\t\t\t\"item_id\": \"akasklshjd\",\n\t\t\t\t\"status\": \"HANDLED\"\n\t\t\t}\n\t\t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"{{queuePackagePostUrl}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"description":"","key":"Content-Type","type":"text","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"message\": \"akasklshjd not found\"\n}"}],"_postman_id":"e07a73af-2b06-4194-a48c-a967017a7830"}],"id":"a4e81904-e85e-4dad-bec7-f3cbe6ca2d40","description":"The CX Platform returns the result of Consumer Actions via a PUSH to an end point of your choice or via pulling from our queue. This section will cover both methods so you are able to decide what works best for your system.
\nPUSH
\nAt the completion of an action - for example a payment - the payment object is pushed to an endpoint of your designation in specific format. This object is specific to the action type and we can configure an endpoint for each action (payment, form, event, quote and check in). The example objects are shown in the
\nPULL
\nThis section elaborates on the API endpoint used to query details about the Queue, such as the number of items in the queue and associated URLs to manipulate the queue. This can be used as an alternative to the Push Webhook.
\nThe Queue API's consist of
\nGET - Package Home - Provides the total items in queue and URL for Pickup
\nGET - Package Pickup - Provides the detail of the items in queue and actions url
\nPOST - Package Action - Provides a way to mutate a queue item (mark as Handled)
\n","_postman_id":"a4e81904-e85e-4dad-bec7-f3cbe6ca2d40"},{"name":"Payment Requests","item":[{"name":"Create Payment Request","id":"9fc7184a-652f-4085-a6b6-0a32beffb9be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"},{"key":"Location-As-Navigable-Url","value":"true"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"USD\",\n \"total_amount\": 123456,\n \"payment_request_date_time\": \"2020-10-04T15:50:43.947Z\",\n \"customer_message\": \"Thank you for your business\",\n \"description\":\"PR-12345\",\n \"due_in_full_date_time\": \"2024-02-09T15:55:33.885Z\",\n \"line_items\": [\n {\n \"line_item_reference\": \"1-31663098\",\n \"date\": \"2024-02-09T15:55:33.885Z\",\n \"amount\": 100,\n \"description\": \"CREDIT!\"\n },\n {\n \"line_item_reference\": \"2-09632236\",\n \"date\": \"2024-02-09T15:55:33.885Z\",\n \"amount\": 123356,\n \"description\": \"PAYMENT!\"\n }\n ],\n \"_embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n },\n \"my_metadata\": {\n \"data\": {\n \"my_key\": \"myData\",\n \"this_key\": \"thatData\",\n \"statement_data\": \"MyData\",\n \"this_is_a_new_key\" :\"thisIsANewValue\"\n }\n }\n}"},"url":"{{baseUrl}}/customer_experience/action/createPaymentRequest","description":"With a Customer in place, your next step is to generate a Payment Request. You will define the amount and any additional information to display to the end consumer in this API.
\nNew Payment Request: Issue a POST request to the createPaymentRequest endpoint for a given customer ID. Upon success, a response will be returned containing the ID of the created Payment Request. Your Customer will be automatically sent a communication with the new payment request immediately.
\nLimitations and Guidelines
\nMany-at-a-Time: A Customer can have any number of active Payment Requests.
\nAttachments: You can attach a PDF document to the Payment Request. The attachment should be a raw Base64 encoded string. Refer to the Postman example titled 'Statement with Attachment' for more information.
\nOne attachment per Statement.
\nMaximum size of 500,000 Base64 characters (~approx 370,000 bytes on disk).
\nLine Items: You can provide more detail for each item by including an array of line items, please note the total amount must equal the sum of the line items.
\nQR Code and Link: By providing an additional header ‘Location-As-Navigable-Url: true’ we will return in the response the tinylink URL and a QR base64 image for your use in other communication platforms (eg print on paper copy).
\n| Field | Notes |
|---|---|
currency | Required. |
total_amount | Required. In Basis Points |
payment_request_date_time | Optional. In ISO8601 format. |
description | Required Any Text, up to 60 characters. Will be displayed on the Customer Portal to assist the customer in differentiating different payment requests. |
_embedded.customer.id | Conditional. Internal system Id referencing the customer for which the Payment Request is being created. Either Id or External Id is required. |
embedded.customer.external_id | Conditional. External system Id referencing the customer for which the Payment Request is being created. Either Id for External Id is required. |
line_items | Optional. An array of lineitem |
line_item |
|
my_metadata | Optional. Discretionary data that is stored with the Statement. Actions related to the Statement return this data in the response. (example: receive Payment item via PUSH or PULL) |
my_metadata.external_id | Optional. Alternate identifier for a statement. example |
my_metadata.data | Optional. Key-value pairs of strings. example |
config_overrides | Optional. Map of configuration setting names and values example Currently, the only supported configuration option is on_setStatement_sendMessage_enabled, which controls the sending of notifications to the customer when a statement is updated. \"true\" sends a notification, \"false\" does not. Configuration overrides are only in effect for the duration and scope of the request in which they are specified. |
optional_data | Optional Data for additional features |
optional_data.reference_id | Optional. When included, the reference ID will be used as a prefix to build incrementing reference IDs when Customers make multiple payments. e.g. ref-123-abc will result in ref-123-abc-1, ref-123-abc-2, ref-123-abc-3, etc attached to each subsequent payment until the Payment Request is updated. NOTE: these values should be unique from one Payment Request update to the next. |
optional_data.po_number | Optional. When included, will be sent with the payment to qualify for Level II/III processing rates. |
optional_data.destination_postal_code | Optional. When included, will be sent with the payment to qualify for Level II/III processing rates |
optional_data.tax_amount | Optional. When included, will be sent with the payment to qualify for Level II/III processing rates |
optional_data.invoice_number | Optional. When included, will be sent with the payment and will show up in payment gateway reports. |
view_detail_url | Optional. HTTPS Url When included, a 'View Detail URL' will be available on the Payment page which will link to the Url sent |
attachments | Optional. Limitations listed previously base 64 object (see examples) |
Important Note: The Payment Request link is only for the Customer. A merchant user should never use that link! Autocomplete is enabled, and a merchant user’s browser may autofill incorrect card details.
\nHere is an email and SMS Text example of a Communication sent out when the Create / Update statement call is completed:
\n![](\"https://lh5.googleusercontent.com/i7FgoyYOxmIdGNj94DIIMdNkcsAA9MxD5IU5RUtNzmx3eyxpT9fY22zrlqEg7_dZdew2qSxDqiyzm6465nrz5fOPZh33rQWRh6UQ74iedSLy5LrH8_lTxEq_NGUeqTIGbjhfrnI9K_b9-S0y_0ETqsg\")
\n\n![](\"https://lh4.googleusercontent.com/a_dWT9Knbv0BRDcD7EXgE0xNE8J1V7eJW6QE39AA6S-XkVYN90lvWNJZvQelG5dg76w441D2Yj9Ki7SaLMF4Nzig_BQlRt_BHaZWbMJ8jr9BARwHy0vHe4PyTYr7gcyb38L4VAS1V2cproTtERt7H8Y\")
","urlObject":{"path":["customer_experience","action","createPaymentRequest"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"c4129f72-5269-4bd6-bde6-a98df221a231","name":"201 Create with Attachment and TinyLink","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"},{"key":"Location-As-Navigable-Url","value":"true"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"USD\",\n \"total_amount\": 123456,\n \"payment_request_date_time\": \"2020-10-04T15:50:43.947Z\",\n \"customer_message\": \"Thank you for your business\",\n \"due_in_full_date_time\": \"2024-02-09T15:55:33.885Z\",\n \"description\":\"PR-12345\",\n \"attachments\": [\n\t\t{\n\t\t\t\"content_type\": \"application/pdf\",\n\t\t\t\"content\": \"{{base64Content}}\"\n\t\t}\n\t],\n \"line_items\": [\n {\n \"line_item_reference\": \"1-31663098\",\n \"date\": \"2024-02-09T15:55:33.885Z\",\n \"amount\": 100,\n \"description\": \"CREDIT!\"\n },\n {\n \"line_item_reference\": \"2-09632236\",\n \"date\": \"2024-02-09T15:55:33.885Z\",\n \"amount\": 123356,\n \"description\": \"PAYMENT!\"\n }\n ],\n \"_embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n },\n \"my_metadata\": {\n \"data\": {\n \"my_key\": \"myData\",\n \"this_key\": \"thatData\",\n \"statement_data\": \"MyData\",\n \"this_is_a_new_key\" :\"thisIsANewValue\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/createPaymentRequest"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\":\"{{paymentRequestId}}\",\n \"currency\": \"USD\",\n \"total_amount\": 123456,\n \"payment_request_date_time\": \"2020-10-04T15:50:43.947Z\",\n \"customer_message\": \"Thank you for your business\",\n \"due_in_full_date_time\": \"2024-02-09T15:55:33.885Z\",\n \"description\":\"PR-12345\",\n \"attachments\": [\n\t\t{\n\t\t\t\"content_type\": \"application/pdf\",\n\t\t\t\"content\": \"{{base64Content}}\"\n\t\t}\n\t],\n \"line_items\": [\n {\n \"line_item_reference\": \"1-31663098\",\n \"date\": \"2024-02-09T15:55:33.885Z\",\n \"amount\": 100,\n \"description\": \"CREDIT!\"\n },\n {\n \"line_item_reference\": \"2-09632236\",\n \"date\": \"2024-02-09T15:55:33.885Z\",\n \"amount\": 123356,\n \"description\": \"PAYMENT!\"\n }\n ],\n \"_embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n },\n \"my_metadata\": {\n \"data\": {\n \"my_key\": \"myData\",\n \"this_key\": \"thatData\",\n \"statement_data\": \"MyData\",\n \"this_is_a_new_key\" :\"thisIsANewValue\"\n }\n }\n}"},{"id":"6c4146ab-276f-48be-bb1b-6959e7cccb45","name":"201 Create with Optional Data","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"},{"key":"Location-As-Navigable-Url","value":"true"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"USD\",\n \"total_amount\": 123456,\n \"payment_request_date_time\": \"2020-10-04T15:50:43.947Z\",\n \"customer_message\": \"Thank you for your business\",\n \"due_in_full_date_time\": \"2024-02-09T15:55:33.885Z\",\n \"description\":\"PR-12345\",\n \"optional_data\":{\n \"tax_amount\":10000,\n \"destination_postal_code\":\"84045\",\n \"po_number\":\"12345\",\n \"clerk_id\":\"Derek\",\n \"reference_id\":\"8bcbf5f3-d5c6-4c88-a72f-d5dc8ba9c8bd\",\n \"invoice_number\":\"12345\"\n },\n \"attachments\": [\n\t\t{\n\t\t\t\"content_type\": \"application/pdf\",\n\t\t\t\"content\": \"{{base64Content}}\"\n\t\t}\n\t],\n \"line_items\": [\n {\n \"line_item_reference\": \"1-31663098\",\n \"date\": \"2024-02-09T15:55:33.885Z\",\n \"amount\": 100,\n \"description\": \"CREDIT!\"\n },\n {\n \"line_item_reference\": \"2-09632236\",\n \"date\": \"2024-02-09T15:55:33.885Z\",\n \"amount\": 123356,\n \"description\": \"PAYMENT!\"\n }\n ],\n \"_embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n },\n \"my_metadata\": {\n \"data\": {\n \"my_key\": \"myData\",\n \"this_key\": \"thatData\",\n \"statement_data\": \"MyData\",\n \"this_is_a_new_key\" :\"thisIsANewValue\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/createPaymentRequest"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\":\"{{paymentRequestId}}\",\n \"currency\": \"USD\",\n \"total_amount\": 123456,\n \"payment_request_date_time\": \"2020-10-04T15:50:43.947Z\",\n \"customer_message\": \"Thank you for your business\",\n \"due_in_full_date_time\": \"2024-02-09T15:55:33.885Z\",\n \"description\":\"PR-12345\",\n \"optional_data\":{\n \"tax_amount\":10000,\n \"destination_postal_code\":\"84045\",\n \"po_number\":\"12345\",\n \"clerk_id\":\"Derek\",\n \"reference_id\":\"92fcc158-0161-4d35-8a98-62ec91d74ca7\",\n \"invoice_number\":\"12345\"\n },\n \"attachments\": [\n\t\t{\n\t\t\t\"content_type\": \"application/pdf\",\n\t\t\t\"content\": \"{{base64Content}}\"\n\t\t}\n\t],\n \"line_items\": [\n {\n \"line_item_reference\": \"1-31663098\",\n \"date\": \"2024-02-09T15:55:33.885Z\",\n \"amount\": 100,\n \"description\": \"CREDIT!\"\n },\n {\n \"line_item_reference\": \"2-09632236\",\n \"date\": \"2024-02-09T15:55:33.885Z\",\n \"amount\": 123356,\n \"description\": \"PAYMENT!\"\n }\n ],\n \"_embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n },\n \"my_metadata\": {\n \"data\": {\n \"my_key\": \"myData\",\n \"this_key\": \"thatData\",\n \"statement_data\": \"MyData\",\n \"this_is_a_new_key\" :\"thisIsANewValue\"\n }\n }\n}"},{"id":"28fee256-5b65-477e-a3e3-7c4bba8f7d51","name":"201 Create with URI Link","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"},{"key":"Location-As-Navigable-Url","value":"true"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"USD\",\n \"total_amount\": 123456,\n \"payment_request_date_time\": \"2020-10-04T15:50:43.947Z\",\n \"customer_message\": \"Thank you for your business\",\n \"due_in_full_date_time\": \"2024-02-09T15:55:33.885Z\",\n \"description\":\"PR-12345\",\n \"view_detail_url\":\"https://www.google.com\",\n \"optional_data\":{\n \"tax_amount\":10000,\n \"destination_postal_code\":\"84045\",\n \"po_number\":\"12345\",\n \"clerk_id\":\"Derek\",\n \"reference_id\":\"decd34ca-121f-4b57-8d10-026027418e42\",\n \"invoice_number\":\"12345\"\n },\n \"attachments\": [\n\t\t{\n\t\t\t\"content_type\": \"application/pdf\",\n\t\t\t\"content\": \"{{base64Content}}\"\n\t\t}\n\t],\n \"line_items\": [\n {\n \"line_item_reference\": \"1-31663098\",\n \"date\": \"2024-02-09T15:55:33.885Z\",\n \"amount\": 100,\n \"description\": \"CREDIT!\"\n },\n {\n \"line_item_reference\": \"2-09632236\",\n \"date\": \"2024-02-09T15:55:33.885Z\",\n \"amount\": 123356,\n \"description\": \"PAYMENT!\"\n }\n ],\n \"_embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n },\n \"my_metadata\": {\n \"data\": {\n \"my_key\": \"myData\",\n \"this_key\": \"thatData\",\n \"statement_data\": \"MyData\",\n \"this_is_a_new_key\" :\"thisIsANewValue\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/createPaymentRequest"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\":\"{{paymentRequestId}}\",\n \"currency\": \"USD\",\n \"total_amount\": 123456,\n \"payment_request_date_time\": \"2020-10-04T15:50:43.947Z\",\n \"customer_message\": \"Thank you for your business\",\n \"due_in_full_date_time\": \"2024-02-09T15:55:33.885Z\",\n \"description\":\"PR-12345\",\n \"view_detail_url\":\"https://www.google.com\",\n \"optional_data\":{\n \"tax_amount\":10000,\n \"destination_postal_code\":\"84045\",\n \"po_number\":\"12345\",\n \"clerk_id\":\"Derek\",\n \"reference_id\":\"2b87b609-65d2-4c2b-8868-f504e6108a6e\",\n \"invoice_number\":\"12345\"\n },\n \"attachments\": [\n\t\t{\n\t\t\t\"content_type\": \"application/pdf\",\n\t\t\t\"content\": \"{{base64Content}}\"\n\t\t}\n\t],\n \"line_items\": [\n {\n \"line_item_reference\": \"1-31663098\",\n \"date\": \"2024-02-09T15:55:33.885Z\",\n \"amount\": 100,\n \"description\": \"CREDIT!\"\n },\n {\n \"line_item_reference\": \"2-09632236\",\n \"date\": \"2024-02-09T15:55:33.885Z\",\n \"amount\": 123356,\n \"description\": \"PAYMENT!\"\n }\n ],\n \"_embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n },\n \"my_metadata\": {\n \"data\": {\n \"my_key\": \"myData\",\n \"this_key\": \"thatData\",\n \"statement_data\": \"MyData\",\n \"this_is_a_new_key\" :\"thisIsANewValue\"\n }\n }\n}"},{"id":"f32841c7-9a34-49eb-8727-d8a5294aadc0","name":"201 Create with Configuration Override","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"},{"key":"Location-As-Navigable-Url","value":"true"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"USD\",\n \"total_amount\": 123456,\n \"payment_request_date_time\": \"2020-10-04T15:50:43.947Z\",\n \"customer_message\": \"Thank you for your business\",\n \"due_in_full_date_time\": \"2024-02-09T15:55:33.885Z\",\n \"description\":\"PR-12345\",\n \"view_detail_url\":\"https://www.google.com\",\n \"optional_data\":{\n \"tax_amount\":10000,\n \"destination_postal_code\":\"84045\",\n \"po_number\":\"12345\",\n \"clerk_id\":\"Derek\",\n \"reference_id\":\"1b7b1264-cade-442c-b511-f1d69cb9cab0\",\n \"invoice_number\":\"12345\"\n },\n \"config_overrides\": {\n\t\t\"on_setStatement_sendMessage_enabled\": \"true\"\n\t},\n \"attachments\": [\n\t\t{\n\t\t\t\"content_type\": \"application/pdf\",\n\t\t\t\"content\": \"{{base64Content}}\"\n\t\t}\n\t],\n \"line_items\": [\n {\n \"line_item_reference\": \"1-31663098\",\n \"date\": \"2024-02-09T15:55:33.885Z\",\n \"amount\": 100,\n \"description\": \"CREDIT!\"\n },\n {\n \"line_item_reference\": \"2-09632236\",\n \"date\": \"2024-02-09T15:55:33.885Z\",\n \"amount\": 123356,\n \"description\": \"PAYMENT!\"\n }\n ],\n \"_embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n },\n \"my_metadata\": {\n \"data\": {\n \"my_key\": \"myData\",\n \"this_key\": \"thatData\",\n \"statement_data\": \"MyData\",\n \"this_is_a_new_key\" :\"thisIsANewValue\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cx/action/createPaymentRequest"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\":\"{{paymentRequestId}}\",\n \"currency\": \"USD\",\n \"total_amount\": 123456,\n \"payment_request_date_time\": \"2020-10-04T15:50:43.947Z\",\n \"customer_message\": \"Thank you for your business\",\n \"due_in_full_date_time\": \"2024-02-09T15:55:33.885Z\",\n \"description\":\"PR-12345\",\n \"view_detail_url\":\"https://www.google.com\",\n \"optional_data\":{\n \"tax_amount\":10000,\n \"destination_postal_code\":\"84045\",\n \"po_number\":\"12345\",\n \"clerk_id\":\"Derek\",\n \"reference_id\":\"57fe1851-76d4-4079-97a1-19d4f52332a0\",\n \"invoice_number\":\"12345\"\n },\n \"attachments\": [\n\t\t{\n\t\t\t\"content_type\": \"application/pdf\",\n\t\t\t\"content\": \"{{base64Content}}\"\n\t\t}\n\t],\n \"line_items\": [\n {\n \"line_item_reference\": \"1-31663098\",\n \"date\": \"2024-02-09T15:55:33.885Z\",\n \"amount\": 100,\n \"description\": \"CREDIT!\"\n },\n {\n \"line_item_reference\": \"2-09632236\",\n \"date\": \"2024-02-09T15:55:33.885Z\",\n \"amount\": 123356,\n \"description\": \"PAYMENT!\"\n }\n ],\n \"_embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n },\n \"my_metadata\": {\n \"data\": {\n \"my_key\": \"myData\",\n \"this_key\": \"thatData\",\n \"statement_data\": \"MyData\",\n \"this_is_a_new_key\" :\"thisIsANewValue\"\n }\n }\n}"},{"id":"8f684cd8-cdd4-48db-9885-2bd3a38e7418","name":"401 Unauthorized Copy","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","description":"If set to true, the response will have the \"Location-As-Navigable-Url-As-TinyLink\" header. The value will be a TinyLink URL that can be used to link to the statement."},{"key":"X-GP-Version","value":"{{X-GP-Version}}","description":"(Required) CX Api key for the Service Location"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"},{"key":"Location-As-Navigable-Url","value":"true"}],"body":{"mode":"raw","raw":"{\n\t\"currency\": \"USD\",\n\t\"totalAmount\": 10000,\n\t\"statementDateTime\": \"2020-02-24T16:47:52.887Z\",\n\t\"customerMessage\": \"Thank you for your business\",\n\t\"dueInFullDateTime\": \"2020-02-24T16:47:52.887Z\",\n\t\"_embedded\": {\n\t\t\"customer\": {\n\t\t\t\"id\": \"{{customerId}}\"\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cx/action/createPaymentRequest"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Date","value":"Mon, 24 Feb 2020 17:26:05 GMT"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"nginx/1.14.1"},{"key":"vary","value":"accept-encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n\t\"message\": \"Not authorized for this service location\"\n}"}],"_postman_id":"9fc7184a-652f-4085-a6b6-0a32beffb9be"},{"name":"Discard Payment Request","id":"4fa0aeaa-ff48-487b-ab42-e0a3c15500b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"AuthToken {{AuthToken}}"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{paymentRequestId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/discard","description":"This endpoint allows you to remove an existing payment request from a customer's list of payment requests.
\n","urlObject":{"path":["customer_experience","action","discard"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"950a4d8c-2adf-47ad-9a6e-a62e92ab8911","name":"Discard Payment Request / OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"AuthToken {{AuthToken}}"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{paymentRequestId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/discard"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"0cc2c2fe-203d-4a5a-88d3-fa39b941305a","name":"Discard Payment Request / Not Found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"AuthToken {{AuthToken}}"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{paymentRequestId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/discard"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Object not found\"\n}"}],"_postman_id":"4fa0aeaa-ff48-487b-ab42-e0a3c15500b9"},{"name":"Create / Update Statement","event":[{"listen":"prerequest","script":{"id":"ca24aa64-78a1-48ec-a347-9de9ad89d586","exec":["var date = new Date().toISOString();\r","pm.environment.set(\"date\", date);"],"type":"text/javascript"}}],"id":"5ceb78ea-427a-466f-acab-49de781a8523","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"},{"key":"Location-As-Navigable-Url","value":"true","type":"text","description":"If set to true, the response will have the \"Location-As-Navigable-Url-As-TinyLink\" header. The value will be a TinyLink URL that can be used to link to the Payment Request.
\n"}],"body":{"mode":"raw","raw":"{\r\n\t\"currency\": \"USD\",\r\n\t\"total_amount\": 10000,\r\n\t\"statement_date_time\": \"2020-02-24T16:47:52.887Z\",\r\n\t\"customer_message\": \"Thank you for your business\",\r\n \"view_detail_url\":\"https://www.google.com\",\r\n\t\"due_in_full_date_time\": \"2020-02-24T16:47:52.887Z\",\r\n\t\"_embedded\": {\r\n\t\t\"customer\": {\r\n\t\t\t\"id\": \"{{customerId}}\"\r\n\t\t}\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/setStatement","description":"This API allows you to clear out a configuration value based on the configuration name.
\nWith a Customer in place, your next step is to generate a Statement, which will serve as a Payment Request for them. You will define the amount and any additional information to display to the end consumer in this API.
\nNew Payment Request: Issue a POST request to the setStatement endpoint for a given customer ID. Upon success, a response will be returned containing the ID of the created Statement. Your Customer will be automatically sent a communication with the new payment request immediately.
\nLimitations and Guidelines
\nOne-at-a-Time: A Customer can have only one active Payment Request. Any new request will overwrite the existing one, showing the most recent amount due.
\nAttachments: You can attach a PDF document to the Payment Request. The attachment should be a raw Base64 encoded string. Refer to the Postman example titled 'Statement with Attachment' for more information.
\nOne attachment per Statement.
\nMaximum size of 500,000 Base64 characters (~approx 370,000 bytes on disk).
\nLine Items: You can provide more detail for each item by including an array of line items, please note the total amount must equal the sum of the line items.
\nQR Code and Link: By providing an additional header ‘Location-As-Navigable-Url: true’ we will return in the response the tinylink URL and a QR base64 image for your use in other communication platforms (eg print on paper copy).
\nImportant Note: The Payment Request link is only for the Customer. A merchant user should never use that link! Autocomplete is enabled, and a merchant user’s browser may autofill incorrect card details.
\nHere is an email and SMS Text example of a Communication sent out when the Create / Update statement call is completed:
\n\n\n","urlObject":{"path":["customer_experience","action","setStatement"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"45ae3422-c719-4c1c-8606-42e2dbf4f32d","name":"200 Update with Attachment and Tiny Link","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"},{"key":"Location-As-Navigable-Url","value":"true","description":"If set to true, the response will have the \"Location-As-Navigable-Url-As-TinyLink\" header. The value will be a TinyLink URL that can be used to link to the statement."}],"body":{"mode":"raw","raw":"{\n\t\"currency\": \"USD\",\n\t\"total_amount\": 10000,\n\t\"statement_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"customer_message\": \"Thank you for your business\",\n\t\"due_in_full_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"attachments\": [\n\t\t{\n\t\t\t\"content_type\": \"application/pdf\",\n\t\t\t\"content\": \"{{base64Content}}\"\n\t\t}\n\t],\n\t\"_embedded\": {\n\t\t\"customer\": {\n\t\t\t\"id\": \"{{customerId}}\"\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/setStatement"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Date","value":"Wed, 26 Feb 2020 19:51:38 GMT"},{"key":"Expires","value":"0"},{"key":"Location-As-Navigable-Url-As-TinyLink","value":"https://c.rt2.me_72r7btloi6/"},{"key":"Location-As-Navigable-Url-As-QR-Code","value":"{{base64QRCode}}","description":"","type":"text"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Set-Cookie","value":"CX2SESSIONID=4171880F2385BD4CF2907EBB0949221B; Path=/; Secure; HttpOnly"},{"key":"vary","value":"accept-encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n\t\"id\": \"{{statementId}}\",\n\t\"currency\": \"USD\",\n\t\"total_amount\": 10000,\n\t\"statement_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"customer_message\": \"Thank you for your business\",\n\t\"due_in_full_date_time\": \"2020-02-24T16:47:52.887Z\",\t\n\t\"_embedded\": {\n\t\t\"customer\": {\n\t\t\t\"id\": \"{{customerId}}\"\n\t\t}\n\t}\n}"},{"id":"66fcdea1-71d2-47e4-a6cf-9e0b475a3ac2","name":"200 Update with Configuration Override","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Location-As-Navigable-Url","value":"true","description":"If set to true, the response will have the \"Location-As-Navigable-Url-As-TinyLink\" header. The value will be a TinyLink URL that can be used to link to the statement."},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"default"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"default"}],"body":{"mode":"raw","raw":"{\n\t\"currency\": \"USD\",\n\t\"total_amount\": 10000,\n\t\"statement_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"customer_message\": \"Thank you for your business\",\n\t\"due_in_full_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"config_overrides\": {\n\t\t\"on_setStatement_sendMessage_enabled\": \"true\"\n\t},\n\t\"_embedded\": {\n\t\t\"customer\": {\n\t\t\t\"id\": \"{{customerId}}\"\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cx/action/setStatement"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Date","value":"Wed, 26 Feb 2020 19:51:38 GMT"},{"key":"Expires","value":"0"},{"key":"Location-As-Navigable-Url-As-TinyLink","value":"https://c.rt2.me_72r7btloi6/"},{"key":"Location-As-Navigable-Url-As-QR-Code","value":"{{base64QRCode}}","description":"","type":"text"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Set-Cookie","value":"CX2SESSIONID=4171880F2385BD4CF2907EBB0949221B; Path=/; Secure; HttpOnly"},{"key":"vary","value":"accept-encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n\t\"id\": \"{{statementId}}\",\n\t\"currency\": \"USD\",\n\t\"total_amount\": 10000,\n\t\"statement_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"customer_message\": \"Thank you for your business\",\n\t\"due_in_full_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"config_overrides\": {\n\t\t\"on_setStatement_sendMessage_enabled\": \"true\"\n\t},\n\t\"_embedded\": {\n\t\t\"customer\": {\n\t\t\t\"id\": \"{{customerId}}\"\n\t\t}\n\t}\n}"},{"id":"10005e5d-ea0c-474c-b12b-8f9a97aaa424","name":"200 Update with Optional Data","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Location-As-Navigable-Url","value":"true","description":"If set to true, the response will have the \"Location-As-Navigable-Url-As-TinyLink\" header. The value will be a TinyLink URL that can be used to link to the statement."},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"default"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"default"}],"body":{"mode":"raw","raw":"{\n\t\"currency\": \"USD\",\n\t\"total_amount\": 10000,\n\t\"statement_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"customer_message\": \"Thank you for your business\",\n\t\"due_in_full_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"optional_data\": {\n\t\t\"tax_amount\": 600,\n\t\t\"po_number\": \"purchase-order-1\",\n\t\t\"invoice_number\": \"INV-0001\",\n\t\t\"destination_postal_code\": \"90210\",\n\t\t\"reference_id\": \"cf1e3e4b-8661-43d8-81f0-6f59c030a061\"\n\t},\n\t\"_embedded\": {\n\t\t\"customer\": {\n\t\t\t\"id\": \"{{customerId}}\"\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cx/action/setStatement"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Date","value":"Wed, 26 Feb 2020 19:51:38 GMT"},{"key":"Expires","value":"0"},{"key":"Location-As-Navigable-Url-As-TinyLink","value":"https://c.rt2.me_72r7btloi6/"},{"key":"Location-As-Navigable-Url-As-QR-Code","value":"{{base64QRCode}}","description":"","type":"text"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Set-Cookie","value":"CX2SESSIONID=4171880F2385BD4CF2907EBB0949221B; Path=/; Secure; HttpOnly"},{"key":"vary","value":"accept-encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n\t\"id\": \"{{statementId}}\",\n\t\"currency\": \"USD\",\n\t\"total_amount\": 10000,\n\t\"statement_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"customer_message\": \"Thank you for your business\",\n\t\"due_in_full_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"optional_data\": {\n\t\t\"tax_amount\": 600,\n\t\t\"po_number\": \"purchase-order-1\",\n\t\t\"invoice_number\": \"INV-0001\",\n\t\t\"destination_postal_code\": \"90210\",\n\t\t\"reference_id\": \"cf1e3e4b-8661-43d8-81f0-6f59c030a061\"\n\t},\n\t\"_embedded\": {\n\t\t\"customer\": {\n\t\t\t\"id\": \"{{customerId}}\"\n\t\t}\n\t}\n}"},{"id":"0db83e27-7d49-4def-ada6-5ef8e1c49db0","name":"201 Created - No Link","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"},{"key":"Location-As-Navigable-Url","value":"false","type":"text","description":"If set to true, the response will have the \"Location-As-Navigable-Url-As-TinyLink\" header. The value will be a TinyLink URL that can be used to link to the statement."}],"body":{"mode":"raw","raw":"{\n\t\"currency\": \"USD\",\n\t\"total_amount\": 10000,\n\t\"statement_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"customer_message\": \"Thank you for your business\",\n\t\"due_in_full_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"_embedded\": {\n\t\t\"customer\": {\n\t\t\t\"id\": \"{{customerId}}\"\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/setStatement"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Date","value":"Mon, 24 Feb 2020 17:28:31 GMT"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"nginx/1.14.1"},{"key":"vary","value":"accept-encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n\t\"id\": \"{{statementId}}\",\n\t\"currency\": \"USD\",\n\t\"total_amount\": 10000,\n\t\"statement_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"customer_message\": \"Thank you for your business\",\n\t\"due_in_full_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"_embedded\": {\n\t\t\"customer\": {\n\t\t\t\"id\": \"{{customerId}}\"\n\t\t}\n\t}\n}"},{"id":"2b4c0213-86bc-4ab6-b90a-dd4e462ceb24","name":"201 Created with myMetadata","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"},{"key":"Location-As-Navigable-Url","value":"true","type":"text","description":"If set to true, the response will have the \"Location-As-Navigable-Url-As-TinyLink\" header. The value will be a TinyLink URL that can be used to link to the statement."}],"body":{"mode":"raw","raw":"{\n\t\"currency\": \"USD\",\n\t\"total_amount\": 10000,\n\t\"statement_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"customer_message\": \"Thank you for your business\",\n\t\"due_in_full_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"my_metadata\": {\n\t\t\"external_id\": \"{{statementExternalId}}\",\n\t\t\"data\": {\n\t\t\t\"loyalty_program\": \"GOLD\"\n\t\t}\n\t},\n\t\"_embedded\": {\n\t\t\"customer\": {\n\t\t\t\"id\": \"{{customerId}}\"\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/setStatement"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"id\": \"{{statementId}}\",\n\t\"currency\": \"USD\",\n\t\"total_amount\": 10000,\n\t\"statement_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"customer_message\": \"Thank you for your business\",\n\t\"due_in_full_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"my_metadata\": {\n\t\t\"external_id\": \"{{statementExternalId}}\",\n\t\t\"data\": {\n\t\t\t\"loyalty_program\": \"GOLD\"\n\t\t}\n\t},\n\t\"_embedded\": {\n\t\t\"customer\": {\n\t\t\t\"id\": \"{{customerId}}\",\n\t\t\t\"my_metadata\": {\n\t\t\t\t\"external_id\": \"{{customerExternalId}}\",\n\t\t\t\t\"data\": {\n\t\t\t\t\t\"middle_name\": \"Joe\"\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}"},{"id":"cebe93b0-2bea-45c4-b0ed-e444127d1638","name":"201 Created with line items","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"},{"key":"Location-As-Navigable-Url","value":"true","type":"text","description":"If set to true, the response will have the \"Location-As-Navigable-Url-As-TinyLink\" header. The value will be a TinyLink URL that can be used to link to the statement."}],"body":{"mode":"raw","raw":"{\n\t\"currency\": \"USD\",\n\t\"total_amount\": 10000,\n\t\"statement_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"customer_message\": \"Thank you for your business\",\n\t\"due_in_full_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"line_items\": [\n\t\t{\n\t\t\t\"line_item_reference\": \"INV-000001\",\n\t\t\t\"date\": \"2021-01-03\",\n\t\t\t\"description\": \"Services provided\",\n\t\t\t\"amount\": 5000\n\t\t},\n\t\t{\n\t\t\t\"line_item_reference\": \"INV-000002\",\n\t\t\t\"date\": \"2021-01-03\",\n\t\t\t\"description\": \"More services provided\",\n\t\t\t\"amount\": 1000\n\t\t}\n\t],\n\t\"_embedded\": {\n\t\t\"customer\": {\n\t\t\t\"id\": \"{{customerId}}\"\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/setStatement"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"id\": \"{{statementId}}\",\n\t\"currency\": \"USD\",\n\t\"total_amount\": 10000,\n\t\"statement_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"customer_message\": \"Thank you for your business\",\n\t\"due_in_full_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"line_items\": [\n\t\t{\n\t\t\t\"line_item_reference\": \"INV-000001\",\n\t\t\t\"date\": \"2021-01-03\",\n\t\t\t\"description\": \"Services provided\",\n\t\t\t\"amount\": 5000\n\t\t},\n\t\t{\n\t\t\t\"line_item_reference\": \"INV-000002\",\n\t\t\t\"date\": \"2021-01-03\",\n\t\t\t\"description\": \"More services provided\",\n\t\t\t\"amount\": 1000\n\t\t}\n\t],\n\t\"_embedded\": {\n\t\t\"customer\": {\n\t\t\t\"id\": \"{{customerId}}\",\n\t\t\t\"my_metadata\": {\n\t\t\t\t\"external_id\": \"{{customerExternalId}}\",\n\t\t\t\t\"data\": {\n\t\t\t\t\t\"middle_name\": \"Joe\"\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}"},{"id":"a5284616-ad13-4893-953f-72c3daddb29b","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Location-As-Navigable-Url","value":"true","type":"text","description":"If set to true, the response will have the \"Location-As-Navigable-Url-As-TinyLink\" header. The value will be a TinyLink URL that can be used to link to the statement."}],"body":{"mode":"raw","raw":"{\n\t\"currency\": \"USD\",\n\t\"total_amount\": 10000,\n\t\"statement_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"customer_message\": \"Thank you for your business\",\n\t\"due_in_full_date_time\": \"2020-02-24T16:47:52.887Z\",\n\t\"_embedded\": {\n\t\t\"customer\": {\n\t\t\t\"id\": \"{{customerId}}\"\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/setStatement"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Date","value":"Mon, 24 Feb 2020 17:26:05 GMT"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"nginx/1.14.1"},{"key":"vary","value":"accept-encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"transfer-encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n\t\"message\": \"Not authorized for this service location\"\n}"}],"_postman_id":"5ceb78ea-427a-466f-acab-49de781a8523"}],"id":"e615fcc5-cb7d-49d1-98f8-3057a6d64aa0","description":"There are 2 options for sending requests for payment to the customers:
\nA Payment Request creates a new request each time it is called allowing 1:Many requests for a given customer.
\nNote: Payment Requests use the discard function when they are no longer needed
\nA Statement Request will overide the current balance for a customer every time it is called allowing only 1 request for a given customer.
\n","_postman_id":"e615fcc5-cb7d-49d1-98f8-3057a6d64aa0"},{"name":"Forms","item":[{"name":"Create Form For Customer","id":"ccb8eecc-3635-4780-af69-bbe1c08d5560","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Api-Key","value":"{{ApigeeApiKey}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"},{"key":"Location-As-Navigable-Url","value":"true","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"_embedded\": {\r\n\t\t\"form_type\": {\r\n\t\t\t\"form_type_identifier\": \"{{formTypeIdentifier}}\"\r\n\t\t},\r\n\t\t\"customer\": {\r\n\t\t\t\"id\": \"{{customerId}}\"\r\n\t\t}\r\n\t}\r\n}"},"url":"{{baseUrl}}/customer_experience/action/createForm","description":"With a Customer in place, your next step is to generate a Form Request. Forms are requested using the form_type_identifier that has been assigned to your system. Please reach out to the Integrataion team to organise the forms required for your system.
\nNew Form Request: Issue a POST request to the createFormRequest endpoint for a given customer ID. Upon success, a response will be returned containing the ID of the created Form Request. Your Customer will be automatically sent a communication with the new form request immediately.
\nLimitations and Guidelines
\nThis endpoint allows you to set defaults for a given location's form. This allows for certain customization by indiviudal location for any given form type ID.
\nSet form label(title) and/or data defaults for a form type.
\n","urlObject":{"path":["customer_experience","action","setFormDefaults"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"1cff66a8-d38c-4fb5-bbf9-decfcae6b4b4","name":"200 Created with form label","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-GP-Api-Key","value":"{{ApigeeApiKey}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"form_label\": {\r\n \"EN\": \"Custom Title\"\r\n },\r\n\t\"_embedded\": {\r\n\t\t\"form_type\": {\r\n\t\t\t\"form_type_identifier\": \"postmanExampleForm\"\r\n\t\t}\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/setFormDefaults"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"{{formId}}\", \n \"form_label\": {\n \"EN\": \"Custom Title\"\n },\n\t\"_embedded\": {\n\t\t\"form_type\": {\n\t\t\t\"form_type_identifier\": \"postmanExampleForm\"\n\t\t}\n\t}\n}"},{"id":"857eeb50-3b6a-4f26-a3cd-82fb3390c07d","name":"200 Created with Form Element Data","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-GP-Api-Key","value":"{{ApigeeApiKey}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"form_element_data\": [\r\n\t\t{\r\n\t\t\t\"id\": \"testKey\",\r\n\t\t\t\"value\": \"ServiceLocationDefaultMarkdown\"\r\n\t\t}\r\n\t],\r\n\t\"_embedded\": {\r\n\t\t\"form_type\": {\r\n\t\t\t\"form_type_identifier\": \"postmanExampleForm\"\r\n\t\t}\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/setFormDefaults"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"{{formId}}\",\n\t\"form_element_data\": [\n\t\t{\n\t\t\t\"id\": \"testKey\",\n\t\t\t\"value\": \"ServiceLocatioNDefaultMarkdown\"\n\t\t}\n\t],\n\t\"_embedded\": {\n\t\t\"form_type\": {\n\t\t\t\"form_type_identifier\": \"postmanExampleForm\"\n\t\t}\n\t}\n}"},{"id":"6b4218e0-4b68-4be5-99d1-bc50138d68ad","name":"200 OK Change Form Title","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-GP-Api-Key","value":"{{ApigeeApiKey}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"form_label\": {\r\n \"EN\": \"Custom Title\"\r\n },\r\n\t\"form_element_data\": [\r\n\t\t{\r\n\t\t\t\"id\": \"testKey\",\r\n\t\t\t\"value\": \"ServiceLocationDefaultMarkdown\"\r\n\t\t}\r\n\t],\r\n\t\"_embedded\": {\r\n\t\t\"form_type\": {\r\n\t\t\t\"form_type_identifier\": \"postmanExampleForm\"\r\n\t\t}\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/setFormDefaults"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"form_element_data\": [\n\t\t{\n\t\t\t\"id\": \"testKey\",\n\t\t\t\"value\": \"ServiceLocatioNDefaultMarkdown\"\n\t\t}\n\t],\n\t\"_embedded\": {\n\t\t\"form_type\": {\n\t\t\t\"form_type_identifier\": \"postmanExampleForm\"\n\t\t}\n\t}\n}"},{"id":"046d6725-015a-4858-b568-57dbf3a1e3f1","name":"404 Form Type Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Api-Key","value":"{{ApigeeApiKey}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"form_element_data\": [\r\n\t\t{\r\n\t\t\t\"id\": \"testKey\",\r\n\t\t\t\"value\": \"ServiceLocationDefaultMarkdown\"\r\n\t\t}\r\n\t],\r\n\t\"_embedded\": {\r\n\t\t\"form_type\": {\r\n\t\t\t\"form_type_identifier\": \"doesntExist\"\r\n\t\t}\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/setFormDefaults"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"message\": \"Couldn't find formtype for doesntExist\"\n}"}],"_postman_id":"9e47a0f7-eee9-4bda-8cdb-1678455e2cf0"},{"name":"Discard Form Request","id":"455b771b-4ae2-4fb7-a862-eb1b20bd5b7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"AuthToken {{AuthToken}}"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{formRequestId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/discard","description":"This endpoint allows you to remove an existing form request from a customer's list of form requests.
\n","urlObject":{"path":["customer_experience","action","discard"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"5865613c-bfff-4f38-adda-751dd6ca3cdc","name":"Discard Form Request / OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"AuthToken {{AuthToken}}"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{formRequestId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/discard"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"7b4b9e23-3717-448a-b9bb-f572cdd6aead","name":"Discard Payment Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"AuthToken {{AuthToken}}"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{formRequestId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/discard"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Object not found\"\n}"}],"_postman_id":"455b771b-4ae2-4fb7-a862-eb1b20bd5b7a"}],"id":"5efa9e00-31d3-4275-9caf-79610330cf52","_postman_id":"5efa9e00-31d3-4275-9caf-79610330cf52","description":""},{"name":"Events","item":[{"name":"Add an Event","id":"842e3c90-bc17-4d20-8eac-2c76f3ea2994","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"}],"body":{"mode":"raw","raw":"{\n \"description\": \"Pet check up\",\n \"start_date_time\": \"2020-02-24T16:00:00.000Z\",\n \"duration\": 30,\n \"_embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/event","description":"Add an Event
\n","urlObject":{"path":["customer_experience","event"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"a6d71f47-71b2-41ff-a023-36a9c3dc561b","name":"201 Add an Event","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"}],"body":{"mode":"raw","raw":"{\n \"description\": \"Pet check up\",\n \"start_date_time\": \"2020-02-24T16:00:00.000Z\",\n \"duration\": 30,\n \"_embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/event"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"{{eventId}}\",\n \"description\": \"Pet check up\",\n \"start_date_time\": \"2020-02-24T16:00:00.000Z\",\n \"duration\": 30,\n \"_embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n }\n}"},{"id":"ce4676c2-ec0b-49bf-b094-d01ff2285448","name":"201 Add an Event with myMetadata","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"}],"body":{"mode":"raw","raw":"{\n \"description\": \"Pet check up\",\n \"start_date_time\": \"2020-02-24T16:00:00.000Z\",\n \"duration\": 30,\n \"myMetadata\": {\n \"externalId\": \"{{eventExternalId}}\",\n \"data\": {\n \"reason\": \"yearly checkup\"\n }\n },\n \"_embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/event"},"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"{{eventId}}\",\n \"description\": \"Pet check up\",\n \"start_date_time\": \"2020-02-24T16:00:00.000Z\",\n \"duration\": 30,\n \"myMetadata\": {\n \"externalId\": \"{{eventExternalId}}\",\n \"data\": {\n \"reason\": \"yearly checkup\"\n }\n },\n \"_embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n }\n}"}],"_postman_id":"842e3c90-bc17-4d20-8eac-2c76f3ea2994"},{"name":"Update an Event","id":"97ee576d-61ef-4f3f-bf9d-b77fa5906ca4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"}],"body":{"mode":"raw","raw":"{\n \"description\": \"Pet check up\",\n \"start_date_time\": \"2020-02-24T16:00:00.000Z\",\n \"duration\": 30,\n \"embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/event/{{eventId}}","description":"Update an Event
\n","urlObject":{"path":["customer_experience","event","{{eventId}}"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"bede9b59-e1e2-4a55-9c80-37ec06895570","name":"200 Update an Event","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"}],"body":{"mode":"raw","raw":"{\n \"description\": \"Pet check up\",\n \"start_date_time\": \"2020-02-24T16:00:00.000Z\",\n \"duration\": 30,\n \"_embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/event/{{eventId}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"{{eventId}}\",\n \"description\": \"Pet check up\",\n \"start_date_time\": \"2020-02-24T16:00:00.000Z\",\n \"duration\": 30,\n \"_embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n }\n}"},{"id":"8fa07a31-f735-4ea6-8fba-7ad446963f7a","name":"200 Update an Event with myMetadata","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"}],"body":{"mode":"raw","raw":"{\n \"description\": \"Pet check up\",\n \"start_date_time\": \"2020-02-24T16:00:00.000Z\",\n \"duration\": 30,\n \"myMetadata\": {\n \"externalId\": \"{{eventExternalId}}\",\n \"data\": {\n \"reason\": \"yearly checkup\"\n }\n },\n \"_embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/event/{{eventId}}"},"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"{{eventId}}\",\n \"description\": \"Pet check up\",\n \"start_date_time\": \"2020-02-24T16:00:00.000Z\",\n \"duration\": 30,\n \"myMetadata\": {\n \"externalId\": \"{{eventExternalId}}\",\n \"data\": {\n \"reason\": \"yearly checkup\"\n }\n },\n \"_embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n }\n}"}],"_postman_id":"97ee576d-61ef-4f3f-bf9d-b77fa5906ca4"},{"name":"Delete an Event","id":"54311f51-7262-4b4f-aa94-3cb04d74071f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"}],"body":{"mode":"raw","raw":""},"url":"{{baseUrl}}/customer_experience/event/{{eventId}}","description":"Delete an event
\n","urlObject":{"path":["customer_experience","event","{{eventId}}"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"2557898e-d7f0-4a39-ba54-681272502eac","name":"200 Delete an Event","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}"},{"key":"X-GP-Version","value":"{{X-GP-Version}}"},{"key":"Authorization","value":"AuthToken {{AuthToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/event/{{eventId}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"54311f51-7262-4b4f-aa94-3cb04d74071f"}],"id":"d8433f18-f08d-473e-a6af-d95e2a7d4b8c","description":"The Events API is a secure and reliable platform for storing customer events such as appointments, and providing merchants with access to the stored information in other CX products such as Callpop and Merchant Success Hub. This API allows partner software to seamlessly synchronize with their system, providing up-to-date event information and enabling efficient and effective management of customer events.
\n","_postman_id":"d8433f18-f08d-473e-a6af-d95e2a7d4b8c"},{"name":"Check In","item":[{"name":"Ask To Check In","id":"9695c3f6-d721-48a7-ae62-f8567d03d95e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"},{"key":"Location-As-Navigable-Url","value":"true","description":"If set to true, the response will have the \"Location-As-Navigable-Url-As-TinyLink\" header. The value will be a TinyLink URL that can be used to link to the statement.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"_embedded\": {\r\n \"customer\":{\r\n \"id\": \"{{customerId}}\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/askToCheckIn","description":"Generate a link for a customer to check in. Requires the service location to be configured to push or pull the check in response.
\n","urlObject":{"path":["customer_experience","action","askToCheckIn"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"70470cec-c366-48da-90d5-d1424fab2053","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"},{"key":"Location-As-Navigable-Url","value":"true","description":"If set to true, the response will have the \"Location-As-Navigable-Url-As-TinyLink\" header. The value will be a TinyLink URL that can be used to link to the statement.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"_embedded\": {\r\n \"customer\":{\r\n \"id\": \"{{customerId}}\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/askToCheckIn"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"_embedded\": {\n \"customer\": {\n \"id\": \"{{customerId}}\"\n }\n }\n}"},{"id":"5cec6e79-adaf-4965-9c06-98d45d8b62d1","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-GP-Api-Key","value":"{{X-GP-Api-Key}}","type":"text"},{"key":"X-GP-Version","value":"{{X-GP-Version}}","type":"text"},{"key":"Authorization","value":"AuthToken {{AuthToken}}","type":"text"},{"key":"Location-As-Navigable-Url","value":"true","description":"If set to true, the response will have the \"Location-As-Navigable-Url-As-TinyLink\" header. The value will be a TinyLink URL that can be used to link to the statement.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"_embedded\": {\r\n \"customer\":{\r\n \"id\": \"{{customerId}}\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/customer_experience/action/askToCheckIn"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"9695c3f6-d721-48a7-ae62-f8567d03d95e"}],"id":"8294301e-bcec-4311-935f-decbe1415c2a","_postman_id":"8294301e-bcec-4311-935f-decbe1415c2a","description":""}],"event":[{"listen":"prerequest","script":{"id":"43dd48a6-c7af-4fae-ba96-e88665ef2d4a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9e55f871-cf4e-4bd4-b94a-e8fa6bf322ed","type":"text/javascript","exec":[""]}}]}