{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3f7e8180-26d8-4195-a02f-2abaa84906a4","name":"Payment API Collection 1.0","description":"# Introduction\n---\n\nTo get a foreseeable and resource-oriented function call we have implemented our API with REST. All response objects will be delivered as JSON objects.\n\nFor an easy switch from test to live mode the gateway supports test keys and live keys. The test key works in the exact same way as the live key, but doesn't do live credit card transactions. You can always use the test key even if you have activated the live key for your staging server.\n\n# Content Type\n---\n\nThe request format, which is required for operations with a request body. The syntax is:\n\n```\nContent-Type: application/json\n```\n\n## Pagination\n---\n\n| Parameter        | Type           | Description  |\n| ------------- | :---------------- | :----- |\n| pageIndex      | integer | The pageIndex number indicating which set of items will be returned in the response. So, the combination of pageIndex=1 and pageSize=20 returns the first 20 items. The combination of pageIndex=2 and pageSize=20 returns items 21 through 40 |\n| pageSize      | integer | The number of items to return in the response. |\n\n## Query string filtering\n---\n\n| Parameter        | Type           | Description  |\n| ------------- | :---------------- | :----- |\n| dateFrom      | DateTime | From DateTime UTC parameter. |\n| dateTo      | DateTime | To DateTime UTC parameter. |\n\n# Authentication\n\n---\n\nAuthentication to the API occurs via HTTP Basic Auth. \nPass the credentials as a Base64-encoded header or as parameters in an HTTP client.\n\nThe credentials must be Base64-encoded. The following is an example of an encoded HTTP Basic Authentication header:\n\n```\nAuthorization: Basic dGVzdF9yNnIxNGl6c3JlYms2c255b3kxajZoYnpqejF4Ym8w\n```\nThe credentials are defined per websites. To get your credentials:\n1. Log in to your Merchant portal.\n2. Go to Developer settings > Website settings > API Keys.\n3. Select the website for your integration.\n4. On the modal copy API key value, set and copy API secret value for sandbox and live mode (if available).\n\n# Error Codes\n\n# Errors\n---\n\nThe conventional HTTP response codes are used 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 the gateway's servers (these are rare).\n\n| Parameter        | Type           | Description  |\n| ------------- |:------------- | :----- |\n| errorType      | string | The type of error returned. |\n| code      | string      |   Error code. |\n| parameter      | string      |   If the error is parameter-specific, the parameter related to the error. |\n| message      | string      |   A human-readable message providing more details about the error.  |\n\n```json\n{\n  \"errors\": [\n    {\n      \"errorType\": \"invalidRequest\",\n      \"code\": \"validationError\",\n      \"parameter\": \"Amount\",\n      \"message\": \"Amount must be greater than 0\"\n    }\n  ]\n}\n```\n\n## HTTP status codes\n---\n\n* 2xx indicates a successful request\n* 4xx informs you about an error\n* 5xx tells you that we did something wrong\n\n| Code        | Meaning           | Description  |\n| ------------- | -------------| ----- |\n| 200      | OK | Everything worked as expected. |\n| 201      | Created | The requested resource is successfuly created. |\n| 400      | Bad Request | The request was unacceptable, often due to missing a required parameter. |\n| 401      | Unauthorized | No valid API key provided. |\n| 404      | Not Found | The requested resource doesn't exist. |\n| 5xx      | Server Error | Something went wrong on the gateway side. |\n\n\n## Error types\n---\n\n| Type | Description |\n| ---- | ------- |\n| invalidRequest | Invalid request errors arise when your request has invalid parameters |\n| paymentError | Error related to payment proccess. The most common type of error |\n| authentication_error | Failure to properly authenticate yourself in the request. |\n| api_error | API errors cover any other type of problem (e.g., a temporary problem with the gateway's servers), and are extremely uncommon |\n\n## Error codes\n---\n\n| Code | Message |\n| ---- | ------- |\n| invalidTransactionStatus | Invalid transaction status. |\n| invalidTransactionType | Invalid transaction type. |\n| invalidPaymentMethod | Invalid payment method. |\n| invalidPaymentChannel | Invalid payment channel. |\n| invalidCvc | Invalid or not provided CVC parameter. |\n| invalidRefundAmount | Refund amount needs to be less or equal to available refund amount. |\n| declinedByAcquirer | Declined by acquirer. |\n| amountTooLarge | The specified amount is greater than the maximum amount allowed. |\n| amountTooSmall | The specified amount is less than the minimum amount allowed. |\n| maxVolumeExceeded | Max volume exceeded. |\n| restrictionByPid | Restriction by Payment ID. |\n| restrictionByEmail | Restriction by email. |\n| blacklisted | Transaction blacklisted. |\n| invalidPaymentSource | Invalid Payment Source. |\n| invalidBillingAddressCountry | Invalid Billing AddressCountry. |\n| invalidCurrency | Invalid Currency. |\n| declinedByBank | Common decline by bank. |\n| declinedByThreeDSecure | Declined by 3D Secure. |\n| authorizationFailure | Authorization failure. |\n| authorizationToTheChannelFailure | Authorization to the channel failure. |\n| channelConnectionError | Channel connection error. |\n| channelInvalidRefundRequest | Channel error, invalid refund request. |\n| threeDSecureCardNotEnrolled | The requested card is not 3D Secure enrolled. |\n| threeDSecureEnrolmentError | 3D Secure Enrolment Error. |\n| threeDSecureAuthenticationError | 3D Secure Authentication Error. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"20832549","team":4103913,"collectionId":"3f7e8180-26d8-4195-a02f-2abaa84906a4","publishedId":"Uyxbr9o5","public":true,"publicUrl":"https://documenter-api.postman.tech/view/20832549/Uyxbr9o5","privateUrl":"https://go.postman.co/documentation/20832549-3f7e8180-26d8-4195-a02f-2abaa84906a4","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-05-05T12:15:56.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"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/bcf95e48a8775999b0cb8d77e235c9ca27f0d19fb14e4785d263c81d4214f60d","favicon":""},"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"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/Uyxbr9o5"}