![\"Example](\"https://paycafe-postman.s3-us-west-2.amazonaws.com/images/checkoutFormOnly2.png\")
Welcome to the PayCafe API documentation. If you have any questions about the API, please contact support@paycafe.com.
\nThe PayCafe API is organized around REST. Our API has resource-oriented endpoint URLs, accepts form-encoded requests, returns JSON-encoded responses, and uses standard HTTPS response codes and authentication.
\nOur API offers endpoints to create customers, request customer data, process payments, and process refunds. If you have a unique case or need additional API support, please contact support@paycafe.com
\nA PayCafe API token and SSL certificate are required for all requests. Please contact PayCafe to request your API token.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication / Security","slug":"authentication-security"}],"owner":"8822521","collectionId":"cb0b29ec-ad10-4b93-b174-cd890243f765","publishedId":"SzYbxcLX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0090FA"},"publishDate":"2020-04-07T21:18:26.000Z"},"item":[{"name":"Getting Started","item":[{"name":"Accepting Credit Card Data (QuickStart)","item":[],"id":"8b8d3831-2b59-41ce-b99e-a6d8869c092a","description":"This guide is meant to get you up and running with a working credit card field on your existing checkout in as few steps as possible. It is absolutely not intended to be a production implementation and may not be compatible with more complicated setups.
\n\n\nFor a more detailed documentation, please click here
\n
The following is a high-level overview of this process:
\nThis guide will assume that you have an existing checkout form into you wish to integrate PayCafe payment processing into.\nFor this example let's assume a typical example checkout form :
\n\n\n\n
Step 1. Add the following JavaScript between the <head></head> tags of your checkout page:
<script type=\"text/javascript\" src=\"js/jquery-3.4.1.min.js\"></script>\n <script type=\"text/javascript\">\n // Error handling for any errors reported by PayCafe\n function parentError(params){\n console.log('parentError function called');\n console.log(params);\n if(params.error_code === 'invalid_card' || params.error_code === 'invalid_card_num'){\n alert('Invalid Card!');\n }\n if(params.error_code === 'invalid_customer'){\n if(params.emailAddress !== false){\n $('#email_address').addClass('invalid');\n }\n if(params.firstName !== false){\n $('#first_name').addClass('invalid');\n }\n if(params.lastName !== false){\n $('#last_name').addClass('invalid');\n }\n if(params.billingAddress.line1 !== false){\n $('#address1').addClass('invalid');\n }\n if(params.billingAddress.city !== false){\n $('#city').addClass('invalid');\n }\n if(params.billingAddress.state !== false){\n $('#state').addClass('invalid');\n }\n if(params.billingAddress.country !== false){\n $('#country').addClass('invalid');\n }\n if(params.billingAddress.postal_code !== false){\n $('#postal_code').addClass('invalid');\n }\n if(params.billingAddress.phone_number !== false){\n $('#phone_number').addClass('invalid');\n }\n }\n if(params.error_code === 'invalid_address'){\n $('#email_address').addClass('invalid');\n $('#first_name').addClass('invalid');\n $('#last_name').addClass('invalid');\n $('#address1').addClass('invalid');\n $('#city').addClass('invalid');\n $('#state').addClass('invalid');\n $('#country').addClass('invalid');\n $('#postal_code').addClass('invalid');\n $('#phone_number').addClass('invalid');\n }\n }\n // Function to collect customer information from the checkout form, send it to the iFrame, and then send it to PayCafe for processing.\n // UPDATE YOUR FORM VALUES HERE\n $(document).ready(function(){\n $('#purchase').click(function(){\n var customerData = {\n 'emailAddress' : $('#email_address').val(),\n 'firstName' : $('#first_name').val(),\n 'lastName' : $('#last_name').val(),\n 'billingAddress' : {\n 'line1' : $('#address1').val(),\n 'line2' : $('#address2').val(),\n 'city' : $('#city').val(),\n 'state' : $('#state').val(),\n 'country' : $('#country').val(),\n 'postal_code' : $('#postal_code').val(),\n 'phone_number' : $('#phone_number').val()\n }\n }\n PayCafe.saveData(\n customerData,\n function(tokens){\n submitForm(tokens);\n console.log(tokens);\n console.log('success callback called');\n },\n function(errors){\n parentError(errors);\n console.log('fail callback called');\n }\n );\n });\n });\n // Success function - this function is executed when PayCafe returns a successful customer and credit card token.\n // If you wish to use AJAX or similar method to store the customer and credit card tokens, you would add that function(s) within the \"submitForm\" function\n function submitForm(params){\n //Store customer token function - optional\n //Store credit card token function - optional\n console.log('submitForm function');\n console.log(params);\n $('#customerToken').val(params.customerToken);\n $('#cardToken').val(params.cardToken);\n $('#purchaseForm').submit();\n }\n </script>\nStep 2: Add the following JavaScript where you would like the credit card fields to appear :
\n <script type=\"text/javascript\" src=\"https://api.paycafe.com/static/js/PayCafeV1.js\"></script>\n <script type=\"text/javascript\">var PayCafe = PayCafeInit('merchantPublicToken', 'api.paycafe.com'); </script>\n\n Be sure to replace ***merchantPublicToken*** with your token\n\n You should now have a credit card field on your checkout page:\n >\n >\nStep 3: Modify the values in the function immediately following '// UPDATE YOUR FORM VALUES HERE' to match the values of the 'id' of all required fields from your form:
\n // UPDATE YOUR FORM VALUES HERE\n $(document).ready(function(){\n $('#purchase').click(function(){\n var customerData = {\n 'emailAddress' : $('#email_address').val(),\n 'firstName' : $('#first_name').val(),\n 'lastName' : $('#last_name').val(),\n 'billingAddress' : {\n 'line1' : $('#address1').val(),\n 'line2' : $('#address2').val(),\n 'city' : $('#city').val(),\n 'state' : $('#state').val(),\n 'country' : $('#country').val(),\n 'postal_code' : $('#postal_code').val(),\n 'phone_number' : $('#phone_number').val()\n }\n }\nEx. Lets say your email address field is\n\n\n ```<div class=\"input-field col s6\">\n <input placeholder=\"\" id=\"email\" name=\"email_address\" type=\"text\" class=\"validate\">\n <label for=\"email_address\">Email Address</label>\n </div>```\n\n You would change\n\n ```'emailAddress': $('#email_address').val(),```\n\nto\n\n ```'emailAddress': $('#email').val(),```\n\nDo this for all fields listed in that function\nStep 4: Replace #purchase with the 'id' of your submit button.
Ex. Lets say your form begins with\n\n <form method=\"POST\" action=\"card.php\" id=\"myCheckout\">\n\nYou would change\n\n $('#purchase').click(function(){\n\nto\n\n $('#myCheckout').click(function(){\nThe following function brings it all together:
\nPayCafe.saveData(\n customerData,\n function(tokens) {\n submitForm(tokens);\n console.log(tokens);\n console.log('< Success Callback Function>');\n },\n function(errors) {\n parentError(errors);\n console.log(' < Failure Callback Function > ');\n });\n
\nsubmitForm and parentError are the callback functions that will handle successful and failed responses respectively, in our example. You would replace these two with functions with your own custom logic to meet your needs.
PayCafe.saveData will pass the customer information from your form to the iFrame, and along with the credit card\ndata, both are sent to PayCafe for processing. Once PayCafe processes the submitted data, a response\nwill be passed to the provided success ( submitForm) or failure ( parentError) functions.
If the processing of the data was successful, PayCafe will respond with an object containing a customer token and a credit card token:
\n {\n error : false,\n customerToken : ‘ads835hja9f00h35025dfa62346hjk’,\n cardToken : ‘j0asdf8h4w5ig03h408hg0haw4’\n }\nand assign it to the variable tokens and pass it to submitForm.
You will have access to the customer and credit card token within the submitForm function. You will need to store these tokens within this function or through a server-side function once the checkout form is submitted.
\n\nPayCafe strongly advises storing the customer and credit card tokens as they can be used not only for recurring payments, but for other API calls like processing refunds.
\n
Once your checkout form is submitted, you will need to call the PayCafe API /charge endpoint\nwith the required variables.\nYou can find documentation on our /charge endpoint in our\nPayCafe API reference.
This guide will outline the first part of integrating PayCafe credit card processing into your checkout using the PCI-compliant iframe. By allowing for the credit card details to be submitted within the PayCafe iframe instead of your checkout form, you will be able to integrate payment processing quickly while adhering to PCI compliance rules and regulations.
\n/charge/create endpoint.This guide will assume that you have an existing checkout form into which you wish to integrate PayCafe payment processing. Your existing checkout form will need to collect the following customer details:
\n\n\n\n
In order to complete a credit card sale transaction, you will need a customer token and a credit card token. To create a customer and credit card token, you will need to include our JavaScript on your checkout form which will create an iframe that accepts card number, expiration date, and CVV. You will then pass customer and credit card details to our JavaScript function, which will submit those details, to PayCafe. Once PayCafe receives the details, our API will process the request and respond with the customer token and credit card token. Those tokens must be saved and then used to process the payment using the /charge/create endpoint.
Place the following JavaScript on your checkout form where you would like the credit card fields to appear. You may also choose to style the credit card iframe to match the styling of your checkout form. For details and examples, please see Styling credit card iframe section.
\n<script type=\"text/javascript\" src=\"https://api.paycafe.com/static/js/PayCafeV1.js\"></script>\n<script type=\"text/javascript\">var PayCafe = PayCafeInit('merchantPublicToken', 'api.paycafe.com'); </script>\n\n\nMake sure to replace merchantPublicToken with the token you received from PayCafe when your merchant account was setup. If you are a PayCafe Authorized Partner, you would have received the merchantPublicToken during the Merchant Boarding process (
\n/merchant/create). If you are a PayCafe merchant and do not have this information, please contact support. If you are a PayCafe Authorized Partner, you may choose to execute the/merchant/statusmethod in order to get the proper tokens.
Once added, the fields for credit card input will load in an iframe on your checkout:
\n![\"Example](\"https://paycafe-postman.s3-us-west-2.amazonaws.com/images/checkoutFormiframe2.png\")
The JavaScript loaded on your checkout form in the previous step will handle interaction with our API.
\nOn your end you will need to:
\nsaveData function. This is the step that will use the customer details, along with the credit card details in the credit card iframe and submit them to the PayCafe API. The PayCafe API will respond with the customer and card tokens or errors (if any).If PayCafe responds succesfully:
\nIf PayCafe responds with an error:
\n/charge/create endpoint of the PayCafe API to complete the sale transaction. This function will need to be executed on the backend of your website/server to POST the proper details to the /charge/create endpoint. This endpoint will respond with either successful transaction details, decline message, or validation errors (e.g. invalid amount).The following is an example of how to integrate these steps into a checkout form.
\n\n\nTo download this complete example including a sample checkout form, click here
\n
The following are examples for Step 1 in the previous section.
\nTo save the customer data, you will need to provide all the customer data to PayCafe in the following structure:
\nvar customerData = {\n 'emailAddress': <string>,\n 'firstName': <string>,\n 'lastName': <string>,\n 'billingAddress': {\n 'line1': <string>,\n 'line2': <string>,\n 'city': <string>,\n 'state': <string>,\n 'country': <string>,\n 'postal_code': <string>,\n 'phone_number': <string>\n }\nHere is an jQuery example for populating the variables using the fields in your checkout form:
\n var customerData = {\n 'emailAddress': $('#email_address').val(),\n 'firstName': $('#first_name').val(),\n 'lastName': $('#last_name').val(),\n 'billingAddress': {\n 'line1': $('#address1').val(),\n 'line2': $('#address2').val(),\n 'city': $('#city').val(),\n 'state': $('#state').val(),\n 'country': $('#country').val(),\n 'postal_code': $('#postal_code').val(),\n 'phone_number': $('#phone_number').val()\n }\n\n\nMake sure the input name on your form matches the name in the function (ex.
\n#email_address) for its respective field.
Replace#purchasewith the 'id' of your checkout form submit button.
In order for these steps to occur seamlessly with your checkout, you will need to encapsulate this process in a function that is executed when your form is submitted:
\n $(document).ready(function(){\n $('#purchase').click(function() {\n var customerData = {\n 'emailAddress': $('#email_address').val(),\n 'firstName': $('#first_name').val(),\n 'lastName': $('#last_name').val(),\n 'billingAddress': {\n 'line1': $('#address1').val(),\n 'line2': $('#address2').val(),\n 'city': $('#city').val(),\n 'state': $('#state').val(),\n 'country': $('#country').val(),\n 'postal_code': $('#postal_code').val(),\n 'phone_number': $('#phone_number').val()\n }\n }\n PayCafe.saveData(\n customerData,\n function(tokens) {\n submitForm(tokens);\n console.log(tokens);\n console.log('< Success Callback Function>');\n },\n function(errors) {\n parentError(errors);\n console.log(' < Failure Callback Function > ');\n });\n });\n });\nThe JavaScript will have access to the customer and credit card token within the submitForm function. You can store these tokens within this function or through a server-side function once the checkout form is submitted.
PayCafe strongly advises storing the customer and credit card tokens as they can be used not only for recurring payments, but for other API calls like processing refunds.
\nThe following are a continuation of examples for Step 1 in the previous section.
\nThis step is an example of how to submit customer and credit card details to PayCafe. Once PayCafe receives the data, it will respond with the customer and card token, or errors (if any).
\nYou can now execute the PayCafe.saveData function and pass it the form data.
PayCafe.saveData(\n customerData,\n function(tokens) {\n submitForm(tokens); // Success Function\n console.log(tokens);\n console.log('< Success Callback Function>');\n },\n function(errors) {\n parentError(errors); // Failure Function\n console.log(' < Failure Callback Function > ');\n });\n\n\n\n
submitFormandparentErrorare the JavaScript callback functions that will handle successful and failed responses respectively, in our example. You would replace these two with functions with your own custom logic to meet your needs.
The following are examples for Step 2 in the previous section.
\nPayCafe.saveData will pass the customer information from your form to the iframe, and along with the credit card data, both are sent to PayCafe for processing. Once PayCafe processes the submitted data, a response will be passed to the provided success (submitForm) or failure (parentError) function.
If PayCafe responds with a successful result, it will include the customer and card tokens. The success function will excute. In the example, the success function is called submitForm. You will need to modify this function to support saving the response tokens.
Here is an example of a success callback function. This function will submit the checkout form\nwith the customer and credit card tokens.
\n function submitForm(params){\n console.log('submitForm function');\n $('#customerToken').val(params.customerToken);\n $('#cardToken').val(params.cardToken);\n $('#purchaseForm').submit();\n }\n\n\nIn this example
\n#purchaseFormis theidof the checkout form. Make sure this matches theidof your checkout form.
This is a successful response example:
\n {\n error : false,\n customerToken : ‘ads835hja9f00h35025dfa62346hjk’,\n cardToken : ‘j0asdf8h4w5ig03h408hg0haw4’\n }\nThis response will be assigned to the variable tokens and will be passed it to submitForm function.
If PayCafe responds with a failure result, it will include the applicable error message(s). The failure function will execute. In the example, the failure function is called parentError. You will need to create/modify the function to manage the errors appropriately.
Here is an example of a failure callback function. This function will accept the response errors\nand respond to the Internet browser with the details. Please consult your developer to integrate\nthe error responses with your checkout process.
\nfunction parentError(params){\n console.log('parentError function called');\n if(params.error_code === 'invalid_card' || params.error_code ===\n 'invalid_card_num'){\n alert('Invalid Card!');\n }\n if(params.error_code === 'invalid_customer'){\n if(params.emailAddress !== false){\n $('#email_address').addClass('invalid');\n }\n if(params.firstName !== false){\n $('#first_name').addClass('invalid');\n }\n if(params.lastName !== false){\n $('#last_name').addClass('invalid');\n }\n if(params.billingAddress.line1 !== false){\n $('#address1').addClass('invalid');\n }\n if(params.billingAddress.city !== false){\n $('#city').addClass('invalid');\n }\n if(params.billingAddress.state !== false){\n $('#state').addClass('invalid');\n }\n if(params.billingAddress.country !== false){\n $('#country').addClass('invalid');\n }\n if(params.billingAddress.postal_code !== false){\n $('#postal_code').addClass('invalid');\n }\n if(params.billingAddress.phone_number !== false){\n $('#phone_number').addClass('invalid');\n }\n }\n if(params.error_code === 'invalid_address'){\n $('#email_address').addClass('invalid');\n $('#first_name').addClass('invalid');\n $('#last_name').addClass('invalid');\n $('#address1').addClass('invalid');\n $('#city').addClass('invalid');\n $('#state').addClass('invalid');\n $('#country').addClass('invalid');\n $('#postal_code').addClass('invalid');\n $('#phone_number').addClass('invalid');\n }\n}\nIf validation failed, PayCafe will respond with an object containing more information regarding the failure. This is a failure response example:
\n error : true,\n error_code : 'invalid_customer',\n emailAddress : true, // true = invalid email, false = valid email\n firstName : true, // true = invalid first name, false = valid first\n namelastName : true, // true = invalid first name, false = valid first name\n billingAddress.line1 : true, // true = invalid billing address line 1\n billingAddress.line2 : true, // true = invalid billing address line 2\n billingAddress.city : true, // true = invalid city\n billingAddress.state : true, // true = invalid state\n billingAddress.postal_code : true, // true = invalid postal code\n billingAddress.country : true, // true = invalid country\n billingAddress.phone_number : true, // true = invalid phone number\n shippingAddress.line1 : true, // true = invalid shipping address line 1\n shippingAddress.line2 : true, // true = invalid shipping address line 2\n shippingAddress.city : true, // true = invalid city\n shippingAddress.state : true, // true = invalid state\n shippingAddress.postal_code : true, // true = invalid postal code \n shippingAddress.country : true, // true = invalid country\n shippingAddress.phone_number : true // true = invalid phone number\n }\nThis response will be assigned to the variable errors and will be passed to the parentError function.
Once your checkout form is submitted and you have received the customerToken and cardToken, you will use the tokens to execute the PayCafe API /charge/create endpoint in order to attempt the credit card transaction.
When you execute the /charge/create endpoint, PayCafe will respond with a success or failure message. The success repsonse indicates that the transaction was processed successfully. A failure response indicates that the transaction was declined. In addition, the failure response provides the reason for the decline. For example, a decline reason may be 'insufficent funds'.
You can find documentation on our /charge/create endpoint.
If you wish to place the PayCafe Credit Card iFrame JavaScript within the <head> section and display the iframe in a different location, rather than having the JavaScript in-line with your HTML you will use the advanced features.
The following code section will be placed within the <head> section of your HTML page. You will need to make sure to populate the merchantPublicToken that is associated with your PayCafe merchatn account and assign a div name located within the Card.Mount call.
<script type=\"text/javascript\" src=\"https://api.paycafe.com/v1/js/PayCafe.js\"></script>\n<script type=\"text/javascript\">\n \n var styles = {\n cardNumberContainer : '',\n cardNumber : '',\n expMonthContainer : '',\n expMonth : '',\n expYearContainer : '',\n expYear : '',\n cvvContainer : '',\n cvv : ''\n }\n \n var Card = PayCafe('merchantPublicToken');\n Card.mount('div-name-here', {styles: styles});\n</script>\nOnce you have placed the proper javascript within the <head> section, you will need to place a <div> whereever you would like the iframe to be displayed. The name of the <div> must match the defined name within the javascript.
<div name='div-name-here'></div>\nHere is an exmaple of the advanced version of the credit card iframe.
\n<html>\n<head>\n\n<script type=\"text/javascript\" src=\"https://api.paycafe.com/v1/js/PayCafe.js\"></script>\n<script type=\"text/javascript\">\nvar styles = {\n cardNumberContainer : 'width: 30%; margin-left:auto; left:auto; right:auto; float:left; padding:.5em;',\n cardNumber : 'background-color: transparent; border: none; border-bottom: 1px solid #9e9e9e; border-radius: 0; outline: none; height: 3rem; width: 100%; font-size: 16px; margin: 0 0 8px 0; padding: 0; -webkit-box-shadow: none; box-shadow: none; -webkit-box-sizing: content-box; box-sizing: content-box; -webkit-transition: border .3s, -webkit-box-shadow .3s; transition: border .3s, -webkit-box-shadow .3s; transition: box-shadow .3s, border .3s; transition: box-shadow .3s, border .3s, -webkit-box-shadow .3s;',\n expMonthContainer : 'width: 15%; margin-left:auto; left:auto; right:auto; float:left; padding:.5em;',\n expMonth : 'background-color: transparent; border: none; border-bottom: 1px solid #9e9e9e; border-radius: 0; outline: none; height: 3rem; width: 100%; font-size: 16px; margin: 0 0 8px 0; padding: 0; -webkit-box-shadow: none; box-shadow: none; -webkit-box-sizing: content-box; box-sizing: content-box; -webkit-transition: border .3s, -webkit-box-shadow .3s; transition: border .3s, -webkit-box-shadow .3s; transition: box-shadow .3s, border .3s; transition: box-shadow .3s, border .3s, -webkit-box-shadow .3s;',\n expYearContainer : 'width: 15%; margin-left:auto; left:auto; right:auto; float:left; padding:.5em;',\n expYear : 'background-color: transparent; border: none; border-bottom: 1px solid #9e9e9e; border-radius: 0; outline: none; height: 3rem; width: 100%; font-size: 16px; margin: 0 0 8px 0; padding: 0; -webkit-box-shadow: none; box-shadow: none; -webkit-box-sizing: content-box; box-sizing: content-box; -webkit-transition: border .3s, -webkit-box-shadow .3s; transition: border .3s, -webkit-box-shadow .3s; transition: box-shadow .3s, border .3s; transition: box-shadow .3s, border .3s, -webkit-box-shadow .3s;',\n cvvContainer : 'width: 10%; margin-left:auto; left:auto; right:auto; float:left; padding:.5em;',\n cvv : 'background-color: transparent; border: none; border-bottom: 1px solid #9e9e9e; border-radius: 0; outline: none; height: 3rem; width: 100%; font-size: 16px; margin: 0 0 8px 0; padding: 0; -webkit-box-shadow: none; box-shadow: none; -webkit-box-sizing: content-box; box-sizing: content-box; -webkit-transition: border .3s, -webkit-box-shadow .3s; transition: border .3s, -webkit-box-shadow .3s; transition: box-shadow .3s, border .3s; transition: box-shadow .3s, border .3s, -webkit-box-shadow .3s;'\n }\n\n var Card = PayCafe('merchantPublicToken');\n Card.mount('PayCafe-CardFrame', {styles: styles});\n</head>\n\n<body>\n\n...\n\n<div name=\"PayCafe-CardFrame\"></div>\n\n...\n\n\n</body>\n</html>\nDuring integration of the PayCafe API it is recommended to test everything thoroughly. The PayCafe API offers a sandbox mode. The sandbox mode allows a developer to use the credit card iframe in a development environment without the requirement of SSL encryption. When using the sandbox mode, real credit card transactions will be blocked.
\nIn order to activate the sandbox mode, simply append _test to the merchantPublicToken when adding the credit card iframe to your checkout page.
Example:\nBelow is an example of the credit card iframe with the appended _test to the merchantPublicToken.
<script type=\"text/javascript\" src=\"https://api.paycafe.com/static/js/PayCafeV1.js\"></script>\n<script type=\"text/javascript\">var PayCafe = PayCafeInit('6plXSDF0sdfaSDfi234lG0fylVB2DtFhyiqTCbLQMCx1DhpgpaFMBFj81li_test', 'api.paycafe.com'); </script>\n \nThis is a list of test credit cards that will duplicate common scenarios.
\nUse this card to simulate a real credit card transaction.
\nCard Number: 9999999912341234\nExpiration Month: 12\nExpiration Year: 2032\nSecurity Code / CVV:321\nUse this card to simulate a response of a banned credit card.
\nCard Number: 9999999956781234\nExpiration Month: 12\nExpiration Year: 2032\nSecurity Code / CVV:456\nUse this card to simulate a merchant that has reached their processing limit.
\nCard Number: 9999999912345678\nExpiration Month: 12\nExpiration Year: 2032\nSecurity Code / CVV: 789\nCard Number: 9999999988888888\nSecurity Code / CVV: 999\nExpiration Month: 12\nExpiration Year: 2032\nUse this card to simulate a general declined transaction.
\nCard Number: 9999999943218765\nExpiration Month: 12\nExpiration Year: 2032\nSecurity Code / CVV: 999\nUse this card to simulate a declined transaction due to insufficient funds
\nCard Number: 9999999956781233\nSecurity Code / CVV: 999\nExpiration Month 12\nExpiration Year: 2032\nUse this card to simulate a declined transaction due to \"AVS\". This is caused by the customer address entered does not match the details of the credit card.
\nCard Number: 9999999987654321\nSecurity Code / CVV: 999\nExpiration Month: 12\nExpiration Year: 2032\nUse this card to simulate a transaction to a merchant that is currently not active.
\nCard Number: 9999999977777777\nSecurity Code / CVV: 999\nExpiration Month: 12\nExpiration Year: 2032\nThe PayCafe Card Data iframe is designed to accept standard CSS3 styling. We have defined named elements that can styled. The style variables must be placed within the <Script></Script> tags.
var payCafeStyles = {\n cardNumberContainer : '',\n cardNumber : '',\n expMonthContainer : '',\n expMonth : '',\n expYearContainer : '',\n expYear : '',\n cvvContainer : '',\n cvv : '',\n body : ''\n}\nBelow is an example of the iFrame with styles applied.
\n<script type=\"text/javascript\" src=\"https://api.paycafe.com/static/js/PayCafeV1.js\"></script>\n<script type=\"text/javascript\">\n\nvar payCafeStyles = {\n cardNumberContainer : 'width: 30%; margin-left:auto; left:auto; right:auto; float:left; padding:.5em;',\n cardNumber : 'background-color: transparent; border: none; border-bottom: 1px solid #9e9e9e; border-radius: 0; outline: none; height: 3rem; width: 100%; font-size: 16px; margin: 0 0 8px 0; padding: 0; -webkit-box-shadow: none; box-shadow: none; -webkit-box-sizing: content-box; box-sizing: content-box; -webkit-transition: border .3s, -webkit-box-shadow .3s; transition: border .3s, -webkit-box-shadow .3s; transition: box-shadow .3s, border .3s; transition: box-shadow .3s, border .3s, -webkit-box-shadow .3s;',\n expMonthContainer : 'width: 15%; margin-left:auto; left:auto; right:auto; float:left; padding:.5em;',\n expMonth : 'background-color: transparent; border: none; border-bottom: 1px solid #9e9e9e; border-radius: 0; outline: none; height: 3rem; width: 100%; font-size: 16px; margin: 0 0 8px 0; padding: 0; -webkit-box-shadow: none; box-shadow: none; -webkit-box-sizing: content-box; box-sizing: content-box; -webkit-transition: border .3s, -webkit-box-shadow .3s; transition: border .3s, -webkit-box-shadow .3s; transition: box-shadow .3s, border .3s; transition: box-shadow .3s, border .3s, -webkit-box-shadow .3s;',\n expYearContainer : 'width: 15%; margin-left:auto; left:auto; right:auto; float:left; padding:.5em;',\n expYear : 'background-color: transparent; border: none; border-bottom: 1px solid #9e9e9e; border-radius: 0; outline: none; height: 3rem; width: 100%; font-size: 16px; margin: 0 0 8px 0; padding: 0; -webkit-box-shadow: none; box-shadow: none; -webkit-box-sizing: content-box; box-sizing: content-box; -webkit-transition: border .3s, -webkit-box-shadow .3s; transition: border .3s, -webkit-box-shadow .3s; transition: box-shadow .3s, border .3s; transition: box-shadow .3s, border .3s, -webkit-box-shadow .3s;',\n cvvContainer : 'width: 10%; margin-left:auto; left:auto; right:auto; float:left; padding:.5em;',\n cvv : 'background-color: transparent; border: none; border-bottom: 1px solid #9e9e9e; border-radius: 0; outline: none; height: 3rem; width: 100%; font-size: 16px; margin: 0 0 8px 0; padding: 0; -webkit-box-shadow: none; box-shadow: none; -webkit-box-sizing: content-box; box-sizing: content-box; -webkit-transition: border .3s, -webkit-box-shadow .3s; transition: border .3s, -webkit-box-shadow .3s; transition: box-shadow .3s, border .3s; transition: box-shadow .3s, border .3s, -webkit-box-shadow .3s;',\n body: 'background-color:#000;'\n }\n\nvar PayCafe = PayCafeInit('merchantPublicToken', 'api.paycafe.com');</script>\nThe PayCafe API offers multiple ways to integrate credit card payments into your website.
\nThis guide will outline the boarding of merchants. This functionality is exclusive for PayCafe Authorized Partners. If you are interested in becoming a PayCafe Authorized Partner, please contact sales@paycafe.com.
\nTo successfully initiate boarding of a merchant using our API you will need:
\nThese details will be supplied to you by the PayCafe integration department.
\nAs a PayCafe Authorized Partner, you will have the ability to start the boarding process for new merchants using our merchant endpoint.
\nPlease note that all merchants must still go through the normal underwriting and review process
\nThe following steps describe the partner-initiated merchant boarding process:
\nIn order to start the merchant boarding process, the partner will make an API call to the /merchant/create endpoint.
Below are the parameters that you will need to supply in the initial API request:
\nBelow is an example of a typical response following a successful merchant creation API request. You will store the ‘merchantToken’ and 'merchantPublicToken' values to use later for activation and payment functions.
\n {\n \"responseStatus\": \"success\",\n \"merchantData\": {\n \"status\": \"new\",\n \"merchantToken\": \"Mm8gca0ugebR3rDMFZ4VbKXNvX0BjM8zIRWz69HybLqfA1g3ZVpwMc96jhTX\",\n \"merchantPublicToken\": \"nyzHwdWnroVaGBByvJJmypweEKalrF4HIMDFKS04m39TkQk1h3vkx2J5o5gv\",\n \"signupURL\": \"http://< PayCafe URL >/merchant/public/link_existing/C3c6Nkz0siCImYVwASdwEO8QyUYrA6V2qWzksx3igag1VmDm0PyD6A4nux2\"\n }\n }\nAn existing merchant is a merchant signed up with PayCafe directly and/or prior to the partner relationship. The merchant may wish to use their already-established PayCafe account with the partner. In this case, the merchant will simply be linked to the partner account and the status of the merchant will be reflected by 'status'.
\nIf a merchant previously signed up for PayCafe outside of the partner signup process, you will receive the following response:
\n {\n \"responseStatus\": \"success\",\n \"merchantData\": {\n \"status\": \"demo\",\n \"info\": \"existing merchant\",\n \"merchantToken\": \"Mm8gca0ugebR3rDMFZ4VbKXNvX0BjM8zIRWz69HybLqfA1g3ZVpwMc96jhTX\",\n \"merchantPublicToken\": \"nyzHwdWnroVaGBByvJJmypweEKalrF4HIMDFKS04m39TkQk1h3vkx2J5o5gv\",\n \"signupURL\": \"http://< PayCafe URL >/merchant/public/link_existing/C3c6Nkz0siCImYVwASdwEO8QyUYrA6V2qWzksx3igag1VmDm0PyD6AF4nux2\"\n }\n }\n\n\nThe Partner will receive the
\nmerchantTokenandmerchantPublicTokento be used for payment processing.
The partner will need to store the following details:
\nThis is a list of the different status values for merchants. When new merchants start the activation process, they will be in 'demo' status.
\nTo offer PayCafe Partners a seamless solution, we provide the ability to send merchant status updates to our partners. By utilizing this feature, partners will enjoy a seamless merchant boarding process wherein merchants sign up, get activated, and start to use partners' services with minimal or no human interaction.
\nA Partner can provide PayCafe with an endpoint to receive notification whenever a merchant's account changes status. For example, PayCafe would make an API call to the partner notification endpoint after underwriting is completed and the merchant is activated.
\nIn order to provide a secure exchange of information we require the endpoint to be over SSL and to accept the following data :
\n {\n \"action\": \"status_change\",\n \"status\": \"active\",\n \"merchantPublicToken\": \"nyzHwdWnroVaGBByvJJmypweEKalrF4HIMDFKS04m39TkQk1h3vkx2J5o5gv\"\n } \nYou can then use the appropriate API tokens to call the /merchant/status endpoint for merchant status details.
PayCafe offers a partner program to companies that are looking for a customized payment solution to fit online merchants. If you are interested in finding out more, please contact sales@paycafe.com.
\nThis section documents API functionality exclusive to PayCafe Authorized Partners.
\n","event":[{"listen":"prerequest","script":{"id":"f8b5df05-ea32-4211-870d-490b9203a568","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3fa52039-f3f3-4222-a657-67dc6602df27","type":"text/javascript","exec":[""]}}],"_postman_id":"dd4a1d71-06c6-4ab0-984a-904630bbc01d"}],"id":"335277d8-5715-4356-95be-949ffa13717f","_postman_id":"335277d8-5715-4356-95be-949ffa13717f","description":""},{"name":"Customer","item":[{"name":"Create Customer Token","id":"c6dfb5d3-ed4c-4419-a4d9-624fd344559f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"merchantToken","value":"Required
\n"},{"key":"firstName","value":"Required
\n"},{"key":"lastName","value":"Required
\n"},{"key":"emailAddress","value":"Required
\n"},{"key":"billingAddress","value":"{\"line1\":\"Required
\nCustomer billing address in JSON format
If no value specified, default value is 'en-US'
\n"},{"key":"shippingAddress","value":"{\"line1\":\"Optional
\nCustomer shipping address in JSON format
The /customer/create object allows you to create a new customer to be used for future billing functionality.
Required
\n"},{"key":"emailAddress","value":"Required
\n"}]},"url":"https://api.paycafe.com/v1/customer/getToken","description":"The /customer/getToken object allows you to retrieve the customer token from a customer account previously created using the /customer/create object.
Required
\n"},{"key":"customerToken","value":"Required
\n"}]},"url":"https://api.paycafe.com/v1/customer/getDetails","description":"The /customer/getDetails object allows you to retrieve the customer details from a customer account previously created using the /customer/create object.
Required
\n"},{"key":"cardNumber","value":"Required
\n"},{"key":"expMonth","value":"Required
\nRequired
\n"},{"key":"customerToken","value":"Required
\n"}]},"url":"https://api.paycafe.com/v1/customer/saveCard","description":"The /customer/saveCard object allows you to save payment (credit card) details to a customer account previously created using the /customer/create object.
In order to use this action, you are required to be PCI-compliant. For details, please visit the PCI Security Standards Council website at https://www.pcisecuritystandards.org/. If you would like to assess your own payment security, please take the PCI Self Assessment Test at https://www.pcisecuritystandards.org/pci_security/completing_self_assessment.
\nIf you prefer to have PayCafe manage your credit card compliance, you may choose to use our credit card iFrame. For details, please contact PayCafe support at support@paycafe.com.
\n","urlObject":{"protocol":"https","path":["v1","customer","saveCard"],"host":["api","paycafe","com"],"query":[],"variable":[]}},"response":[{"id":"7ef20cad-85a9-4a69-8996-292c5aa321f6","name":"Success Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"description":{"content":"","type":"text/plain"},"key":"merchantToken","value":"Customer objects allow you to perform customer related functions. The API allows you to create new customers, get customer token(s), get customer details, and save credit card details to your customers. You can retrieve individual customers as well.
\n","event":[{"listen":"prerequest","script":{"id":"eebd150d-321b-426a-8816-f314b1d803df","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a7587368-12cc-42ba-ba7e-b0dc81a76890","type":"text/javascript","exec":[""]}}],"_postman_id":"7b58b211-31ea-4058-890d-a46b44450f40"},{"name":"Charge","item":[{"name":"Create Charge","id":"65629efa-5c60-408a-b9a5-ad7501c6cfb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"merchantToken","value":"Required
\n"},{"key":"cardToken","value":"Required
\n"},{"key":"customerToken","value":"Required
\n"},{"key":"amount","value":"Required
\nRequired
\nRequired
\nOptional
\nOptional
\nOptional
\nTo charge a credit or a debit card, you create a /charge/create object. Charges are identified by a unique, random ID, named the trans_id parameter.
If you plan to send credit card details in this action, you are required to be PCI-compliant. For details, please visit the PCI Security Standards Council website at https://www.pcisecuritystandards.org/. If you would like to assess your own payment security, please take the PCI Self Assessment Test at https://www.pcisecuritystandards.org/pci_security/completing_self_assessment.
\nIf you prefer to have PayCafe manage your credit card compliance, you may choose to use our credit card iFrame. For details, please contact PayCafe support at support@paycafe.com.
\n","urlObject":{"protocol":"https","path":["v1","charge","create"],"host":["api","paycafe","com"],"query":[],"variable":[]}},"response":[{"id":"12f4ebbd-6ffe-4569-9e48-916e5b09b929","name":"Success Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"description":{"content":"","type":"text/plain"},"key":"merchantToken","value":"Required
\n"},{"key":"cardToken","value":"Required
\n"},{"key":"amount","value":"Required
\nRequired
\n"},{"key":"transactionID","value":"Required
\n"}]},"url":"https://api.paycafe.com/v1/charge/refund","description":"To submit a refund to a credit or a debit card, you create a /charge/refund object. Charges are identified by a unique, random ID, named the trans_id parameter. Partial refunds are optional.
To charge a credit or a debit card, you create a Charge object. You can retrieve and refund individual charges as well as list all charges. Charges are identified by a unique, random ID, named the trans_id parameter.
Required
\nRequired\nRequired
\nRequired
\nRequired
\nRequired
\nRequired
\nOptional
\n","type":"text"},{"key":"completeURL","value":"Optional
\n","type":"text"}]},"url":"https://api.paycafe.com/v1/merchant/create","description":"As a PayCafe authorized partner, you may use the /merchant/create to create new merchants. The new merchants will be stored with the reference to the partner which created them.
Required
\n"},{"key":"merchantToken","value":"Optional
\nAs a PayCafe authorized partner, you may use the /merchant/status to view the status of any merchant you created.
If you are an authorized PayCafe partner, you may use the /merchant objects to create new merchants and interact with existing merchants. The new merchants will be stored with the reference to the partner which created them.
If you are interested in becoming a PayCafe Authorized Partner, please contact sales@paycafe.com.
\n","event":[{"listen":"prerequest","script":{"id":"3eb147b3-0b66-4823-b929-537190569b4a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"169da011-f9bd-4185-8264-a80c821411ad","type":"text/javascript","exec":[""]}}],"_postman_id":"7abf1536-9556-47e2-abeb-66794baa1e70"},{"name":"Transactions","item":[{"name":"Get Transaction Details","id":"454dd76c-21a9-48d9-a228-7ca71abb400e","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"merchantToken","value":"Required
\n"},{"key":"transactionID","value":"Required
\n"},{"key":"customerToken","value":"Required
\n"},{"key":"cardToken","value":"Required
\n"}]},"url":"https://api.paycafe.com/v1/transaction/getByID","description":"The /transaction/getByID object will allow you to retrieve details on an existing transaction.
To interact or retrieve details on an existing transaction use the /transaction object.
Error responses that apply to all PayCafe API objects.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_merchant_token\",\n \"message\": \"Invalid Merchant Token\",\n \"sub_code\": \"\"\n}\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_customer_token\",\n \"message\": \"Invalid Customer Token\",\n \"sub_code\": \"\"\n}\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_partner_token\",\n \"message\": \"Invalid Partner Token\",\n \"sub_code\": \"\"\n}\nThe error responses in this section are related to /customer object requests.
Possible error responses for /customer/create object requests.
This error response will indicate that one or more required parameters have not been supplied or are incomplete.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"missing_field\",\n \"message\": \"Missing required field\",\n \"sub_code\": [\n {\n \"fieldName\": \"emailAddress\",\n \"message\": \"The email address field is required.\"\n },\n {\n \"fieldName\": \"firstName\",\n \"message\": \"The first name field is required.\"\n },\n {\n \"fieldName\": \"lastName\",\n \"message\": \"The last name field is required.\"\n },\n {\n \"fieldName\": \"billingAddress\",\n \"message\": \"The billing address field is required.\"\n }\n ]\n}\nYou will receive this reponse when the information provided is not valid.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_details\",\n \"message\": \"Invalid Details\",\n \"sub_code\": [\n {\n \"fieldName\": \"emailAddress\",\n \"message\": \"The email address must be a valid email address.\"\n },\n {\n \"fieldName\": \"firstName\",\n \"message\": \"The first name format is invalid.\"\n },\n {\n \"fieldName\": \"lastName\",\n \"message\": \"The last name format is invalid.\"\n }\n ]\n}\nYou will use the sub_code JSON element to determine which address is invalid.
{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_address\",\n \"message\": \"Invalid Address\",\n \"sub_code\": [\n {\n \"fieldName\": \"billing_phone_number\",\n \"message\": \"The phone number format is invalid.\"\n },\n {\n \"fieldName\": \"billing_line1\",\n \"message\": \"The line1 format is invalid.\"\n },\n {\n \"fieldName\": \"billing_city\",\n \"message\": \"The city format is invalid.\"\n },\n {\n \"fieldName\": \"billing_country\",\n \"message\": \"The country format is invalid.\"\n },\n {\n \"fieldName\": \"billing_state\",\n \"message\": \"The state format is invalid.\"\n },\n {\n \"fieldName\": \"billing_postal_code\",\n \"message\": \"The postal code format is invalid.\"\n }\n ]\n}\nThis could have happened due to continued abuse or other violations. These customers are permanently banned from processing any transactions for any PayCafe merchant.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"email_banned\",\n \"message\": \"Customer Email Has Been Banned\",\n \"sub_code\": \"\"\n}\nThe details provided are related to a customer that has submitted multiple credit card disputes that are considered by PayCafe as abuse of the chargeback system.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"email_has_chargeback\",\n \"message\": \"Customer has Chargeback\",\n \"sub_code\": \"\"\n}\nPossible error responses for /customer/getToken object requests.
This error response will indicate that one or more required parameters have not been supplied or are incomplete.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"missing_field\",\n \"message\": \"Missing required field\",\n \"sub_code\": [\n {\n \"fieldName\": \"emailAddress\",\n \"message\": \"The email address field is required.\"\n }\n ]\n}\nThe supplied parameters resulted in no customer records found. If if you feel this is an error, please contact PayCafe support.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"customer_not_found\",\n \"message\": \"Customer Not Found\",\n \"sub_code\": \"\"\n}\nPossible error responses for /customer/getDetails object requests.
The supplied customer token is invalid or malformed.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_customer_token\",\n \"message\": \"Invalid Customer Token\",\n \"sub_code\": \"\"\n}\nPossible error responses for /customer/saveCard object requests.
You will receive this error response if any required card details are missing.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_card_data\",\n \"message\": \"Invalid Card Data\",\n \"sub_code\": [\n {\n \"fieldName\": \"cardNumber\",\n \"message\": \"The card number must be between 12 and 19 digits.\"\n },\n {\n \"fieldName\": \"expYear\",\n \"message\": \"The exp year must be 4 digits.\"\n },\n {\n \"fieldName\": \"expMonth\",\n \"message\": \"The exp month must be 2 digits.\"\n },\n {\n \"fieldName\": \"cvv\",\n \"message\": \"The cvv must be between 3 and 4 digits.\"\n }\n ]\n}\nThis error response will indicate that one or more required parameters have not been supplied or are incomplete.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"missing_field\",\n \"message\": \"Missing required field\",\n \"sub_code\": [\n {\n \"fieldName\": \"cardNumber\",\n \"message\": \"The card number field is required.\"\n },\n {\n \"fieldName\": \"expYear\",\n \"message\": \"The exp year field is required.\"\n },\n {\n \"fieldName\": \"expMonth\",\n \"message\": \"The exp month field is required.\"\n },\n {\n \"fieldName\": \"cvv\",\n \"message\": \"The cvv field is required.\"\n }\n ]\n}\nThe supplied customer token is invalid or malformed.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_customer_token\",\n \"message\": \"Invalid Customer Token\",\n \"sub_code\": \"\"\n}\nYou will receive this response if the credit card being submitted has been permanently blocked by PayCafe.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"card_banned\",\n \"message\": \"Card Has Been Banned\",\n \"sub_code\": \"\"\n}\nThe error responses in this section are related to /charge object requests.
Possible error responses for /charge/create object requests.
The supplied card token supplied is invalid or malformed.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_card_token\",\n \"message\": \"Invalid Card Token\",\n \"sub_code\": \"\"\n}\nThe supplied charge amount is either malformed, contains currency symbols, or is not numeric.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_amount\",\n \"message\": \"Invalid Transaction Amount\",\n \"sub_code\": \"\"\n}\nThe supplied credit card has been blocked by our system for previous activities.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"card_blocked\",\n \"message\": \"Card Has Been Blocked\",\n \"sub_code\": \"\"\n}\nThis error response will indicate that one or more required parameters have not been supplied or incomplete.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"missing_field\",\n \"message\": \"Missing required field\",\n \"sub_code\": [\n {\n \"fieldName\": \"description\",\n \"message\": \"The description field is required.\"\n },\n {\n \"fieldName\": \"salesPageURL\",\n \"message\": \"The sales page URL is required.\"\n }.\n {\n \"fieldName\": \"cardToken\",\n \"message\": \"The cardToken is required.\"\n }.\n {\n \"fieldName\": \"customerToken\",\n \"message\": \"The customerToken is required.\"\n }.\n {\n \"fieldName\": \"amount\",\n \"message\": \"The amount is required.\"\n }\n ]\n}\nYou will recieve this error if the sale page URL was not supplied, malformed, or not accessible. This field requires a fully qualified URL that is accessible on the Internet. The standard structure for the sales page URL is http[s]://[domain-name].[extention]/[additional path]. For example, https://www.paycafe.com
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_sales_page_url\",\n \"message\": \"Sales Page URL required\",\n \"sub_code\": \"\"\n}\nThe supplied customer token is not associated credit card token.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"client_mismatch\",\n \"message\": \"Card Token Does Not Match Client\",\n \"sub_code\": \"\"\n}\nThe supplied credit card token is associated with a credit card that has expired.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"card_expired\",\n \"message\": \"Card Has Expired\",\n \"sub_code\": \"\"\n}\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"card_limit\",\n \"message\": \"Card Has Reached Limit\",\n \"sub_code\": \"\"\n}\nThe supplied credit card has been permantly blocked by PayCafe.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"card_banned\",\n \"message\": \"Card Has Been Banned\",\n \"sub_code\": \"\"\n}\nThe charge amount is greater than the maximum charge amount set for the merchant. If you wish to increase this limit, please contact risk@paycafe.com.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"max_ticket\",\n \"message\": \"Total Amount Exeeds Max Ticket Amount\",\n \"sub_code\": \"\"\n}\nThe merchant token is related to a merchant which is not currently active or no longer allowed process credit card payments using PayCafe services. If this merchant was previously active, you may contact PayCafe for a status update at risk@paycafe.com.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"merchant_not_active\",\n \"message\": \"Merchant Is not active\",\n \"sub_code\": \"\"\n}\nThe charge attempt was declined. You may use the sub_code JSON element to determine the specific reason for the decline. Important: The response below is showing a sample of what the response could be. The sub_code will respond with the sepcific decline reason. For example, a common decline reason is 'insufficent funds'.
{\n \"responseStatus\": \"error\",\n \"error_code\": \"charge_failed\",\n \"message\": \"Card Charge Failed\",\n \"sub_code\": {\n \"fieldName\": \"cvv\",\n \"message\": \"CVV2 No Match\"\n }\n}\nPossible error responses for /charge/refund object requests.
The supplied credit card token is invalid or malformed.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_card_token\",\n \"message\": \"Invalid Card Token\",\n \"sub_code\": \"\"\n}\nThe supplied customer token is invalid or malformed.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_customer_token\",\n \"message\": \"Invalid Customer Token\",\n \"sub_code\": \"\"\n}\nThe supplied refund amount is either malformed, contains currency symbols, or is not numeric.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_amount\",\n \"message\": \"Invalid Transaction Amount\",\n \"sub_code\": \"\"\n}\nThe supplied transaction ID is invalid or malformed.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_transaction\",\n \"message\": \"Could not find transaction\",\n \"sub_code\": \"\"\n}\nThe supplied refund amount is greater than the amount of the original transaction or greater than the remaining refund amount (if there was a previous partial refund).
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"refund_failed_amount\",\n \"message\": \"Refund Amount Can Not Be More Than The Purchase Amount\",\n \"sub_code\": \"\"\n}\nThe supplied customer token does not match the customer token assoicated with the original transaction.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"client_mismatch\",\n \"message\": \"Provided client does not match transaction\",\n \"sub_code\": \"\"\n}\nThe supplied credit card token does not match the credit card token associated with the original transaction.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"payment_mismatch\",\n \"message\": \"Provided payment method does not match transaction\",\n \"sub_code\": \"\"\n}\nThe refund was declined due to existing refunds for the transaction, chargebacks associated with the original transaction, or merchant is disabled.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"refund_failed\",\n \"message\": \"Refund Failed to Process\",\n \"sub_code\": \"\"\n}\nThe error responses in this section are related to /transaction object requests.
Possible error responses for /transaction/getByID object requests.
This error response will indicate that one or more required parameters have not been supplied or are incomplete.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"missing_field\",\n \"message\": \"Missing required field\",\n \"sub_code\": [\n {\n \"fieldName\": \"customerToken\",\n \"message\": \"The customer token field is required.\"\n },\n {\n \"fieldName\": \"cardToken\",\n \"message\": \"The card token field is required.\"\n },\n {\n \"fieldName\": \"transactionID\",\n \"message\": \"The transaction id field is required.\"\n }\n ]\n}\nThe supplied transaction ID could not be found or is invalid.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_transaction\",\n \"message\": \"Could not find transaction\",\n \"sub_code\": \"\"\n}\nThe error responses in this section are related to /merchant object requests.
Possible error responses for /merchant/create object requests.
The supplied partner token is invalid or malformed.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_merchant_token\",\n \"message\": \"Invalid Merchant Token\",\n \"sub_code\": \"\"\n}\nThe details provided are invalid or malformed.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_details\",\n \"message\": \"Invalid Details\",\n \"sub_code\": [\n {\n \"fieldName\": \"emailAddress\",\n \"message\": \"Field: emailAddress is invalid\"\n },\n {\n \"fieldName\": \"partnerID\",\n \"message\": \"Field: partnerID is invalid\"\n },\n {\n \"fieldName\": \"firstName\",\n \"message\": \"Field: firstName is invalid\"\n },\n {\n \"fieldName\": \"lastName\",\n \"message\": \"Field: lastName is invalid\"\n }\n ]\n}\nThis error response will indicate that one or more required parameters have not been supplied or incomplete.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"missing_field\",\n \"message\": \"Missing required field\",\n \"sub_code\": [\n {\n \"fieldName\": \"emailAddress\",\n \"message\": \"The email address field is required.\"\n },\n {\n \"fieldName\": \"firstName\",\n \"message\": \"The first name field is required.\"\n },\n {\n \"fieldName\": \"lastName\",\n \"message\": \"The last name field is required.\"\n },\n {\n \"fieldName\": \"partnerID\",\n \"message\": \"Field: partnerID is required\"\n },\n {\n \"fieldName\": \"referralID\",\n \"message\": \"Field: referralID is required\"\n }\n ]\n}\nPossible error responses for /merchant/status object requests.
This reponse will indicate that the supplied partnerToken is invalid or malformed.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_partner_token\",\n \"message\": \"Invalid Partner Token\",\n \"sub_code\": \"\"\n}\nThe supplied merchantToken is invalid or malformed.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_merchant_token\",\n \"message\": \"Invalid Token\",\n \"sub_code\": \"\"\n}\nThe supplied merchantToken is invalid or malformed.
\n{\n \"responseStatus\": \"error\",\n \"error_code\": \"merchant_not_found\",\n \"message\": \"Merchant not found\",\n \"sub_code\": \"\"\n}\nYou will recieve this error if the URL supplied in the completeURL parameter is invalid, incomplete or missing (if the completeText parameter is supplied).
{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_complete_url\",\n \"message\": \"Invalid complete URL\",\n \"sub_code\": \"\"\n}\nYou will recieve this error if the text supplied in the completeText parameter is invalid, too short, or missing (if the completeURL parameter is supplied).
{\n \"responseStatus\": \"error\",\n \"error_code\": \"invalid_complete_text\",\n \"message\": \"Invalid complete text\",\n \"sub_code\": \"\"\n}\nPayCafe uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with PayCafe's servers or an internal issue (which is quite rare).
\nSome 4xx errors that could be handled programmatically (e.g., a card is declined) include an error code that briefly explains the error reported.
\nHTTP Status Code Summary
\nImportant Note: Error responses listed in this section will have a HTTP Status Code 400.
\n","event":[{"listen":"prerequest","script":{"id":"2601e9b8-b542-4242-bc18-b209a4661637","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"510edaed-1bd8-4f4f-8565-e837fed948d9","type":"text/javascript","exec":[""]}}],"_postman_id":"2df6bda4-2910-4976-abda-299e2a533c7a"}],"event":[{"listen":"prerequest","script":{"id":"b2be0e88-5777-4f8f-a74c-b5cfc01fdcf1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"629e566e-79bb-43e3-8f73-9cc4ca53084e","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.paycafe.com/v1"}]}