{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"9602359c-7111-4ec5-b0df-5803ccb9f469","name":"Digicel API Reference","description":"This documentation provides REST based API's for rapid application integration to customize and manage merchant accounts accepting credit/debit cards for goods and services.\n\n\\> These API specifications are intended for Developers who want to implement the REST API within their own applications.\n\n# Getting Started\n\nGet in contact with a SoftPoint representative to get your API Keys and the API Sandbox environment URL.\n\nWhen you are ready to move to production we will review your application and provide a production APP Key, Client Key and URL to start processing live requests.\n\n_The orchestration platform is certified as a Level 1 - PCI Service Provider. All communication between your application and the API servers are SSL-encrypted._\n\n> If you store or process cardholder data with your application, you must ensure that your application meets the Payment Card Industry Data Security Standard (PCI DSS) requirements. Depending on transaction volume, you may be required to have your application audited by a Qualified Security Assessor (QSA). \n  \n\n### Account Keys\n\nAll endpoints require the following merchant keys to be sent in the HEADERS:\n\n``` bash\ndigicel-app-key: [provided by SoftPoint]\ndigicel-client-key: [provided by SoftPoint]\n\n ```\n\n# Test Card Numbers\n\nYou can use the following card numbers in the `cardnumber` parameter in for testing transactions.\n\n| processor | card brand | card number | cvv | exp | supports 3DS |\n| --- | --- | --- | --- | --- | --- |\n| Ding | AMEX | 370000000000002 | 7373 | 03/30 | No |\n| Ding | MASTERCARD | 5454545454545454 | 737 | 03/30 | No |\n| Ding | VISA | 4000000000000002 | 737 | 03/30 | No |\n| Banks/Ding | AMEX | 340000000001 098 | Any | Any | Yes |\n| Banks | AMEX | Any | Any | Any | No |\n| Banks/Ding | MASTERCARD | 520000000000 3092 | Any | Any | Yes |\n| Banks/Ding | MASTERCARD | 5200000000001096 | Any | Any | Yes |\n| Banks | MASTERCARD | 512X342233150747 | Any | Any | No |\n| Banks | MASTERCARD | 512X343287499758 | Any | Any | No |\n| Banks | MASTERCARD | 51203501XXX64594 | Any | Any | No |\n| Banks/Ding | VISA | 4000000000003139 | Any | Any | Yes |\n| Banks/Ding | VISA | 4000000000001091 | Any | Any | Yes |\n| Banks | VISA | 489537998XXXX580 | 518 | 12/23 | No |\n| Banks | VISA | 489537998XXXX572 | 841 | 12/23 | No |\n| Banks | VISA | 489537998XXXX564 | 011 | 12/23 | No |\n| Banks | VISA | 4000000000002164 | Any | Any | No. Use this card to receive actual 3ds rejections. |\n\n# Response Codes\n\nThe following response status codes are specific to the these API Requests.\n\n| Status | Code | Description |\n| --- | --- | --- |\n| SUCCESS | 00 | The transaction has been accepted and approved by the host processor |\n| PENDING | 01 | Call issuer for authorization |\n| DECLINED | 02 | The transaction has been accepted but declined by the host processor |\n| DECLINED | 03 | Request formatting error. Typically this error is received when missing required parameter values. The transaction was not passed to the host processor. |\n| DECLINED | 04 | Confiscate card (no fraud assumed) |\n| DECLINED | 05 | Do not honor card |\n| DECLINED | 06 | A duplicate `digicel-idempotent-key` header value was detected. The transaction was not passed to the host processor. |\n| DECLINED | 07 | The card passed for a level 3 transaction is not qualified. The transaction was not passed to the host processor. |\n| PENDING | 08 | Valid ID required for transaction |\n| DECLINED | 09 | Non-specified Error. You can try the transaction again |\n| DECLINED | 10 | Approved for lesser amount |\n| DECLINED | 11 | Invalid Account format |\n| DECLINED | 12 | Transaction type not permitted for this account |\n| DECLINED | 13 | Invalid transaction amount |\n| DECLINED | 14 | Account number or length error. |\n| DECLINED | 15 | Invalid issuer. |\n| DECLINED | 17 | Cardholder requested a cancellation on recurring charges |\n| DECLINED | 18 | Customer dispute |\n| DECLINED | 19 | Bad transaction data or setup, re-enter |\n| DECLINED | 20 | Void no longer possible, issue a refund |\n| DECLINED | 21 | Invalid refund transaction, issue a void |\n| DECLINED | 22 | Violation |\n| DECLINED | 24 | PIN tries exceeded |\n| DECLINED | 30 | Date error. Check format or value is a future date |\n| DECLINED | 31 | Card type not accepted by host / switch |\n| DECLINED | 34 | Confiscate card (fraud assumed) |\n| DECLINED | 40 | Requested function not supported |\n| DECLINED | 41 | Confiscate card (reported lost) |\n| DECLINED | 43 | Confiscate card (reported stoled) |\n| DECLINED | 44 | Try lesser amount |\n| DECLINED | 51 | Insufficient funds |\n| DECLINED | 54 | Credit/Debit card expired |\n| DECLINED | 55 | Bad Debit/ EBT pin info |\n| DECLINED | 56 | Invalid Address |\n| DECLINED | 57 | Card not permitted for this transaction type |\n| DECLINED | 59 | Card billing zip code is required for keyed in transactions |\n| DECLINED | 60 | Invalid Zip/Postal code |\n| DECLINED | 61 | Exceeds withdrawal limit |\n| DECLINED | 62 | Invalid service code |\n| DECLINED | 63 | Security violation |\n| DECLINED | 65 | Exceeds activity limit |\n| DECLINED | 70 | Terminal does not support card type |\n| DECLINED | 72 | Account closed |\n| DECLINED | 73 | Capture already processed |\n| DECLINED | 74 | Refund / Void already processed |\n| DECLINED | 76 | Record not found |\n| DECLINED | 77 | Invalid parameters |\n| DECLINED | 81 | Encryption Error (usually debit/ebt) |\n| DECLINED | 82 | CVV incorrect |\n| DECLINED | 84 | 3DS data incorrect |\n| DECLINED | 89 | Bad merchant ID |\n| DECLINED | 94 | Duplicate batch number |\n| DECLINED | 96 | System error |\n| DECLINED | 97 | CVV2 / CID error |\n| DECLINED | 99 | Void not accepted |\n| DECLINED | N3 | Cash back services unavailable (VISA) |\n| DECLINED | N4 | Too much cash back (VISA) |\n| DECLINED | N7 | CVV2 mismatch (VISA) |\n\n# Error Response format\n\n``` json\n{\n        \"status\": \"<string>\",\n        \"code\": \"<string>\",\n        \"message\": \"<string>\"\n} \n\n ```\n\n# Special Declined cases\n\n### BankDeclined\n\nThis error message is returned by Ding.\n\nOn Ding Production environment, it means that the request was declined by the bank. Ding api response does not return the actual reason but these are some known instances: CVV failure, Credit floor, Do Not Honor, Lost/Stolen.\n\nOn Ding Sandbox environment, it means that one of the test processors rejected the transaction, usually because such processor only supports a limited number of test cards. Whe this occurs, the workaround is this:\n\n- Use one of these cards: 5200 0000 0000 1096 or 4000 0000 0000 1091\n    \n- Always use zip code 00001 (this is the code Ding uses to force approved responses)\n    \n- Try the transaction more than once in case the declined case still persists (due to hitting the same test processor)\n    \n\n# Support\n\nContact Support: [support@softpointcloud.com](https://mailto:support@softpointcloud.com)  \nName: SoftPoint","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"24046901","team":2903371,"collectionId":"9602359c-7111-4ec5-b0df-5803ccb9f469","publishedId":"2sAXxWYTsn","public":true,"publicUrl":"https://doc.gateway.softpoint.io","privateUrl":"https://go.postman.co/documentation/24046901-9602359c-7111-4ec5-b0df-5803ccb9f469","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0E4478"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/a5118245-501c-4fa1-9286-157bb27a4dff/bG9nby1zLWxpZ2h0LW9yaWdpbmFsLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"0E4478"}},{"name":"light","logo":"https://content.pstmn.io/efdec250-3b92-41e4-a466-bc461dc4556c/c3BfbG9nb19ibGFjay5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0E4478"}}]}},"version":"8.10.1","publishDate":"2024-11-30T01:21:40.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/efdec250-3b92-41e4-a466-bc461dc4556c/c3BfbG9nb19ibGFjay5wbmc=","logoDark":"https://content.pstmn.io/a5118245-501c-4fa1-9286-157bb27a4dff/bG9nby1zLWxpZ2h0LW9yaWdpbmFsLnBuZw=="}},"statusCode":200},"environments":[{"name":"Sandbox","id":"60f68bfc-c05a-42b0-8cbc-7c34f198ddae","owner":"24046901","values":[{"key":"baseUrl","value":"https://sandbox-sit-api-gtw.softpoint.io/digicel/v1","enabled":true,"type":"default"},{"key":"client_key","value":"4000011","enabled":true,"type":"default"},{"key":"api_key","value":"085911da0abeae93f80ca1d3a1b4604c","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/545c9e11f2695c674686855fcb473d40eb918281a66708135c4b460b683d2809","favicon":"https://softpoint.io/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Sandbox","value":"24046901-60f68bfc-c05a-42b0-8cbc-7c34f198ddae"}],"canonicalUrl":"https://doc.gateway.softpoint.io/view/metadata/2sAXxWYTsn"}