{"_id":"550885622b5ede2f0071ae14","sync_unique":"","user":"5476eb1df3736008009e9ced","body":"## Entry points\n\nThe Paynova API has two entry points, one for testing and one for our live production environment. You will receive the url's for these entry points together with your account information.\n\n## Protocol\n\nThe Paynova API uses HTTPS exclusively.\n\n## Content format\n\nWe officially support JSON and UTF-8 encoding for all requests and responses.\n\nIf you prefer XML, our API supports that, too, but we are unable to provide any integration support for integrations using XML.\n\n## Headers\n\nWe recommend that you send request and receive results as JSON, so make sure to include the appropriate headers in your request.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Accept: application/json\\nContent-Type: application/json\",\n      \"language\": \"http\",\n      \"name\": \"HTTP Headers\"\n    }\n  ]\n}\n[/block]","category":"5506aa4949bcc90d00d408bb","createdAt":"2015-03-17T19:49:54.183Z","hidden":false,"isReference":false,"link_url":"","type":"basic","parentDoc":null,"title":"Request basics","version":"54930e7c777ff221004a7e70","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"excerpt":"","next":{"description":"","pages":[]},"order":0,"slug":"request-basics","updates":[],"__v":7,"githubsync":"","link_external":false,"project":"54930e7c777ff221004a7e6d","childrenPages":[]}

Request basics


## Entry points The Paynova API has two entry points, one for testing and one for our live production environment. You will receive the url's for these entry points together with your account information. ## Protocol The Paynova API uses HTTPS exclusively. ## Content format We officially support JSON and UTF-8 encoding for all requests and responses. If you prefer XML, our API supports that, too, but we are unable to provide any integration support for integrations using XML. ## Headers We recommend that you send request and receive results as JSON, so make sure to include the appropriate headers in your request. [block:code] { "codes": [ { "code": "Accept: application/json\nContent-Type: application/json", "language": "http", "name": "HTTP Headers" } ] } [/block]
## Entry points The Paynova API has two entry points, one for testing and one for our live production environment. You will receive the url's for these entry points together with your account information. ## Protocol The Paynova API uses HTTPS exclusively. ## Content format We officially support JSON and UTF-8 encoding for all requests and responses. If you prefer XML, our API supports that, too, but we are unable to provide any integration support for integrations using XML. ## Headers We recommend that you send request and receive results as JSON, so make sure to include the appropriate headers in your request. [block:code] { "codes": [ { "code": "Accept: application/json\nContent-Type: application/json", "language": "http", "name": "HTTP Headers" } ] } [/block]
{"_id":"551163929f7c7619005f8506","sync_unique":"","__v":1,"createdAt":"2015-03-24T13:16:02.483Z","project":"54930e7c777ff221004a7e6d","order":1,"slug":"test-environment","user":"5476eb1df3736008009e9ced","excerpt":"","link_external":false,"parentDoc":null,"type":"basic","updates":[],"body":"Paynova provides a fully-functional test environment for integrating and testing our API.\n\nThe test environment is sandboxed and **no live transactions will be created,** so you can safely run tests before processing live transactions in our production environment.\n\nYou will receive test account credentials from Paynova merchant support when your account is set up.\n\nFor Invoice as a Service, you can use the test persons below in order to make purchases. Since our test environment is sandboxed and does not retrieve information about real people, It is not possible to make invoice purchases using real personal information.\n\n\nTest persons:\n```\n195005292627\n195006025810\n194001013756\n194001015124\n195006271273\n198001177990\n198401012177\n190510227689\n193001019938\n```\n\nSocial Security Numbers with C/O adress:\n```\n190510227689\n193001019938\n```","category":"5506aa4949bcc90d00d408bb","githubsync":"","link_url":"","next":{"description":"","pages":[]},"title":"Test environment","version":"54930e7c777ff221004a7e70","api":{"auth":"required","params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"hidden":false,"isReference":true,"childrenPages":[]}

Test environment


Paynova provides a fully-functional test environment for integrating and testing our API. The test environment is sandboxed and **no live transactions will be created,** so you can safely run tests before processing live transactions in our production environment. You will receive test account credentials from Paynova merchant support when your account is set up. For Invoice as a Service, you can use the test persons below in order to make purchases. Since our test environment is sandboxed and does not retrieve information about real people, It is not possible to make invoice purchases using real personal information. Test persons: ``` 195005292627 195006025810 194001013756 194001015124 195006271273 198001177990 198401012177 190510227689 193001019938 ``` Social Security Numbers with C/O adress: ``` 190510227689 193001019938 ```
Paynova provides a fully-functional test environment for integrating and testing our API. The test environment is sandboxed and **no live transactions will be created,** so you can safely run tests before processing live transactions in our production environment. You will receive test account credentials from Paynova merchant support when your account is set up. For Invoice as a Service, you can use the test persons below in order to make purchases. Since our test environment is sandboxed and does not retrieve information about real people, It is not possible to make invoice purchases using real personal information. Test persons: ``` 195005292627 195006025810 194001013756 194001015124 195006271273 198001177990 198401012177 190510227689 193001019938 ``` Social Security Numbers with C/O adress: ``` 190510227689 193001019938 ```
{"_id":"5506acae6ad8831900e208d5","hidden":false,"link_external":false,"slug":"http-status-codes","sync_unique":"","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":""},"category":"5506aa4949bcc90d00d408bb","isReference":false,"link_url":"","project":"54930e7c777ff221004a7e6d","type":"basic","updates":[],"body":"The Paynova API uses the following HTTP status codes.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`200`\",\n    \"h-0\": \"Code\",\n    \"h-1\": \"Status\",\n    \"1-0\": \"`201`\",\n    \"0-1\": \"`OK`\",\n    \"1-1\": \"`Created`\",\n    \"2-0\": \"`401`\",\n    \"3-0\": \"`404`\",\n    \"4-0\": \"`500`\",\n    \"4-1\": \"`Internal Server Error`\",\n    \"2-1\": \"`Unauthorized`\",\n    \"3-1\": \"`Not Found`\",\n    \"h-2\": \"Usage\",\n    \"0-2\": \"The request itself was understood by our system and was able to be processed.\\n\\n**Note:** The HTTP code says nothing about the actual **outcome** of the request. This information is returned in the response body.\",\n    \"1-2\": \"Something has been created in Paynova's system (e.g. an `order`)\",\n    \"2-2\": \"You forgot to provide your credentials or they are not valid.\",\n    \"3-2\": \"The url you are trying to access is not a valid RESTful resource.\",\n    \"4-2\": \"Your request is malformed and our API does not understand how to process it\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\"\n}\n[/block]\n## Error handling\n\nWhen an API request results in an error, Paynova typically responds with HTTP status code `200 OK` and a response body with a JSON object containing `isSuccess: false`, an `errorNumber` and `errorMessage`.\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"STATUS 200 OK\\n\\n{\\n    \\\"status\\\": {\\n        \\\"isSuccess\\\": false,\\n        \\\"errorNumber\\\": 3000,\\n        \\\"statusKey\\\": \\\"ORDER_NOT_FOUND\\\",\\n        \\\"statusMessage\\\": \\\"The specified order was not found.\\\",\\n        \\\"errors\\\": null,\\n        \\\"exceptionDetails\\\": null\\n    },\\n    \\\"orderId\\\": null,\\n    \\\"transactionId\\\": null,\\n    \\\"acquirerId\\\": 0,\\n    \\\"acquirerReferenceId\\\": null\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nHowever, if your API request is malformed Paynova will return HTTP status code `500 Internal Server Error`.","createdAt":"2015-03-16T10:13:02.496Z","excerpt":"","githubsync":"","next":{"description":"","pages":[]},"parentDoc":null,"title":"HTTP status codes","__v":17,"order":2,"user":"5476eb1df3736008009e9ced","version":"54930e7c777ff221004a7e70","childrenPages":[]}

HTTP status codes


The Paynova API uses the following HTTP status codes. [block:parameters] { "data": { "0-0": "`200`", "h-0": "Code", "h-1": "Status", "1-0": "`201`", "0-1": "`OK`", "1-1": "`Created`", "2-0": "`401`", "3-0": "`404`", "4-0": "`500`", "4-1": "`Internal Server Error`", "2-1": "`Unauthorized`", "3-1": "`Not Found`", "h-2": "Usage", "0-2": "The request itself was understood by our system and was able to be processed.\n\n**Note:** The HTTP code says nothing about the actual **outcome** of the request. This information is returned in the response body.", "1-2": "Something has been created in Paynova's system (e.g. an `order`)", "2-2": "You forgot to provide your credentials or they are not valid.", "3-2": "The url you are trying to access is not a valid RESTful resource.", "4-2": "Your request is malformed and our API does not understand how to process it" }, "cols": 3, "rows": 5 } [/block] [block:textarea] { "text": "", "sidebar": true } [/block] [block:api-header] { "type": "basic" } [/block] ## Error handling When an API request results in an error, Paynova typically responds with HTTP status code `200 OK` and a response body with a JSON object containing `isSuccess: false`, an `errorNumber` and `errorMessage`. [block:code] { "codes": [ { "code": "STATUS 200 OK\n\n{\n \"status\": {\n \"isSuccess\": false,\n \"errorNumber\": 3000,\n \"statusKey\": \"ORDER_NOT_FOUND\",\n \"statusMessage\": \"The specified order was not found.\",\n \"errors\": null,\n \"exceptionDetails\": null\n },\n \"orderId\": null,\n \"transactionId\": null,\n \"acquirerId\": 0,\n \"acquirerReferenceId\": null\n}", "language": "json" } ] } [/block] However, if your API request is malformed Paynova will return HTTP status code `500 Internal Server Error`.
The Paynova API uses the following HTTP status codes. [block:parameters] { "data": { "0-0": "`200`", "h-0": "Code", "h-1": "Status", "1-0": "`201`", "0-1": "`OK`", "1-1": "`Created`", "2-0": "`401`", "3-0": "`404`", "4-0": "`500`", "4-1": "`Internal Server Error`", "2-1": "`Unauthorized`", "3-1": "`Not Found`", "h-2": "Usage", "0-2": "The request itself was understood by our system and was able to be processed.\n\n**Note:** The HTTP code says nothing about the actual **outcome** of the request. This information is returned in the response body.", "1-2": "Something has been created in Paynova's system (e.g. an `order`)", "2-2": "You forgot to provide your credentials or they are not valid.", "3-2": "The url you are trying to access is not a valid RESTful resource.", "4-2": "Your request is malformed and our API does not understand how to process it" }, "cols": 3, "rows": 5 } [/block] [block:textarea] { "text": "", "sidebar": true } [/block] [block:api-header] { "type": "basic" } [/block] ## Error handling When an API request results in an error, Paynova typically responds with HTTP status code `200 OK` and a response body with a JSON object containing `isSuccess: false`, an `errorNumber` and `errorMessage`. [block:code] { "codes": [ { "code": "STATUS 200 OK\n\n{\n \"status\": {\n \"isSuccess\": false,\n \"errorNumber\": 3000,\n \"statusKey\": \"ORDER_NOT_FOUND\",\n \"statusMessage\": \"The specified order was not found.\",\n \"errors\": null,\n \"exceptionDetails\": null\n },\n \"orderId\": null,\n \"transactionId\": null,\n \"acquirerId\": 0,\n \"acquirerReferenceId\": null\n}", "language": "json" } ] } [/block] However, if your API request is malformed Paynova will return HTTP status code `500 Internal Server Error`.
{"_id":"55088558e35e9c3b0083af9c","updates":[],"user":"5476eb1df3736008009e9ced","next":{"description":"","pages":[]},"excerpt":"","order":3,"version":"54930e7c777ff221004a7e70","category":"5506aa4949bcc90d00d408bb","createdAt":"2015-03-17T19:49:44.059Z","hidden":false,"isReference":false,"link_external":false,"project":"54930e7c777ff221004a7e6d","slug":"authentication","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"sync_unique":"","body":"All requests are authenticated with [Basic HTTP Authentication](http://tools.ietf.org/html/rfc1945#section-10.2). \n\nThe `username` is your **merchant ID** and the `password` is your **API password**.\n\n*You will receive this information from our Paynova merchant support when your account is created.* \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"username = Merchant ID\\npassword = API password\",\n      \"language\": \"text\",\n      \"name\": \"Basic Authentication\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","githubsync":"","link_url":"","parentDoc":null,"title":"Authentication","type":"basic","__v":5,"childrenPages":[]}

Authentication


All requests are authenticated with [Basic HTTP Authentication](http://tools.ietf.org/html/rfc1945#section-10.2). The `username` is your **merchant ID** and the `password` is your **API password**. *You will receive this information from our Paynova merchant support when your account is created.* [block:code] { "codes": [ { "code": "username = Merchant ID\npassword = API password", "language": "text", "name": "Basic Authentication" } ], "sidebar": true } [/block]
All requests are authenticated with [Basic HTTP Authentication](http://tools.ietf.org/html/rfc1945#section-10.2). The `username` is your **merchant ID** and the `password` is your **API password**. *You will receive this information from our Paynova merchant support when your account is created.* [block:code] { "codes": [ { "code": "username = Merchant ID\npassword = API password", "language": "text", "name": "Basic Authentication" } ], "sidebar": true } [/block]
{"_id":"550875a36065ed17002643c0","isReference":false,"next":{"description":"","pages":[]},"order":4,"sync_unique":"","__v":6,"body":"All **synchronous** calls are [authenticated](/v1.0/docs/authentication) via Basic HTTP Authentication.\n\nThe following calls are **asynchronous** and require DIGEST verification to ensure that the original message has not been changed:\n\n  * POST-redirects\n  * Event hook notifications (webhooks) \n\nPaynova uses the SHA-1 hash function. Details on how to calculate the DIGEST hash are described in each relevant section.","category":"5506aa4949bcc90d00d408bb","createdAt":"2015-03-17T18:42:43.370Z","githubsync":"","link_url":"","project":"54930e7c777ff221004a7e6d","type":"basic","version":"54930e7c777ff221004a7e70","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"hidden":false,"link_external":false,"updates":[],"user":"5476eb1df3736008009e9ced","excerpt":"","parentDoc":null,"slug":"digest","title":"Digest verification","childrenPages":[]}

Digest verification


All **synchronous** calls are [authenticated](/v1.0/docs/authentication) via Basic HTTP Authentication. The following calls are **asynchronous** and require DIGEST verification to ensure that the original message has not been changed: * POST-redirects * Event hook notifications (webhooks) Paynova uses the SHA-1 hash function. Details on how to calculate the DIGEST hash are described in each relevant section.
All **synchronous** calls are [authenticated](/v1.0/docs/authentication) via Basic HTTP Authentication. The following calls are **asynchronous** and require DIGEST verification to ensure that the original message has not been changed: * POST-redirects * Event hook notifications (webhooks) Paynova uses the SHA-1 hash function. Details on how to calculate the DIGEST hash are described in each relevant section.
{"_id":"55087cf70c409c2100fd1499","project":"54930e7c777ff221004a7e6d","type":"basic","user":"5476eb1df3736008009e9ced","isReference":false,"parentDoc":null,"slug":"versioning","sync_unique":"","category":"5506aa4949bcc90d00d408bb","createdAt":"2015-03-17T19:13:59.020Z","hidden":false,"updates":[],"version":"54930e7c777ff221004a7e70","api":{"settings":"","url":"","auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"githubsync":"","link_url":"","title":"Versioning","next":{"pages":[],"description":""},"order":5,"__v":1,"body":"Paynova strives to keep our API simple and not introduce breaking changes when we add functionality. Currently, all changes to the API are backwards compatible and there are no plans to introduce versioning in our API.","excerpt":"","link_external":false,"childrenPages":[]}

Versioning


Paynova strives to keep our API simple and not introduce breaking changes when we add functionality. Currently, all changes to the API are backwards compatible and there are no plans to introduce versioning in our API.
Paynova strives to keep our API simple and not introduce breaking changes when we add functionality. Currently, all changes to the API are backwards compatible and there are no plans to introduce versioning in our API.
{"_id":"54cf24aba9e1cf0d005c89fb","body":"**Get Addresses** returns all available names and addresses for a legal person in the specified country.\n\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Currently **Get Addresses** is only supported for Sweden.\"\n}\n[/block]\n## HTTP Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /addresses/{countryCode}/{governmentId}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n## Request Parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`countryCode`\\n*required*\",\n    \"0-1\": \"`string(2)`\",\n    \"0-2\": \"The two-letter country code in ISO 3166 format.\\n\\n\\n**Examples:** `\\\"SE\\\"`\",\n    \"1-2\": \"For Sweden: The customer's 12 digit personnummer, with or without a dash.\\n\\n**Examples:** `\\\"198901157993\\\"`, `\\\"19890115-7993\\\"`\",\n    \"1-1\": \"`string(12)`\",\n    \"1-0\": \"`governmentId`\\n*required*\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n## Response Parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"**Conditions:**\\n> This parameter is not returned in error situations\\n\\n**Example:** `199612082165`\",\n    \"1-2\": \"**Conditions:**\\n> This parameter is not returned in error situations\\n\\n**Example:** `\\\"SE\\\"`\",\n    \"0-1\": \"`string(12)`\",\n    \"1-1\": \"`string(2)`\",\n    \"0-0\": \"`governmentId`\\n***conditional***\",\n    \"1-0\": \"`countryCode`\\n***conditional***\",\n    \"3-0\": \"`status`\\n*required*\",\n    \"3-1\": \"[ `status`:fa-external-link-square:](doc:status)\",\n    \"3-2\": \"API operation status\\n\\n**Example:**\\n```\\n{\\n        \\\"isSuccess\\\": true,\\n        \\\"errorNumber\\\": 0,\\n        \\\"statusKey\\\": \\\"SUCCESS\\\",\\n        \\\"statusMessage\\\": \\\"The operation was successful.\\\",\\n        \\\"errors\\\": null,\\n        \\\"exceptionDetails\\\": null\\n    }\\n```\",\n    \"2-0\": \"`addresses`\\n***conditional***\",\n    \"2-1\": \"array of [`nameAndAddress`:fa-external-link-square:](doc:nameandaddress)\",\n    \"2-2\": \"**Conditions:**\\n> This parameter is not returned in error situations\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","category":"54cf24974acee20d001e52fc","excerpt":"","hidden":false,"link_external":false,"parentDoc":null,"slug":"get-addresses","__v":15,"api":{"examples":{"codes":[{"language":"json","name":"Get Swedish addresses","code":"\"GET\" https://api.paynova.com/addresses/SE/198901157993"}]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"governmentId\": \"198901157993\",\n    \"countryCode\": \"SE\",\n    \"addresses\": [\n        {\n            \"name\": {\n                \"companyName\": null,\n                \"title\": null,\n                \"firstName\": \"Sven\",\n                \"middleNames\": null,\n                \"lastName\": \"Holm\",\n                \"suffix\": null\n            },\n            \"address\": {\n                \"type\": \"legal\",\n                \"street1\": \"GATUADRESS 77\",\n                \"street2\": null,\n                \"street3\": null,\n                \"street4\": null,\n                \"city\": \"LANDSKRONA\",\n                \"postalCode\": \"26151\",\n                \"regionCode\": null,\n                \"countryCode\": \"SE\"\n            }\n        }\n    ],\n    \"status\": {\n        \"isSuccess\": true,\n        \"errorNumber\": 0,\n        \"statusKey\": \"SUCCESS\",\n        \"statusMessage\": \"The operation was successful.\",\n        \"errors\": null,\n        \"exceptionDetails\": null\n    }\n}","name":""},{"name":"Validation Error","status":200,"language":"json","code":"{\n    \"governmentId\": null,\n    \"countryCode\": null,\n    \"addresses\": [],\n    \"status\": {\n        \"isSuccess\": false,\n        \"errorNumber\": -2,\n        \"statusKey\": \"VALIDATION_ERROR\",\n        \"statusMessage\": \"The request contained one or more validation errors.  See the errors collection for further details.\",\n        \"errors\": [\n            {\n                \"errorCode\": \"RegularExpression\",\n                \"fieldName\": \"GovernmentId\",\n                \"message\": \"'Government Id' is not in the correct format.\"\n            }\n        ],\n        \"exceptionDetails\": null\n    }\n}"},{"code":"{\n    \"governmentId\": null,\n    \"countryCode\": null,\n    \"addresses\": [],\n    \"status\": {\n        \"isSuccess\": false,\n        \"errorNumber\": 5005,\n        \"statusKey\": \"ADDR_LOOKUP_PROCESSOR\",\n        \"statusMessage\": \"Generic failure in processor for address lookup.\",\n        \"errors\": null,\n        \"exceptionDetails\": null\n    }\n}","language":"json","status":200,"name":"Processor Error"},{"name":"No Match","code":"{\n\t\t\"governmentId\": null,\n\t\t\"countryCode\": null,\n\t\t\"addresses\": [],\n\t\t\"status\": {\n\t\t\t\t\"isSuccess\": false,\n\t\t\t\t\"errorNumber\": 5006,\n\t\t\t\t\"statusKey\": \"NO_MATCH\",\n\t\t\t\t\"statusMessage\": \"The operation yielded no result.\",\n\t\t\t\t\"errors\": null,\n\t\t\t\t\"exceptionDetails\": null\n\t\t}\n}","language":"json","status":200}]},"settings":"","url":"/addresses/{countryCode}/{governmentId}","auth":"required"},"createdAt":"2015-02-02T07:18:03.016Z","githubsync":"","order":0,"title":"Get addresses","link_url":"","sync_unique":"","updates":[],"isReference":true,"project":"54930e7c777ff221004a7e6d","type":"get","user":"5476eb1df3736008009e9ced","version":"54930e7c777ff221004a7e70","next":{"description":"","pages":[]},"childrenPages":[]}

getGet addresses


**Get Addresses** returns all available names and addresses for a legal person in the specified country. [block:callout] { "type": "info", "body": "Currently **Get Addresses** is only supported for Sweden." } [/block] ## HTTP Request [block:code] { "codes": [ { "code": "GET /addresses/{countryCode}/{governmentId}", "language": "http" } ] } [/block] ## Request Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`countryCode`\n*required*", "0-1": "`string(2)`", "0-2": "The two-letter country code in ISO 3166 format.\n\n\n**Examples:** `\"SE\"`", "1-2": "For Sweden: The customer's 12 digit personnummer, with or without a dash.\n\n**Examples:** `\"198901157993\"`, `\"19890115-7993\"`", "1-1": "`string(12)`", "1-0": "`governmentId`\n*required*" }, "cols": 3, "rows": 2 } [/block] ## Response Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-2": "**Conditions:**\n> This parameter is not returned in error situations\n\n**Example:** `199612082165`", "1-2": "**Conditions:**\n> This parameter is not returned in error situations\n\n**Example:** `\"SE\"`", "0-1": "`string(12)`", "1-1": "`string(2)`", "0-0": "`governmentId`\n***conditional***", "1-0": "`countryCode`\n***conditional***", "3-0": "`status`\n*required*", "3-1": "[ `status`:fa-external-link-square:](doc:status)", "3-2": "API operation status\n\n**Example:**\n```\n{\n \"isSuccess\": true,\n \"errorNumber\": 0,\n \"statusKey\": \"SUCCESS\",\n \"statusMessage\": \"The operation was successful.\",\n \"errors\": null,\n \"exceptionDetails\": null\n }\n```", "2-0": "`addresses`\n***conditional***", "2-1": "array of [`nameAndAddress`:fa-external-link-square:](doc:nameandaddress)", "2-2": "**Conditions:**\n> This parameter is not returned in error situations" }, "cols": 3, "rows": 4 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



**Get Addresses** returns all available names and addresses for a legal person in the specified country. [block:callout] { "type": "info", "body": "Currently **Get Addresses** is only supported for Sweden." } [/block] ## HTTP Request [block:code] { "codes": [ { "code": "GET /addresses/{countryCode}/{governmentId}", "language": "http" } ] } [/block] ## Request Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`countryCode`\n*required*", "0-1": "`string(2)`", "0-2": "The two-letter country code in ISO 3166 format.\n\n\n**Examples:** `\"SE\"`", "1-2": "For Sweden: The customer's 12 digit personnummer, with or without a dash.\n\n**Examples:** `\"198901157993\"`, `\"19890115-7993\"`", "1-1": "`string(12)`", "1-0": "`governmentId`\n*required*" }, "cols": 3, "rows": 2 } [/block] ## Response Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-2": "**Conditions:**\n> This parameter is not returned in error situations\n\n**Example:** `199612082165`", "1-2": "**Conditions:**\n> This parameter is not returned in error situations\n\n**Example:** `\"SE\"`", "0-1": "`string(12)`", "1-1": "`string(2)`", "0-0": "`governmentId`\n***conditional***", "1-0": "`countryCode`\n***conditional***", "3-0": "`status`\n*required*", "3-1": "[ `status`:fa-external-link-square:](doc:status)", "3-2": "API operation status\n\n**Example:**\n```\n{\n \"isSuccess\": true,\n \"errorNumber\": 0,\n \"statusKey\": \"SUCCESS\",\n \"statusMessage\": \"The operation was successful.\",\n \"errors\": null,\n \"exceptionDetails\": null\n }\n```", "2-0": "`addresses`\n***conditional***", "2-1": "array of [`nameAndAddress`:fa-external-link-square:](doc:nameandaddress)", "2-2": "**Conditions:**\n> This parameter is not returned in error situations" }, "cols": 3, "rows": 4 } [/block]
{"_id":"54cf2705a9e1cf0d005c8a0b","category":"54cf24974acee20d001e52fc","parentDoc":null,"updates":[],"user":"5476eb1df3736008009e9ced","__v":11,"api":{"method":"post","params":[],"results":{"codes":[{"name":"","code":"{\n  \"status\": {\n    \"isSuccess\": true,\n    \"errorNumber\": 0,\n    \"statusKey\": \"SUCCESS\",\n    \"statusMessage\": \"The operation was successful.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  },\n  \"availablePaymentMethods\": [\n    \n    {\n      \"paymentMethodId\": 1,\n      \"paymentMethodProductId\": null,\n      \"displayName\": \"VISA\",\n      \"group\": {\n        \"key\": \"card\",\n        \"displayName\": \"Kredit-/betalkort\"\n      },\n      \"interestRate\": null,\n      \"notificationFee\": null,\n      \"setupFee\": null,\n      \"numberOfInstallments\": null,\n      \"installmentPeriod\": null,\n      \"installmentUnit\": null,\n      \"legalDocuments\": null,\n      \"addressTypeRestrictions\": []\n    },\n    {\n      \"paymentMethodId\": 2,\n      \"paymentMethodProductId\": null,\n      \"displayName\": \"MasterCard\",\n      \"group\": {\n        \"key\": \"card\",\n        \"displayName\": \"Kredit-/betalkort\"\n      },\n      \"interestRate\": null,\n      \"notificationFee\": null,\n      \"setupFee\": null,\n      \"numberOfInstallments\": null,\n      \"installmentPeriod\": null,\n      \"installmentUnit\": null,\n      \"legalDocuments\": null,\n      \"addressTypeRestrictions\": []\n    },\n    {\n      \"paymentMethodId\": 311,\n      \"paymentMethodProductId\": \"DirectInvoice\",\n      \"displayName\": \"Faktura\",\n      \"group\": {\n        \"key\": \"invoice\",\n        \"displayName\": \"Invoice\"\n      },\n      \"interestRate\": {\n        \"label\": \"Ränta\",\n        \"symbol\": \"%\",\n        \"value\": \"6.00\"\n      },\n      \"notificationFee\": {\n        \"label\": \"Fakturaavgift\",\n        \"symbol\": \"kr\",\n        \"value\": \"29.00\"\n      },\n      \"setupFee\": {\n        \"label\": \"Uppläggningsavgift\",\n        \"symbol\": \"kr\",\n        \"value\": \"0.000\"\n      },\n      \"numberOfInstallments\": null,\n      \"installmentPeriod\": null,\n      \"installmentUnit\": null,\n      \"legalDocuments\": [\n        {\n          \"label\": \"Allmänna Villkor Faktura\",\n          \"uri\": \"http://api.paynova.com/mypages/web/Content/documents/legal/Nova/sv_se/villkor_faktura_20151126.pdf\"\n        },\n        {\n          \"label\": \"Standardiserad Europeisk konsumentkreditinformation\",\n          \"uri\": \"http://api.paynova.com/mypages/web/Content/documents/legal/Nova/sv_se/standardiserad_europeisk_konsumentkreditinformation_20160120.pdf\"\n        },\n        {\n          \"label\": \"Hantering av personuppgifter\",\n          \"uri\": \"http://api.paynova.com/mypages/web/Content/documents/legal/Nova/sv_se/personuppgiftsbehandling_20151126.pdf\"\n        }\n      ],\n      \"addressTypeRestrictions\": [\n        \"legal\"\n      ]\n    },\n    {\n      \"paymentMethodId\": 311,\n      \"paymentMethodProductId\": \"InstallmentsThreeMonths\",\n      \"displayName\": \"Delbetalning 3 månader\",\n      \"group\": {\n        \"key\": \"installment\",\n        \"displayName\": \"Part-Payment\"\n      },\n      \"interestRate\": {\n        \"label\": \"Ränta\",\n        \"symbol\": \"%\",\n        \"value\": \"6.00\"\n      },\n      \"notificationFee\": {\n        \"label\": \"Fakturaavgift\",\n        \"symbol\": \"kr\",\n        \"value\": \"29.00\"\n      },\n      \"setupFee\": {\n        \"label\": \"Uppläggningsavgift\",\n        \"symbol\": \"kr\",\n        \"value\": \"95.00\"\n      },\n      \"numberOfInstallments\": 3,\n      \"installmentPeriod\": 1,\n      \"installmentUnit\": \"month\",\n      \"legalDocuments\": [\n        {\n          \"label\": \"Allmänna Villkor Delbetalning\",\n          \"uri\": \"http://api.paynova.com/mypages/web/Content/documents/legal/Nova/sv_se/villkor_delbetalning_20160530.pdf\"\n        },\n        {\n          \"label\": \"Standardiserad Europeisk konsumentkreditinformation\",\n          \"uri\": \"http://api.paynova.com/mypages/web/Content/documents/legal/Nova/sv_se/standardiserad_europeisk_konsumentkreditinformation_20160120.pdf\"\n        },\n        {\n          \"label\": \"Hantering av personuppgifter\",\n          \"uri\": \"http://api.paynova.com/mypages/web/Content/documents/legal/Nova/sv_se/personuppgiftsbehandling_20151126.pdf\"\n        }\n      ],\n      \"addressTypeRestrictions\": [\n        \"legal\"\n      ]\n    },\n    {\n      \"paymentMethodId\": 311,\n      \"paymentMethodProductId\": \"InstallmentsSixMonths\",\n      \"displayName\": \"Delbetalning 6 månader\",\n      \"group\": {\n        \"key\": \"installment\",\n        \"displayName\": \"Part-Payment\"\n      },\n      \"interestRate\": {\n        \"label\": \"Ränta\",\n        \"symbol\": \"%\",\n        \"value\": \"6.00\"\n      },\n      \"notificationFee\": {\n        \"label\": \"Fakturaavgift\",\n        \"symbol\": \"kr\",\n        \"value\": \"29.00\"\n      },\n      \"setupFee\": {\n        \"label\": \"Uppläggningsavgift\",\n        \"symbol\": \"kr\",\n        \"value\": \"195.00\"\n      },\n      \"numberOfInstallments\": 6,\n      \"installmentPeriod\": 1,\n      \"installmentUnit\": \"month\",\n      \"legalDocuments\": [\n        {\n          \"label\": \"Allmänna Villkor Delbetalning\",\n          \"uri\": \"http://api.paynova.com/mypages/web/Content/documents/legal/Nova/sv_se/villkor_delbetalning_20160530.pdf\"\n        },\n        {\n          \"label\": \"Standardiserad Europeisk konsumentkreditinformation\",\n          \"uri\": \"http://api.paynova.com/mypages/web/Content/documents/legal/Nova/sv_se/standardiserad_europeisk_konsumentkreditinformation_20160120.pdf\"\n        },\n        {\n          \"label\": \"Hantering av personuppgifter\",\n          \"uri\": \"http://api.paynova.com/mypages/web/Content/documents/legal/Nova/sv_se/personuppgiftsbehandling_20151126.pdf\"\n        }\n      ],\n      \"addressTypeRestrictions\": [\n        \"legal\"\n      ]\n    },\n    {\n            \"PaymentMethodId\": 126,\n            \"PaymentMethodProductId\": null,\n            \"DisplayName\": \"Swish\",\n            \"Group\": {\n                \"Key\": \"online_bank\",\n                \"DisplayName\": \"Internetbank\"\n            },\n            \"InterestRate\": null,\n            \"NotificationFee\": null,\n            \"SetupFee\": null,\n            \"NumberOfInstallments\": null,\n            \"InstallmentPeriod\": null,\n            \"InstallmentUnit\": null,\n            \"LegalDocuments\": null,\n            \"AddressTypeRestrictions\": []\n        }\n  ]\n}","language":"json","status":200}]},"settings":"","url":"/paymentoptions","auth":"required","examples":{"codes":[{"name":"Get Payment Options for Sweden","language":"json","code":"\"POST\" https://api.paynova.com/paymentoptions\n\n{\n  \"TotalAmount\": 1125.00,\n  \"CurrencyCode\": \"SEK\",\n  \"PaymentChannelId\": 1,\n  \"CountryCode\": \"SE\",\n  \"LanguageCode\": \"SWE\"\n}"}]}},"body":"**Get Payment Options** retrieves all the available payment options for the current purchase based on the total amount, currency and country.\n\nUse the information from the response to display the available payment options to the user.\n\n## HTTP Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /paymentoptions\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n## Request Parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`totalAmount`\\n*required*\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"1-0\": \"`currencyCode`\\n*required*\",\n    \"2-0\": \"`paymentChannelId`\\n*required*\",\n    \"3-0\": \"`countryCode`\\n*required*\",\n    \"4-0\": \"`languageCode`\\n*required*\",\n    \"1-1\": \"`string(3)`\",\n    \"2-1\": \"`int`\",\n    \"3-1\": \"`string(2)`\",\n    \"4-1\": \"`string(3)`\",\n    \"0-1\": \"`decimal`\",\n    \"4-2\": \"Language in which label texts should be returned.\\n\\n**Examples:** `\\\"SWE\\\"`, `\\\"ENG\\\"`\",\n    \"3-2\": \"Two-letter [Country Code.](doc:country-codes) \\n\\n**Examples:** `\\\"SE\\\"`, `\\\"NO\\\"`\",\n    \"2-2\": \"The ID of the payment channel, see [paymentChannelID](doc:paymentchannelid) page for possible values.\\n\\n**Example:** `1`\",\n    \"1-2\": \"ISO 4217 alpha-3 or numerical code.\\n\\n**Examples:** `\\\"SEK\\\"`, `\\\"752\\\"`\",\n    \"0-2\": \"Total amount for the purchase.\\n\\n**Example:** `595.00`\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","createdAt":"2015-02-02T07:28:05.202Z","githubsync":"","slug":"get-payment-options","type":"post","version":"54930e7c777ff221004a7e70","excerpt":"","link_external":false,"link_url":"","project":"54930e7c777ff221004a7e6d","sync_unique":"","title":"Get payment options","hidden":false,"isReference":true,"next":{"description":"","pages":[]},"order":1,"childrenPages":[]}

postGet payment options


**Get Payment Options** retrieves all the available payment options for the current purchase based on the total amount, currency and country. Use the information from the response to display the available payment options to the user. ## HTTP Request [block:code] { "codes": [ { "code": "POST /paymentoptions", "language": "http" } ] } [/block] ## Request Parameters [block:parameters] { "data": { "0-0": "`totalAmount`\n*required*", "h-0": "Property", "h-1": "Type", "h-2": "Description", "1-0": "`currencyCode`\n*required*", "2-0": "`paymentChannelId`\n*required*", "3-0": "`countryCode`\n*required*", "4-0": "`languageCode`\n*required*", "1-1": "`string(3)`", "2-1": "`int`", "3-1": "`string(2)`", "4-1": "`string(3)`", "0-1": "`decimal`", "4-2": "Language in which label texts should be returned.\n\n**Examples:** `\"SWE\"`, `\"ENG\"`", "3-2": "Two-letter [Country Code.](doc:country-codes) \n\n**Examples:** `\"SE\"`, `\"NO\"`", "2-2": "The ID of the payment channel, see [paymentChannelID](doc:paymentchannelid) page for possible values.\n\n**Example:** `1`", "1-2": "ISO 4217 alpha-3 or numerical code.\n\n**Examples:** `\"SEK\"`, `\"752\"`", "0-2": "Total amount for the purchase.\n\n**Example:** `595.00`" }, "cols": 3, "rows": 5 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



**Get Payment Options** retrieves all the available payment options for the current purchase based on the total amount, currency and country. Use the information from the response to display the available payment options to the user. ## HTTP Request [block:code] { "codes": [ { "code": "POST /paymentoptions", "language": "http" } ] } [/block] ## Request Parameters [block:parameters] { "data": { "0-0": "`totalAmount`\n*required*", "h-0": "Property", "h-1": "Type", "h-2": "Description", "1-0": "`currencyCode`\n*required*", "2-0": "`paymentChannelId`\n*required*", "3-0": "`countryCode`\n*required*", "4-0": "`languageCode`\n*required*", "1-1": "`string(3)`", "2-1": "`int`", "3-1": "`string(2)`", "4-1": "`string(3)`", "0-1": "`decimal`", "4-2": "Language in which label texts should be returned.\n\n**Examples:** `\"SWE\"`, `\"ENG\"`", "3-2": "Two-letter [Country Code.](doc:country-codes) \n\n**Examples:** `\"SE\"`, `\"NO\"`", "2-2": "The ID of the payment channel, see [paymentChannelID](doc:paymentchannelid) page for possible values.\n\n**Example:** `1`", "1-2": "ISO 4217 alpha-3 or numerical code.\n\n**Examples:** `\"SEK\"`, `\"752\"`", "0-2": "Total amount for the purchase.\n\n**Example:** `595.00`" }, "cols": 3, "rows": 5 } [/block]
{"_id":"54cf2572a9e1cf0d005c8a02","title":"Create order","user":"5476eb1df3736008009e9ced","createdAt":"2015-02-02T07:21:22.558Z","githubsync":"","isReference":true,"sync_unique":"","hidden":false,"link_external":false,"link_url":"","next":{"pages":[],"description":""},"api":{"method":"post","params":[],"results":{"codes":[{"status":201,"language":"json","code":"{\n\"status\": {\n\"isSuccess\": true,\n\"errorNumber\": 0,\n\"statusKey\": \"SUCCESS\",\n\"statusMessage\": \"The operation was successful.\",\n\"errors\": null,\n\"exceptionDetails\": null\n},\n\"orderId\": \"1bee7570-76c0-495b-bc0a-a43300d0410c\"\n}","name":""},{"status":200,"language":"json","code":"{\n\"status\": {\n\"isSuccess\": false,\n\"errorNumber\": -2,\n\"statusKey\": \"VALIDATION_ERROR\",\n\"statusMessage\": \"The request contained one or more validation errors. See the errors collection for further details.\",\n\"errors\": [\n{\n\"errorCode\": \"Length\",\n\"fieldName\": \"CurrencyCode\",\n\"message\": \"'Currency Code' must be between 2 and 3 characters. You entered 5 characters.\"\n}\n],\n\"exceptionDetails\": null\n},\n\"orderId\": null\n}","name":"Validation Error"},{"status":200,"language":"json","code":"{\n  \"status\": {\n    \"isSuccess\": false,\n    \"errorNumber\": 3021,\n    \"statusKey\": \"DUPLICATE_ORDER\",\n    \"statusMessage\": \"An authorized or completed order already exists within the last 60 minutes for this order number and total amount combination.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  },\n  \"orderId\": null\n}","name":"Duplicate Order"}]},"settings":"","url":"/orders/create/{orderNumber}/{totalAmount}/{currencyCode}","auth":"required","examples":{"codes":[{"name":"Simple order","code":"\"POST\" https://api.paynova.com/orders/create/ORDER-123/100/SEK","language":"json"},{"name":"Detailed order ","language":"json","code":"\"POST\" https://api.paynova.com/orders/create\n\n{\n  \"orderNumber\": \"TEST\",\n  \"currencyCode\": \"SEK\",\n  \"totalAmount\": 125.00,\n  \"customer\": {\n    \"customerId\": \"\",\n    \"governmentId\": \"196006208133\",\n    \"emailAddress\": \"fakturademo@paynova.com\",\n    \"name\": {\n      \"companyName\": \"\",\n      \"firstName\": \"CHRISTOPHER\",\n      \"lastName\": \"WILLIAMS\"\n    },\n    \"homeTelephone\": \"\",\n    \"workTelephone\": \"\",\n    \"mobileTelephone\": \"\"\n  },\n  \"billTo\": {\n    \"name\": {\n      \"companyName\": \"\",\n      \"firstName\": \"CHRISTOPHER\",\n      \"lastName\": \"WILLIAMS\"\n    },\n    \"address\": {\n      \"street1\": \"TESTSTREET1\",\n      \"street2\": \"\",\n      \"street3\": \"\",\n      \"street4\": \"\",\n      \"city\": \"Göteborg\",\n      \"postalCode\": \"405 08\",\n      \"regionCode\": \"\",\n      \"countryCode\": \"SE\"\n    }\n  },\n  \"shipTo\": {\n    \"name\": {\n      \"companyName\": \"\",\n      \"firstName\": \"CHRISTOPHER\",\n      \"lastName\": \"WILLIAMS\"\n    },\n    \"address\": {\n      \"street1\": \"TESTSTREET1\",\n      \"street2\": \"\",\n      \"street3\": \"\",\n      \"street4\": \"\",\n      \"city\": \"Göteborg\",\n      \"postalCode\": \"405 08\",\n      \"regionCode\": \"\",\n      \"countryCode\": \"SE\"\n    }\n  },\n  \"lineItems\": [\n    {\n      \"id\": 1,\n      \"articleNumber\": \"1\",\n      \"name\": \"Sample train ticket #1\",\n      \"description\": \"Sample train ticket description goes here\",\n      \"productUrl\": \"http://www.google.se\",\n      \"quantity\": 1,\n      \"unitMeasure\": \"st\",\n      \"unitAmountExcludingTax\": 100,\n      \"taxPercent\": 25,\n      \"totalLineTaxAmount\": 25,\n      \"totalLineAmount\": 125\n    }\n  ],\n  \"orderDescription\": \"travel\",\n  \"salesChannel\": \"web\",\n  \"salesLocationId\": \"my office\"\n}"}]}},"body":"**Create order** creates an order in Paynova's system with a unique identifier (Order ID) which can be used in subsequent requests to intialize or authorize a payment on that order.\n\n## HTTP Request\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /orders/create/{orderNumber}/{totalAmount}/{currencyCode}\",\n      \"language\": \"http\",\n      \"name\": \"Simple order\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /orders/create\",\n      \"language\": \"http\",\n      \"name\": \"Detailed order\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Note\",\n  \"body\": \"For simple orders, the `orderNumber`, `totalAmount` and `currencyCode` can be specified directly as part of the REST endpoint.\\n\\nFor detailed orders, the abbreviated endpoint `/orders/create` can be used and `orderNumber`, `totalAmount` and `currencyCode` can be specified in the body together with the other detailed order parameters.\\n\\nParameters taken from the URL (`orderNumber`, `totalAmount` and `currencyCode`) will replace any parameters received in the POST body.\"\n}\n[/block]\n## Request Parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`orderNumber`\\n*required*\",\n    \"0-1\": \"`string(4-50)`\",\n    \"0-2\": \"Your identifier for the order, most likely from your order management system.\\n\\n**Constraints:**\\n\\n> **Must be completely unique for Invoice as payment method.** \\n\\n**Example:** `\\\"ORDER-123\\\"`\",\n    \"1-2\": \"The three-letter (alpha-3) ISO currency code or currency number as per ISO 4217.\\n\\nSee the [Currency Code](doc:currency-codes) page for more details.\\n\\n**Example:** `\\\"SEK\\\"`, `\\\"752\\\"`\",\n    \"2-2\": \"The total amount of the order. If line items are provided, the value of this field must equal the total sum of all line items.\\n\\n**Constraints:**\\n<ul>\\n<li> Please be sure to use a decimal point as the decimal separator. Commas are not supported.</li>\\n<li> Only two digits may be specified after the decimal point.</li>\\n<li> For Japanese Yuan (JPY), only whole numbers are allowed.</li>\\n</ul>\\n \\n**Example:** `100.00`\",\n    \"1-1\": \"`string(2-3)`\",\n    \"2-1\": \"`decimal`\",\n    \"1-0\": \"`currencyCode`\\n*required*\",\n    \"2-0\": \"`totalAmount`\\n*required*\",\n    \"3-0\": \"`salesChannel`\\n***optional***\",\n    \"3-1\": \"`string(0-50)`\",\n    \"4-1\": \"`string(0-50)`\",\n    \"6-1\": \"[`nameAndAddress`:fa-external-link-square:](doc:nameandaddress)\",\n    \"7-1\": \"[`nameAndAddress`:fa-external-link-square:](doc:nameandaddress)\",\n    \"8-1\": \"[`lineitem`:fa-external-link-square:](doc:lineitem)\",\n    \"5-1\": \"[`customer`:fa-external-link-square:](doc:customer)\",\n    \"4-0\": \"`salesLocationId`\\n***optional***\",\n    \"5-0\": \"`customer`\\n***conditional***\",\n    \"6-0\": \"`billTo`\\n***conditional***\",\n    \"3-2\": \"Your reference for the sales channel through which the customer is purchasing goods/services.\\n\\n**Example:** `\\\"web\\\"`\",\n    \"4-2\": \"Your identifier for the sales location. This might be a website URL, a country, a call-center location etc.\\n\\n**Constraints**\\n> **Only applicable for card payments.**\\n\\n**Example:** `\\\"Liljeholmen\\\"`\",\n    \"5-2\": \"Information about the customer.\\n\\n**Conditions:** \\n> **Required for Invoice as a Service orders, and if fraud screening is used.**\\n\\n**Example:** \\n```\\n{\\n    \\\"customerId\\\": \\\"\\\",\\n    \\\"governmentId\\\": \\\"196006208133\\\",\\n    \\\"emailAddress\\\": \\\"fakturademo@paynova.com\\\",\\n    \\\"name\\\": {\\n      \\\"companyName\\\": \\\"\\\",\\n      \\\"firstName\\\": \\\"CHRISTOPHER\\\",\\n      \\\"lastName\\\": \\\"WILLIAMS\\\"\\n    }\\n    } \\n    ```\",\n    \"7-0\": \"`shipTo`\\n***conditional***\",\n    \"8-0\": \"`lineitems`\\n***conditional***\",\n    \"6-2\": \"The billing name and address of the customer/company, generally the \\\"invoice address\\\" or \\\"account holder\\\" details.\\n\\n**Conditions:** \\n> **Required for Invoice as a Service orders, and if fraud screening is used.**\\n\\n**Example:** `\\\"GATUADRESS 77\\\"`\",\n    \"7-2\": \"The ship-to name and address of the recipient.\\n\\n**Conditions:** \\n> **Required for Invoice as a Service orders, and if fraud screening is used.**\\n\\n**Example:** `\\\"GATUADRESS 77\\\"`\",\n    \"8-2\": \"The line items included in this order (i.e. the items which the customer has purchased). You may include as many line items as required to specify the order.\\n\\n**Conditions:**\\n> It is highly recommended that you always send in complete line item information. Several payment methods, especially invoicing methods, require complete line information and you will not be able to use these methods if lineItems are not provided.\",\n    \"9-0\": \"`orderDescription`\\n***conditional***\",\n    \"9-2\": \"A free-text field which describes the order. This information is stored on the transaction level.\\n\\n**Conditions:**\\n> Required for PayPal.\\n\\n**Example:** `\\\"travel\\\"`\",\n    \"9-1\": \"`string(1-255)`\",\n    \"10-0\": \"`purchaseReference`\\n***conditional***\",\n    \"10-1\": \"`string(30)`\",\n    \"10-2\": \"Your reference for the customer/buyer.\\n\\n**Conditions:**\\n> Required for B2B Invoice\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]\n## Response Parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"API operation status.\\n\\n**Example:** \\n```\\n{\\n\\\"isSuccess\\\": true,\\n\\\"errorNumber\\\": 0,\\n\\\"statusKey\\\": \\\"SUCCESS\\\",\\n\\\"statusMessage\\\": \\\"The operation was successful.\\\",\\n\\\"errors\\\": null,\\n\\\"exceptionDetails\\\": null\\n}```\",\n    \"1-2\": \"Paynova's unique identifier for the order.\\n\\n**Conditions:** \\n> This parameter will not be returned if the operation fails.\\n\\n**Example:** `\\\"30c8d09b-28c6-4246-b4d4-a3b000e181c7\\\"`\",\n    \"0-1\": \"[`status`:fa-external-link-square:](doc:status)\",\n    \"1-1\": \"`guid`\",\n    \"0-0\": \"`status`\\n*required*\",\n    \"1-0\": \"`orderId`\\n***conditional***\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","category":"54cf2533a9e1cf0d005c89fe","project":"54930e7c777ff221004a7e6d","updates":[],"version":"54930e7c777ff221004a7e70","__v":56,"excerpt":"","order":0,"type":"post","parentDoc":null,"slug":"create-order","childrenPages":[]}

postCreate order


**Create order** creates an order in Paynova's system with a unique identifier (Order ID) which can be used in subsequent requests to intialize or authorize a payment on that order. ## HTTP Request [block:code] { "codes": [ { "code": "POST /orders/create/{orderNumber}/{totalAmount}/{currencyCode}", "language": "http", "name": "Simple order" } ] } [/block] [block:code] { "codes": [ { "code": "POST /orders/create", "language": "http", "name": "Detailed order" } ] } [/block] [block:callout] { "type": "info", "title": "Note", "body": "For simple orders, the `orderNumber`, `totalAmount` and `currencyCode` can be specified directly as part of the REST endpoint.\n\nFor detailed orders, the abbreviated endpoint `/orders/create` can be used and `orderNumber`, `totalAmount` and `currencyCode` can be specified in the body together with the other detailed order parameters.\n\nParameters taken from the URL (`orderNumber`, `totalAmount` and `currencyCode`) will replace any parameters received in the POST body." } [/block] ## Request Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`orderNumber`\n*required*", "0-1": "`string(4-50)`", "0-2": "Your identifier for the order, most likely from your order management system.\n\n**Constraints:**\n\n> **Must be completely unique for Invoice as payment method.** \n\n**Example:** `\"ORDER-123\"`", "1-2": "The three-letter (alpha-3) ISO currency code or currency number as per ISO 4217.\n\nSee the [Currency Code](doc:currency-codes) page for more details.\n\n**Example:** `\"SEK\"`, `\"752\"`", "2-2": "The total amount of the order. If line items are provided, the value of this field must equal the total sum of all line items.\n\n**Constraints:**\n<ul>\n<li> Please be sure to use a decimal point as the decimal separator. Commas are not supported.</li>\n<li> Only two digits may be specified after the decimal point.</li>\n<li> For Japanese Yuan (JPY), only whole numbers are allowed.</li>\n</ul>\n \n**Example:** `100.00`", "1-1": "`string(2-3)`", "2-1": "`decimal`", "1-0": "`currencyCode`\n*required*", "2-0": "`totalAmount`\n*required*", "3-0": "`salesChannel`\n***optional***", "3-1": "`string(0-50)`", "4-1": "`string(0-50)`", "6-1": "[`nameAndAddress`:fa-external-link-square:](doc:nameandaddress)", "7-1": "[`nameAndAddress`:fa-external-link-square:](doc:nameandaddress)", "8-1": "[`lineitem`:fa-external-link-square:](doc:lineitem)", "5-1": "[`customer`:fa-external-link-square:](doc:customer)", "4-0": "`salesLocationId`\n***optional***", "5-0": "`customer`\n***conditional***", "6-0": "`billTo`\n***conditional***", "3-2": "Your reference for the sales channel through which the customer is purchasing goods/services.\n\n**Example:** `\"web\"`", "4-2": "Your identifier for the sales location. This might be a website URL, a country, a call-center location etc.\n\n**Constraints**\n> **Only applicable for card payments.**\n\n**Example:** `\"Liljeholmen\"`", "5-2": "Information about the customer.\n\n**Conditions:** \n> **Required for Invoice as a Service orders, and if fraud screening is used.**\n\n**Example:** \n```\n{\n \"customerId\": \"\",\n \"governmentId\": \"196006208133\",\n \"emailAddress\": \"fakturademo@paynova.com\",\n \"name\": {\n \"companyName\": \"\",\n \"firstName\": \"CHRISTOPHER\",\n \"lastName\": \"WILLIAMS\"\n }\n } \n ```", "7-0": "`shipTo`\n***conditional***", "8-0": "`lineitems`\n***conditional***", "6-2": "The billing name and address of the customer/company, generally the \"invoice address\" or \"account holder\" details.\n\n**Conditions:** \n> **Required for Invoice as a Service orders, and if fraud screening is used.**\n\n**Example:** `\"GATUADRESS 77\"`", "7-2": "The ship-to name and address of the recipient.\n\n**Conditions:** \n> **Required for Invoice as a Service orders, and if fraud screening is used.**\n\n**Example:** `\"GATUADRESS 77\"`", "8-2": "The line items included in this order (i.e. the items which the customer has purchased). You may include as many line items as required to specify the order.\n\n**Conditions:**\n> It is highly recommended that you always send in complete line item information. Several payment methods, especially invoicing methods, require complete line information and you will not be able to use these methods if lineItems are not provided.", "9-0": "`orderDescription`\n***conditional***", "9-2": "A free-text field which describes the order. This information is stored on the transaction level.\n\n**Conditions:**\n> Required for PayPal.\n\n**Example:** `\"travel\"`", "9-1": "`string(1-255)`", "10-0": "`purchaseReference`\n***conditional***", "10-1": "`string(30)`", "10-2": "Your reference for the customer/buyer.\n\n**Conditions:**\n> Required for B2B Invoice" }, "cols": 3, "rows": 11 } [/block] ## Response Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-2": "API operation status.\n\n**Example:** \n```\n{\n\"isSuccess\": true,\n\"errorNumber\": 0,\n\"statusKey\": \"SUCCESS\",\n\"statusMessage\": \"The operation was successful.\",\n\"errors\": null,\n\"exceptionDetails\": null\n}```", "1-2": "Paynova's unique identifier for the order.\n\n**Conditions:** \n> This parameter will not be returned if the operation fails.\n\n**Example:** `\"30c8d09b-28c6-4246-b4d4-a3b000e181c7\"`", "0-1": "[`status`:fa-external-link-square:](doc:status)", "1-1": "`guid`", "0-0": "`status`\n*required*", "1-0": "`orderId`\n***conditional***" }, "cols": 3, "rows": 2 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



**Create order** creates an order in Paynova's system with a unique identifier (Order ID) which can be used in subsequent requests to intialize or authorize a payment on that order. ## HTTP Request [block:code] { "codes": [ { "code": "POST /orders/create/{orderNumber}/{totalAmount}/{currencyCode}", "language": "http", "name": "Simple order" } ] } [/block] [block:code] { "codes": [ { "code": "POST /orders/create", "language": "http", "name": "Detailed order" } ] } [/block] [block:callout] { "type": "info", "title": "Note", "body": "For simple orders, the `orderNumber`, `totalAmount` and `currencyCode` can be specified directly as part of the REST endpoint.\n\nFor detailed orders, the abbreviated endpoint `/orders/create` can be used and `orderNumber`, `totalAmount` and `currencyCode` can be specified in the body together with the other detailed order parameters.\n\nParameters taken from the URL (`orderNumber`, `totalAmount` and `currencyCode`) will replace any parameters received in the POST body." } [/block] ## Request Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`orderNumber`\n*required*", "0-1": "`string(4-50)`", "0-2": "Your identifier for the order, most likely from your order management system.\n\n**Constraints:**\n\n> **Must be completely unique for Invoice as payment method.** \n\n**Example:** `\"ORDER-123\"`", "1-2": "The three-letter (alpha-3) ISO currency code or currency number as per ISO 4217.\n\nSee the [Currency Code](doc:currency-codes) page for more details.\n\n**Example:** `\"SEK\"`, `\"752\"`", "2-2": "The total amount of the order. If line items are provided, the value of this field must equal the total sum of all line items.\n\n**Constraints:**\n<ul>\n<li> Please be sure to use a decimal point as the decimal separator. Commas are not supported.</li>\n<li> Only two digits may be specified after the decimal point.</li>\n<li> For Japanese Yuan (JPY), only whole numbers are allowed.</li>\n</ul>\n \n**Example:** `100.00`", "1-1": "`string(2-3)`", "2-1": "`decimal`", "1-0": "`currencyCode`\n*required*", "2-0": "`totalAmount`\n*required*", "3-0": "`salesChannel`\n***optional***", "3-1": "`string(0-50)`", "4-1": "`string(0-50)`", "6-1": "[`nameAndAddress`:fa-external-link-square:](doc:nameandaddress)", "7-1": "[`nameAndAddress`:fa-external-link-square:](doc:nameandaddress)", "8-1": "[`lineitem`:fa-external-link-square:](doc:lineitem)", "5-1": "[`customer`:fa-external-link-square:](doc:customer)", "4-0": "`salesLocationId`\n***optional***", "5-0": "`customer`\n***conditional***", "6-0": "`billTo`\n***conditional***", "3-2": "Your reference for the sales channel through which the customer is purchasing goods/services.\n\n**Example:** `\"web\"`", "4-2": "Your identifier for the sales location. This might be a website URL, a country, a call-center location etc.\n\n**Constraints**\n> **Only applicable for card payments.**\n\n**Example:** `\"Liljeholmen\"`", "5-2": "Information about the customer.\n\n**Conditions:** \n> **Required for Invoice as a Service orders, and if fraud screening is used.**\n\n**Example:** \n```\n{\n \"customerId\": \"\",\n \"governmentId\": \"196006208133\",\n \"emailAddress\": \"fakturademo@paynova.com\",\n \"name\": {\n \"companyName\": \"\",\n \"firstName\": \"CHRISTOPHER\",\n \"lastName\": \"WILLIAMS\"\n }\n } \n ```", "7-0": "`shipTo`\n***conditional***", "8-0": "`lineitems`\n***conditional***", "6-2": "The billing name and address of the customer/company, generally the \"invoice address\" or \"account holder\" details.\n\n**Conditions:** \n> **Required for Invoice as a Service orders, and if fraud screening is used.**\n\n**Example:** `\"GATUADRESS 77\"`", "7-2": "The ship-to name and address of the recipient.\n\n**Conditions:** \n> **Required for Invoice as a Service orders, and if fraud screening is used.**\n\n**Example:** `\"GATUADRESS 77\"`", "8-2": "The line items included in this order (i.e. the items which the customer has purchased). You may include as many line items as required to specify the order.\n\n**Conditions:**\n> It is highly recommended that you always send in complete line item information. Several payment methods, especially invoicing methods, require complete line information and you will not be able to use these methods if lineItems are not provided.", "9-0": "`orderDescription`\n***conditional***", "9-2": "A free-text field which describes the order. This information is stored on the transaction level.\n\n**Conditions:**\n> Required for PayPal.\n\n**Example:** `\"travel\"`", "9-1": "`string(1-255)`", "10-0": "`purchaseReference`\n***conditional***", "10-1": "`string(30)`", "10-2": "Your reference for the customer/buyer.\n\n**Conditions:**\n> Required for B2B Invoice" }, "cols": 3, "rows": 11 } [/block] ## Response Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-2": "API operation status.\n\n**Example:** \n```\n{\n\"isSuccess\": true,\n\"errorNumber\": 0,\n\"statusKey\": \"SUCCESS\",\n\"statusMessage\": \"The operation was successful.\",\n\"errors\": null,\n\"exceptionDetails\": null\n}```", "1-2": "Paynova's unique identifier for the order.\n\n**Conditions:** \n> This parameter will not be returned if the operation fails.\n\n**Example:** `\"30c8d09b-28c6-4246-b4d4-a3b000e181c7\"`", "0-1": "[`status`:fa-external-link-square:](doc:status)", "1-1": "`guid`", "0-0": "`status`\n*required*", "1-0": "`orderId`\n***conditional***" }, "cols": 3, "rows": 2 } [/block]
{"_id":"54cf255ea9e1cf0d005c8a00","order":1,"project":"54930e7c777ff221004a7e6d","slug":"authorize-payment","title":"Authorize payment","updates":["59f32b3deba8cd00265b873b"],"body":"The **Authorize Payment** service is used to process transactions via our API instead of via a hosted payment pages.\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"**Authorize Payment must be used for the following payment types:**\\n\\n* Recurring payments\\n* Profile payments (non-3D Secure)\\n\\n**Authorize Payment can be used for the following instead of a hosted payment page:**\\n\\n* Invoice and installments\",\n  \"title\": \"Valid payment types\"\n}\n[/block]\n## HTTP Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /orders/{orderId}/authorizePayment\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n## Request Parameters \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`authorizationType`\\n*required*\",\n    \"3-0\": \"`transactionId`\\n***conditional***\",\n    \"4-0\": \"`paymentChannelId`\\n***conditional***\",\n    \"5-0\": \"`routingIndicator`\\n***conditional***\",\n    \"6-0\": \"`paymentMethodProductId`\\n***conditional***\",\n    \"7-0\": \"`profilePaymentOptions`\\n***conditional***\",\n    \"0-2\": \"**Examples:** `\\\"InvoicePayment\\\"`, `\\\"ProfilePayment\\\"`, `\\\"RecurringPayment\\\"`, `\\\"MobilePayment\\\"`\",\n    \"3-2\": \"The transaction ID of the initial authorization transaction.\\n\\n**Conditions:**\\n> Only required for recurring payments.\\n\\n**Example:** `\\\"201412161427444300\\\"`\",\n    \"5-2\": \"The name or id of the routing table to use when processing payments.\\n\\n**Conditions:**\\n> This field is used for advanced configurations and should only be provided if asked to do so by Paynova. Providing an invalid value in this field may result in payment failures.\\n\\n**Example:** `\\\"4658\\\"`\",\n    \"6-2\": \"The payment method product ID for the specific payment type.\\n\\n**Conditions:**\\n\\n> Required for invoice/installment orders.\\n\\n**Example:** `\\\"DirectInvoice\\\"`\",\n    \"3-1\": \"`string(18)`\",\n    \"0-1\": \"`string`\",\n    \"4-1\": \"`int`\",\n    \"4-2\": \"The id of the payment channel.\\n\\nSee [paymentChannelId](doc:paymentchannelid) page for possible values.\\n\\n**Conditions:** \\n> For recurring payments, this parameter is optional.\\n\\n**Example:** `1`\",\n    \"6-1\": \"`string`\",\n    \"7-1\": \"[`ProfilePaymentOptions`:fa-external-link-square:](doc:profilepaymentoptions)\",\n    \"5-1\": \"`string`\",\n    \"7-2\": \"**Conditions:** \\n> Required for profile payments.\\n\\n**Example:** \\n```\\n{\\n    \\\"ProfileId\\\": \\\"12345\\\",\\n    \\\"ProfileCard\\\": \\\"7FAFC9F1-A1EC-4303-8555-3DF3D910925E\\\"\\n  }```\",\n    \"1-0\": \"`totalAmount`\\n*required*\",\n    \"1-1\": \"`decimal`\",\n    \"1-2\": \"The total amount that should be processed for this payment. \\n\\n**Constraints:** \\n<ul>\\n<li> Please be sure to use a decimal point as the decimal separator. Commas are not supported.</li>\\n<li>Only two digits may be specified after the decimal point.</li>\\n<li> This must be equal to or less than the original order amount, and less than the original order amount minus any payments which have been already made on the order. </li>\\n<li>For Japanese Yuan (JPY), only whole numbers are allowed.\\n</li>\\n</ul>\\n\\n**Example:** `125.00`\",\n    \"2-0\": \"`paymentMethodId`\\n***conditional***\",\n    \"2-1\": \"`int`\",\n    \"2-2\": \"For invoice and installments set this to **311**. \\n\\nFor B2B Invoice: **312**\\n\\nFor Swish payments: **126**\\n\\n\\n\\n**Conditions:**\\n> Required for invoice, installments, and mobile payments. For recurring and profile payments, do not send in this parameter.\\n\\n**Example:** `311`, `126`, `312`\",\n    \"8-0\": \"`urlCallback`\\n***conditional***\",\n    \"8-1\": \"`string`\",\n    \"8-2\": \"The callback URL for when the payment is completed or cancelled.\\n\\n**Conditions:**\\n> **Required for mobile payments.**\\n\\n**Example:** `\\\"https://www.example.com/callback\\\"`\",\n    \"9-0\": \"`mobileTelephone`\\n***conditional***\",\n    \"9-1\": \"`string`\",\n    \"9-2\": \"The mobile telephone number of the payer.\\n\\n**Constraints:** \\n<ul>\\n<li> Must be in E.164 format.</li>\\n</li>\\n</ul>\\n\\t\\t\\n**Conditions:**\\n> **Required for mobile payments.**\\n\\n**Example:** `\\\"+46731234567\\\"`\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]\n##Response Parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`status`\\n***optional***\",\n    \"1-0\": \"`orderId`\\n***conditional***\",\n    \"2-0\": \"`transactionId`\\n***conditional***\",\n    \"3-0\": \"`acquirerId`\\n***conditional***\",\n    \"4-0\": \"`acquirerReferenceId`\\n***conditional***\",\n    \"4-2\": \"Reference ID from the settling part.\\n\\n**Conditions:**\\n> This parameter is not returned in error situations.\\n\\n**Example:** `\\\"167685\\\"`\",\n    \"3-2\": \"ID of the settling part.\\n\\n**Conditions:**\\n> This parameter is not returned in error situations.\\n\\n**Example:** `1045`\",\n    \"2-2\": \"Paynova's unique identifier associated with this transaction. This identifier must be used in subsequent requests to Finalize Authorization and Annul Authorization.\\n\\n**Conditions:**\\n> This parameter is not returned in error situations.\\n\\n**Example:** `\\\"201602090957016672\\\"`\",\n    \"1-2\": \"Paynova's unique identifier associated with this transaction.\\n\\n**Conditions:**\\n> This parameter is not returned in error situations.\\n\\n**Example:** `\\\"123456\\\"`\",\n    \"0-1\": \"[`status`:fa-external-link-square:](doc:status)\",\n    \"1-1\": \"`guid`\",\n    \"2-1\": \"`string (18)`\",\n    \"3-1\": \"`int`\",\n    \"4-1\": \"`string`\",\n    \"0-2\": \"API operation status.\\n\\n**Example:**  \\n```\\n{\\n    \\\"isSuccess\\\": true,\\n    \\\"errorNumber\\\": 0,\\n    \\\"statusKey\\\": \\\"SUCCESS\\\",\\n    \\\"statusMessage\\\": \\\"The operation was successful.\\\",\\n    \\\"errors\\\": null,\\n    \\\"exceptionDetails\\\": null\\n  }\\n```\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","githubsync":"","link_external":false,"user":"5476eb1df3736008009e9ced","sync_unique":"","__v":6,"isReference":true,"next":{"description":"","pages":[]},"category":"54cf2533a9e1cf0d005c89fe","hidden":false,"link_url":"","excerpt":"","parentDoc":null,"type":"post","version":"54930e7c777ff221004a7e70","api":{"auth":"required","examples":{"codes":[{"name":"Invoice payment","language":"json","code":"\"POST\" https://api.paynova.com/orders/76806205-cbfb-4c05-9c40-a6c400ff9b97/authorizePayment\n\n{\n\"AuthorizationType\": \"InvoicePayment\",\n\"TotalAmount\": 125.00,\n\"PaymentMethodId\": 311,\n\"PaymentMethodProductId\": \"DirectInvoice\",\n\"PaymentChannelId\": 1\n}\n"},{"name":"Recurring payment","language":"json","code":"\"POST\" https://api.paynova.com/orders/76806205-cbfb-4c05-9c40-a6c400ff9b97/authorizePayment\n\n{\n  \"AuthorizationType\": \"RecurringPayment\",\n  \"TotalAmount\": 125.00,\n  \"TransactionId\": \"201412161427444300\"\n}"},{"name":"Profile payment","language":"json","code":"\"POST\" https://api.paynova.com/orders/76806205-cbfb-4c05-9c40-a6c400ff9b97/authorizePayment\n\n{\n  \"AuthorizationType\": \"ProfilePayment\",\n  \"TotalAmount\": 125.00,\n  \"ProfilePaymentOptions\": {\n    \"ProfileId\": \"12345\",\n    \"ProfileCard\": \"7FAFC9F1-A1EC-4303-8555-3DF3D910925E\"\n  }\n}"},{"name":"Mobile payment","language":"json","code":"\"POST\" https://api.paynova.com/orders/76806205-cbfb-4c05-9c40-a6c400ff9b97/authorizePayment\n\n{\n  \"AuthorizationType\": \"MobilePayment\",\n  \"TotalAmount\": 125.00,\n  \"mobileTelephone\": \"+46731234567\",\n    \"urlCallback\": \"https://www.example.com/callback\",\n    \"paymentChannelId\": 1,\n    \"paymentMethodId\": 126\n}"}]},"method":"post","params":[],"results":{"codes":[{"code":"{\n  \"status\": {\n    \"isSuccess\": true,\n    \"errorNumber\": 0,\n    \"statusKey\": \"SUCCESS\",\n    \"statusMessage\": \"The operation was successful.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  },\n  \"orderId\": \"76806205-cbfb-4c05-9c40-a6c400ff9b97\",\n  \"transactionId\": \"201611201633354007\",\n  \"acquirerId\": 1045,\n  \"acquirerReferenceId\": \"167685\"\n}","language":"json","status":200,"name":""},{"language":"json","status":200,"name":"Validation Error","code":"{\n  \"status\": {\n    \"isSuccess\": false,\n    \"errorNumber\": -2,\n    \"statusKey\": \"VALIDATION_ERROR\",\n    \"statusMessage\": \"The request contained one or more validation errors.  See the errors collection for further details.\",\n    \"errors\": [\n      {\n        \"errorCode\": \"NotEmpty\",\n        \"fieldName\": \"TransactionId\",\n        \"message\": \"When authorizing a recurring payment, the original transaction Id must be provided.\"\n      }\n    ],\n    \"exceptionDetails\": null\n  },\n  \"orderId\": null,\n  \"transactionId\": null,\n  \"acquirerId\": 0,\n  \"acquirerReferenceId\": null\n}"},{"code":"{\n  \"status\": {\n    \"isSuccess\": false,\n    \"errorNumber\": 3022,\n    \"statusKey\": \"PAYABLE_AMT_EXCEEDED\",\n    \"statusMessage\": \"The total amount specified in your request is greater than the remaining payable amount on the order.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  },\n  \"orderId\": null,\n  \"transactionId\": null,\n  \"acquirerId\": 0,\n  \"acquirerReferenceId\": null\n}","language":"json","status":200,"name":"Amount Exceeded"},{"name":"Internal Error","status":200,"language":"json","code":"{\n  \"status\": {\n    \"isSuccess\": false,\n    \"errorNumber\": -1,\n    \"statusKey\": \"INTERNAL_ERROR\",\n    \"statusMessage\": \"An internal error has occurred.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  },\n  \"orderId\": null,\n  \"transactionId\": null,\n  \"acquirerId\": 0,\n  \"acquirerReferenceId\": null\n}"},{"name":"Payment Route Not Found","status":200,"language":"json","code":"{\n  \"status\": {\n    \"isSuccess\": false,\n    \"errorNumber\": 5003,\n    \"statusKey\": \"COULD_NOT_DETERMINE_PMT_ROUTE\",\n    \"statusMessage\": \"No payment route could be found that meets the criteria of this transaction.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  },\n  \"orderId\": null,\n  \"transactionId\": null,\n  \"acquirerId\": 0,\n  \"acquirerReferenceId\": null\n}"},{"name":"Declined","status":200,"language":"json","code":"{\n\t\"status\": {\n\t\t\"isSuccess\": False,\n\t\t\"errorNumber\": 5000,\n\t\t\"statusKey\": \"GENERAL_DECLINE\",\n\t\t\"statusMessage\": \"The operation was declined by the bank or processor.\"\n\t},\n\t\"acquirerId\": 0\n}"}]},"settings":"","url":"/orders/{orderId}/authorizePayment"},"createdAt":"2015-02-02T07:21:02.961Z","childrenPages":[]}

postAuthorize payment


The **Authorize Payment** service is used to process transactions via our API instead of via a hosted payment pages. [block:callout] { "type": "success", "body": "**Authorize Payment must be used for the following payment types:**\n\n* Recurring payments\n* Profile payments (non-3D Secure)\n\n**Authorize Payment can be used for the following instead of a hosted payment page:**\n\n* Invoice and installments", "title": "Valid payment types" } [/block] ## HTTP Request [block:code] { "codes": [ { "code": "POST /orders/{orderId}/authorizePayment", "language": "http" } ] } [/block] ## Request Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`authorizationType`\n*required*", "3-0": "`transactionId`\n***conditional***", "4-0": "`paymentChannelId`\n***conditional***", "5-0": "`routingIndicator`\n***conditional***", "6-0": "`paymentMethodProductId`\n***conditional***", "7-0": "`profilePaymentOptions`\n***conditional***", "0-2": "**Examples:** `\"InvoicePayment\"`, `\"ProfilePayment\"`, `\"RecurringPayment\"`, `\"MobilePayment\"`", "3-2": "The transaction ID of the initial authorization transaction.\n\n**Conditions:**\n> Only required for recurring payments.\n\n**Example:** `\"201412161427444300\"`", "5-2": "The name or id of the routing table to use when processing payments.\n\n**Conditions:**\n> This field is used for advanced configurations and should only be provided if asked to do so by Paynova. Providing an invalid value in this field may result in payment failures.\n\n**Example:** `\"4658\"`", "6-2": "The payment method product ID for the specific payment type.\n\n**Conditions:**\n\n> Required for invoice/installment orders.\n\n**Example:** `\"DirectInvoice\"`", "3-1": "`string(18)`", "0-1": "`string`", "4-1": "`int`", "4-2": "The id of the payment channel.\n\nSee [paymentChannelId](doc:paymentchannelid) page for possible values.\n\n**Conditions:** \n> For recurring payments, this parameter is optional.\n\n**Example:** `1`", "6-1": "`string`", "7-1": "[`ProfilePaymentOptions`:fa-external-link-square:](doc:profilepaymentoptions)", "5-1": "`string`", "7-2": "**Conditions:** \n> Required for profile payments.\n\n**Example:** \n```\n{\n \"ProfileId\": \"12345\",\n \"ProfileCard\": \"7FAFC9F1-A1EC-4303-8555-3DF3D910925E\"\n }```", "1-0": "`totalAmount`\n*required*", "1-1": "`decimal`", "1-2": "The total amount that should be processed for this payment. \n\n**Constraints:** \n<ul>\n<li> Please be sure to use a decimal point as the decimal separator. Commas are not supported.</li>\n<li>Only two digits may be specified after the decimal point.</li>\n<li> This must be equal to or less than the original order amount, and less than the original order amount minus any payments which have been already made on the order. </li>\n<li>For Japanese Yuan (JPY), only whole numbers are allowed.\n</li>\n</ul>\n\n**Example:** `125.00`", "2-0": "`paymentMethodId`\n***conditional***", "2-1": "`int`", "2-2": "For invoice and installments set this to **311**. \n\nFor B2B Invoice: **312**\n\nFor Swish payments: **126**\n\n\n\n**Conditions:**\n> Required for invoice, installments, and mobile payments. For recurring and profile payments, do not send in this parameter.\n\n**Example:** `311`, `126`, `312`", "8-0": "`urlCallback`\n***conditional***", "8-1": "`string`", "8-2": "The callback URL for when the payment is completed or cancelled.\n\n**Conditions:**\n> **Required for mobile payments.**\n\n**Example:** `\"https://www.example.com/callback\"`", "9-0": "`mobileTelephone`\n***conditional***", "9-1": "`string`", "9-2": "The mobile telephone number of the payer.\n\n**Constraints:** \n<ul>\n<li> Must be in E.164 format.</li>\n</li>\n</ul>\n\t\t\n**Conditions:**\n> **Required for mobile payments.**\n\n**Example:** `\"+46731234567\"`" }, "cols": 3, "rows": 10 } [/block] ##Response Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`status`\n***optional***", "1-0": "`orderId`\n***conditional***", "2-0": "`transactionId`\n***conditional***", "3-0": "`acquirerId`\n***conditional***", "4-0": "`acquirerReferenceId`\n***conditional***", "4-2": "Reference ID from the settling part.\n\n**Conditions:**\n> This parameter is not returned in error situations.\n\n**Example:** `\"167685\"`", "3-2": "ID of the settling part.\n\n**Conditions:**\n> This parameter is not returned in error situations.\n\n**Example:** `1045`", "2-2": "Paynova's unique identifier associated with this transaction. This identifier must be used in subsequent requests to Finalize Authorization and Annul Authorization.\n\n**Conditions:**\n> This parameter is not returned in error situations.\n\n**Example:** `\"201602090957016672\"`", "1-2": "Paynova's unique identifier associated with this transaction.\n\n**Conditions:**\n> This parameter is not returned in error situations.\n\n**Example:** `\"123456\"`", "0-1": "[`status`:fa-external-link-square:](doc:status)", "1-1": "`guid`", "2-1": "`string (18)`", "3-1": "`int`", "4-1": "`string`", "0-2": "API operation status.\n\n**Example:** \n```\n{\n \"isSuccess\": true,\n \"errorNumber\": 0,\n \"statusKey\": \"SUCCESS\",\n \"statusMessage\": \"The operation was successful.\",\n \"errors\": null,\n \"exceptionDetails\": null\n }\n```" }, "cols": 3, "rows": 5 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The **Authorize Payment** service is used to process transactions via our API instead of via a hosted payment pages. [block:callout] { "type": "success", "body": "**Authorize Payment must be used for the following payment types:**\n\n* Recurring payments\n* Profile payments (non-3D Secure)\n\n**Authorize Payment can be used for the following instead of a hosted payment page:**\n\n* Invoice and installments", "title": "Valid payment types" } [/block] ## HTTP Request [block:code] { "codes": [ { "code": "POST /orders/{orderId}/authorizePayment", "language": "http" } ] } [/block] ## Request Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`authorizationType`\n*required*", "3-0": "`transactionId`\n***conditional***", "4-0": "`paymentChannelId`\n***conditional***", "5-0": "`routingIndicator`\n***conditional***", "6-0": "`paymentMethodProductId`\n***conditional***", "7-0": "`profilePaymentOptions`\n***conditional***", "0-2": "**Examples:** `\"InvoicePayment\"`, `\"ProfilePayment\"`, `\"RecurringPayment\"`, `\"MobilePayment\"`", "3-2": "The transaction ID of the initial authorization transaction.\n\n**Conditions:**\n> Only required for recurring payments.\n\n**Example:** `\"201412161427444300\"`", "5-2": "The name or id of the routing table to use when processing payments.\n\n**Conditions:**\n> This field is used for advanced configurations and should only be provided if asked to do so by Paynova. Providing an invalid value in this field may result in payment failures.\n\n**Example:** `\"4658\"`", "6-2": "The payment method product ID for the specific payment type.\n\n**Conditions:**\n\n> Required for invoice/installment orders.\n\n**Example:** `\"DirectInvoice\"`", "3-1": "`string(18)`", "0-1": "`string`", "4-1": "`int`", "4-2": "The id of the payment channel.\n\nSee [paymentChannelId](doc:paymentchannelid) page for possible values.\n\n**Conditions:** \n> For recurring payments, this parameter is optional.\n\n**Example:** `1`", "6-1": "`string`", "7-1": "[`ProfilePaymentOptions`:fa-external-link-square:](doc:profilepaymentoptions)", "5-1": "`string`", "7-2": "**Conditions:** \n> Required for profile payments.\n\n**Example:** \n```\n{\n \"ProfileId\": \"12345\",\n \"ProfileCard\": \"7FAFC9F1-A1EC-4303-8555-3DF3D910925E\"\n }```", "1-0": "`totalAmount`\n*required*", "1-1": "`decimal`", "1-2": "The total amount that should be processed for this payment. \n\n**Constraints:** \n<ul>\n<li> Please be sure to use a decimal point as the decimal separator. Commas are not supported.</li>\n<li>Only two digits may be specified after the decimal point.</li>\n<li> This must be equal to or less than the original order amount, and less than the original order amount minus any payments which have been already made on the order. </li>\n<li>For Japanese Yuan (JPY), only whole numbers are allowed.\n</li>\n</ul>\n\n**Example:** `125.00`", "2-0": "`paymentMethodId`\n***conditional***", "2-1": "`int`", "2-2": "For invoice and installments set this to **311**. \n\nFor B2B Invoice: **312**\n\nFor Swish payments: **126**\n\n\n\n**Conditions:**\n> Required for invoice, installments, and mobile payments. For recurring and profile payments, do not send in this parameter.\n\n**Example:** `311`, `126`, `312`", "8-0": "`urlCallback`\n***conditional***", "8-1": "`string`", "8-2": "The callback URL for when the payment is completed or cancelled.\n\n**Conditions:**\n> **Required for mobile payments.**\n\n**Example:** `\"https://www.example.com/callback\"`", "9-0": "`mobileTelephone`\n***conditional***", "9-1": "`string`", "9-2": "The mobile telephone number of the payer.\n\n**Constraints:** \n<ul>\n<li> Must be in E.164 format.</li>\n</li>\n</ul>\n\t\t\n**Conditions:**\n> **Required for mobile payments.**\n\n**Example:** `\"+46731234567\"`" }, "cols": 3, "rows": 10 } [/block] ##Response Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`status`\n***optional***", "1-0": "`orderId`\n***conditional***", "2-0": "`transactionId`\n***conditional***", "3-0": "`acquirerId`\n***conditional***", "4-0": "`acquirerReferenceId`\n***conditional***", "4-2": "Reference ID from the settling part.\n\n**Conditions:**\n> This parameter is not returned in error situations.\n\n**Example:** `\"167685\"`", "3-2": "ID of the settling part.\n\n**Conditions:**\n> This parameter is not returned in error situations.\n\n**Example:** `1045`", "2-2": "Paynova's unique identifier associated with this transaction. This identifier must be used in subsequent requests to Finalize Authorization and Annul Authorization.\n\n**Conditions:**\n> This parameter is not returned in error situations.\n\n**Example:** `\"201602090957016672\"`", "1-2": "Paynova's unique identifier associated with this transaction.\n\n**Conditions:**\n> This parameter is not returned in error situations.\n\n**Example:** `\"123456\"`", "0-1": "[`status`:fa-external-link-square:](doc:status)", "1-1": "`guid`", "2-1": "`string (18)`", "3-1": "`int`", "4-1": "`string`", "0-2": "API operation status.\n\n**Example:** \n```\n{\n \"isSuccess\": true,\n \"errorNumber\": 0,\n \"statusKey\": \"SUCCESS\",\n \"statusMessage\": \"The operation was successful.\",\n \"errors\": null,\n \"exceptionDetails\": null\n }\n```" }, "cols": 3, "rows": 5 } [/block]
{"_id":"54cf25934acee20d001e52ff","next":{"description":"","pages":[]},"user":"5476eb1df3736008009e9ced","hidden":false,"link_url":"","order":2,"parentDoc":null,"updates":[],"excerpt":"","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"status\":{\n        \"isSuccess\":true,\n        \"errorNumber\":0,\n        \"statusKey\":\"SUCCESS\",\n        \"statusMessage\":\"The operation was successful.\"\n    },\n    \"sessionId\":\"ce0a6ef0-63b3-4ae4-8001-a3b100b23ffe\",\n    \"url\":\"https://paygate.paynova.com/Aero/Payment/2/ce0a6ef0-63b3-4ae4-8001-a3b100b23ffe\"\n}","name":""},{"status":200,"language":"json","code":"{\n    \"Status\": {\n        \"IsSuccess\": false,\n        \"ErrorNumber\": -2,\n        \"StatusKey\": \"VALIDATION_ERROR\",\n        \"StatusMessage\": \"The request contained one or more validation errors.  See the errors collection for further details.\",\n        \"Errors\": [\n            {\n                \"ErrorCode\": \"Length\",\n                \"FieldName\": \"TransactionId\",\n                \"Message\": \"'Transaction Id' must be 18 characters in length. You entered 3 characters.\"\n            },\n            {\n                \"ErrorCode\": \"RegularExpression\",\n                \"FieldName\": \"TransactionId\",\n                \"Message\": \"'Transaction Id' is not in the correct format.\"\n            }\n          ]","name":"Validation Error"},{"name":"Order Not Found","status":200,"language":"json","code":"{\n    \"Status\": {\n        \"IsSuccess\": false,\n        \"ErrorNumber\": 3000,\n        \"StatusKey\": \"ORDER_NOT_FOUND\",\n        \"StatusMessage\": \"The specified order was not found.\",\n        \"Errors\": null,\n        \"ExceptionDetails\": null\n    },\n    \"SessionId\": \"00000000-0000-0000-0000-000000000000\",\n    \"Url\": null\n}"}]},"settings":"","url":"/orders/{orderId}/initializePayment","auth":"required","examples":{"codes":[{"code":"\"POST\" https://api.paynova.com/orders/53d0cf82-8711-4237-a02a-a31c00c56dfc/initializePayment\n\n{\n  \"totalAmount\":100.00,\n  \"paymentChannelId\":1,\n  \"paymentMethods\": [\n   {\n       \"id\": \"311\"\n   }\n    ],\n  \"interfaceOptions\": {\n      \"interfaceId\":5,\n      \"layoutName\":\"Paynova_Fullpage_1\",\n      \"customerLanguageCode\":\"SWE\",\n      \"urlRedirectSuccess\":\"http://myshop.com/success\",\n      \"urlRedirectCancel\":\"http://myshop.com/cancel\",\n      \"urlRedirectPending\":\"http://myshop.com/pending\",\n    \"urlCallback\":\"http://requestb.in/osdj3jos\"\n     }\n}","name":"Initialize Payment Session","language":"json"}]},"method":"post"},"body":"The **Initialize Payment** service is used to create a payment session for a previously created order in Paynova's system. You will receive an identifier (GUID) for the payment session. \n\n\n\n## HTTP Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /orders/{orderId}/initializePayment\",\n      \"language\": \"http\",\n      \"name\": \"HTTP\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"When a payment session is successfully created, Paynova will POST-redirect the customer back to your server upon completion of the payment session using one of the URLs provided. For more information see [`POST-redirect`:fa-external-link-square:](post-redirect)\"\n}\n[/block]\n##Request Parameters \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`orderId`\\n*required*\",\n    \"1-0\": \"`totalAmount`\\n*required*\",\n    \"2-0\": \"`paymentChannelId`\\n*required*\",\n    \"3-0\": \"`paymentMethods`\\n*required*\",\n    \"4-0\": \"`customData`\\n***optional***\",\n    \"5-0\": \"`sessionTimeout`\\n***optional***\",\n    \"6-0\": \"`routingIndicator`\\n***conditional***\",\n    \"7-0\": \"`fraudScreeningProfile`\\n***conditional***\",\n    \"8-0\": \"`interfaceOptions`\\n***optional***\",\n    \"9-0\": \"`lineItems`\\n***conditional***\",\n    \"0-2\": \"The unique order identifier that you received from Paynova in the Create Order response.\\n\\n**Example:** `\\\"1bee7570-76c0-495b-bc0a-a43300d0410c\\\"`\",\n    \"5-2\": \"The time-to-live (TTL) of the session, in seconds, before the session times out.\\n\\n**Constraints:**\\n> sessionTimeout must be between 180 and 28800 seconds.\\n\\n**Example:** `900`\",\n    \"7-2\": \"The name or id of the fraud screening profile (named set of fraud screening rules) to use.\\n\\n**Conditions:**\\n > This field is used for advanced configurations and should only be provided if asked to do so by Paynova. Providing an invalid or incorrect value in this field may result in transactions being incorrectly accepted/declined by the fraud screening provider.\",\n    \"9-2\": \"Line items included in this payment. \\n\\n**Conditions:**\\n> Line items are required when initializing a payment session for an amount less than the original order total.\\n\\n**Example:** \\n``` \\n{\\n         \\\"Id\\\":\\\"1\\\",    \\n         \\\"ArticleNumber\\\":1000,        \\n         \\\"Name\\\":\\\"Some product\\\",        \\n         \\\"Description\\\":\\\"Some product description\\\",\\n         \\\"ProductUrl\\\":\\\"http://myshop.com/products/1000\\\",\\n         \\\"Quantity\\\":4,\\n         \\\"UnitMeasure\\\":\\\"st\\\",\\n         \\\"UnitAmountExcludingTax\\\":20,\\n         \\\"TaxPercent\\\":25,\\n         \\\"TotalLineTaxAmount\\\":20,\\n         \\\"TotalLineAmount\\\":100,\\n         \\\"LineItemGroupKey\\\":null\\n      }\\n```\",\n    \"1-2\": \"The total amount that should be processed for this payment. \\n\\n**Constraints:**\\n<ul>\\n<li> Please be sure to use a decimal point as the decimal separator. Commas are not supported.</li>\\n<li>Only two digits may be specified after the decimal point.</li>\\n<li> This must be equal to or less than the original order amount, and less than the original order amount minus any payments which have been already made on the order. </li>\\n<li>For Japanese Yuan (JPY), only whole numbers are allowed.\\n</li>\\n</ul>\\n\\n**Example:** `125.00`\",\n    \"6-2\": \"The name or id of the routing table to use when processing payments.\\n\\n**Conditions:** \\n> This field is used for advanced configurations and should only be provided if asked to do so by Paynova. Providing an invalid value in this field may result in payment failures.\\n\\n**Example:** `\\\"4658\\\"`\",\n    \"3-2\": \"The id's for the payments methods to display on the hosted payment page. The full list of available payment methods are available [here](doc:paymentmethods).\\n\\n**Example:** `311`\\n\\n```\\n{\\n\\n     \\\"id\\\": \\\"311\\\"\\n\\n}\\n```\",\n    \"2-2\": \"The id of the payment channel.\\n\\nSee [paymentChannelId](doc:paymentchannelid) page for possible values.\\n\\n**Example:** `1`\",\n    \"2-1\": \"`int`\",\n    \"0-1\": \"`guid`\",\n    \"1-1\": \"`decimal`\",\n    \"3-1\": \"`array`\",\n    \"4-1\": \"[`customData`:fa-external-link-square:](doc:customdata)\",\n    \"5-1\": \"`int`\",\n    \"6-1\": \"`string`\",\n    \"8-1\": \"[`interfaceoption`:fa-external-link-square:](doc:interfaceoptions)\",\n    \"9-1\": \"[`lineitem`:fa-external-link-square:](doc:lineitem)\",\n    \"4-2\": \"Collection of up to 10 private key-value data fields to store as metadata on the transaction. This data can be viewed in Merchant Services and is returned in the GetOrder response object. We do not use this data for processing transactions.\\n\\n**Example:** \\n\\n```\\n{\\n\\n\\tkey: AAAAA,\\n\\tvalue: 123456\\n\\n}\\n```\",\n    \"7-1\": \"`string`\",\n    \"8-2\": \"Interface options for the hosted payment page.\\n\\n**Example:** \\n```\\n{\\n      \\\"interfaceId\\\":5,\\n      \\\"layoutName\\\":\\\"Paynova_Fullpage_1\\\",\\n      \\\"customerLanguageCode\\\":\\\"SWE\\\",\\n      \\\"urlRedirectSuccess\\\":\\\"http://myshop.com/success\\\",\\n      \\\"urlRedirectCancel\\\":\\\"http://myshop.com/cancel\\\",\\n      \\\"urlRedirectPending\\\":\\\"http://myshop.com/pending\\\",\\n    \\\"urlCallback\\\":\\\"http://requestb.in/osdj3jos\\\"\\n     }\\n    ```\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]\n## Response Parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`Status`\\n*required*\",\n    \"0-1\": \"[`status`:fa-external-link-square:](doc:status)\",\n    \"0-2\": \"API operation status.\\n\\n**Example:**    \\n```\\n{\\n\\\"isSuccess\\\":true,\\n        \\\"errorNumber\\\":0,\\n        \\\"statusKey\\\":\\\"SUCCESS\\n    \\\"statusMessage\\\":\\\"The operation was successful.\\\"}\\n```\",\n    \"1-0\": \"`SessionId`\\n***conditional***\",\n    \"1-1\": \"`guid`\",\n    \"2-0\": \"`Url`\\n***conditional***\",\n    \"2-1\": \"`string`\",\n    \"1-2\": \"The id of the payment session.\\n\\n**Conditions:**\\n> This parameter is not returned in error situations.\\n\\n**Example:** `\\\"ce0a6ef0-63b3-4ae4-8001-a3b100b23ffe\\\"`\",\n    \"2-2\": \"The url to which the user should be redirected to complete the payment.\\n\\n**Conditions:**\\n> This parameter is not returned in error situations.\\n\\n**Example:** ```\\\"https://paygate.paynova.com/Aero/Payment/2/ce0a6ef0-63b3-4ae4-8001-a3b100b23ffe\\\"```\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","createdAt":"2015-02-02T07:21:55.609Z","githubsync":"","isReference":true,"sync_unique":"","__v":1,"version":"54930e7c777ff221004a7e70","type":"post","link_external":false,"project":"54930e7c777ff221004a7e6d","slug":"initialize-payment","title":"Initialize payment","category":"54cf2533a9e1cf0d005c89fe","childrenPages":[]}

postInitialize payment


The **Initialize Payment** service is used to create a payment session for a previously created order in Paynova's system. You will receive an identifier (GUID) for the payment session. ## HTTP Request [block:code] { "codes": [ { "code": "POST /orders/{orderId}/initializePayment", "language": "http", "name": "HTTP" } ] } [/block] [block:callout] { "type": "info", "body": "When a payment session is successfully created, Paynova will POST-redirect the customer back to your server upon completion of the payment session using one of the URLs provided. For more information see [`POST-redirect`:fa-external-link-square:](post-redirect)" } [/block] ##Request Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`orderId`\n*required*", "1-0": "`totalAmount`\n*required*", "2-0": "`paymentChannelId`\n*required*", "3-0": "`paymentMethods`\n*required*", "4-0": "`customData`\n***optional***", "5-0": "`sessionTimeout`\n***optional***", "6-0": "`routingIndicator`\n***conditional***", "7-0": "`fraudScreeningProfile`\n***conditional***", "8-0": "`interfaceOptions`\n***optional***", "9-0": "`lineItems`\n***conditional***", "0-2": "The unique order identifier that you received from Paynova in the Create Order response.\n\n**Example:** `\"1bee7570-76c0-495b-bc0a-a43300d0410c\"`", "5-2": "The time-to-live (TTL) of the session, in seconds, before the session times out.\n\n**Constraints:**\n> sessionTimeout must be between 180 and 28800 seconds.\n\n**Example:** `900`", "7-2": "The name or id of the fraud screening profile (named set of fraud screening rules) to use.\n\n**Conditions:**\n > This field is used for advanced configurations and should only be provided if asked to do so by Paynova. Providing an invalid or incorrect value in this field may result in transactions being incorrectly accepted/declined by the fraud screening provider.", "9-2": "Line items included in this payment. \n\n**Conditions:**\n> Line items are required when initializing a payment session for an amount less than the original order total.\n\n**Example:** \n``` \n{\n \"Id\":\"1\", \n \"ArticleNumber\":1000, \n \"Name\":\"Some product\", \n \"Description\":\"Some product description\",\n \"ProductUrl\":\"http://myshop.com/products/1000\",\n \"Quantity\":4,\n \"UnitMeasure\":\"st\",\n \"UnitAmountExcludingTax\":20,\n \"TaxPercent\":25,\n \"TotalLineTaxAmount\":20,\n \"TotalLineAmount\":100,\n \"LineItemGroupKey\":null\n }\n```", "1-2": "The total amount that should be processed for this payment. \n\n**Constraints:**\n<ul>\n<li> Please be sure to use a decimal point as the decimal separator. Commas are not supported.</li>\n<li>Only two digits may be specified after the decimal point.</li>\n<li> This must be equal to or less than the original order amount, and less than the original order amount minus any payments which have been already made on the order. </li>\n<li>For Japanese Yuan (JPY), only whole numbers are allowed.\n</li>\n</ul>\n\n**Example:** `125.00`", "6-2": "The name or id of the routing table to use when processing payments.\n\n**Conditions:** \n> This field is used for advanced configurations and should only be provided if asked to do so by Paynova. Providing an invalid value in this field may result in payment failures.\n\n**Example:** `\"4658\"`", "3-2": "The id's for the payments methods to display on the hosted payment page. The full list of available payment methods are available [here](doc:paymentmethods).\n\n**Example:** `311`\n\n```\n{\n\n \"id\": \"311\"\n\n}\n```", "2-2": "The id of the payment channel.\n\nSee [paymentChannelId](doc:paymentchannelid) page for possible values.\n\n**Example:** `1`", "2-1": "`int`", "0-1": "`guid`", "1-1": "`decimal`", "3-1": "`array`", "4-1": "[`customData`:fa-external-link-square:](doc:customdata)", "5-1": "`int`", "6-1": "`string`", "8-1": "[`interfaceoption`:fa-external-link-square:](doc:interfaceoptions)", "9-1": "[`lineitem`:fa-external-link-square:](doc:lineitem)", "4-2": "Collection of up to 10 private key-value data fields to store as metadata on the transaction. This data can be viewed in Merchant Services and is returned in the GetOrder response object. We do not use this data for processing transactions.\n\n**Example:** \n\n```\n{\n\n\tkey: AAAAA,\n\tvalue: 123456\n\n}\n```", "7-1": "`string`", "8-2": "Interface options for the hosted payment page.\n\n**Example:** \n```\n{\n \"interfaceId\":5,\n \"layoutName\":\"Paynova_Fullpage_1\",\n \"customerLanguageCode\":\"SWE\",\n \"urlRedirectSuccess\":\"http://myshop.com/success\",\n \"urlRedirectCancel\":\"http://myshop.com/cancel\",\n \"urlRedirectPending\":\"http://myshop.com/pending\",\n \"urlCallback\":\"http://requestb.in/osdj3jos\"\n }\n ```" }, "cols": 3, "rows": 10 } [/block] ## Response Parameters [block:parameters] { "data": { "0-0": "`Status`\n*required*", "0-1": "[`status`:fa-external-link-square:](doc:status)", "0-2": "API operation status.\n\n**Example:** \n```\n{\n\"isSuccess\":true,\n \"errorNumber\":0,\n \"statusKey\":\"SUCCESS\n \"statusMessage\":\"The operation was successful.\"}\n```", "1-0": "`SessionId`\n***conditional***", "1-1": "`guid`", "2-0": "`Url`\n***conditional***", "2-1": "`string`", "1-2": "The id of the payment session.\n\n**Conditions:**\n> This parameter is not returned in error situations.\n\n**Example:** `\"ce0a6ef0-63b3-4ae4-8001-a3b100b23ffe\"`", "2-2": "The url to which the user should be redirected to complete the payment.\n\n**Conditions:**\n> This parameter is not returned in error situations.\n\n**Example:** ```\"https://paygate.paynova.com/Aero/Payment/2/ce0a6ef0-63b3-4ae4-8001-a3b100b23ffe\"```" }, "cols": 3, "rows": 3 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The **Initialize Payment** service is used to create a payment session for a previously created order in Paynova's system. You will receive an identifier (GUID) for the payment session. ## HTTP Request [block:code] { "codes": [ { "code": "POST /orders/{orderId}/initializePayment", "language": "http", "name": "HTTP" } ] } [/block] [block:callout] { "type": "info", "body": "When a payment session is successfully created, Paynova will POST-redirect the customer back to your server upon completion of the payment session using one of the URLs provided. For more information see [`POST-redirect`:fa-external-link-square:](post-redirect)" } [/block] ##Request Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`orderId`\n*required*", "1-0": "`totalAmount`\n*required*", "2-0": "`paymentChannelId`\n*required*", "3-0": "`paymentMethods`\n*required*", "4-0": "`customData`\n***optional***", "5-0": "`sessionTimeout`\n***optional***", "6-0": "`routingIndicator`\n***conditional***", "7-0": "`fraudScreeningProfile`\n***conditional***", "8-0": "`interfaceOptions`\n***optional***", "9-0": "`lineItems`\n***conditional***", "0-2": "The unique order identifier that you received from Paynova in the Create Order response.\n\n**Example:** `\"1bee7570-76c0-495b-bc0a-a43300d0410c\"`", "5-2": "The time-to-live (TTL) of the session, in seconds, before the session times out.\n\n**Constraints:**\n> sessionTimeout must be between 180 and 28800 seconds.\n\n**Example:** `900`", "7-2": "The name or id of the fraud screening profile (named set of fraud screening rules) to use.\n\n**Conditions:**\n > This field is used for advanced configurations and should only be provided if asked to do so by Paynova. Providing an invalid or incorrect value in this field may result in transactions being incorrectly accepted/declined by the fraud screening provider.", "9-2": "Line items included in this payment. \n\n**Conditions:**\n> Line items are required when initializing a payment session for an amount less than the original order total.\n\n**Example:** \n``` \n{\n \"Id\":\"1\", \n \"ArticleNumber\":1000, \n \"Name\":\"Some product\", \n \"Description\":\"Some product description\",\n \"ProductUrl\":\"http://myshop.com/products/1000\",\n \"Quantity\":4,\n \"UnitMeasure\":\"st\",\n \"UnitAmountExcludingTax\":20,\n \"TaxPercent\":25,\n \"TotalLineTaxAmount\":20,\n \"TotalLineAmount\":100,\n \"LineItemGroupKey\":null\n }\n```", "1-2": "The total amount that should be processed for this payment. \n\n**Constraints:**\n<ul>\n<li> Please be sure to use a decimal point as the decimal separator. Commas are not supported.</li>\n<li>Only two digits may be specified after the decimal point.</li>\n<li> This must be equal to or less than the original order amount, and less than the original order amount minus any payments which have been already made on the order. </li>\n<li>For Japanese Yuan (JPY), only whole numbers are allowed.\n</li>\n</ul>\n\n**Example:** `125.00`", "6-2": "The name or id of the routing table to use when processing payments.\n\n**Conditions:** \n> This field is used for advanced configurations and should only be provided if asked to do so by Paynova. Providing an invalid value in this field may result in payment failures.\n\n**Example:** `\"4658\"`", "3-2": "The id's for the payments methods to display on the hosted payment page. The full list of available payment methods are available [here](doc:paymentmethods).\n\n**Example:** `311`\n\n```\n{\n\n \"id\": \"311\"\n\n}\n```", "2-2": "The id of the payment channel.\n\nSee [paymentChannelId](doc:paymentchannelid) page for possible values.\n\n**Example:** `1`", "2-1": "`int`", "0-1": "`guid`", "1-1": "`decimal`", "3-1": "`array`", "4-1": "[`customData`:fa-external-link-square:](doc:customdata)", "5-1": "`int`", "6-1": "`string`", "8-1": "[`interfaceoption`:fa-external-link-square:](doc:interfaceoptions)", "9-1": "[`lineitem`:fa-external-link-square:](doc:lineitem)", "4-2": "Collection of up to 10 private key-value data fields to store as metadata on the transaction. This data can be viewed in Merchant Services and is returned in the GetOrder response object. We do not use this data for processing transactions.\n\n**Example:** \n\n```\n{\n\n\tkey: AAAAA,\n\tvalue: 123456\n\n}\n```", "7-1": "`string`", "8-2": "Interface options for the hosted payment page.\n\n**Example:** \n```\n{\n \"interfaceId\":5,\n \"layoutName\":\"Paynova_Fullpage_1\",\n \"customerLanguageCode\":\"SWE\",\n \"urlRedirectSuccess\":\"http://myshop.com/success\",\n \"urlRedirectCancel\":\"http://myshop.com/cancel\",\n \"urlRedirectPending\":\"http://myshop.com/pending\",\n \"urlCallback\":\"http://requestb.in/osdj3jos\"\n }\n ```" }, "cols": 3, "rows": 10 } [/block] ## Response Parameters [block:parameters] { "data": { "0-0": "`Status`\n*required*", "0-1": "[`status`:fa-external-link-square:](doc:status)", "0-2": "API operation status.\n\n**Example:** \n```\n{\n\"isSuccess\":true,\n \"errorNumber\":0,\n \"statusKey\":\"SUCCESS\n \"statusMessage\":\"The operation was successful.\"}\n```", "1-0": "`SessionId`\n***conditional***", "1-1": "`guid`", "2-0": "`Url`\n***conditional***", "2-1": "`string`", "1-2": "The id of the payment session.\n\n**Conditions:**\n> This parameter is not returned in error situations.\n\n**Example:** `\"ce0a6ef0-63b3-4ae4-8001-a3b100b23ffe\"`", "2-2": "The url to which the user should be redirected to complete the payment.\n\n**Conditions:**\n> This parameter is not returned in error situations.\n\n**Example:** ```\"https://paygate.paynova.com/Aero/Payment/2/ce0a6ef0-63b3-4ae4-8001-a3b100b23ffe\"```" }, "cols": 3, "rows": 3 } [/block]
{"_id":"54cf25f1a9e1cf0d005c8a05","category":"54cf2533a9e1cf0d005c89fe","project":"54930e7c777ff221004a7e6d","slug":"finalize-authorization","updates":[],"type":"post","version":"54930e7c777ff221004a7e70","api":{"auth":"required","examples":{"codes":[{"name":"Finalize Using Order ID","language":"json","code":"\"POST\" https://api.paynova.com/orders/47bf277b-17b0-4d8b-b9c9-a3b100dbb21c/transactions/201409251527280673/finalize/125.00"},{"name":"Finalize Using Transaction ID ","language":"json","code":"\"POST\" https://api.paynova.com/transactions/201611201742550301/finalize/125.00"}]},"method":"post","params":[],"results":{"codes":[{"name":"","code":"{\n  \"status\": {\n    \"isSuccess\": true,\n    \"errorNumber\": 0,\n    \"statusKey\": \"SUCCESS\",\n    \"statusMessage\": \"The operation was successful.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  },\n  \"totalAmountFinalized\": \"125\",\n  \"totalAmountPendingFinalization\": \"0\",\n  \"canFinalizeAgain\": false,\n  \"amountRemainingForFinalization\": \"0\",\n  \"transactionId\": \"201611201803594004\",\n  \"batchId\": null,\n  \"acquirerId\": \"1045\"\n}","language":"json","status":200},{"status":200,"name":"Validation Error","code":"{\n    \"Status\": {\n        \"IsSuccess\": false,\n        \"ErrorNumber\": -2,\n        \"StatusKey\": \"VALIDATION_ERROR\",\n        \"StatusMessage\": \"The request contained one or more validation errors.  See the errors collection for further details.\",\n        \"Errors\": [\n            {\n                \"ErrorCode\": \"Length\",\n                \"FieldName\": \"TransactionId\",\n                \"Message\": \"'Transaction Id' must be 18 characters in length. You entered 8 characters.\"\n            },\n            {\n                \"ErrorCode\": \"RegularExpression\",\n                \"FieldName\": \"TransactionId\",\n                \"Message\": \"'Transaction Id' is not in the correct format.\"\n            }\n        ],\n        \"ExceptionDetails\": null\n    },\n    \"TotalAmountFinalized\": 0,\n    \"TotalAmountPendingFinalization\": 0,\n    \"CanFinalizeAgain\": false,\n    \"AmountRemainingForFinalization\": 0,\n    \"TransactionId\": null,\n    \"BatchId\": null,\n    \"AcquirerId\": null\n}","language":"json"},{"name":"Cannot Finalize Payment","status":200,"language":"json","code":"{\n  \"status\": {\n    \"isSuccess\": false,\n    \"errorNumber\": 3012,\n    \"statusKey\": \"CANNOT_FINALIZE_PAYMENT\",\n    \"statusMessage\": \"The payment provider implementation indicated that the payment cannot be finalized in its current state.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  },\n  \"totalAmountFinalized\": \"0\",\n  \"totalAmountPendingFinalization\": \"0\",\n  \"canFinalizeAgain\": false,\n  \"amountRemainingForFinalization\": \"0\",\n  \"transactionId\": null,\n  \"batchId\": null,\n  \"acquirerId\": null\n}"}]},"settings":"","url":"/orders/{OrderId}/transactions/{transactionId}/finalize/{totalAmount}"},"body":"The **Finalize Authorization** service is used to finalize all or part of an authorization.\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Depending on the payment method this service will have different results. See the following table for information about different payment method types.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Please note that due to GDPR requirements, an invoice must be finalized within 90 days of it's created date.\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Payment method\",\n    \"h-1\": \"Result\",\n    \"h-2\": \"Comments\",\n    \"0-0\": \"Invoice/installments\",\n    \"0-1\": \"The order will be activated and the first invoice will be sent out.\",\n    \"0-2\": \"Currently, only finalization of the full order amount is supported.\",\n    \"2-0\": \"Internet Banks\",\n    \"2-1\": \"This method is not used because internet banks are automatically finalized.\",\n    \"1-0\": \"Credit/Debit Cards\",\n    \"1-1\": \"The authorization will be captured.\",\n    \"1-2\": \"You may finalize an authorization only once. The capture amount must be equal to or less than the original authorized amount.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n## HTTP Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /orders/{orderId}/transactions/{transactionId}/finalize/{totalAmount}\\n\",\n      \"language\": \"http\",\n      \"name\": \"Finalize Using Order ID \"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /transactions/{transactionId}/finalize/{totalAmount}\",\n      \"language\": \"http\",\n      \"name\": \"Finalize Using Transaction ID\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Note: When using the REST endpoints, the values supplied in the REST paths do not need to be supplied in the request body/object and will be used instead of values provided in the request body/object.\"\n}\n[/block]\n##Request Parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`orderId`\\n***conditional***\",\n    \"1-0\": \"`transactionId `\\n*required*\",\n    \"2-0\": \"`totalAmount `\\n*required*\",\n    \"3-0\": \"`lineItems`\\n***conditional***\",\n    \"4-0\": \"` `\",\n    \"5-0\": \"` `\",\n    \"6-0\": \"` `\",\n    \"7-0\": \"` `\",\n    \"8-0\": \"` `\",\n    \"0-2\": \"The unique ID you received from Paynova to identify the order.\\n\\n**Conditions:**\\n> Required if finalizing using order ID.\\n\\n**Example:** `\\\"1bee7570-76c0-495b-bc0a-a43300d0410c\\\"`\",\n    \"1-2\": \"The unique ID of the authorization transaction that you received from Paynova.\\n\\n**Example:** `\\\"201412161427444300\\\"`\",\n    \"2-2\": \"The total amount to finalize. \\n\\n**Constraints:**\\n<ul>\\n<li> Please be sure to use a decimal point as the decimal separator. Commas are not supported.</li>\\n<li>Only two digits may be specified after the decimal point.</li>\\n<li> This must be equal to or less than the original order amount, and less than the original order amount minus any payments which have been already made on the order. </li>\\n<li>For Japanese Yuan (JPY), only whole numbers are allowed.\\n</li>\\n</ul>\\n\\n**Example:** `125.00`\",\n    \"3-1\": \"[`lineitem`:fa-external-link-square:](doc:lineitem)\",\n    \"3-2\": \"Line items included in this authorization.\\n \\n**Conditions**\\n> Line items are only required for detailed orders and when authorizing an amount less than the corresponding payment amount.\\n\\n> Line items are only allowed when the original order was a detailed order.\\n\\nSee [Orders](doc:orders) for more information on detailed vs. simple orders.\",\n    \"0-1\": \"`guid`\",\n    \"1-1\": \"`string(18)`\",\n    \"2-1\": \"`decimal`\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n## Response parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`status`\\n*required*\",\n    \"0-1\": \"[`status`:fa-external-link-square:](doc:status)\",\n    \"0-2\": \"API operation status.\\n\\n**Example:** \\n```\\n{\\n        \\\"isSuccess\\\":true,\\n        \\\"errorNumber\\\":0,\\n        \\\"statusKey\\\":\\\"SUCCESS\\\",\\n        \\\"statusMessage\\\":\\\"The operation was successful.\\\"    \\n}\\n```\",\n    \"1-0\": \"`canFinalizeAgain`\\n*required*\",\n    \"1-1\": \"`boolean`\",\n    \"1-2\": \"Indicates whether or not the authorization can accept more finalizations.\\n\\n**Example:** `true`, `false`\",\n    \"2-0\": \"`amountRemainingForFinalize`\\n*required*\",\n    \"2-1\": \"`decimal`\",\n    \"2-2\": \"Indicates the amount remaining to be finalized for the authorization. \\n\\n**Constraints**\\n> If `\\\"canFinalizeAgain\\\"` is `false`, the value for this property will be `0.00`.\\n\\n**Example:** `0.00`\",\n    \"3-0\": \"`transactionId`\\n***conditional***\",\n    \"3-1\": \"`string(18)`\",\n    \"3-2\": \"Paynova's transaction id for the finalization.\\n\\n**Conditions**\\n> This parameter will not be returned in error situations.\\n\\n**Example:** `\\\"201502090957016672\\\"`\",\n    \"4-0\": \"`batchId`\\n***conditional***\",\n    \"4-1\": \"`string`\",\n    \"4-2\": \"Settlement batch ID.\\n\\n**Conditions:**\\n> Only returned for payment methods which are batched nightly (for example, credit cards).\\n\\n**Example:** `\\\"268030203046\\\"`\",\n    \"5-0\": \"`acquirerId`\\n***conditional***\",\n    \"5-1\": \"`string`\",\n    \"5-2\": \"Paynova's ID for the acquirer of the transaction.\\n\\n**Conditions**\\n> This parameter will not be returned in error situations.\\n\\n**Example:** `\\\"1010\\\"`\",\n    \"6-0\": \"`totalAmountFinalized`\\n**required**\",\n    \"6-1\": \"`decimal`\",\n    \"7-0\": \"`totalAmountPendingFinalization`\\n**required**\",\n    \"7-1\": \"`decimal`\",\n    \"6-2\": \"The total amount that has been finalized.\\n\\n**Example:** `100.0`\",\n    \"7-2\": \"Indicates the amount pending to be finalized for the authorization. \\n\\n**Example:** `0.00`\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]","next":{"description":"","pages":[]},"parentDoc":null,"sync_unique":"","link_url":"","order":3,"createdAt":"2015-02-02T07:23:29.414Z","excerpt":"","hidden":false,"isReference":true,"link_external":false,"__v":1,"githubsync":"","title":"Finalize authorization","user":"5476eb1df3736008009e9ced","childrenPages":[]}

postFinalize authorization


The **Finalize Authorization** service is used to finalize all or part of an authorization. [block:callout] { "type": "info", "body": "Depending on the payment method this service will have different results. See the following table for information about different payment method types." } [/block] [block:callout] { "type": "info", "body": "Please note that due to GDPR requirements, an invoice must be finalized within 90 days of it's created date." } [/block] [block:parameters] { "data": { "h-0": "Payment method", "h-1": "Result", "h-2": "Comments", "0-0": "Invoice/installments", "0-1": "The order will be activated and the first invoice will be sent out.", "0-2": "Currently, only finalization of the full order amount is supported.", "2-0": "Internet Banks", "2-1": "This method is not used because internet banks are automatically finalized.", "1-0": "Credit/Debit Cards", "1-1": "The authorization will be captured.", "1-2": "You may finalize an authorization only once. The capture amount must be equal to or less than the original authorized amount." }, "cols": 3, "rows": 3 } [/block] ## HTTP Request [block:code] { "codes": [ { "code": "POST /orders/{orderId}/transactions/{transactionId}/finalize/{totalAmount}\n", "language": "http", "name": "Finalize Using Order ID " } ] } [/block] [block:code] { "codes": [ { "code": "POST /transactions/{transactionId}/finalize/{totalAmount}", "language": "http", "name": "Finalize Using Transaction ID" } ] } [/block] [block:callout] { "type": "info", "body": "Note: When using the REST endpoints, the values supplied in the REST paths do not need to be supplied in the request body/object and will be used instead of values provided in the request body/object." } [/block] ##Request Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`orderId`\n***conditional***", "1-0": "`transactionId `\n*required*", "2-0": "`totalAmount `\n*required*", "3-0": "`lineItems`\n***conditional***", "4-0": "` `", "5-0": "` `", "6-0": "` `", "7-0": "` `", "8-0": "` `", "0-2": "The unique ID you received from Paynova to identify the order.\n\n**Conditions:**\n> Required if finalizing using order ID.\n\n**Example:** `\"1bee7570-76c0-495b-bc0a-a43300d0410c\"`", "1-2": "The unique ID of the authorization transaction that you received from Paynova.\n\n**Example:** `\"201412161427444300\"`", "2-2": "The total amount to finalize. \n\n**Constraints:**\n<ul>\n<li> Please be sure to use a decimal point as the decimal separator. Commas are not supported.</li>\n<li>Only two digits may be specified after the decimal point.</li>\n<li> This must be equal to or less than the original order amount, and less than the original order amount minus any payments which have been already made on the order. </li>\n<li>For Japanese Yuan (JPY), only whole numbers are allowed.\n</li>\n</ul>\n\n**Example:** `125.00`", "3-1": "[`lineitem`:fa-external-link-square:](doc:lineitem)", "3-2": "Line items included in this authorization.\n \n**Conditions**\n> Line items are only required for detailed orders and when authorizing an amount less than the corresponding payment amount.\n\n> Line items are only allowed when the original order was a detailed order.\n\nSee [Orders](doc:orders) for more information on detailed vs. simple orders.", "0-1": "`guid`", "1-1": "`string(18)`", "2-1": "`decimal`" }, "cols": 3, "rows": 4 } [/block] ## Response parameters [block:parameters] { "data": { "0-0": "`status`\n*required*", "0-1": "[`status`:fa-external-link-square:](doc:status)", "0-2": "API operation status.\n\n**Example:** \n```\n{\n \"isSuccess\":true,\n \"errorNumber\":0,\n \"statusKey\":\"SUCCESS\",\n \"statusMessage\":\"The operation was successful.\" \n}\n```", "1-0": "`canFinalizeAgain`\n*required*", "1-1": "`boolean`", "1-2": "Indicates whether or not the authorization can accept more finalizations.\n\n**Example:** `true`, `false`", "2-0": "`amountRemainingForFinalize`\n*required*", "2-1": "`decimal`", "2-2": "Indicates the amount remaining to be finalized for the authorization. \n\n**Constraints**\n> If `\"canFinalizeAgain\"` is `false`, the value for this property will be `0.00`.\n\n**Example:** `0.00`", "3-0": "`transactionId`\n***conditional***", "3-1": "`string(18)`", "3-2": "Paynova's transaction id for the finalization.\n\n**Conditions**\n> This parameter will not be returned in error situations.\n\n**Example:** `\"201502090957016672\"`", "4-0": "`batchId`\n***conditional***", "4-1": "`string`", "4-2": "Settlement batch ID.\n\n**Conditions:**\n> Only returned for payment methods which are batched nightly (for example, credit cards).\n\n**Example:** `\"268030203046\"`", "5-0": "`acquirerId`\n***conditional***", "5-1": "`string`", "5-2": "Paynova's ID for the acquirer of the transaction.\n\n**Conditions**\n> This parameter will not be returned in error situations.\n\n**Example:** `\"1010\"`", "6-0": "`totalAmountFinalized`\n**required**", "6-1": "`decimal`", "7-0": "`totalAmountPendingFinalization`\n**required**", "7-1": "`decimal`", "6-2": "The total amount that has been finalized.\n\n**Example:** `100.0`", "7-2": "Indicates the amount pending to be finalized for the authorization. \n\n**Example:** `0.00`" }, "cols": 3, "rows": 8 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The **Finalize Authorization** service is used to finalize all or part of an authorization. [block:callout] { "type": "info", "body": "Depending on the payment method this service will have different results. See the following table for information about different payment method types." } [/block] [block:callout] { "type": "info", "body": "Please note that due to GDPR requirements, an invoice must be finalized within 90 days of it's created date." } [/block] [block:parameters] { "data": { "h-0": "Payment method", "h-1": "Result", "h-2": "Comments", "0-0": "Invoice/installments", "0-1": "The order will be activated and the first invoice will be sent out.", "0-2": "Currently, only finalization of the full order amount is supported.", "2-0": "Internet Banks", "2-1": "This method is not used because internet banks are automatically finalized.", "1-0": "Credit/Debit Cards", "1-1": "The authorization will be captured.", "1-2": "You may finalize an authorization only once. The capture amount must be equal to or less than the original authorized amount." }, "cols": 3, "rows": 3 } [/block] ## HTTP Request [block:code] { "codes": [ { "code": "POST /orders/{orderId}/transactions/{transactionId}/finalize/{totalAmount}\n", "language": "http", "name": "Finalize Using Order ID " } ] } [/block] [block:code] { "codes": [ { "code": "POST /transactions/{transactionId}/finalize/{totalAmount}", "language": "http", "name": "Finalize Using Transaction ID" } ] } [/block] [block:callout] { "type": "info", "body": "Note: When using the REST endpoints, the values supplied in the REST paths do not need to be supplied in the request body/object and will be used instead of values provided in the request body/object." } [/block] ##Request Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`orderId`\n***conditional***", "1-0": "`transactionId `\n*required*", "2-0": "`totalAmount `\n*required*", "3-0": "`lineItems`\n***conditional***", "4-0": "` `", "5-0": "` `", "6-0": "` `", "7-0": "` `", "8-0": "` `", "0-2": "The unique ID you received from Paynova to identify the order.\n\n**Conditions:**\n> Required if finalizing using order ID.\n\n**Example:** `\"1bee7570-76c0-495b-bc0a-a43300d0410c\"`", "1-2": "The unique ID of the authorization transaction that you received from Paynova.\n\n**Example:** `\"201412161427444300\"`", "2-2": "The total amount to finalize. \n\n**Constraints:**\n<ul>\n<li> Please be sure to use a decimal point as the decimal separator. Commas are not supported.</li>\n<li>Only two digits may be specified after the decimal point.</li>\n<li> This must be equal to or less than the original order amount, and less than the original order amount minus any payments which have been already made on the order. </li>\n<li>For Japanese Yuan (JPY), only whole numbers are allowed.\n</li>\n</ul>\n\n**Example:** `125.00`", "3-1": "[`lineitem`:fa-external-link-square:](doc:lineitem)", "3-2": "Line items included in this authorization.\n \n**Conditions**\n> Line items are only required for detailed orders and when authorizing an amount less than the corresponding payment amount.\n\n> Line items are only allowed when the original order was a detailed order.\n\nSee [Orders](doc:orders) for more information on detailed vs. simple orders.", "0-1": "`guid`", "1-1": "`string(18)`", "2-1": "`decimal`" }, "cols": 3, "rows": 4 } [/block] ## Response parameters [block:parameters] { "data": { "0-0": "`status`\n*required*", "0-1": "[`status`:fa-external-link-square:](doc:status)", "0-2": "API operation status.\n\n**Example:** \n```\n{\n \"isSuccess\":true,\n \"errorNumber\":0,\n \"statusKey\":\"SUCCESS\",\n \"statusMessage\":\"The operation was successful.\" \n}\n```", "1-0": "`canFinalizeAgain`\n*required*", "1-1": "`boolean`", "1-2": "Indicates whether or not the authorization can accept more finalizations.\n\n**Example:** `true`, `false`", "2-0": "`amountRemainingForFinalize`\n*required*", "2-1": "`decimal`", "2-2": "Indicates the amount remaining to be finalized for the authorization. \n\n**Constraints**\n> If `\"canFinalizeAgain\"` is `false`, the value for this property will be `0.00`.\n\n**Example:** `0.00`", "3-0": "`transactionId`\n***conditional***", "3-1": "`string(18)`", "3-2": "Paynova's transaction id for the finalization.\n\n**Conditions**\n> This parameter will not be returned in error situations.\n\n**Example:** `\"201502090957016672\"`", "4-0": "`batchId`\n***conditional***", "4-1": "`string`", "4-2": "Settlement batch ID.\n\n**Conditions:**\n> Only returned for payment methods which are batched nightly (for example, credit cards).\n\n**Example:** `\"268030203046\"`", "5-0": "`acquirerId`\n***conditional***", "5-1": "`string`", "5-2": "Paynova's ID for the acquirer of the transaction.\n\n**Conditions**\n> This parameter will not be returned in error situations.\n\n**Example:** `\"1010\"`", "6-0": "`totalAmountFinalized`\n**required**", "6-1": "`decimal`", "7-0": "`totalAmountPendingFinalization`\n**required**", "7-1": "`decimal`", "6-2": "The total amount that has been finalized.\n\n**Example:** `100.0`", "7-2": "Indicates the amount pending to be finalized for the authorization. \n\n**Example:** `0.00`" }, "cols": 3, "rows": 8 } [/block]
{"_id":"54cf26d94acee20d001e5307","__v":1,"api":{"method":"post","params":[],"results":{"codes":[{"name":null,"code":"{\n    \"status\":{\n        \"isSuccess\":true,\n        \"errorNumber\":0,\n        \"statusKey\":\"SUCCESS\",\n        \"statusMessage\":\"The operation was successful.\"\n    }\n}","language":"json","status":200},{"status":200,"name":"Annul Amount Exceeded","code":"{\n  \"status\": {\n    \"isSuccess\": false,\n    \"errorNumber\": 3017,\n    \"statusKey\": \"ANNUL_AMT_EXCEEDED\",\n    \"statusMessage\": \"The total amount you have specified in your annul call is greater than the available balance to annul.  Existing annulments and finalizations which are in a pending state also count against the available balance.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  }\n}","language":"json"},{"status":200,"language":"json","code":"{\n  \"status\": {\n    \"isSuccess\": false,\n    \"errorNumber\": 3003,\n    \"statusKey\": \"LINE_ITEMS_REQUIRED\",\n    \"statusMessage\": \"This operation requires that line items be specified for detailed orders when the total amount specified does not equal the original order total amount.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  }\n}","name":"Lineitems Required"}]},"settings":"","url":"/orders/{orderId}/transactions/{transactionId}/annul/{totalAmount}","auth":"required","examples":{"codes":[{"code":"\"POST\" https://api.paynova.com/orders/47bf277b-17b0-4d8b-b9c9-a3b100dbb21c/transactions/201409251527280673/annul/100.00","language":"curl","name":"Annul Authorization"}]}},"hidden":false,"next":{"pages":[],"description":""},"sync_unique":"","body":"**Annul authorization** annuls all or part of an authorization.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Depending on the payment method this service has different results. See the following table for information about different payment method types.\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Invoice/installment\",\n    \"1-0\": \"Credit/Debit Cards\",\n    \"2-0\": \"Internet Banks\",\n    \"0-1\": \"The credit authorization will be cancelled. No invoice will be sent out for this order.\",\n    \"1-1\": \"The authorization will be reversed. A credit/debit card authorization can only be annulled in its entirety. Partial annulments are not supported.\",\n    \"h-0\": \"Payment method\",\n    \"h-1\": \"Result\",\n    \"h-2\": \"Comment\",\n    \"2-1\": \"This method has no effect because internet banks are automatically finalized (there is no authorization).\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n## HTTP Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /orders/{orderId}/transactions/{transactionId}/annul/{totalAmount}\\n\",\n      \"language\": \"http\",\n      \"name\": \"Annul Using Order ID \"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /transactions/{transactionId}/annul/{totalAmount}\",\n      \"language\": \"http\",\n      \"name\": \"Annul Using Transaction ID\"\n    }\n  ]\n}\n[/block]\n\n## REQUEST PARAMETERS\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`transactionId`\\n*required*\",\n    \"0-2\": \"The authorization transaction id you received from Paynova.\",\n    \"1-0\": \"`totalAmount`\\n*required*\",\n    \"1-1\": \"`decimal`\",\n    \"0-1\": \"`guid`\",\n    \"1-2\": \"The total amount to annul.\\n\\n**Conditions:**\\n> Depending on the payment method, partial annullments may or may not be allowed. \\n\\nSee the [Payment Methods](doc:paymentmethods) page for more information.\",\n    \"2-0\": \"`lineItems`\\n***conditional***\",\n    \"2-1\": \"[`lineitem`:fa-external-link-square:](doc:lineitem)\",\n    \"2-2\": \"The line items which are being annulled.\\n\\n**Conditions:**\\n> Line items are only required when annulling an amount less than the original transaction amount.\\n\\n> Line items are only allowed when the original order was a detailed order.\\n\\nSee [Orders](doc:orders) for more information on detailed vs. simple orders.\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"3-0\": \"`customData`\\n\\n***conditional***\",\n    \"3-2\": \"Collection of up to 10 private key-value data fields to store as meta-data on the transaction. This data can be viewed in Merchant Services and is returned in the GetOrder response object.\\n\\n**Conditions:**\\n> We do not use this data for processing transactions.\",\n    \"3-1\": \"[`customData`:fa-external-link-square:](doc:customdata)\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n## RESPONSE PARAMETERS\n[block:parameters]\n{\n  \"data\": {\n    \"h-2\": \"Description\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"0-0\": \"`status`\\n*required*\",\n    \"0-1\": \"[`status`:fa-external-link-square:](doc:status)\",\n    \"0-2\": \"API operation status.\\n\\n**Example:**\\n```\\n{\\n        \\\"isSuccess\\\":true,\\n        \\\"errorNumber\\\":0,\\n        \\\"statusKey\\\":\\\"SUCCESS\\\",\\n        \\\"statusMessage\\\":\\\"The operation was successful.\\\"\\n}\\n```\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]","createdAt":"2015-02-02T07:27:21.934Z","excerpt":"","order":0,"parentDoc":null,"slug":"annul-authorization","category":"54cf2539a9e1cf0d005c89ff","githubsync":"","link_external":false,"link_url":"","type":"post","version":"54930e7c777ff221004a7e70","isReference":true,"project":"54930e7c777ff221004a7e6d","title":"Annul authorization","updates":[],"user":"5476eb1df3736008009e9ced","childrenPages":[]}

postAnnul authorization


**Annul authorization** annuls all or part of an authorization. [block:callout] { "type": "info", "body": "Depending on the payment method this service has different results. See the following table for information about different payment method types." } [/block] [block:parameters] { "data": { "0-0": "Invoice/installment", "1-0": "Credit/Debit Cards", "2-0": "Internet Banks", "0-1": "The credit authorization will be cancelled. No invoice will be sent out for this order.", "1-1": "The authorization will be reversed. A credit/debit card authorization can only be annulled in its entirety. Partial annulments are not supported.", "h-0": "Payment method", "h-1": "Result", "h-2": "Comment", "2-1": "This method has no effect because internet banks are automatically finalized (there is no authorization)." }, "cols": 2, "rows": 3 } [/block] ## HTTP Request [block:code] { "codes": [ { "code": "POST /orders/{orderId}/transactions/{transactionId}/annul/{totalAmount}\n", "language": "http", "name": "Annul Using Order ID " } ] } [/block] [block:code] { "codes": [ { "code": "POST /transactions/{transactionId}/annul/{totalAmount}", "language": "http", "name": "Annul Using Transaction ID" } ] } [/block] ## REQUEST PARAMETERS [block:parameters] { "data": { "0-0": "`transactionId`\n*required*", "0-2": "The authorization transaction id you received from Paynova.", "1-0": "`totalAmount`\n*required*", "1-1": "`decimal`", "0-1": "`guid`", "1-2": "The total amount to annul.\n\n**Conditions:**\n> Depending on the payment method, partial annullments may or may not be allowed. \n\nSee the [Payment Methods](doc:paymentmethods) page for more information.", "2-0": "`lineItems`\n***conditional***", "2-1": "[`lineitem`:fa-external-link-square:](doc:lineitem)", "2-2": "The line items which are being annulled.\n\n**Conditions:**\n> Line items are only required when annulling an amount less than the original transaction amount.\n\n> Line items are only allowed when the original order was a detailed order.\n\nSee [Orders](doc:orders) for more information on detailed vs. simple orders.", "h-0": "Property", "h-1": "Type", "h-2": "Description", "3-0": "`customData`\n\n***conditional***", "3-2": "Collection of up to 10 private key-value data fields to store as meta-data on the transaction. This data can be viewed in Merchant Services and is returned in the GetOrder response object.\n\n**Conditions:**\n> We do not use this data for processing transactions.", "3-1": "[`customData`:fa-external-link-square:](doc:customdata)" }, "cols": 3, "rows": 4 } [/block] ## RESPONSE PARAMETERS [block:parameters] { "data": { "h-2": "Description", "h-0": "Property", "h-1": "Type", "0-0": "`status`\n*required*", "0-1": "[`status`:fa-external-link-square:](doc:status)", "0-2": "API operation status.\n\n**Example:**\n```\n{\n \"isSuccess\":true,\n \"errorNumber\":0,\n \"statusKey\":\"SUCCESS\",\n \"statusMessage\":\"The operation was successful.\"\n}\n```" }, "cols": 3, "rows": 1 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



**Annul authorization** annuls all or part of an authorization. [block:callout] { "type": "info", "body": "Depending on the payment method this service has different results. See the following table for information about different payment method types." } [/block] [block:parameters] { "data": { "0-0": "Invoice/installment", "1-0": "Credit/Debit Cards", "2-0": "Internet Banks", "0-1": "The credit authorization will be cancelled. No invoice will be sent out for this order.", "1-1": "The authorization will be reversed. A credit/debit card authorization can only be annulled in its entirety. Partial annulments are not supported.", "h-0": "Payment method", "h-1": "Result", "h-2": "Comment", "2-1": "This method has no effect because internet banks are automatically finalized (there is no authorization)." }, "cols": 2, "rows": 3 } [/block] ## HTTP Request [block:code] { "codes": [ { "code": "POST /orders/{orderId}/transactions/{transactionId}/annul/{totalAmount}\n", "language": "http", "name": "Annul Using Order ID " } ] } [/block] [block:code] { "codes": [ { "code": "POST /transactions/{transactionId}/annul/{totalAmount}", "language": "http", "name": "Annul Using Transaction ID" } ] } [/block] ## REQUEST PARAMETERS [block:parameters] { "data": { "0-0": "`transactionId`\n*required*", "0-2": "The authorization transaction id you received from Paynova.", "1-0": "`totalAmount`\n*required*", "1-1": "`decimal`", "0-1": "`guid`", "1-2": "The total amount to annul.\n\n**Conditions:**\n> Depending on the payment method, partial annullments may or may not be allowed. \n\nSee the [Payment Methods](doc:paymentmethods) page for more information.", "2-0": "`lineItems`\n***conditional***", "2-1": "[`lineitem`:fa-external-link-square:](doc:lineitem)", "2-2": "The line items which are being annulled.\n\n**Conditions:**\n> Line items are only required when annulling an amount less than the original transaction amount.\n\n> Line items are only allowed when the original order was a detailed order.\n\nSee [Orders](doc:orders) for more information on detailed vs. simple orders.", "h-0": "Property", "h-1": "Type", "h-2": "Description", "3-0": "`customData`\n\n***conditional***", "3-2": "Collection of up to 10 private key-value data fields to store as meta-data on the transaction. This data can be viewed in Merchant Services and is returned in the GetOrder response object.\n\n**Conditions:**\n> We do not use this data for processing transactions.", "3-1": "[`customData`:fa-external-link-square:](doc:customdata)" }, "cols": 3, "rows": 4 } [/block] ## RESPONSE PARAMETERS [block:parameters] { "data": { "h-2": "Description", "h-0": "Property", "h-1": "Type", "0-0": "`status`\n*required*", "0-1": "[`status`:fa-external-link-square:](doc:status)", "0-2": "API operation status.\n\n**Example:**\n```\n{\n \"isSuccess\":true,\n \"errorNumber\":0,\n \"statusKey\":\"SUCCESS\",\n \"statusMessage\":\"The operation was successful.\"\n}\n```" }, "cols": 3, "rows": 1 } [/block]
{"_id":"54cf26109d09bb0d00a179ea","createdAt":"2015-02-02T07:24:00.249Z","link_external":false,"link_url":"","title":"Refund payment","type":"post","user":"5476eb1df3736008009e9ced","__v":2,"body":"The **Refund Payment** service is used to refund a Payment within Paynova's system.\n\n\n\n\n## HTTP Request \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /orders/{orderId}/transactions/{transactionId}/refund/{totalAmount}\",\n      \"language\": \"http\",\n      \"name\": \"Refund Using Order ID\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /transactions/{transactionId}/refund/{totalAmount}\",\n      \"language\": \"http\",\n      \"name\": \"Refund Using Transaction ID\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"When using the REST endpoints, the values supplied in the REST paths do not need to be supplied in the request body/object and will be used instead of values provided in the request body/object.\"\n}\n[/block]\n## REQUEST PARAMETERS\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`orderId`\\n***conditional***\",\n    \"0-1\": \"`string`\",\n    \"0-2\": \"The unique identifier for the order which you received in the response from your original [Create Order](http://api.developers.paynova.com/docs/create-order) request.\\n\\n**Conditions:**\\n> Required if refunding using order ID.\\n\\n**Example:** `\\\"1bee7570-76c0-495b-bc0a-a43300d0410c\\\"`\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"1-0\": \"`transactionId`\\n*required*\",\n    \"1-1\": \"`string`\",\n    \"1-2\": \"The transaction ID you received in your call to finalize authorization.\\n\\n**Constraints:** \\n* The transaction must have been successfully finalized before a refund may be processed. Otherwise `annul authorization` should be used.\",\n    \"2-0\": \"`totalAmount`\\n*required*\",\n    \"2-1\": \"`decimal`\",\n    \"2-2\": \"The total amount to refund. If provided, the amount must be equal to or less than the finalized amount.\\n\\n**Example:** `100.00`\",\n    \"3-0\": \"`lineItems`\\n***conditional***\",\n    \"3-1\": \"[`lineitem`:fa-external-link-square:](http://api.developers.paynova.com/docs/lineitem)\",\n    \"3-2\": \"The line items which are being refunded.\\n\\n**Conditions:**\\n> Line items are required if the totalAmount is less than the original finalized amount.\\n\\n> Line items may not be specified for simple orders.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","category":"54cf2539a9e1cf0d005c89ff","next":{"description":"","pages":[]},"order":1,"slug":"refund-payment","updates":[],"version":"54930e7c777ff221004a7e70","api":{"auth":"required","examples":{"codes":[{"code":"\"POST\" https://api.paynova.com/orders/47bf277b-17b0-4d8b-b9c9-a3b100dbb21c/transactions/201409251527280673/refund/100.00\n\n{\n    \"LineItems\":[\n        {\n            \"Id\":\"1\",\n            \"ArticleNumber\":1000,\n            \"Name\":\"Some product\",\n            \"Description\":\"Some product description\",\n            \"ProductUrl\":\"http://myshop.com/products/1000\",\n            \"Quantity\":4,\n            \"UnitMeasure\":\"st\",\n            \"UnitAmountExcludingTax\":20,\n            \"TaxPercent\":25,\n            \"TotalLineTaxAmount\":20,\n            \"TotalLineAmount\":100,\n            \"LineItemGroupKey\":null\n        }\n    ]\n}","language":"json","name":"Partial Refund"},{"code":"\"POST\" https://api.paynova.com/orders/47bf277b-17b0-4d8b-b9c9-a3b100dbb21c/transactions/201409251527280673/refund/100.00","language":"curl","name":"Refund Simple order"}]},"method":"post","params":[],"results":{"codes":[{"name":"","code":"{\n    \"status\":{\n        \"isSuccess\":true,\n        \"errorNumber\":0,\n        \"statusKey\":\"SUCCESS\",\n        \"statusMessage\":\"The operation was successful.\"\n    },\n    \"totalAmountRefunded\":\"100.00\",\n    \"canRefundAgain\":false,\n    \"transactionId\":\"201409251527280673\",\n    \"batchId\":\"269030203046\",\n    \"acquirerId\":\"1010\"\n}","language":"json","status":200},{"name":"Lineitems Required","code":"{\n  \"status\": {\n    \"isSuccess\": false,\n    \"errorNumber\": 3003,\n    \"statusKey\": \"LINE_ITEMS_REQUIRED\",\n    \"statusMessage\": \"This operation requires that line items be specified for detailed orders when the total amount specified does not equal the original order total amount.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  },\n  \"totalAmountRefunded\": \"0\",\n  \"totalAmountPendingRefund\": \"0\",\n  \"canRefundAgain\": false,\n  \"amountRemainingForRefund\": \"0\",\n  \"transactionId\": null,\n  \"batchId\": null,\n  \"acquirerId\": null\n}","language":"json","status":200},{"status":200,"language":"json","code":"{\n  \"status\": {\n    \"isSuccess\": false,\n    \"errorNumber\": -2,\n    \"statusKey\": \"VALIDATION_ERROR\",\n    \"statusMessage\": \"The request contained one or more validation errors.  See the errors collection for further details.\",\n    \"errors\": [\n      {\n        \"errorCode\": \"Predicate\",\n        \"fieldName\": \"LineItems[0].TotalLineTaxAmount\",\n        \"message\": \"The specified condition was not met for 'Total Line Tax Amount'.\"\n      },\n      {\n        \"errorCode\": \"Predicate\",\n        \"fieldName\": \"LineItems[0].TotalLineAmount\",\n        \"message\": \"The specified condition was not met for 'Total Line Amount'.\"\n      }\n    ],\n    \"exceptionDetails\": null\n  },\n  \"totalAmountRefunded\": \"0\",\n  \"totalAmountPendingRefund\": \"0\",\n  \"canRefundAgain\": false,\n  \"amountRemainingForRefund\": \"0\",\n  \"transactionId\": null,\n  \"batchId\": null,\n  \"acquirerId\": null\n}","name":"Validation Error"}]},"settings":"","url":"/orders/{orderId}/transactions/{transactionId}/refund/{totalAmount}"},"isReference":true,"parentDoc":null,"project":"54930e7c777ff221004a7e6d","sync_unique":"","hidden":false,"excerpt":"","githubsync":"","childrenPages":[]}

postRefund payment


The **Refund Payment** service is used to refund a Payment within Paynova's system. ## HTTP Request [block:code] { "codes": [ { "code": "POST /orders/{orderId}/transactions/{transactionId}/refund/{totalAmount}", "language": "http", "name": "Refund Using Order ID" } ] } [/block] [block:code] { "codes": [ { "code": "POST /transactions/{transactionId}/refund/{totalAmount}", "language": "http", "name": "Refund Using Transaction ID" } ] } [/block] [block:callout] { "type": "info", "body": "When using the REST endpoints, the values supplied in the REST paths do not need to be supplied in the request body/object and will be used instead of values provided in the request body/object." } [/block] ## REQUEST PARAMETERS [block:parameters] { "data": { "0-0": "`orderId`\n***conditional***", "0-1": "`string`", "0-2": "The unique identifier for the order which you received in the response from your original [Create Order](http://api.developers.paynova.com/docs/create-order) request.\n\n**Conditions:**\n> Required if refunding using order ID.\n\n**Example:** `\"1bee7570-76c0-495b-bc0a-a43300d0410c\"`", "h-0": "Property", "h-1": "Type", "h-2": "Description", "1-0": "`transactionId`\n*required*", "1-1": "`string`", "1-2": "The transaction ID you received in your call to finalize authorization.\n\n**Constraints:** \n* The transaction must have been successfully finalized before a refund may be processed. Otherwise `annul authorization` should be used.", "2-0": "`totalAmount`\n*required*", "2-1": "`decimal`", "2-2": "The total amount to refund. If provided, the amount must be equal to or less than the finalized amount.\n\n**Example:** `100.00`", "3-0": "`lineItems`\n***conditional***", "3-1": "[`lineitem`:fa-external-link-square:](http://api.developers.paynova.com/docs/lineitem)", "3-2": "The line items which are being refunded.\n\n**Conditions:**\n> Line items are required if the totalAmount is less than the original finalized amount.\n\n> Line items may not be specified for simple orders." }, "cols": 3, "rows": 4 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The **Refund Payment** service is used to refund a Payment within Paynova's system. ## HTTP Request [block:code] { "codes": [ { "code": "POST /orders/{orderId}/transactions/{transactionId}/refund/{totalAmount}", "language": "http", "name": "Refund Using Order ID" } ] } [/block] [block:code] { "codes": [ { "code": "POST /transactions/{transactionId}/refund/{totalAmount}", "language": "http", "name": "Refund Using Transaction ID" } ] } [/block] [block:callout] { "type": "info", "body": "When using the REST endpoints, the values supplied in the REST paths do not need to be supplied in the request body/object and will be used instead of values provided in the request body/object." } [/block] ## REQUEST PARAMETERS [block:parameters] { "data": { "0-0": "`orderId`\n***conditional***", "0-1": "`string`", "0-2": "The unique identifier for the order which you received in the response from your original [Create Order](http://api.developers.paynova.com/docs/create-order) request.\n\n**Conditions:**\n> Required if refunding using order ID.\n\n**Example:** `\"1bee7570-76c0-495b-bc0a-a43300d0410c\"`", "h-0": "Property", "h-1": "Type", "h-2": "Description", "1-0": "`transactionId`\n*required*", "1-1": "`string`", "1-2": "The transaction ID you received in your call to finalize authorization.\n\n**Constraints:** \n* The transaction must have been successfully finalized before a refund may be processed. Otherwise `annul authorization` should be used.", "2-0": "`totalAmount`\n*required*", "2-1": "`decimal`", "2-2": "The total amount to refund. If provided, the amount must be equal to or less than the finalized amount.\n\n**Example:** `100.00`", "3-0": "`lineItems`\n***conditional***", "3-1": "[`lineitem`:fa-external-link-square:](http://api.developers.paynova.com/docs/lineitem)", "3-2": "The line items which are being refunded.\n\n**Conditions:**\n> Line items are required if the totalAmount is less than the original finalized amount.\n\n> Line items may not be specified for simple orders." }, "cols": 3, "rows": 4 } [/block]
{"_id":"582b3bc8e29d2b31003519c7","excerpt":"","githubsync":"","isReference":true,"sync_unique":"","version":"54930e7c777ff221004a7e70","project":"54930e7c777ff221004a7e6d","api":{"settings":"","url":"/orders/{orderId}/transactions/{transactionId}/lineItems","auth":"required","examples":{"codes":[{"code":"\"PATCH\" https://api.paynova.com/orders/order-123/transactions/201611201833163630/lineItems\n\n{\n  \"operations\": [\n    {\n      \"operationType\": \"RemoveLineItem\",\n      \"lineItemId\": \"4\"\n    },\n    {\n      \"operationType\": \"AddLineItem\",\n      \"lineItemId\": \"4\",\n      \"lineItem\": {\n        \"id\": \"4\",\n        \"articleNumber\": \"101400X\",\n        \"name\": \"Product name\",\n        \"description\": \"A very nice product\",\n        \"quantity\": 1,\n        \"unitMeasure\": \"st\",\n \n        \"unitAmountExcludingTax\": 143.20,\n        \"taxPercent\": 25,\n        \"totalLineTaxAmount\": 35.80,\n        \"totalLineAmount\": 179.00\n      }\n    }\n  ]\n}","language":"json"}]},"method":"patch","params":[],"results":{"codes":[{"name":"","code":"{\n  \"status\": {\n    \"isSuccess\": true,\n    \"errorNumber\": 0,\n    \"statusKey\": \"SUCCESS\",\n    \"statusMessage\": \"The operation was successful.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  },\n  \"transactionId\": \"201611201833163630\"\n}","language":"json","status":200},{"name":"Lineitem Not found","code":"{\n  \"status\": {\n    \"isSuccess\": false,\n    \"errorNumber\": 3023,\n    \"statusKey\": \"LINE_ITEM_NOT_FOUND\",\n    \"statusMessage\": \"The line item specified in the request could not be found on the order.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  },\n  \"transactionId\": null\n}","language":"json","status":200}]}},"createdAt":"2016-11-15T16:46:00.513Z","link_url":"","order":2,"parentDoc":null,"link_external":false,"next":{"pages":[],"description":""},"slug":"update-order","type":"patch","updates":[],"user":"5818a4ecb1e11c1900bf76c3","__v":0,"body":"The **Update Order** service is used to update the order lines of an existing order. An order can be updated at any time, both before and after it has been finalized.\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"This method is used for invoice and installment payments.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Orders can be updated both before and after they are finalized. If the update is made after the order has been finalized then the update will be finalized immediately. If the update is made before the order has been finalized then the update will not be finalized until the order is finalized.\"\n}\n[/block]\n## HTTP Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"PATCH /orders/{orderId}/transactions/{transactionId}/lineItems\\t\",\n      \"language\": \"http\",\n      \"name\": \"HTTP\"\n    }\n  ]\n}\n[/block]\n## Request Parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`operations`\\n*required*\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"1-0\": \"`transactionId`\\n*required*\",\n    \"1-2\": \"The transaction ID of the authorization transaction.\",\n    \"0-2\": \"**Valid Operations:** `\\\"RemoveLineItem\\\"`, `\\\"AddLineItem\\\"`\\n\\n**Add line item**\\nTo add a new line item use the `AddLineItem` operation and specify a new unique line item ID.\\n\\n**Remove line item**\\nTo remove a line item use the `RemoveLineItem` operation and specify the line item ID to remove.\\n\\n**Update line item**\\nTo update an existing line item, include a `RemoveLineItem` and a `AddLineItem` operation in the same request and specify the same line item ID in both operations.\",\n    \"0-1\": \"`string`\",\n    \"1-1\": \"`string`\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n## Response Parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`status`\\n*required*\",\n    \"0-1\": \"[`status`:fa-external-link-square:](doc:status)\",\n    \"1-0\": \"`transactionId`\\n***conditional***\",\n    \"1-2\": \"Paynova's unique identifier associated with this transaction.\\n\\n**Conditions:**\\n> This parameter is not returned in error situations.\",\n    \"0-2\": \"API operation status.\\n\\n**Example:**\\n```\\n{\\n    \\\"isSuccess\\\": true,\\n    \\\"errorNumber\\\": 0,\\n    \\\"statusKey\\\": \\\"SUCCESS\\\",\\n    \\\"statusMessage\\\": \\\"The operation was successful.\\\",\\n    \\\"errors\\\": null,\\n    \\\"exceptionDetails\\\": null\\n  }\\n```\",\n    \"1-1\": \"`string`\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","category":"54cf2539a9e1cf0d005c89ff","hidden":false,"title":"Update order","childrenPages":[]}

patchUpdate order


The **Update Order** service is used to update the order lines of an existing order. An order can be updated at any time, both before and after it has been finalized. [block:callout] { "type": "success", "body": "This method is used for invoice and installment payments." } [/block] [block:callout] { "type": "info", "body": "Orders can be updated both before and after they are finalized. If the update is made after the order has been finalized then the update will be finalized immediately. If the update is made before the order has been finalized then the update will not be finalized until the order is finalized." } [/block] ## HTTP Request [block:code] { "codes": [ { "code": "PATCH /orders/{orderId}/transactions/{transactionId}/lineItems\t", "language": "http", "name": "HTTP" } ] } [/block] ## Request Parameters [block:parameters] { "data": { "0-0": "`operations`\n*required*", "h-0": "Property", "h-1": "Type", "h-2": "Description", "1-0": "`transactionId`\n*required*", "1-2": "The transaction ID of the authorization transaction.", "0-2": "**Valid Operations:** `\"RemoveLineItem\"`, `\"AddLineItem\"`\n\n**Add line item**\nTo add a new line item use the `AddLineItem` operation and specify a new unique line item ID.\n\n**Remove line item**\nTo remove a line item use the `RemoveLineItem` operation and specify the line item ID to remove.\n\n**Update line item**\nTo update an existing line item, include a `RemoveLineItem` and a `AddLineItem` operation in the same request and specify the same line item ID in both operations.", "0-1": "`string`", "1-1": "`string`" }, "cols": 3, "rows": 2 } [/block] ## Response Parameters [block:parameters] { "data": { "0-0": "`status`\n*required*", "0-1": "[`status`:fa-external-link-square:](doc:status)", "1-0": "`transactionId`\n***conditional***", "1-2": "Paynova's unique identifier associated with this transaction.\n\n**Conditions:**\n> This parameter is not returned in error situations.", "0-2": "API operation status.\n\n**Example:**\n```\n{\n \"isSuccess\": true,\n \"errorNumber\": 0,\n \"statusKey\": \"SUCCESS\",\n \"statusMessage\": \"The operation was successful.\",\n \"errors\": null,\n \"exceptionDetails\": null\n }\n```", "1-1": "`string`" }, "cols": 3, "rows": 2 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The **Update Order** service is used to update the order lines of an existing order. An order can be updated at any time, both before and after it has been finalized. [block:callout] { "type": "success", "body": "This method is used for invoice and installment payments." } [/block] [block:callout] { "type": "info", "body": "Orders can be updated both before and after they are finalized. If the update is made after the order has been finalized then the update will be finalized immediately. If the update is made before the order has been finalized then the update will not be finalized until the order is finalized." } [/block] ## HTTP Request [block:code] { "codes": [ { "code": "PATCH /orders/{orderId}/transactions/{transactionId}/lineItems\t", "language": "http", "name": "HTTP" } ] } [/block] ## Request Parameters [block:parameters] { "data": { "0-0": "`operations`\n*required*", "h-0": "Property", "h-1": "Type", "h-2": "Description", "1-0": "`transactionId`\n*required*", "1-2": "The transaction ID of the authorization transaction.", "0-2": "**Valid Operations:** `\"RemoveLineItem\"`, `\"AddLineItem\"`\n\n**Add line item**\nTo add a new line item use the `AddLineItem` operation and specify a new unique line item ID.\n\n**Remove line item**\nTo remove a line item use the `RemoveLineItem` operation and specify the line item ID to remove.\n\n**Update line item**\nTo update an existing line item, include a `RemoveLineItem` and a `AddLineItem` operation in the same request and specify the same line item ID in both operations.", "0-1": "`string`", "1-1": "`string`" }, "cols": 3, "rows": 2 } [/block] ## Response Parameters [block:parameters] { "data": { "0-0": "`status`\n*required*", "0-1": "[`status`:fa-external-link-square:](doc:status)", "1-0": "`transactionId`\n***conditional***", "1-2": "Paynova's unique identifier associated with this transaction.\n\n**Conditions:**\n> This parameter is not returned in error situations.", "0-2": "API operation status.\n\n**Example:**\n```\n{\n \"isSuccess\": true,\n \"errorNumber\": 0,\n \"statusKey\": \"SUCCESS\",\n \"statusMessage\": \"The operation was successful.\",\n \"errors\": null,\n \"exceptionDetails\": null\n }\n```", "1-1": "`string`" }, "cols": 3, "rows": 2 } [/block]
{"_id":"54cf265a9d09bb0d00a179ec","__v":1,"body":"The **Get Customer Profile** service is used to retrieve information about a merchant customer profile stored at Paynova.\n\n## HTTP Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /customerprofiles/{profileId}\",\n      \"language\": \"text\",\n      \"name\": \"Get Customer Profile\"\n    }\n  ]\n}\n[/block]\n## Request parameters \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`profileId`\\n*required*\",\n    \"0-1\": \"`string`\",\n    \"0-2\": \"Your unique identifier for the customer profile stored at Paynova.\\n\\n**Example:** `\\\"1\\\"`\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n## Response parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`status`\\n*required*\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-1\": \"[`status`:fa-external-link-square:](doc:status)\",\n    \"1-0\": \"`profileId`\\n***conditional***\",\n    \"1-1\": \"`string`\",\n    \"2-0\": \"`profileCards`\\n***conditional***\",\n    \"2-1\": \"[`profilecard`:fa-external-link-square:](doc:profilecard)\",\n    \"0-2\": \"API operation status.\\n\\n**Example:** \\n\\n```\\n{\\n        \\\"isSuccess\\\":true,\\n        \\\"errorNumber\\\":0,\\n        \\\"statusKey\\\":\\\"SUCCESS\\\",\\n        \\\"statusMessage\\\":\\\"The operation was successful.\\\"\\n    }\\n```\",\n    \"1-2\": \"Your unique identifier for the customer's profile.\\n\\n**Conditions:**\\n> This parameter will not be returned in error situations.\\n\\n**Example:** `\\\"1\\\"`\",\n    \"2-2\": \"Details about any profile cards stored within the customer profile will be returned here.\\n\\n**Conditions:**\\n> This parameter will not be returned in error situations.\\n\\n**Example:** \\n```\\n{\\n            \\\"cardId\\\":\\\"a61e7be3-deb2-4b20-89ba-a39a00b3f669\\\",\\n            \\\"expirationYear\\\":18,\\n            \\\"expirationMonth\\\":4,\\n            \\\"firstSix\\\":\\\"411111\\\",\\n            \\\"lastFour\\\":\\\"1111\\\"            \\n        }\\n```\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","category":"54cf26394acee20d001e5303","createdAt":"2015-02-02T07:25:14.116Z","isReference":true,"order":0,"sync_unique":"","api":{"params":[],"results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n    \"status\":{\n        \"isSuccess\":true,\n        \"errorNumber\":0,\n        \"statusKey\":\"SUCCESS\",\n        \"statusMessage\":\"The operation was successful.\"\n    },\n    \"profileId\":\"1\",\n    \"profileCards\":[\n        {\n            \"cardId\":\"a61e7be3-deb2-4b20-89ba-a39a00b3f669\",\n            \"expirationYear\":18,\n            \"expirationMonth\":4,\n            \"firstSix\":\"411111\",\n            \"lastFour\":\"1111\"\n            \n        }\n    ]\n}"},{"name":"Profile Not Found","code":"{\n    \"Status\": {\n        \"IsSuccess\": false,\n        \"ErrorNumber\": 2000,\n        \"StatusKey\": \"CUST_PROF_NOT_FOUND\",\n        \"StatusMessage\": \"The specified customer profile was not found.\",\n        \"Errors\": null,\n        \"ExceptionDetails\": null\n    },\n    \"ProfileId\": null,\n    \"ProfileCards\": null\n}","language":"json","status":200},{"name":"Validation Error","status":200,"language":"json","code":"{\n    \"Status\": {\n        \"IsSuccess\": false,\n        \"ErrorNumber\": -2,\n        \"StatusKey\": \"VALIDATION_ERROR\",\n        \"StatusMessage\": \"The request contained one or more validation errors.  See the errors collection for further details.\",\n        \"Errors\": [\n            {\n                \"ErrorCode\": \"Length\",\n                \"FieldName\": \"ProfileId\",\n                \"Message\": \"'Profile Id' must be between 1 and 255 characters. You entered 0 characters.\"\n            }\n        ],\n        \"ExceptionDetails\": null\n    },\n    \"ProfileId\": null,\n    \"ProfileCards\": null\n}"}]},"settings":"","url":"/customerprofiles/{profileId}","auth":"required","examples":{"codes":[{"code":"\"GET\" https://api.paynova.com/customerprofiles/1","language":"curl","name":"Get Customer Profile"}]},"method":"get"},"githubsync":"","hidden":false,"next":{"description":"","pages":[]},"slug":"get-customer-profile","type":"get","version":"54930e7c777ff221004a7e70","link_external":false,"link_url":"","user":"5476eb1df3736008009e9ced","excerpt":"","parentDoc":null,"project":"54930e7c777ff221004a7e6d","title":"Get customer profile","updates":[],"childrenPages":[]}

getGet customer profile


The **Get Customer Profile** service is used to retrieve information about a merchant customer profile stored at Paynova. ## HTTP Request [block:code] { "codes": [ { "code": "GET /customerprofiles/{profileId}", "language": "text", "name": "Get Customer Profile" } ] } [/block] ## Request parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`profileId`\n*required*", "0-1": "`string`", "0-2": "Your unique identifier for the customer profile stored at Paynova.\n\n**Example:** `\"1\"`" }, "cols": 3, "rows": 1 } [/block] ## Response parameters [block:parameters] { "data": { "0-0": "`status`\n*required*", "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-1": "[`status`:fa-external-link-square:](doc:status)", "1-0": "`profileId`\n***conditional***", "1-1": "`string`", "2-0": "`profileCards`\n***conditional***", "2-1": "[`profilecard`:fa-external-link-square:](doc:profilecard)", "0-2": "API operation status.\n\n**Example:** \n\n```\n{\n \"isSuccess\":true,\n \"errorNumber\":0,\n \"statusKey\":\"SUCCESS\",\n \"statusMessage\":\"The operation was successful.\"\n }\n```", "1-2": "Your unique identifier for the customer's profile.\n\n**Conditions:**\n> This parameter will not be returned in error situations.\n\n**Example:** `\"1\"`", "2-2": "Details about any profile cards stored within the customer profile will be returned here.\n\n**Conditions:**\n> This parameter will not be returned in error situations.\n\n**Example:** \n```\n{\n \"cardId\":\"a61e7be3-deb2-4b20-89ba-a39a00b3f669\",\n \"expirationYear\":18,\n \"expirationMonth\":4,\n \"firstSix\":\"411111\",\n \"lastFour\":\"1111\" \n }\n```" }, "cols": 3, "rows": 3 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The **Get Customer Profile** service is used to retrieve information about a merchant customer profile stored at Paynova. ## HTTP Request [block:code] { "codes": [ { "code": "GET /customerprofiles/{profileId}", "language": "text", "name": "Get Customer Profile" } ] } [/block] ## Request parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`profileId`\n*required*", "0-1": "`string`", "0-2": "Your unique identifier for the customer profile stored at Paynova.\n\n**Example:** `\"1\"`" }, "cols": 3, "rows": 1 } [/block] ## Response parameters [block:parameters] { "data": { "0-0": "`status`\n*required*", "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-1": "[`status`:fa-external-link-square:](doc:status)", "1-0": "`profileId`\n***conditional***", "1-1": "`string`", "2-0": "`profileCards`\n***conditional***", "2-1": "[`profilecard`:fa-external-link-square:](doc:profilecard)", "0-2": "API operation status.\n\n**Example:** \n\n```\n{\n \"isSuccess\":true,\n \"errorNumber\":0,\n \"statusKey\":\"SUCCESS\",\n \"statusMessage\":\"The operation was successful.\"\n }\n```", "1-2": "Your unique identifier for the customer's profile.\n\n**Conditions:**\n> This parameter will not be returned in error situations.\n\n**Example:** `\"1\"`", "2-2": "Details about any profile cards stored within the customer profile will be returned here.\n\n**Conditions:**\n> This parameter will not be returned in error situations.\n\n**Example:** \n```\n{\n \"cardId\":\"a61e7be3-deb2-4b20-89ba-a39a00b3f669\",\n \"expirationYear\":18,\n \"expirationMonth\":4,\n \"firstSix\":\"411111\",\n \"lastFour\":\"1111\" \n }\n```" }, "cols": 3, "rows": 3 } [/block]
{"_id":"54cf267a4acee20d001e5304","category":"54cf26394acee20d001e5303","createdAt":"2015-02-02T07:25:46.938Z","githubsync":"","isReference":true,"updates":[],"api":{"params":[],"results":{"codes":[{"status":200,"name":"","code":"{\n    \"status\":{\n        \"isSuccess\":true,\n        \"errorNumber\":0,\n        \"statusKey\":\"SUCCESS\",\n        \"statusMessage\":\"The operation was successful.\"\n    }\n}","language":"json"},{"code":"{\n    \"Status\": {\n        \"IsSuccess\": false,\n        \"ErrorNumber\": 2000,\n        \"StatusKey\": \"CUST_PROF_NOT_FOUND\",\n        \"StatusMessage\": \"The specified customer profile was not found.\",\n        \"Errors\": null,\n        \"ExceptionDetails\": null\n    }\n}","language":"json","status":200,"name":"Profile Not Found"},{"language":"json","code":"{\n    \"Status\": {\n        \"IsSuccess\": false,\n        \"ErrorNumber\": -2,\n        \"StatusKey\": \"VALIDATION_ERROR\",\n        \"StatusMessage\": \"The request contained one or more validation errors.  See the errors collection for further details.\",\n        \"Errors\": [\n            {\n                \"ErrorCode\": \"Length\",\n                \"FieldName\": \"ProfileId\",\n                \"Message\": \"'Profile Id' must be between 1 and 255 characters. You entered 0 characters.\"\n            }\n        ],\n        \"ExceptionDetails\": null\n    }\n}","name":"Validation Error","status":200}]},"settings":"","url":"/customerprofiles/{profileId}","auth":"required","examples":{"codes":[{"name":"Remove Customer Profile","language":"curl","code":"\"DELETE\" https://api.paynova.com/customerprofiles/1"}]},"method":"delete"},"excerpt":"","hidden":false,"project":"54930e7c777ff221004a7e6d","type":"delete","user":"5476eb1df3736008009e9ced","__v":2,"link_url":"","parentDoc":null,"sync_unique":"","title":"Remove customer profile","version":"54930e7c777ff221004a7e70","body":"The **Remove Customer Profile** service is used to remove a customer profile and all related data.\n\n## HTTP Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"DELETE /customerprofiles/{profileId}\",\n      \"language\": \"http\",\n      \"name\": \"Remove Customer Profile\"\n    }\n  ]\n}\n[/block]\n## Request Parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`profileId`\\n*required*\",\n    \"0-1\": \"`string`\",\n    \"0-2\": \"Your unique identifier for the customer profile stored at Paynova.\\n\\n**Example:** `\\\"1\\\"`\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n## Response Parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`status`\\n*required*\",\n    \"0-1\": \"[`status`:fa-external-link-square:](doc:status)\",\n    \"0-2\": \"API operation status.\\n\\n**Example:** \\n```\\n{\\n        \\\"isSuccess\\\":true,\\n        \\\"errorNumber\\\":0,\\n        \\\"statusKey\\\":\\\"SUCCESS\\\",\\n        \\\"statusMessage\\\":\\\"The operation was successful.\\\"\\n}\\n```\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]","next":{"description":"","pages":[]},"order":1,"slug":"remove-customer-profile","link_external":false,"childrenPages":[]}

deleteRemove customer profile


The **Remove Customer Profile** service is used to remove a customer profile and all related data. ## HTTP Request [block:code] { "codes": [ { "code": "DELETE /customerprofiles/{profileId}", "language": "http", "name": "Remove Customer Profile" } ] } [/block] ## Request Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`profileId`\n*required*", "0-1": "`string`", "0-2": "Your unique identifier for the customer profile stored at Paynova.\n\n**Example:** `\"1\"`" }, "cols": 3, "rows": 1 } [/block] ## Response Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`status`\n*required*", "0-1": "[`status`:fa-external-link-square:](doc:status)", "0-2": "API operation status.\n\n**Example:** \n```\n{\n \"isSuccess\":true,\n \"errorNumber\":0,\n \"statusKey\":\"SUCCESS\",\n \"statusMessage\":\"The operation was successful.\"\n}\n```" }, "cols": 3, "rows": 1 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The **Remove Customer Profile** service is used to remove a customer profile and all related data. ## HTTP Request [block:code] { "codes": [ { "code": "DELETE /customerprofiles/{profileId}", "language": "http", "name": "Remove Customer Profile" } ] } [/block] ## Request Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`profileId`\n*required*", "0-1": "`string`", "0-2": "Your unique identifier for the customer profile stored at Paynova.\n\n**Example:** `\"1\"`" }, "cols": 3, "rows": 1 } [/block] ## Response Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`status`\n*required*", "0-1": "[`status`:fa-external-link-square:](doc:status)", "0-2": "API operation status.\n\n**Example:** \n```\n{\n \"isSuccess\":true,\n \"errorNumber\":0,\n \"statusKey\":\"SUCCESS\",\n \"statusMessage\":\"The operation was successful.\"\n}\n```" }, "cols": 3, "rows": 1 } [/block]
{"_id":"54cf269ba9e1cf0d005c8a08","category":"54cf26394acee20d001e5303","link_external":false,"parentDoc":null,"updates":[],"githubsync":"","link_url":"","version":"54930e7c777ff221004a7e70","api":{"settings":"","url":"/customerprofiles/{profileId}/cards/{cardId}","auth":"required","examples":{"codes":[{"name":"Remove Customer Profile Card","language":"curl","code":"\"DELETE\" https://api.paynova.com/customerprofiles/3/cards/318a8fa5-baf9-4609-9eac-a3b500bdaca4 "}]},"method":"delete","params":[],"results":{"codes":[{"code":"{\n    \"status\":{\n        \"isSuccess\":true,\n        \"errorNumber\":0,\n        \"statusKey\":\"SUCCESS\",\n        \"statusMessage\":\"The operation was successful.\"\n    }\n}","name":"","status":200,"language":"json"},{"name":"Validation Error","status":200,"language":"json","code":"{\n  \"status\": {\n    \"isSuccess\": false,\n    \"errorNumber\": -2,\n    \"statusKey\": \"VALIDATION_ERROR\",\n    \"statusMessage\": \"The request contained one or more validation errors.  See the errors collection for further details.\",\n    \"errors\": [\n      {\n        \"errorCode\": \"NotEqual\",\n        \"fieldName\": \"CardId\",\n        \"message\": \"'Card Id' should not be equal to '00000000-0000-0000-0000-000000000000'.\"\n      }\n    ],\n    \"exceptionDetails\": null\n  }\n}"}]}},"body":"The **Remove Customer Profile Card** service is used to remove a stored card from a customer profile.\n\n\n## HTTP Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"DELETE /customerprofiles/{profileId}/cards/{cardId}\",\n      \"language\": \"http\",\n      \"name\": \"Remove Customer Profile Card\"\n    }\n  ]\n}\n[/block]\n## Request parameters \n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`profileId`\\n*required*\",\n    \"1-0\": \"`cardId`\\n*required*\",\n    \"0-1\": \"`string`\",\n    \"1-1\": \"`string`\",\n    \"0-2\": \"Your unique identifier for the customer profile stored at Paynova.\",\n    \"1-2\": \"Paynova's unique identifier for the card associated with the customer profile.\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n## Response parameters \n[block:parameters]\n{\n  \"data\": {\n    \"h-2\": \"Description\",\n    \"h-1\": \"Type\",\n    \"h-0\": \"Property\",\n    \"0-0\": \"`status`\\n*required*\",\n    \"0-1\": \"[`status`:fa-external-link-square:](doc:status)\",\n    \"0-2\": \"API operation status.\\n\\n**Example:**\\n```\\n{\\n        \\\"isSuccess\\\":true,\\n        \\\"errorNumber\\\":0,\\n        \\\"statusKey\\\":\\\"SUCCESS\\\",\\n        \\\"statusMessage\\\":\\\"The operation was successful.\\\"\\n    }\\n```\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]","createdAt":"2015-02-02T07:26:19.673Z","excerpt":"","__v":1,"next":{"pages":[],"description":""},"order":2,"project":"54930e7c777ff221004a7e6d","sync_unique":"","title":"Remove customer profile card","type":"delete","user":"5476eb1df3736008009e9ced","hidden":false,"isReference":true,"slug":"remove-customer-profile-card","childrenPages":[]}

deleteRemove customer profile card


The **Remove Customer Profile Card** service is used to remove a stored card from a customer profile. ## HTTP Request [block:code] { "codes": [ { "code": "DELETE /customerprofiles/{profileId}/cards/{cardId}", "language": "http", "name": "Remove Customer Profile Card" } ] } [/block] ## Request parameters [block:parameters] { "data": { "0-0": "`profileId`\n*required*", "1-0": "`cardId`\n*required*", "0-1": "`string`", "1-1": "`string`", "0-2": "Your unique identifier for the customer profile stored at Paynova.", "1-2": "Paynova's unique identifier for the card associated with the customer profile.", "h-0": "Property", "h-1": "Type", "h-2": "Description" }, "cols": 3, "rows": 2 } [/block] ## Response parameters [block:parameters] { "data": { "h-2": "Description", "h-1": "Type", "h-0": "Property", "0-0": "`status`\n*required*", "0-1": "[`status`:fa-external-link-square:](doc:status)", "0-2": "API operation status.\n\n**Example:**\n```\n{\n \"isSuccess\":true,\n \"errorNumber\":0,\n \"statusKey\":\"SUCCESS\",\n \"statusMessage\":\"The operation was successful.\"\n }\n```" }, "cols": 3, "rows": 1 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The **Remove Customer Profile Card** service is used to remove a stored card from a customer profile. ## HTTP Request [block:code] { "codes": [ { "code": "DELETE /customerprofiles/{profileId}/cards/{cardId}", "language": "http", "name": "Remove Customer Profile Card" } ] } [/block] ## Request parameters [block:parameters] { "data": { "0-0": "`profileId`\n*required*", "1-0": "`cardId`\n*required*", "0-1": "`string`", "1-1": "`string`", "0-2": "Your unique identifier for the customer profile stored at Paynova.", "1-2": "Paynova's unique identifier for the card associated with the customer profile.", "h-0": "Property", "h-1": "Type", "h-2": "Description" }, "cols": 3, "rows": 2 } [/block] ## Response parameters [block:parameters] { "data": { "h-2": "Description", "h-1": "Type", "h-0": "Property", "0-0": "`status`\n*required*", "0-1": "[`status`:fa-external-link-square:](doc:status)", "0-2": "API operation status.\n\n**Example:**\n```\n{\n \"isSuccess\":true,\n \"errorNumber\":0,\n \"statusKey\":\"SUCCESS\",\n \"statusMessage\":\"The operation was successful.\"\n }\n```" }, "cols": 3, "rows": 1 } [/block]
{"_id":"5857e009a6ee0a19008c81cb","version":"54930e7c777ff221004a7e70","link_external":false,"order":0,"parentDoc":null,"type":"get","updates":[],"category":"5857de7a6ee38323003fe794","createdAt":"2016-12-19T13:26:33.099Z","next":{"pages":[],"description":""},"slug":"e-leg-get-providers","__v":0,"githubsync":"","hidden":false,"isReference":true,"user":"5818a4ecb1e11c1900bf76c3","sync_unique":"","title":"Get Providers","api":{"examples":{"codes":[{"name":"JSON","code":"\"GET\" /authentication/providers ","language":"json"}]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"providers\": [\n    \"BankIdSwedenAuthenticationProvider\"\n  ],\n  \"status\": {\n    \"isSuccess\": true,\n    \"errorNumber\": 0,\n    \"statusKey\": \"SUCCESS\",\n    \"statusMessage\": \"The operation was successful.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  }\n}","name":""},{"status":200,"name":"Cannot Get List of Authentication Providers","language":"json","code":"{\n  \"authenticationSessionId\": null,\n  \"status\": {\n    \"isSuccess\": false,\n    \"errorNumber\": 6002,\n    \"statusKey\": \"CAN_NOT_GET_LIST_OF_AUTH_PROVIDERS\",\n    \"statusMessage\": \"An error occurred while retrieving the list of authenticatino providers.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  }\n}"}]},"settings":"","url":"/authentication/providers","auth":"required"},"body":"**Get Providers** returns all available authentication providers.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /authentication/providers\",\n      \"language\": \"http\",\n      \"name\": \"HTTP Request\"\n    }\n  ]\n}\n[/block]\n## Request Parameters\n\nYou don't need any request parameters for `Get Providers`\n\n\n## Response parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`Providers`\\n***conditional***\",\n    \"0-1\": \"`array of string`\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"A list of the names of all supported authentication providers.\\n\\n**Conditions:**\\n> This parameter is not returned in error situations. \\n\\n**Example:** `[ \\\"BankIdSwedenAuthenticationProvider\\\" ]`\",\n    \"1-0\": \"`status`\\n*required*\",\n    \"1-1\": \"`status`\",\n    \"1-2\": \"API Operation status.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","excerpt":"","link_url":"","project":"54930e7c777ff221004a7e6d","childrenPages":[]}

getGet Providers


**Get Providers** returns all available authentication providers. [block:code] { "codes": [ { "code": "GET /authentication/providers", "language": "http", "name": "HTTP Request" } ] } [/block] ## Request Parameters You don't need any request parameters for `Get Providers` ## Response parameters [block:parameters] { "data": { "0-0": "`Providers`\n***conditional***", "0-1": "`array of string`", "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-2": "A list of the names of all supported authentication providers.\n\n**Conditions:**\n> This parameter is not returned in error situations. \n\n**Example:** `[ \"BankIdSwedenAuthenticationProvider\" ]`", "1-0": "`status`\n*required*", "1-1": "`status`", "1-2": "API Operation status." }, "cols": 3, "rows": 2 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



**Get Providers** returns all available authentication providers. [block:code] { "codes": [ { "code": "GET /authentication/providers", "language": "http", "name": "HTTP Request" } ] } [/block] ## Request Parameters You don't need any request parameters for `Get Providers` ## Response parameters [block:parameters] { "data": { "0-0": "`Providers`\n***conditional***", "0-1": "`array of string`", "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-2": "A list of the names of all supported authentication providers.\n\n**Conditions:**\n> This parameter is not returned in error situations. \n\n**Example:** `[ \"BankIdSwedenAuthenticationProvider\" ]`", "1-0": "`status`\n*required*", "1-1": "`status`", "1-2": "API Operation status." }, "cols": 3, "rows": 2 } [/block]
{"_id":"5857e1ea6ee38323003fe79b","hidden":false,"parentDoc":null,"sync_unique":"","type":"post","body":"**Initiate Authentication Session** Creates an authentication session using the selected authentication provider.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /authentication/person/{countryCode}/{governmentId}\",\n      \"language\": \"json\",\n      \"name\": \"HTTP Request\"\n    }\n  ]\n}\n[/block]\n## Request Parameters \n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`countrycode`\\n*required*\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-1\": \"`string(2)`\",\n    \"0-2\": \"The two-letter country code in ISO 3166 format. \\n\\n**Examples:** `\\\"SE\\\"`\",\n    \"1-0\": \"`governmentId`\\n*required*\",\n    \"1-1\": \"`string(12)`\",\n    \"1-2\": \"For Sweden: The customer's 12 digit government ID, without a dash. \\n\\nExamples: `\\\"198901157993\\\"`\",\n    \"2-0\": \"`providerType`\\n*required*\",\n    \"2-1\": \"`string`\",\n    \"2-2\": \"The name of the provider to use for authenticating. For a list of available providers see the \\\"GET\\\" /authentication/providers endpoint.\\n\\n**Examples:** `\\\"BankIdSwedenAuthenticationProvider\\\"`\",\n    \"3-0\": \"`authenticationMethods`\\n*required*\",\n    \"3-1\": \"`array of string`\",\n    \"3-2\": \"A list of allowed authentication methods for this authentication session.\\n\\n**Examples:**\\n \\n ```[\\\"MobileBankId\\\"]```\",\n    \"4-0\": \"`clientIPAddress`\",\n    \"4-1\": \"`string`\",\n    \"4-2\": \"IP address of the customer. Recommended. \\n\\n This enables BankID to \\\"reconnect\\\" a customer to an active session if the connection to the session is lost. \\n\\n**Examples:** `\\\"10.123.123.123\\\"`\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n## Response Parameters \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`authenticationSessionId`\\n***conditional***\",\n    \"0-1\": \"`guid`\",\n    \"0-2\": \"Unique identifier for the created authentication session.\\n\\n**Conditions:**\\n\\n> This parameter is not returned in error situations.\\n\\n**Examples:** `\\\"eb85023a-ff9d-4537-95d0-f9d045b3e872\\\"`\",\n    \"1-0\": \"`status`\\n*required*\",\n    \"1-1\": \"`status`\",\n    \"1-2\": \"API Operation status.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","excerpt":"","link_external":false,"next":{"pages":[],"description":""},"slug":"e-leg-initiate-authentication-session","version":"54930e7c777ff221004a7e70","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"\"POST\" /authentication/person/SE/198312288718\n\n{\n\t\"providerType\": \"BankIdSwedenAuthenticationProvider\",\n\t\"authenticationMethods\": \n\t[\n\t\t\"MobileBankId\"\n\t]\n}"}]},"method":"post","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"authenticationSessionId\": \"eb85023a-ff9d-4537-95d0-f9d045b3e872\",\n  \"status\": {\n    \"isSuccess\": true,\n    \"errorNumber\": 0,\n    \"statusKey\": \"SUCCESS\",\n    \"statusMessage\": \"The operation was successful.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  }\n}","name":""},{"status":200,"name":"Cannot Initiate Authentication Session","language":"json","code":"{\n  \"authenticationSessionId\": null,\n  \"status\": {\n    \"isSuccess\": false,\n    \"errorNumber\": 6000,\n    \"statusKey\": \"CAN_NOT_INITIATE_AUTHENTICATION_SESSION\",\n    \"statusMessage\": \"An error occurred while attempting to initiate an authentication session.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  }\n}"},{"name":"Validation Error","status":200,"language":"json","code":"{\n  \"authenticationSessionId\": null,\n  \"status\": {\n    \"isSuccess\": false,\n    \"errorNumber\": -2,\n    \"statusKey\": \"VALIDATION_ERROR\",\n    \"statusMessage\": \"The request contained one or more validation errors.  See the errors collection for further details.\",\n    \"errors\": [\n      {\n        \"errorCode\": \"RegularExpression\",\n        \"fieldName\": \"CountryCode\",\n        \"message\": \"'Country Code' is not in the correct format.\"\n      },\n\t  {\n        \"errorCode\": \"GovernmentIdIsInvalid\",\n        \"fieldName\": \"GovernmentId\",\n        \"message\": \"Provided value does not evaluate to a valid government id.\"\n      }\n    ],\n    \"exceptionDetails\": null\n  }\n}"}]},"settings":"","url":"/authentication/person/{countryCode}/{governmentId}"},"githubsync":"","isReference":true,"link_url":"","project":"54930e7c777ff221004a7e6d","title":"Initiate Authentication Session","user":"5818a4ecb1e11c1900bf76c3","__v":2,"category":"5857de7a6ee38323003fe794","createdAt":"2016-12-19T13:34:34.958Z","order":1,"updates":["5a2e7d41bee8ae0026c7344e","5a324525c12b480032040ee0"],"childrenPages":[]}

postInitiate Authentication Session


**Initiate Authentication Session** Creates an authentication session using the selected authentication provider. [block:code] { "codes": [ { "code": "POST /authentication/person/{countryCode}/{governmentId}", "language": "json", "name": "HTTP Request" } ] } [/block] ## Request Parameters [block:parameters] { "data": { "0-0": "`countrycode`\n*required*", "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-1": "`string(2)`", "0-2": "The two-letter country code in ISO 3166 format. \n\n**Examples:** `\"SE\"`", "1-0": "`governmentId`\n*required*", "1-1": "`string(12)`", "1-2": "For Sweden: The customer's 12 digit government ID, without a dash. \n\nExamples: `\"198901157993\"`", "2-0": "`providerType`\n*required*", "2-1": "`string`", "2-2": "The name of the provider to use for authenticating. For a list of available providers see the \"GET\" /authentication/providers endpoint.\n\n**Examples:** `\"BankIdSwedenAuthenticationProvider\"`", "3-0": "`authenticationMethods`\n*required*", "3-1": "`array of string`", "3-2": "A list of allowed authentication methods for this authentication session.\n\n**Examples:**\n \n ```[\"MobileBankId\"]```", "4-0": "`clientIPAddress`", "4-1": "`string`", "4-2": "IP address of the customer. Recommended. \n\n This enables BankID to \"reconnect\" a customer to an active session if the connection to the session is lost. \n\n**Examples:** `\"10.123.123.123\"`" }, "cols": 3, "rows": 5 } [/block] ## Response Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`authenticationSessionId`\n***conditional***", "0-1": "`guid`", "0-2": "Unique identifier for the created authentication session.\n\n**Conditions:**\n\n> This parameter is not returned in error situations.\n\n**Examples:** `\"eb85023a-ff9d-4537-95d0-f9d045b3e872\"`", "1-0": "`status`\n*required*", "1-1": "`status`", "1-2": "API Operation status." }, "cols": 3, "rows": 2 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



**Initiate Authentication Session** Creates an authentication session using the selected authentication provider. [block:code] { "codes": [ { "code": "POST /authentication/person/{countryCode}/{governmentId}", "language": "json", "name": "HTTP Request" } ] } [/block] ## Request Parameters [block:parameters] { "data": { "0-0": "`countrycode`\n*required*", "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-1": "`string(2)`", "0-2": "The two-letter country code in ISO 3166 format. \n\n**Examples:** `\"SE\"`", "1-0": "`governmentId`\n*required*", "1-1": "`string(12)`", "1-2": "For Sweden: The customer's 12 digit government ID, without a dash. \n\nExamples: `\"198901157993\"`", "2-0": "`providerType`\n*required*", "2-1": "`string`", "2-2": "The name of the provider to use for authenticating. For a list of available providers see the \"GET\" /authentication/providers endpoint.\n\n**Examples:** `\"BankIdSwedenAuthenticationProvider\"`", "3-0": "`authenticationMethods`\n*required*", "3-1": "`array of string`", "3-2": "A list of allowed authentication methods for this authentication session.\n\n**Examples:**\n \n ```[\"MobileBankId\"]```", "4-0": "`clientIPAddress`", "4-1": "`string`", "4-2": "IP address of the customer. Recommended. \n\n This enables BankID to \"reconnect\" a customer to an active session if the connection to the session is lost. \n\n**Examples:** `\"10.123.123.123\"`" }, "cols": 3, "rows": 5 } [/block] ## Response Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`authenticationSessionId`\n***conditional***", "0-1": "`guid`", "0-2": "Unique identifier for the created authentication session.\n\n**Conditions:**\n\n> This parameter is not returned in error situations.\n\n**Examples:** `\"eb85023a-ff9d-4537-95d0-f9d045b3e872\"`", "1-0": "`status`\n*required*", "1-1": "`status`", "1-2": "API Operation status." }, "cols": 3, "rows": 2 } [/block]
{"_id":"58591b697c26220f00bd6062","parentDoc":null,"project":"54930e7c777ff221004a7e6d","user":"5818a4ecb1e11c1900bf76c3","version":"54930e7c777ff221004a7e70","link_external":false,"link_url":"","title":"Get Authentication Session Status","excerpt":"","slug":"get-authentication-session-status","category":"5857de7a6ee38323003fe794","createdAt":"2016-12-20T11:52:09.920Z","githubsync":"","isReference":true,"order":2,"type":"get","__v":0,"api":{"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"statusCode\": \"Initiated\",\n  \"providerStatusCode\": \"OUTSTANDING_TRANSACTION\",\n  \"providerErrorCode\": null,\n  \"status\": {\n    \"isSuccess\": true,\n    \"errorNumber\": 0,\n    \"statusKey\": \"SUCCESS\",\n    \"statusMessage\": \"The operation was successful.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  }\n}","name":""},{"status":200,"language":"json","code":"{\n  \"statusCode\": null,\n  \"providerStatusCode\": null,\n  \"providerErrorCode\": null,\n  \"status\": {\n    \"isSuccess\": false,\n    \"errorNumber\": 6003,\n    \"statusKey\": \"TOO_MANY_REQUESTS\",\n    \"statusMessage\": \"Checks for provider BankIdSwedenAuthenticationProvider was called with an interval of 1253,959ms which is lower than the allowed rate 2000ms.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  }\n}","name":"Too Many Requests"},{"name":"Cannot Check Authentication Session","status":200,"language":"json","code":"{\n  \"statusCode\": null,\n  \"providerStatusCode\": null,\n  \"providerErrorCode\": null,\n  \"status\": {\n    \"isSuccess\": false,\n    \"errorNumber\": 6001,\n    \"statusKey\": \"CAN_NOT_CHECK_AUTHENTICATION_SESSION\",\n    \"statusMessage\": \"An error occurred while checking an authentication session.\",\n    \"errors\": null,\n    \"exceptionDetails\": null\n  }\n}"},{"name":"Validation Error","status":200,"language":"json","code":"{\n  \"statusCode\": null,\n  \"providerStatusCode\": null,\n  \"providerErrorCode\": null,\n  \"status\": {\n    \"isSuccess\": false,\n    \"errorNumber\": -2,\n    \"statusKey\": \"VALIDATION_ERROR\",\n    \"statusMessage\": \"The request contained one or more validation errors.  See the errors collection for further details.\",\n    \"errors\": [\n      {\n        \"errorCode\": \"NotEmpty\",\n        \"fieldName\": \"AuthenticationSessionId\",\n        \"message\": \"'Authentication Session Id' should not be empty.\"\n      }\n    ],\n    \"exceptionDetails\": null\n  }\n}"}]},"settings":"","url":"/authentication/session/{sessionId}","auth":"required","examples":{"codes":[{"language":"json","code":"\"GET\" /authentication/session/eb85023a-ff9d-4537-95d0-f9d045b3e872\n"}]}},"updates":[],"hidden":false,"next":{"description":"","pages":[]},"sync_unique":"","body":"The **Get Authentication Session Status** command returns the current status of an authentication session.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"The providers may have a rate limit on how often you are allowed to check an authentication sessions status, if you poll this endpoint at a higher rate than this limit you will get an error message telling you to back off and poll with a higher interval.\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /authentication/session/{sessionId}\",\n      \"language\": \"http\",\n      \"name\": \"HTTP Request\"\n    }\n  ]\n}\n[/block]\n## Request Parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`sessionId`\\n*required*\",\n    \"0-1\": \"`guid`\",\n    \"0-2\": \"The ID of the authentication session.\\n\\n**Examples:** \\\"eb85023a-ff9d-4537-95d0-f9d045b3e872\\\"\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n## Response Parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`statusCode`\\n***conditional***\",\n    \"0-1\": \"`string`\",\n    \"0-2\": \"The normalized status code for the authentication sessions current status.\\n\\n**Possible values:** \\n> `\\\"Initiated\\\"`, `\\\"Ongoing\\\"`, `\\\"Completed\\\"`, `\\\"Failed\\\"`, `\\\"Expired\\\"`, `\\\"Cancelled\\\"`\",\n    \"1-0\": \"`providerStatusCode`\\n***conditional***\",\n    \"1-1\": \"`string`\",\n    \"1-2\": \"The verbatim status code returned by the authentication provider.\\n\\n**Possible values:**\\n> Please refer to the authentication providers documentation for a listing of the possible status codes.\",\n    \"2-0\": \"`providerErrorCode`\",\n    \"2-1\": \"`string`\",\n    \"3-0\": \"`status`\\n*required*\",\n    \"3-1\": \"`status`\",\n    \"3-2\": \"API Operation status.\",\n    \"2-2\": \"The verbatim status code returned by the authentication provider.\\n\\n**Possible values:**\\n> Please refer to the authentication providers documentation for a listing of the possible status codes.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","childrenPages":[]}

getGet Authentication Session Status


The **Get Authentication Session Status** command returns the current status of an authentication session. [block:callout] { "type": "warning", "body": "The providers may have a rate limit on how often you are allowed to check an authentication sessions status, if you poll this endpoint at a higher rate than this limit you will get an error message telling you to back off and poll with a higher interval." } [/block] [block:code] { "codes": [ { "code": "GET /authentication/session/{sessionId}", "language": "http", "name": "HTTP Request" } ] } [/block] ## Request Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`sessionId`\n*required*", "0-1": "`guid`", "0-2": "The ID of the authentication session.\n\n**Examples:** \"eb85023a-ff9d-4537-95d0-f9d045b3e872\"" }, "cols": 3, "rows": 1 } [/block] ## Response Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`statusCode`\n***conditional***", "0-1": "`string`", "0-2": "The normalized status code for the authentication sessions current status.\n\n**Possible values:** \n> `\"Initiated\"`, `\"Ongoing\"`, `\"Completed\"`, `\"Failed\"`, `\"Expired\"`, `\"Cancelled\"`", "1-0": "`providerStatusCode`\n***conditional***", "1-1": "`string`", "1-2": "The verbatim status code returned by the authentication provider.\n\n**Possible values:**\n> Please refer to the authentication providers documentation for a listing of the possible status codes.", "2-0": "`providerErrorCode`", "2-1": "`string`", "3-0": "`status`\n*required*", "3-1": "`status`", "3-2": "API Operation status.", "2-2": "The verbatim status code returned by the authentication provider.\n\n**Possible values:**\n> Please refer to the authentication providers documentation for a listing of the possible status codes." }, "cols": 3, "rows": 4 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The **Get Authentication Session Status** command returns the current status of an authentication session. [block:callout] { "type": "warning", "body": "The providers may have a rate limit on how often you are allowed to check an authentication sessions status, if you poll this endpoint at a higher rate than this limit you will get an error message telling you to back off and poll with a higher interval." } [/block] [block:code] { "codes": [ { "code": "GET /authentication/session/{sessionId}", "language": "http", "name": "HTTP Request" } ] } [/block] ## Request Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`sessionId`\n*required*", "0-1": "`guid`", "0-2": "The ID of the authentication session.\n\n**Examples:** \"eb85023a-ff9d-4537-95d0-f9d045b3e872\"" }, "cols": 3, "rows": 1 } [/block] ## Response Parameters [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`statusCode`\n***conditional***", "0-1": "`string`", "0-2": "The normalized status code for the authentication sessions current status.\n\n**Possible values:** \n> `\"Initiated\"`, `\"Ongoing\"`, `\"Completed\"`, `\"Failed\"`, `\"Expired\"`, `\"Cancelled\"`", "1-0": "`providerStatusCode`\n***conditional***", "1-1": "`string`", "1-2": "The verbatim status code returned by the authentication provider.\n\n**Possible values:**\n> Please refer to the authentication providers documentation for a listing of the possible status codes.", "2-0": "`providerErrorCode`", "2-1": "`string`", "3-0": "`status`\n*required*", "3-1": "`status`", "3-2": "API Operation status.", "2-2": "The verbatim status code returned by the authentication provider.\n\n**Possible values:**\n> Please refer to the authentication providers documentation for a listing of the possible status codes." }, "cols": 3, "rows": 4 } [/block]
{"_id":"5835ba82b67de41b00d7b4a2","body":"When you receive an EHN from us you will always receive the following fields:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`EVENT_TYPE`\\n*required*\",\n    \"1-0\": \"`EVENT_TIMESTAMP`\\n*required*\",\n    \"2-0\": \"`DELIVERY_TIMESTAMP`\\n*required*\",\n    \"3-0\": \"`MERCHANT_ID`\\n*required*\",\n    \"4-0\": \"`Digest`\\n*required*\",\n    \"0-1\": \"`string`\",\n    \"1-1\": \"`datetime`\",\n    \"2-1\": \"`datetime`\",\n    \"3-1\": \"`int`\",\n    \"4-1\": \"`string(40)`\",\n    \"4-2\": \"A SHA-1 hash to be used in verifying the message's origin.\",\n    \"3-2\": \"The ID of the merchant account for which the event occurred.\",\n    \"2-2\": \"UTC timestamp of when this notification delivery is being attempted.\\n\\n**Example:** `2016-11-06 12:22:19Z`\",\n    \"1-2\": \"UTC timestamp of when the event occurred. \\n\\n**Example:** `2016-11-06 12:22:19Z`\",\n    \"0-2\": \"A string literal indicating the type of notification being sent.\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","isReference":false,"link_external":false,"project":"54930e7c777ff221004a7e6d","version":"54930e7c777ff221004a7e70","parentDoc":null,"slug":"common-fields","type":"basic","api":{"auth":"required","params":[],"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"githubsync":"","link_url":"","next":{"pages":[],"description":""},"order":0,"updates":[],"__v":0,"excerpt":"","sync_unique":"","user":"5818a4ecb1e11c1900bf76c3","category":"5835938b9a8d971900dd2e38","createdAt":"2016-11-23T15:49:22.119Z","hidden":false,"title":"Common Fields","childrenPages":[]}

Common Fields


When you receive an EHN from us you will always receive the following fields: [block:parameters] { "data": { "0-0": "`EVENT_TYPE`\n*required*", "1-0": "`EVENT_TIMESTAMP`\n*required*", "2-0": "`DELIVERY_TIMESTAMP`\n*required*", "3-0": "`MERCHANT_ID`\n*required*", "4-0": "`Digest`\n*required*", "0-1": "`string`", "1-1": "`datetime`", "2-1": "`datetime`", "3-1": "`int`", "4-1": "`string(40)`", "4-2": "A SHA-1 hash to be used in verifying the message's origin.", "3-2": "The ID of the merchant account for which the event occurred.", "2-2": "UTC timestamp of when this notification delivery is being attempted.\n\n**Example:** `2016-11-06 12:22:19Z`", "1-2": "UTC timestamp of when the event occurred. \n\n**Example:** `2016-11-06 12:22:19Z`", "0-2": "A string literal indicating the type of notification being sent.", "h-0": "Property", "h-1": "Type", "h-2": "Description" }, "cols": 3, "rows": 5 } [/block]
When you receive an EHN from us you will always receive the following fields: [block:parameters] { "data": { "0-0": "`EVENT_TYPE`\n*required*", "1-0": "`EVENT_TIMESTAMP`\n*required*", "2-0": "`DELIVERY_TIMESTAMP`\n*required*", "3-0": "`MERCHANT_ID`\n*required*", "4-0": "`Digest`\n*required*", "0-1": "`string`", "1-1": "`datetime`", "2-1": "`datetime`", "3-1": "`int`", "4-1": "`string(40)`", "4-2": "A SHA-1 hash to be used in verifying the message's origin.", "3-2": "The ID of the merchant account for which the event occurred.", "2-2": "UTC timestamp of when this notification delivery is being attempted.\n\n**Example:** `2016-11-06 12:22:19Z`", "1-2": "UTC timestamp of when the event occurred. \n\n**Example:** `2016-11-06 12:22:19Z`", "0-2": "A string literal indicating the type of notification being sent.", "h-0": "Property", "h-1": "Type", "h-2": "Description" }, "cols": 3, "rows": 5 } [/block]
{"_id":"5835a58db67de41b00d7b47a","order":1,"slug":"ehn-payment","title":"EHN: Payment","version":"54930e7c777ff221004a7e70","body":"The **Payment** EHN is received when a payment has either been completed or attempted on a payment session in our Aero hosted payment interface.\n\n## Data Fields\n\nIn addition to the [Common Fields](doc:common-fields), you will receive the following information:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`ORDER_ID`\\n*required*\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"1-0\": \"`ORDER_NUMBER`\\n*required*\",\n    \"2-0\": \"`SESSION_ID`\\n*required*\",\n    \"3-0\": \"`PAYMENT_STATUS`\\n*required*\",\n    \"4-0\": \"`PAYMENT_STATUS_REASON`\\n*required*\",\n    \"5-0\": \"`AMOUNT`\\n*required*\",\n    \"6-0\": \"`CURRENCY_CODE`\\n*required*\",\n    \"7-0\": \"`TRANSACTION_ID`\\n*required*\",\n    \"8-0\": \"`PAYMENT_METHOD_ID`\\n*required*\",\n    \"9-0\": \"`CARD_FIRST_SIX`\\n***conditional***\",\n    \"10-0\": \"`CARD_LAST_FOUR`\\n***conditional***\",\n    \"11-0\": \"`CARD_CARDHOLDER_NAME`\\n***conditional***\",\n    \"12-0\": \"`CARD_EXPIRATION_MONTH`\\n***conditional***\",\n    \"13-0\": \"`CARD_EXPIRATION_YEAR`\\n***conditional***\",\n    \"14-0\": \"`ACQUIRER_ID`\\n*required*\",\n    \"15-0\": \"`ACQUIRER_REFERENCE_ID`\\n*required*\",\n    \"16-0\": \"`ACQUIRER_RESPONSE_CODE`\\n***conditional***\",\n    \"17-0\": \"`CUSTOM_DATA_COUNT`\\n*required*\",\n    \"18-0\": \"`CUSTOM_DATA_#_KEY`\\n***conditional***\",\n    \"19-0\": \"`CUSTOM_DATA_#_VALUE`\\n***conditional***\",\n    \"20-0\": \"`APPROVAL_CODE`\\n***conditional***\",\n    \"0-1\": \"`guid`\",\n    \"2-1\": \"`guid`\",\n    \"1-1\": \"`string`\",\n    \"3-1\": \"`string`\",\n    \"4-1\": \"`string`\",\n    \"5-1\": \"`decimal`\",\n    \"6-1\": \"`string(3)`\",\n    \"7-1\": \"`int`\",\n    \"8-1\": \"`int`\",\n    \"9-1\": \"`string(6)`\",\n    \"10-1\": \"`string(4)`\",\n    \"11-1\": \"`string`\",\n    \"12-1\": \"`int`\",\n    \"13-1\": \"`string(4)`\",\n    \"14-1\": \"`int`\",\n    \"15-1\": \"`string`\",\n    \"16-1\": \"`string`\",\n    \"18-1\": \"`string`\",\n    \"19-1\": \"`string`\",\n    \"20-1\": \"`string`\",\n    \"17-1\": \"`int`\",\n    \"0-2\": \"Paynova's unique identifier for the order to which the payment belongs.\",\n    \"1-2\": \"Your order/PO number for this order.\",\n    \"2-2\": \"Paynova's unique payment session ID, if this payment was made within a payment session.\",\n    \"3-2\": \"The status of the payment.\\n\\n**Possible values:**\\n\\n> **CANCELLED**\\nThe payment was cancelled.\\n\\n> **DECLINED**\\nThe payment was declined.\\n\\n> **ERROR**\\nAn unexpected, unrecoverable error occurred while processing this payment.\\n\\n> **PENDING**\\nThe payment is in a pending state.\\n\\n> **COMPLETED**\\nThe payment has been completed and no further action is required.\\n\\n> **AUTHORIZED**\\nThe payment has been authorized, and a finalize is required to complete the transaction.\",\n    \"4-2\": \"A finer-grained status code possibly providing more information as to the value of PAYMENT_STATUS.\\n\\n**Possible values:**\\n\\n> **NONE**\\nNo additional reason information is available.\\n\\n> **FRAUD_SCREENING**\\nThe transaction was declined by fraud screening.\\n\\n> **BANK_COMMUNICATION_ERROR**\\nThere was an error communicating with the bank.\\n\\n> **BANK_ACCOUNT_VALIDATION**\\nThe transaction was declined due to invalid bank account details.\\n\\n> **DECLINED_BY_PROCESSOR**\\nThe transaction was declined by the bank or processor.\\n\\n> **FAILED_AUTHENTICATION**\\nThe transaction failed authentication (3-D Secure, for example).\\n\\n> **CANCELLED_BY_CUSTOMER**\\nThe customer cancelled the transaction.\",\n    \"5-2\": \"The amount of the transaction. Two decimal points, decimal point as separator.\\n\\n**Example:** `1234.56`\",\n    \"6-2\": \"The three-letter currency code.\\n\\n**Example:** `\\\"SEK\\\"`\",\n    \"7-2\": \"The transaction ID.\\n\\n**Constraints:**\\n> Length=18\\n\\n**Example:** `\\\"123123123123123123\\\"`\",\n    \"8-2\": \"The ID of the payment method.\\nSee [Payment Methods](doc:paymentmethods) page for possible values.\",\n    \"9-2\": \"The card BIN (first six digits).\\n\\n**Conditions:**\\n> Only applicable for card payments. \\n\\n**Example:** `\\\"666666\\\"`\",\n    \"10-2\": \"The last four digits of the card number.\\n\\n**Conditions:**\\n> Only applicable for card payments. \\n\\n**Example:** `\\\"4444\\\"`\",\n    \"11-2\": \"The cardholder's name (name printed on the card).\\n\\n**Conditions:**\\n> Only applicable for card payments.\",\n    \"12-2\": \"The card expiration month.\\n\\n**Constraints:**\\n> Length=2\\n\\n**Conditions:**\\n> Only applicable for card payments.\\n\\n**Example:** `10`\",\n    \"13-2\": \"The card expiration year.\\n\\n**Conditions:**\\n> Only applicable for card payments. \\n\\n**Example:** `2016`\",\n    \"14-2\": \"Paynova's ID for the acquirer of the transaction.\\n\\n**Constraints:**\\n> Length=4\",\n    \"15-2\": \"The reference id that the bank uses to refer to this transaction.\",\n    \"16-2\": \"Acquirer response code.\\n\\n**Conditions:**\\n> Returned if provided by the acquirer.\",\n    \"17-2\": \"Indicates the 1-indexed number of CUSTOM_DATA fields included in this notification.\",\n    \"18-2\": \"The key of the key-value pair.\\n\\n**Conditions:**\\n> Applicable only if CUSTOM_DATA_COUNT > 0.\",\n    \"20-2\": \"The approval code.\",\n    \"19-2\": \"The value of the key-value pair.\\n\\n**Conditions:**\\n> Applicable only if CUSTOM_DATA_COUNT > 0.\"\n  },\n  \"cols\": 3,\n  \"rows\": 21\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"**If fraud screening is used, the following fields will also be sent.**\"\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`FRAUD_SCREENING_PROVIDER_ID`\\n*required*\",\n    \"0-1\": \"`int`\",\n    \"0-2\": \"The ID of the fraud screening provider.\\n\\n**Possible values (ID-Name):**\\n>  33 - Razor\\n> 12 - CyberSource\\n> 37 - Accertify\",\n    \"1-0\": \"`FRAUD_SCREENING_PROVIDER_NAME`\\n*required*\",\n    \"1-1\": \"`string`\",\n    \"1-2\": \"The name of the fraud screening provider.\",\n    \"2-0\": \"`FRAUD_SCREENING_MODE`\\n*required*\",\n    \"3-0\": \"`FRAUD_SCREENING_DECISION`\\n*required*\",\n    \"4-0\": \"`FRAUD_SCREENING_SCORE`\\n*required*\",\n    \"5-0\": \"`FRAUD_SCREENING_MESSAGE`\\n*required*\",\n    \"6-0\": \"`FRAUD_SCREENING_REFERENCE_ID`\\n*required*\",\n    \"2-2\": \"One of `Disabled`, `LoggingOnly` or `Enabled`.\",\n    \"2-1\": \"`string`\",\n    \"3-1\": \"`string`\",\n    \"4-1\": \"`decimal`\",\n    \"5-1\": \"`string`\",\n    \"6-1\": \"`string`\",\n    \"3-2\": \"One of `Accept`, `Challenge`, `Reject`, `Review` or `Suspicious`.\",\n    \"4-2\": \"The scoring value returned by the provider.\",\n    \"5-2\": \"The message returned by the provider.\",\n    \"6-2\": \"The reference ID returned by the provider to which the transaction can be looked up at the provider.\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"**If the FRAUD_SCREENING_PROVIDER_ID = 33 (Razor), the following fields will also be sent.**\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`RAZOR_MESSAGE`\\n*required*\",\n    \"0-1\": \"`string`\",\n    \"0-2\": \"Razor-specific message.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"**If the FRAUD_SCREENING_PROVIDER_ID = 37 (Accertify), the following fields will also be sent.**\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`ACCERTIFY_REMARKS`\\n*required*\",\n    \"0-1\": \"`string`\",\n    \"1-1\": \"`string`\",\n    \"2-1\": \"`string`\",\n    \"1-0\": \"`ACCERTIFY_RULES_TRIPPED`\\n*required*\",\n    \"2-0\": \"`ACCERTIFY_TRANSACTION_ID`\\n*required*\",\n    \"0-2\": \"Remarks returned by Accertify.\",\n    \"1-2\": \"Rules which were tripped/triggered.\",\n    \"2-2\": \"Accertify's transaction ID.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"**If DCC (Dynamic Currency Conversion) is used, the following fields will also be sent.**\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`DCC_AMOUNT`\\n*required*\",\n    \"1-0\": \"`DCC_CURRENCY_CODE` \\n*required*\",\n    \"2-0\": \"`DCC_EXCHANGE_RATE` \\n*required*\",\n    \"3-0\": \"`DCC_EXCHANGE_RATE_SOURCE_NAME` \\n*required*\",\n    \"0-1\": \"`decimal`\",\n    \"1-1\": \"`string(3)`\",\n    \"2-1\": \"`decimal`\",\n    \"3-1\": \"`string`\",\n    \"0-2\": \"The converted amount (the amount the customer paid in their home currency).\",\n    \"1-2\": \"The currency code in which the customer paid.\",\n    \"2-2\": \"The exchange-rate at which the conversion took place.\",\n    \"3-2\": \"The source bank of the exchange rate.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example - Payment\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Total-Route-Time: 0\\nContent-Length: 972\\nConnect-Time: 2\\nConnection: close\\nContent-Type: application/x-www-form-urlencoded\\nPn-Digest: 57E0AD4EF608761FEC10073274EF54BC33C12386\\nVia: 1.1 vegur\\nX-Request-Id: dced1302-8923-41c2-a62c-4315d70071f7\\nHost: requestb.in\",\n      \"language\": \"text\",\n      \"name\": \"Headers\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"SESSION_ID: 04156f48-e6d4-45b1-8f62-a37f00cb17c2\\nCARD_EXPIRATION_YEAR: 2017\\nACCERTIFY_RULES_TRIPPED:\\nACCERTIFY_REMARKS:\\nCARD_EXPIRATION_MONTH: 4\\nFRAUD_SCREENING_REFERENCE_ID: d1e499d0-4ba9-48e7-86b4-ed938594015b\\nAPPROVAL_CODE: 582860\\nFRAUD_SCREENING_PROVIDER_ID: 37\\nORDER_ID: 3ec05393-4598-484e-8666-a37f00cb0499\\nFRAUD_SCREENING_SCORE: 0\\nORDER_NUMBER: API-99C91D50-20140806141826\\nACQUIRER_REFERENCE_ID: 500113544\\nPAYMENT_STATUS: AUTHORIZED\\nAMOUNT: 100.00\\nACQUIRER_ID: 1010\\nDIGEST: 514ECFE34864E8F717CE016F1505D94FBF8B5813\\nDELIVERY_TIMESTAMP: 2016-11-06 12:22:19Z\\nFRAUD_SCREENING_PROVIDER_NAME: Accertify\\nFRAUD_SCREENING_MODE: Enabled\\nEVENT_TYPE: PAYMENT\\nCARD_CARDHOLDER_NAME: NAMN ENAMNI\\nPAYMENT_STATUS_REASON: NONE\\nTRANSACTION_ID: 201408061421475374\\nEVENT_TIMESTAMP: 2016-11-06 12:22:19Z\\nCARD_FIRST_SIX: 411111\\nACCERTIFY_TRANSACTION_ID: API-99C91D50-20\\nFRAUD_SCREENING_DECISION: Accept\\nPAYMENT_METHOD_ID: 1\\nCARD_LAST_FOUR: 1111\\nCURRENCY_CODE: SEK\\nCUSTOM_DATA_COUNT: 0\\nMERCHANT_ID: 4999\",\n      \"language\": \"text\",\n      \"name\": \"FORM/POST Parameters\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"ACCERTIFY_REMARKS=&ACCERTIFY_RULES_TRIPPED=&ACCERTIFY_TRANSACTION_ID=API-99C91D50-20&ACQUIRER_ID=1010&ACQUIRER_REFERENCE_ID=500113544&AMOUNT=100.00&APPROVAL_CODE=582860&CARD_CARDHOLDER_NAME=asdf+as%c3%b6ldk+as&CARD_EXPIRATION_MONTH=4&CARD_EXPIRATION_YEAR=2016&CARD_FIRST_SIX=411111&CARD_LAST_FOUR=1111&CURRENCY_CODE=SEK&CUSTOM_DATA_COUNT=0&DELIVERY_TIMESTAMP=2014-08-06+12%3a22%3a19Z&DIGEST=514ECFE34864E8F717CE016F1505D94FBF8B5813&EVENT_TIMESTAMP=2016-11-06+12%3a22%3a19Z&EVENT_TYPE=PAYMENT&FRAUD_SCREENING_DECISION=Accept&FRAUD_SCREENING_MODE=Enabled&FRAUD_SCREENING_PROVIDER_ID=37&FRAUD_SCREENING_PROVIDER_NAME=Accertify&FRAUD_SCREENING_REFERENCE_ID=d1e499d0-4ba9-48e7-86b4-ed938594015b&FRAUD_SCREENING_SCORE=0&MERCHANT_ID=4999&ORDER_ID=3ec05393-4598-484e-8666-a37f00cb0499&ORDER_NUMBER=API-99C91D50-20161106141826&PAYMENT_METHOD_ID=1&PAYMENT_STATUS=AUTHORIZED&PAYMENT_STATUS_REASON=NONE&SESSION_ID=04156f48-e6d4-45b1-8f62-a37f00cb17c2&TRANSACTION_ID=201611061421475374\\n\",\n      \"language\": \"text\",\n      \"name\": \"RAW Body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","githubsync":"","isReference":false,"type":"basic","__v":0,"category":"5835938b9a8d971900dd2e38","link_external":false,"link_url":"","parentDoc":null,"project":"54930e7c777ff221004a7e6d","user":"5818a4ecb1e11c1900bf76c3","excerpt":"","hidden":false,"sync_unique":"","updates":[],"api":{"auth":"required","params":[],"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"createdAt":"2016-11-23T14:19:57.531Z","next":{"pages":[],"description":""},"childrenPages":[]}

EHN: Payment


The **Payment** EHN is received when a payment has either been completed or attempted on a payment session in our Aero hosted payment interface. ## Data Fields In addition to the [Common Fields](doc:common-fields), you will receive the following information: [block:parameters] { "data": { "0-0": "`ORDER_ID`\n*required*", "h-0": "Property", "h-1": "Type", "h-2": "Description", "1-0": "`ORDER_NUMBER`\n*required*", "2-0": "`SESSION_ID`\n*required*", "3-0": "`PAYMENT_STATUS`\n*required*", "4-0": "`PAYMENT_STATUS_REASON`\n*required*", "5-0": "`AMOUNT`\n*required*", "6-0": "`CURRENCY_CODE`\n*required*", "7-0": "`TRANSACTION_ID`\n*required*", "8-0": "`PAYMENT_METHOD_ID`\n*required*", "9-0": "`CARD_FIRST_SIX`\n***conditional***", "10-0": "`CARD_LAST_FOUR`\n***conditional***", "11-0": "`CARD_CARDHOLDER_NAME`\n***conditional***", "12-0": "`CARD_EXPIRATION_MONTH`\n***conditional***", "13-0": "`CARD_EXPIRATION_YEAR`\n***conditional***", "14-0": "`ACQUIRER_ID`\n*required*", "15-0": "`ACQUIRER_REFERENCE_ID`\n*required*", "16-0": "`ACQUIRER_RESPONSE_CODE`\n***conditional***", "17-0": "`CUSTOM_DATA_COUNT`\n*required*", "18-0": "`CUSTOM_DATA_#_KEY`\n***conditional***", "19-0": "`CUSTOM_DATA_#_VALUE`\n***conditional***", "20-0": "`APPROVAL_CODE`\n***conditional***", "0-1": "`guid`", "2-1": "`guid`", "1-1": "`string`", "3-1": "`string`", "4-1": "`string`", "5-1": "`decimal`", "6-1": "`string(3)`", "7-1": "`int`", "8-1": "`int`", "9-1": "`string(6)`", "10-1": "`string(4)`", "11-1": "`string`", "12-1": "`int`", "13-1": "`string(4)`", "14-1": "`int`", "15-1": "`string`", "16-1": "`string`", "18-1": "`string`", "19-1": "`string`", "20-1": "`string`", "17-1": "`int`", "0-2": "Paynova's unique identifier for the order to which the payment belongs.", "1-2": "Your order/PO number for this order.", "2-2": "Paynova's unique payment session ID, if this payment was made within a payment session.", "3-2": "The status of the payment.\n\n**Possible values:**\n\n> **CANCELLED**\nThe payment was cancelled.\n\n> **DECLINED**\nThe payment was declined.\n\n> **ERROR**\nAn unexpected, unrecoverable error occurred while processing this payment.\n\n> **PENDING**\nThe payment is in a pending state.\n\n> **COMPLETED**\nThe payment has been completed and no further action is required.\n\n> **AUTHORIZED**\nThe payment has been authorized, and a finalize is required to complete the transaction.", "4-2": "A finer-grained status code possibly providing more information as to the value of PAYMENT_STATUS.\n\n**Possible values:**\n\n> **NONE**\nNo additional reason information is available.\n\n> **FRAUD_SCREENING**\nThe transaction was declined by fraud screening.\n\n> **BANK_COMMUNICATION_ERROR**\nThere was an error communicating with the bank.\n\n> **BANK_ACCOUNT_VALIDATION**\nThe transaction was declined due to invalid bank account details.\n\n> **DECLINED_BY_PROCESSOR**\nThe transaction was declined by the bank or processor.\n\n> **FAILED_AUTHENTICATION**\nThe transaction failed authentication (3-D Secure, for example).\n\n> **CANCELLED_BY_CUSTOMER**\nThe customer cancelled the transaction.", "5-2": "The amount of the transaction. Two decimal points, decimal point as separator.\n\n**Example:** `1234.56`", "6-2": "The three-letter currency code.\n\n**Example:** `\"SEK\"`", "7-2": "The transaction ID.\n\n**Constraints:**\n> Length=18\n\n**Example:** `\"123123123123123123\"`", "8-2": "The ID of the payment method.\nSee [Payment Methods](doc:paymentmethods) page for possible values.", "9-2": "The card BIN (first six digits).\n\n**Conditions:**\n> Only applicable for card payments. \n\n**Example:** `\"666666\"`", "10-2": "The last four digits of the card number.\n\n**Conditions:**\n> Only applicable for card payments. \n\n**Example:** `\"4444\"`", "11-2": "The cardholder's name (name printed on the card).\n\n**Conditions:**\n> Only applicable for card payments.", "12-2": "The card expiration month.\n\n**Constraints:**\n> Length=2\n\n**Conditions:**\n> Only applicable for card payments.\n\n**Example:** `10`", "13-2": "The card expiration year.\n\n**Conditions:**\n> Only applicable for card payments. \n\n**Example:** `2016`", "14-2": "Paynova's ID for the acquirer of the transaction.\n\n**Constraints:**\n> Length=4", "15-2": "The reference id that the bank uses to refer to this transaction.", "16-2": "Acquirer response code.\n\n**Conditions:**\n> Returned if provided by the acquirer.", "17-2": "Indicates the 1-indexed number of CUSTOM_DATA fields included in this notification.", "18-2": "The key of the key-value pair.\n\n**Conditions:**\n> Applicable only if CUSTOM_DATA_COUNT > 0.", "20-2": "The approval code.", "19-2": "The value of the key-value pair.\n\n**Conditions:**\n> Applicable only if CUSTOM_DATA_COUNT > 0." }, "cols": 3, "rows": 21 } [/block] [block:textarea] { "text": "", "sidebar": true } [/block] [block:callout] { "type": "info", "body": "**If fraud screening is used, the following fields will also be sent.**" } [/block] [block:textarea] { "text": "", "sidebar": true } [/block] [block:parameters] { "data": { "0-0": "`FRAUD_SCREENING_PROVIDER_ID`\n*required*", "0-1": "`int`", "0-2": "The ID of the fraud screening provider.\n\n**Possible values (ID-Name):**\n> 33 - Razor\n> 12 - CyberSource\n> 37 - Accertify", "1-0": "`FRAUD_SCREENING_PROVIDER_NAME`\n*required*", "1-1": "`string`", "1-2": "The name of the fraud screening provider.", "2-0": "`FRAUD_SCREENING_MODE`\n*required*", "3-0": "`FRAUD_SCREENING_DECISION`\n*required*", "4-0": "`FRAUD_SCREENING_SCORE`\n*required*", "5-0": "`FRAUD_SCREENING_MESSAGE`\n*required*", "6-0": "`FRAUD_SCREENING_REFERENCE_ID`\n*required*", "2-2": "One of `Disabled`, `LoggingOnly` or `Enabled`.", "2-1": "`string`", "3-1": "`string`", "4-1": "`decimal`", "5-1": "`string`", "6-1": "`string`", "3-2": "One of `Accept`, `Challenge`, `Reject`, `Review` or `Suspicious`.", "4-2": "The scoring value returned by the provider.", "5-2": "The message returned by the provider.", "6-2": "The reference ID returned by the provider to which the transaction can be looked up at the provider." }, "cols": 3, "rows": 7 } [/block] [block:callout] { "type": "info", "body": "**If the FRAUD_SCREENING_PROVIDER_ID = 33 (Razor), the following fields will also be sent.**" } [/block] [block:parameters] { "data": { "0-0": "`RAZOR_MESSAGE`\n*required*", "0-1": "`string`", "0-2": "Razor-specific message." }, "cols": 3, "rows": 1 } [/block] [block:callout] { "type": "info", "body": "**If the FRAUD_SCREENING_PROVIDER_ID = 37 (Accertify), the following fields will also be sent.**" } [/block] [block:parameters] { "data": { "0-0": "`ACCERTIFY_REMARKS`\n*required*", "0-1": "`string`", "1-1": "`string`", "2-1": "`string`", "1-0": "`ACCERTIFY_RULES_TRIPPED`\n*required*", "2-0": "`ACCERTIFY_TRANSACTION_ID`\n*required*", "0-2": "Remarks returned by Accertify.", "1-2": "Rules which were tripped/triggered.", "2-2": "Accertify's transaction ID." }, "cols": 3, "rows": 3 } [/block] [block:callout] { "type": "success", "body": "**If DCC (Dynamic Currency Conversion) is used, the following fields will also be sent.**" } [/block] [block:parameters] { "data": { "0-0": "`DCC_AMOUNT`\n*required*", "1-0": "`DCC_CURRENCY_CODE` \n*required*", "2-0": "`DCC_EXCHANGE_RATE` \n*required*", "3-0": "`DCC_EXCHANGE_RATE_SOURCE_NAME` \n*required*", "0-1": "`decimal`", "1-1": "`string(3)`", "2-1": "`decimal`", "3-1": "`string`", "0-2": "The converted amount (the amount the customer paid in their home currency).", "1-2": "The currency code in which the customer paid.", "2-2": "The exchange-rate at which the conversion took place.", "3-2": "The source bank of the exchange rate." }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "Example - Payment", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "Total-Route-Time: 0\nContent-Length: 972\nConnect-Time: 2\nConnection: close\nContent-Type: application/x-www-form-urlencoded\nPn-Digest: 57E0AD4EF608761FEC10073274EF54BC33C12386\nVia: 1.1 vegur\nX-Request-Id: dced1302-8923-41c2-a62c-4315d70071f7\nHost: requestb.in", "language": "text", "name": "Headers" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "SESSION_ID: 04156f48-e6d4-45b1-8f62-a37f00cb17c2\nCARD_EXPIRATION_YEAR: 2017\nACCERTIFY_RULES_TRIPPED:\nACCERTIFY_REMARKS:\nCARD_EXPIRATION_MONTH: 4\nFRAUD_SCREENING_REFERENCE_ID: d1e499d0-4ba9-48e7-86b4-ed938594015b\nAPPROVAL_CODE: 582860\nFRAUD_SCREENING_PROVIDER_ID: 37\nORDER_ID: 3ec05393-4598-484e-8666-a37f00cb0499\nFRAUD_SCREENING_SCORE: 0\nORDER_NUMBER: API-99C91D50-20140806141826\nACQUIRER_REFERENCE_ID: 500113544\nPAYMENT_STATUS: AUTHORIZED\nAMOUNT: 100.00\nACQUIRER_ID: 1010\nDIGEST: 514ECFE34864E8F717CE016F1505D94FBF8B5813\nDELIVERY_TIMESTAMP: 2016-11-06 12:22:19Z\nFRAUD_SCREENING_PROVIDER_NAME: Accertify\nFRAUD_SCREENING_MODE: Enabled\nEVENT_TYPE: PAYMENT\nCARD_CARDHOLDER_NAME: NAMN ENAMNI\nPAYMENT_STATUS_REASON: NONE\nTRANSACTION_ID: 201408061421475374\nEVENT_TIMESTAMP: 2016-11-06 12:22:19Z\nCARD_FIRST_SIX: 411111\nACCERTIFY_TRANSACTION_ID: API-99C91D50-20\nFRAUD_SCREENING_DECISION: Accept\nPAYMENT_METHOD_ID: 1\nCARD_LAST_FOUR: 1111\nCURRENCY_CODE: SEK\nCUSTOM_DATA_COUNT: 0\nMERCHANT_ID: 4999", "language": "text", "name": "FORM/POST Parameters" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "ACCERTIFY_REMARKS=&ACCERTIFY_RULES_TRIPPED=&ACCERTIFY_TRANSACTION_ID=API-99C91D50-20&ACQUIRER_ID=1010&ACQUIRER_REFERENCE_ID=500113544&AMOUNT=100.00&APPROVAL_CODE=582860&CARD_CARDHOLDER_NAME=asdf+as%c3%b6ldk+as&CARD_EXPIRATION_MONTH=4&CARD_EXPIRATION_YEAR=2016&CARD_FIRST_SIX=411111&CARD_LAST_FOUR=1111&CURRENCY_CODE=SEK&CUSTOM_DATA_COUNT=0&DELIVERY_TIMESTAMP=2014-08-06+12%3a22%3a19Z&DIGEST=514ECFE34864E8F717CE016F1505D94FBF8B5813&EVENT_TIMESTAMP=2016-11-06+12%3a22%3a19Z&EVENT_TYPE=PAYMENT&FRAUD_SCREENING_DECISION=Accept&FRAUD_SCREENING_MODE=Enabled&FRAUD_SCREENING_PROVIDER_ID=37&FRAUD_SCREENING_PROVIDER_NAME=Accertify&FRAUD_SCREENING_REFERENCE_ID=d1e499d0-4ba9-48e7-86b4-ed938594015b&FRAUD_SCREENING_SCORE=0&MERCHANT_ID=4999&ORDER_ID=3ec05393-4598-484e-8666-a37f00cb0499&ORDER_NUMBER=API-99C91D50-20161106141826&PAYMENT_METHOD_ID=1&PAYMENT_STATUS=AUTHORIZED&PAYMENT_STATUS_REASON=NONE&SESSION_ID=04156f48-e6d4-45b1-8f62-a37f00cb17c2&TRANSACTION_ID=201611061421475374\n", "language": "text", "name": "RAW Body" } ], "sidebar": true } [/block]
The **Payment** EHN is received when a payment has either been completed or attempted on a payment session in our Aero hosted payment interface. ## Data Fields In addition to the [Common Fields](doc:common-fields), you will receive the following information: [block:parameters] { "data": { "0-0": "`ORDER_ID`\n*required*", "h-0": "Property", "h-1": "Type", "h-2": "Description", "1-0": "`ORDER_NUMBER`\n*required*", "2-0": "`SESSION_ID`\n*required*", "3-0": "`PAYMENT_STATUS`\n*required*", "4-0": "`PAYMENT_STATUS_REASON`\n*required*", "5-0": "`AMOUNT`\n*required*", "6-0": "`CURRENCY_CODE`\n*required*", "7-0": "`TRANSACTION_ID`\n*required*", "8-0": "`PAYMENT_METHOD_ID`\n*required*", "9-0": "`CARD_FIRST_SIX`\n***conditional***", "10-0": "`CARD_LAST_FOUR`\n***conditional***", "11-0": "`CARD_CARDHOLDER_NAME`\n***conditional***", "12-0": "`CARD_EXPIRATION_MONTH`\n***conditional***", "13-0": "`CARD_EXPIRATION_YEAR`\n***conditional***", "14-0": "`ACQUIRER_ID`\n*required*", "15-0": "`ACQUIRER_REFERENCE_ID`\n*required*", "16-0": "`ACQUIRER_RESPONSE_CODE`\n***conditional***", "17-0": "`CUSTOM_DATA_COUNT`\n*required*", "18-0": "`CUSTOM_DATA_#_KEY`\n***conditional***", "19-0": "`CUSTOM_DATA_#_VALUE`\n***conditional***", "20-0": "`APPROVAL_CODE`\n***conditional***", "0-1": "`guid`", "2-1": "`guid`", "1-1": "`string`", "3-1": "`string`", "4-1": "`string`", "5-1": "`decimal`", "6-1": "`string(3)`", "7-1": "`int`", "8-1": "`int`", "9-1": "`string(6)`", "10-1": "`string(4)`", "11-1": "`string`", "12-1": "`int`", "13-1": "`string(4)`", "14-1": "`int`", "15-1": "`string`", "16-1": "`string`", "18-1": "`string`", "19-1": "`string`", "20-1": "`string`", "17-1": "`int`", "0-2": "Paynova's unique identifier for the order to which the payment belongs.", "1-2": "Your order/PO number for this order.", "2-2": "Paynova's unique payment session ID, if this payment was made within a payment session.", "3-2": "The status of the payment.\n\n**Possible values:**\n\n> **CANCELLED**\nThe payment was cancelled.\n\n> **DECLINED**\nThe payment was declined.\n\n> **ERROR**\nAn unexpected, unrecoverable error occurred while processing this payment.\n\n> **PENDING**\nThe payment is in a pending state.\n\n> **COMPLETED**\nThe payment has been completed and no further action is required.\n\n> **AUTHORIZED**\nThe payment has been authorized, and a finalize is required to complete the transaction.", "4-2": "A finer-grained status code possibly providing more information as to the value of PAYMENT_STATUS.\n\n**Possible values:**\n\n> **NONE**\nNo additional reason information is available.\n\n> **FRAUD_SCREENING**\nThe transaction was declined by fraud screening.\n\n> **BANK_COMMUNICATION_ERROR**\nThere was an error communicating with the bank.\n\n> **BANK_ACCOUNT_VALIDATION**\nThe transaction was declined due to invalid bank account details.\n\n> **DECLINED_BY_PROCESSOR**\nThe transaction was declined by the bank or processor.\n\n> **FAILED_AUTHENTICATION**\nThe transaction failed authentication (3-D Secure, for example).\n\n> **CANCELLED_BY_CUSTOMER**\nThe customer cancelled the transaction.", "5-2": "The amount of the transaction. Two decimal points, decimal point as separator.\n\n**Example:** `1234.56`", "6-2": "The three-letter currency code.\n\n**Example:** `\"SEK\"`", "7-2": "The transaction ID.\n\n**Constraints:**\n> Length=18\n\n**Example:** `\"123123123123123123\"`", "8-2": "The ID of the payment method.\nSee [Payment Methods](doc:paymentmethods) page for possible values.", "9-2": "The card BIN (first six digits).\n\n**Conditions:**\n> Only applicable for card payments. \n\n**Example:** `\"666666\"`", "10-2": "The last four digits of the card number.\n\n**Conditions:**\n> Only applicable for card payments. \n\n**Example:** `\"4444\"`", "11-2": "The cardholder's name (name printed on the card).\n\n**Conditions:**\n> Only applicable for card payments.", "12-2": "The card expiration month.\n\n**Constraints:**\n> Length=2\n\n**Conditions:**\n> Only applicable for card payments.\n\n**Example:** `10`", "13-2": "The card expiration year.\n\n**Conditions:**\n> Only applicable for card payments. \n\n**Example:** `2016`", "14-2": "Paynova's ID for the acquirer of the transaction.\n\n**Constraints:**\n> Length=4", "15-2": "The reference id that the bank uses to refer to this transaction.", "16-2": "Acquirer response code.\n\n**Conditions:**\n> Returned if provided by the acquirer.", "17-2": "Indicates the 1-indexed number of CUSTOM_DATA fields included in this notification.", "18-2": "The key of the key-value pair.\n\n**Conditions:**\n> Applicable only if CUSTOM_DATA_COUNT > 0.", "20-2": "The approval code.", "19-2": "The value of the key-value pair.\n\n**Conditions:**\n> Applicable only if CUSTOM_DATA_COUNT > 0." }, "cols": 3, "rows": 21 } [/block] [block:textarea] { "text": "", "sidebar": true } [/block] [block:callout] { "type": "info", "body": "**If fraud screening is used, the following fields will also be sent.**" } [/block] [block:textarea] { "text": "", "sidebar": true } [/block] [block:parameters] { "data": { "0-0": "`FRAUD_SCREENING_PROVIDER_ID`\n*required*", "0-1": "`int`", "0-2": "The ID of the fraud screening provider.\n\n**Possible values (ID-Name):**\n> 33 - Razor\n> 12 - CyberSource\n> 37 - Accertify", "1-0": "`FRAUD_SCREENING_PROVIDER_NAME`\n*required*", "1-1": "`string`", "1-2": "The name of the fraud screening provider.", "2-0": "`FRAUD_SCREENING_MODE`\n*required*", "3-0": "`FRAUD_SCREENING_DECISION`\n*required*", "4-0": "`FRAUD_SCREENING_SCORE`\n*required*", "5-0": "`FRAUD_SCREENING_MESSAGE`\n*required*", "6-0": "`FRAUD_SCREENING_REFERENCE_ID`\n*required*", "2-2": "One of `Disabled`, `LoggingOnly` or `Enabled`.", "2-1": "`string`", "3-1": "`string`", "4-1": "`decimal`", "5-1": "`string`", "6-1": "`string`", "3-2": "One of `Accept`, `Challenge`, `Reject`, `Review` or `Suspicious`.", "4-2": "The scoring value returned by the provider.", "5-2": "The message returned by the provider.", "6-2": "The reference ID returned by the provider to which the transaction can be looked up at the provider." }, "cols": 3, "rows": 7 } [/block] [block:callout] { "type": "info", "body": "**If the FRAUD_SCREENING_PROVIDER_ID = 33 (Razor), the following fields will also be sent.**" } [/block] [block:parameters] { "data": { "0-0": "`RAZOR_MESSAGE`\n*required*", "0-1": "`string`", "0-2": "Razor-specific message." }, "cols": 3, "rows": 1 } [/block] [block:callout] { "type": "info", "body": "**If the FRAUD_SCREENING_PROVIDER_ID = 37 (Accertify), the following fields will also be sent.**" } [/block] [block:parameters] { "data": { "0-0": "`ACCERTIFY_REMARKS`\n*required*", "0-1": "`string`", "1-1": "`string`", "2-1": "`string`", "1-0": "`ACCERTIFY_RULES_TRIPPED`\n*required*", "2-0": "`ACCERTIFY_TRANSACTION_ID`\n*required*", "0-2": "Remarks returned by Accertify.", "1-2": "Rules which were tripped/triggered.", "2-2": "Accertify's transaction ID." }, "cols": 3, "rows": 3 } [/block] [block:callout] { "type": "success", "body": "**If DCC (Dynamic Currency Conversion) is used, the following fields will also be sent.**" } [/block] [block:parameters] { "data": { "0-0": "`DCC_AMOUNT`\n*required*", "1-0": "`DCC_CURRENCY_CODE` \n*required*", "2-0": "`DCC_EXCHANGE_RATE` \n*required*", "3-0": "`DCC_EXCHANGE_RATE_SOURCE_NAME` \n*required*", "0-1": "`decimal`", "1-1": "`string(3)`", "2-1": "`decimal`", "3-1": "`string`", "0-2": "The converted amount (the amount the customer paid in their home currency).", "1-2": "The currency code in which the customer paid.", "2-2": "The exchange-rate at which the conversion took place.", "3-2": "The source bank of the exchange rate." }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "Example - Payment", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "Total-Route-Time: 0\nContent-Length: 972\nConnect-Time: 2\nConnection: close\nContent-Type: application/x-www-form-urlencoded\nPn-Digest: 57E0AD4EF608761FEC10073274EF54BC33C12386\nVia: 1.1 vegur\nX-Request-Id: dced1302-8923-41c2-a62c-4315d70071f7\nHost: requestb.in", "language": "text", "name": "Headers" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "SESSION_ID: 04156f48-e6d4-45b1-8f62-a37f00cb17c2\nCARD_EXPIRATION_YEAR: 2017\nACCERTIFY_RULES_TRIPPED:\nACCERTIFY_REMARKS:\nCARD_EXPIRATION_MONTH: 4\nFRAUD_SCREENING_REFERENCE_ID: d1e499d0-4ba9-48e7-86b4-ed938594015b\nAPPROVAL_CODE: 582860\nFRAUD_SCREENING_PROVIDER_ID: 37\nORDER_ID: 3ec05393-4598-484e-8666-a37f00cb0499\nFRAUD_SCREENING_SCORE: 0\nORDER_NUMBER: API-99C91D50-20140806141826\nACQUIRER_REFERENCE_ID: 500113544\nPAYMENT_STATUS: AUTHORIZED\nAMOUNT: 100.00\nACQUIRER_ID: 1010\nDIGEST: 514ECFE34864E8F717CE016F1505D94FBF8B5813\nDELIVERY_TIMESTAMP: 2016-11-06 12:22:19Z\nFRAUD_SCREENING_PROVIDER_NAME: Accertify\nFRAUD_SCREENING_MODE: Enabled\nEVENT_TYPE: PAYMENT\nCARD_CARDHOLDER_NAME: NAMN ENAMNI\nPAYMENT_STATUS_REASON: NONE\nTRANSACTION_ID: 201408061421475374\nEVENT_TIMESTAMP: 2016-11-06 12:22:19Z\nCARD_FIRST_SIX: 411111\nACCERTIFY_TRANSACTION_ID: API-99C91D50-20\nFRAUD_SCREENING_DECISION: Accept\nPAYMENT_METHOD_ID: 1\nCARD_LAST_FOUR: 1111\nCURRENCY_CODE: SEK\nCUSTOM_DATA_COUNT: 0\nMERCHANT_ID: 4999", "language": "text", "name": "FORM/POST Parameters" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "ACCERTIFY_REMARKS=&ACCERTIFY_RULES_TRIPPED=&ACCERTIFY_TRANSACTION_ID=API-99C91D50-20&ACQUIRER_ID=1010&ACQUIRER_REFERENCE_ID=500113544&AMOUNT=100.00&APPROVAL_CODE=582860&CARD_CARDHOLDER_NAME=asdf+as%c3%b6ldk+as&CARD_EXPIRATION_MONTH=4&CARD_EXPIRATION_YEAR=2016&CARD_FIRST_SIX=411111&CARD_LAST_FOUR=1111&CURRENCY_CODE=SEK&CUSTOM_DATA_COUNT=0&DELIVERY_TIMESTAMP=2014-08-06+12%3a22%3a19Z&DIGEST=514ECFE34864E8F717CE016F1505D94FBF8B5813&EVENT_TIMESTAMP=2016-11-06+12%3a22%3a19Z&EVENT_TYPE=PAYMENT&FRAUD_SCREENING_DECISION=Accept&FRAUD_SCREENING_MODE=Enabled&FRAUD_SCREENING_PROVIDER_ID=37&FRAUD_SCREENING_PROVIDER_NAME=Accertify&FRAUD_SCREENING_REFERENCE_ID=d1e499d0-4ba9-48e7-86b4-ed938594015b&FRAUD_SCREENING_SCORE=0&MERCHANT_ID=4999&ORDER_ID=3ec05393-4598-484e-8666-a37f00cb0499&ORDER_NUMBER=API-99C91D50-20161106141826&PAYMENT_METHOD_ID=1&PAYMENT_STATUS=AUTHORIZED&PAYMENT_STATUS_REASON=NONE&SESSION_ID=04156f48-e6d4-45b1-8f62-a37f00cb17c2&TRANSACTION_ID=201611061421475374\n", "language": "text", "name": "RAW Body" } ], "sidebar": true } [/block]
{"_id":"5a0448410460700026dbddb5","project":"54930e7c777ff221004a7e6d","version":"54930e7c777ff221004a7e70","category":"5835938b9a8d971900dd2e38","user":"5818a4ecb1e11c1900bf76c3","updates":["5a0464db4efc550032fb381b"],"next":{"pages":[],"description":""},"createdAt":"2017-11-09T12:21:21.241Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":""},"isReference":true,"order":2,"body":"The **Refund** EHN is received when a refund has either been completed or failed. Only applicable to refunds for mobile payments.\n\n## Data Fields\n\nIn addition to the [Common Fields](doc:common-fields), you will receive the following information:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`ORDER_ID`\\n*required*\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"1-0\": \"`ORDER_NUMBER`\\n*required*\",\n    \"2-0\": \"`REFUND_STATUS`\\n*required*\",\n    \"3-0\": \"`REFUND_STATUS_REASON`\\n*required*\",\n    \"4-0\": \"`AMOUNT`\\n*required*\",\n    \"5-0\": \"`CURRENCY_CODE`\\n*required*\",\n    \"6-0\": \"`TRANSACTION_ID`\\n*required*\",\n    \"7-0\": \"`ACQUIRER_ID`\\n*required*\",\n    \"8-0\": \"`ACQUIRER_REFERENCE_ID`\\n*required*\",\n    \"0-1\": \"`guid`\",\n    \"1-1\": \"`string`\",\n    \"2-1\": \"`string`\",\n    \"3-1\": \"`string`\",\n    \"4-1\": \"`decimal`\",\n    \"5-1\": \"`string(3)`\",\n    \"6-1\": \"`int`\",\n    \"7-1\": \"`int`\",\n    \"8-1\": \"`string`\",\n    \"0-2\": \"Paynova's unique identifier for the order to which the payment belongs.\",\n    \"1-2\": \"Your order/PO number for this order.\",\n    \"2-2\": \"The status of the refund.\\n\\n**Possible values:**\\n\\n\\n\\n> **DECLINED**\\nThe refund was declined.\\n\\n\\n> **PENDING**\\nThe refund is in a pending state.\\n\\n> **COMPLETED**\\nThe refund has been completed and no further action is required.\",\n    \"3-2\": \"A finer-grained status code possibly providing more information as to the value of REFUND_STATUS.\\n\\n**Possible values:**\\n\\n> **NONE**\\nNo additional reason information is available.\\n\\n> **BANK_COMMUNICATION_ERROR**\\nThere was an error communicating with the bank.\\n\\n> **DECLINED_BY_PROCESSOR**\\nThe transaction was declined by the bank or processor.\",\n    \"4-2\": \"The amount of the transaction. Two decimal points, decimal point as separator.\\n\\n**Example:** `1234.56`\",\n    \"5-2\": \"The three-letter currency code.\\n\\n**Example:** `\\\"SEK\\\"`\",\n    \"6-2\": \"The transaction ID.\\n\\n**Constraints:**\\n> Length=18\\n\\n**Example:** `\\\"123123123123123123\\\"`\",\n    \"7-2\": \"Paynova's ID for the acquirer of the transaction.\\n\\n**Constraints:**\\n> Length=4\",\n    \"8-2\": \"The reference id that the bank uses to refer to this transaction.\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example - REFUND\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Total-Route-Time: 0\\nContent-Length: 972\\nConnect-Time: 2\\nConnection: close\\nContent-Type: application/x-www-form-urlencoded\\nPn-Digest: 57E0AD4EF608761FEC10073274EF54BC33C12386\\nVia: 1.1 vegur\\nX-Request-Id: dced1302-8923-41c2-a62c-4315d70071f7\\nHost: requestb.in\",\n      \"language\": \"text\",\n      \"name\": \"Headers\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"ORDER_ID: 3ec05393-4598-484e-8666-a37f00cb0499\\nORDER_NUMBER: API-99C91D50-20140806141826\\nACQUIRER_REFERENCE_ID: 500113544\\nREFUND_STATUS: COMPLETED\\nAMOUNT: 100.00\\nACQUIRER_ID: 1010\\nDIGEST: 514ECFE34864E8F717CE016F1505D94FBF8B5813\\nDELIVERY_TIMESTAMP: 2016-11-06 12:22:19Z\\nTRANSACTION_ID: 201611061421475374\\nEVENT_TYPE: REFUND\\nREFUND_STATUS_REASON: NONE\\nEVENT_TIMESTAMP: 2016-11-06 12:22:19Z\\nCURRENCY_CODE: SEK\\nMERCHANT_ID: 4999\",\n      \"language\": \"text\",\n      \"name\": \"FORM/POST Parameters\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"ACQUIRER_ID=1010&ACQUIRER_REFERENCE_ID=500113544&AMOUNT=100.00&CURRENCY_CODE=SEK&DELIVERY_TIMESTAMP=2014-08-06+12%3a22%3a19Z&DIGEST=514ECFE34864E8F717CE016F1505D94FBF8B5813&EVENT_TIMESTAMP=2016-11-06+12%3a22%3a19Z&EVENT_TYPE=REFUND&MERCHANT_ID=4999&ORDER_ID=3ec05393-4598-484e-8666-a37f00cb0499&ORDER_NUMBER=API-99C91D50-20161106141826&PAYMENT_METHOD_ID=1&REFUND_STATUS=COMPLETED&REFUND_STATUS_REASON=NONE&SESSION_ID=04156f48-e6d4-45b1-8f62-a37f00cb17c2&TRANSACTION_ID=201611061421475374\",\n      \"language\": \"text\",\n      \"name\": \"RAW Body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"ehn-refund-1","type":"basic","title":"EHN: Refund","__v":1,"parentDoc":null,"childrenPages":[]}

EHN: Refund


The **Refund** EHN is received when a refund has either been completed or failed. Only applicable to refunds for mobile payments. ## Data Fields In addition to the [Common Fields](doc:common-fields), you will receive the following information: [block:parameters] { "data": { "0-0": "`ORDER_ID`\n*required*", "h-0": "Property", "h-1": "Type", "h-2": "Description", "1-0": "`ORDER_NUMBER`\n*required*", "2-0": "`REFUND_STATUS`\n*required*", "3-0": "`REFUND_STATUS_REASON`\n*required*", "4-0": "`AMOUNT`\n*required*", "5-0": "`CURRENCY_CODE`\n*required*", "6-0": "`TRANSACTION_ID`\n*required*", "7-0": "`ACQUIRER_ID`\n*required*", "8-0": "`ACQUIRER_REFERENCE_ID`\n*required*", "0-1": "`guid`", "1-1": "`string`", "2-1": "`string`", "3-1": "`string`", "4-1": "`decimal`", "5-1": "`string(3)`", "6-1": "`int`", "7-1": "`int`", "8-1": "`string`", "0-2": "Paynova's unique identifier for the order to which the payment belongs.", "1-2": "Your order/PO number for this order.", "2-2": "The status of the refund.\n\n**Possible values:**\n\n\n\n> **DECLINED**\nThe refund was declined.\n\n\n> **PENDING**\nThe refund is in a pending state.\n\n> **COMPLETED**\nThe refund has been completed and no further action is required.", "3-2": "A finer-grained status code possibly providing more information as to the value of REFUND_STATUS.\n\n**Possible values:**\n\n> **NONE**\nNo additional reason information is available.\n\n> **BANK_COMMUNICATION_ERROR**\nThere was an error communicating with the bank.\n\n> **DECLINED_BY_PROCESSOR**\nThe transaction was declined by the bank or processor.", "4-2": "The amount of the transaction. Two decimal points, decimal point as separator.\n\n**Example:** `1234.56`", "5-2": "The three-letter currency code.\n\n**Example:** `\"SEK\"`", "6-2": "The transaction ID.\n\n**Constraints:**\n> Length=18\n\n**Example:** `\"123123123123123123\"`", "7-2": "Paynova's ID for the acquirer of the transaction.\n\n**Constraints:**\n> Length=4", "8-2": "The reference id that the bank uses to refer to this transaction." }, "cols": 3, "rows": 9 } [/block] [block:api-header] { "type": "basic", "title": "Example - REFUND", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "Total-Route-Time: 0\nContent-Length: 972\nConnect-Time: 2\nConnection: close\nContent-Type: application/x-www-form-urlencoded\nPn-Digest: 57E0AD4EF608761FEC10073274EF54BC33C12386\nVia: 1.1 vegur\nX-Request-Id: dced1302-8923-41c2-a62c-4315d70071f7\nHost: requestb.in", "language": "text", "name": "Headers" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "ORDER_ID: 3ec05393-4598-484e-8666-a37f00cb0499\nORDER_NUMBER: API-99C91D50-20140806141826\nACQUIRER_REFERENCE_ID: 500113544\nREFUND_STATUS: COMPLETED\nAMOUNT: 100.00\nACQUIRER_ID: 1010\nDIGEST: 514ECFE34864E8F717CE016F1505D94FBF8B5813\nDELIVERY_TIMESTAMP: 2016-11-06 12:22:19Z\nTRANSACTION_ID: 201611061421475374\nEVENT_TYPE: REFUND\nREFUND_STATUS_REASON: NONE\nEVENT_TIMESTAMP: 2016-11-06 12:22:19Z\nCURRENCY_CODE: SEK\nMERCHANT_ID: 4999", "language": "text", "name": "FORM/POST Parameters" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "ACQUIRER_ID=1010&ACQUIRER_REFERENCE_ID=500113544&AMOUNT=100.00&CURRENCY_CODE=SEK&DELIVERY_TIMESTAMP=2014-08-06+12%3a22%3a19Z&DIGEST=514ECFE34864E8F717CE016F1505D94FBF8B5813&EVENT_TIMESTAMP=2016-11-06+12%3a22%3a19Z&EVENT_TYPE=REFUND&MERCHANT_ID=4999&ORDER_ID=3ec05393-4598-484e-8666-a37f00cb0499&ORDER_NUMBER=API-99C91D50-20161106141826&PAYMENT_METHOD_ID=1&REFUND_STATUS=COMPLETED&REFUND_STATUS_REASON=NONE&SESSION_ID=04156f48-e6d4-45b1-8f62-a37f00cb17c2&TRANSACTION_ID=201611061421475374", "language": "text", "name": "RAW Body" } ], "sidebar": true } [/block]
The **Refund** EHN is received when a refund has either been completed or failed. Only applicable to refunds for mobile payments. ## Data Fields In addition to the [Common Fields](doc:common-fields), you will receive the following information: [block:parameters] { "data": { "0-0": "`ORDER_ID`\n*required*", "h-0": "Property", "h-1": "Type", "h-2": "Description", "1-0": "`ORDER_NUMBER`\n*required*", "2-0": "`REFUND_STATUS`\n*required*", "3-0": "`REFUND_STATUS_REASON`\n*required*", "4-0": "`AMOUNT`\n*required*", "5-0": "`CURRENCY_CODE`\n*required*", "6-0": "`TRANSACTION_ID`\n*required*", "7-0": "`ACQUIRER_ID`\n*required*", "8-0": "`ACQUIRER_REFERENCE_ID`\n*required*", "0-1": "`guid`", "1-1": "`string`", "2-1": "`string`", "3-1": "`string`", "4-1": "`decimal`", "5-1": "`string(3)`", "6-1": "`int`", "7-1": "`int`", "8-1": "`string`", "0-2": "Paynova's unique identifier for the order to which the payment belongs.", "1-2": "Your order/PO number for this order.", "2-2": "The status of the refund.\n\n**Possible values:**\n\n\n\n> **DECLINED**\nThe refund was declined.\n\n\n> **PENDING**\nThe refund is in a pending state.\n\n> **COMPLETED**\nThe refund has been completed and no further action is required.", "3-2": "A finer-grained status code possibly providing more information as to the value of REFUND_STATUS.\n\n**Possible values:**\n\n> **NONE**\nNo additional reason information is available.\n\n> **BANK_COMMUNICATION_ERROR**\nThere was an error communicating with the bank.\n\n> **DECLINED_BY_PROCESSOR**\nThe transaction was declined by the bank or processor.", "4-2": "The amount of the transaction. Two decimal points, decimal point as separator.\n\n**Example:** `1234.56`", "5-2": "The three-letter currency code.\n\n**Example:** `\"SEK\"`", "6-2": "The transaction ID.\n\n**Constraints:**\n> Length=18\n\n**Example:** `\"123123123123123123\"`", "7-2": "Paynova's ID for the acquirer of the transaction.\n\n**Constraints:**\n> Length=4", "8-2": "The reference id that the bank uses to refer to this transaction." }, "cols": 3, "rows": 9 } [/block] [block:api-header] { "type": "basic", "title": "Example - REFUND", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "Total-Route-Time: 0\nContent-Length: 972\nConnect-Time: 2\nConnection: close\nContent-Type: application/x-www-form-urlencoded\nPn-Digest: 57E0AD4EF608761FEC10073274EF54BC33C12386\nVia: 1.1 vegur\nX-Request-Id: dced1302-8923-41c2-a62c-4315d70071f7\nHost: requestb.in", "language": "text", "name": "Headers" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "ORDER_ID: 3ec05393-4598-484e-8666-a37f00cb0499\nORDER_NUMBER: API-99C91D50-20140806141826\nACQUIRER_REFERENCE_ID: 500113544\nREFUND_STATUS: COMPLETED\nAMOUNT: 100.00\nACQUIRER_ID: 1010\nDIGEST: 514ECFE34864E8F717CE016F1505D94FBF8B5813\nDELIVERY_TIMESTAMP: 2016-11-06 12:22:19Z\nTRANSACTION_ID: 201611061421475374\nEVENT_TYPE: REFUND\nREFUND_STATUS_REASON: NONE\nEVENT_TIMESTAMP: 2016-11-06 12:22:19Z\nCURRENCY_CODE: SEK\nMERCHANT_ID: 4999", "language": "text", "name": "FORM/POST Parameters" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "ACQUIRER_ID=1010&ACQUIRER_REFERENCE_ID=500113544&AMOUNT=100.00&CURRENCY_CODE=SEK&DELIVERY_TIMESTAMP=2014-08-06+12%3a22%3a19Z&DIGEST=514ECFE34864E8F717CE016F1505D94FBF8B5813&EVENT_TIMESTAMP=2016-11-06+12%3a22%3a19Z&EVENT_TYPE=REFUND&MERCHANT_ID=4999&ORDER_ID=3ec05393-4598-484e-8666-a37f00cb0499&ORDER_NUMBER=API-99C91D50-20161106141826&PAYMENT_METHOD_ID=1&REFUND_STATUS=COMPLETED&REFUND_STATUS_REASON=NONE&SESSION_ID=04156f48-e6d4-45b1-8f62-a37f00cb17c2&TRANSACTION_ID=201611061421475374", "language": "text", "name": "RAW Body" } ], "sidebar": true } [/block]
{"_id":"5835b1203200a827005e1960","api":{"params":[],"url":"","results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required"},"body":"The **Session End** notification is sent when a payment session has ended.\n\n\n## Data Fields\n\nIn addition to the [Common Fields](doc:common-fields), you will receive the following information:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Data type : Format\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`ORDER_ID` \\n*required*\",\n    \"1-0\": \"`ORDER_NUMBER` \\n*required*\",\n    \"2-0\": \"`SESSION_ID` \\n*required*\",\n    \"3-0\": \"`SESSION_STATUS` \\n*required*\",\n    \"4-0\": \"`SESSION_STATUS_REASON`\\n*required*\",\n    \"5-0\": \"`CUSTOM_DATA_COUNT` \\n*required*\",\n    \"6-0\": \"`CUSTOM_DATA_#_KEY` \\n***conditional***\",\n    \"7-0\": \"`CUSTOM_DATA_#_VALUE`\\n***conditional***\",\n    \"8-0\": \"``\",\n    \"9-0\": \"``\",\n    \"1-1\": \"`string`\",\n    \"3-1\": \"`string`\",\n    \"4-1\": \"`string`\",\n    \"7-1\": \"`string`\",\n    \"6-1\": \"`string`\",\n    \"0-1\": \"`guid`\",\n    \"2-1\": \"`guid`\",\n    \"5-1\": \"`int`\",\n    \"0-2\": \"Paynova's unique identifier for the order to which this payment belongs.\",\n    \"1-2\": \"Your order/PO number for this order.\",\n    \"2-2\": \"Paynova's unique payment session ID if this payment was made within a payment session.\",\n    \"5-2\": \"Indicates the 1-indexed number of CUSTOM_DATA fields included in this notification.\",\n    \"6-2\": \"The key of the key-value pair.\\n**Applicable only if CUSTOM_DATA_COUNT > 0.**\",\n    \"7-2\": \"The value of the key-value pair.\\n**Applicable only if CUSTOM_DATA_COUNT > 0.**\",\n    \"3-2\": \"**Possible values:**\\n\\n> **EXPIRED**\\nThe session has expired (timed out).\\n> \\n> **COMPLETED**\\n> The session has been completed.\\n> \\n> **CANCELLED**\\nThe session has been cancelled.\",\n    \"4-2\": \"**Possible values:**\\n\\n> **NONE**\\nNo additional information available.\\n> \\n> **CUSTOMER_CANCELLED_SESSION**\\n> The customer actively cancelled the payment.\\n> \\n> **PAYMENT_COMPLETED**\\n> The payment has been completed.\\n> \\n> **FAILED_PAYMENT_THRESHOLD**\\n> The customer exceeded their number of failed attempts.\\t\\n> \\n> **CUSTOMER_CLOSED_BROWSER**\\nThe customer closed their browser.\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example - Session End\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Total-Route-Time: 0\\nContent-Length: 392\\nConnect-Time: 0\\nConnection: close\\nContent-Type: application/x-www-form-urlencoded\\nPn-Digest: 828C134D4C58A35FFD71C4893D641FFB542CEE6E\\nVia: 1.1 vegur\\nX-Request-Id: 4011c170-96ee-4db0-b683-a47b2d74cf87\\nHost: requestb.in\",\n      \"language\": \"text\",\n      \"name\": \"Headers\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"CUSTOM_DATA_COUNT: 0\\nSESSION_ID: 04156f48-e6d4-45b1-8f62-a37f00cb17c2\\nEVENT_TYPE: SESSION_END\\nORDER_ID: 3ec05393-4598-484e-8666-a37f00cb0499\\nORDER_NUMBER: API-99C91D50-20140806141826\\nSESSION_STATUS: COMPLETED\\nEVENT_TIMESTAMP: 2016-11-06 12:22:19Z\\nDELIVERY_TIMESTAMP: 2016-11-06 12:22:19Z\\nMERCHANT_ID: 4999\\nDIGEST: 5E716D9AC9554C7B901FE20C0F03798308E3A62F\\nSESSION_STATUS_REASON: PAYMENT_COMPLETED\",\n      \"language\": \"text\",\n      \"name\": \"POST/FORM Parameters\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"CUSTOM_DATA_COUNT=0&DELIVERY_TIMESTAMP=2016-11-06+12%3a22%3a19Z&DIGEST=5E716D9AC9554C7B901FE20C0F03798308E3A62F&EVENT_TIMESTAMP=2016-11-06+12%3a22%3a19Z&EVENT_TYPE=SESSION_END&MERCHANT_ID=4999&ORDER_ID=3ec05393-4598-484e-8666-a37f00cb0499&ORDER_NUMBER=API-99C91D50-20140806141826&SESSION_ID=04156f48-e6d4-45b1-8f62-a37f00cb17c2&SESSION_STATUS=COMPLETED&SESSION_STATUS_REASON=PAYMENT_COMPLETED\\n\",\n      \"language\": \"text\",\n      \"name\": \"RAW Body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","parentDoc":null,"excerpt":"","githubsync":"","link_external":false,"project":"54930e7c777ff221004a7e6d","type":"basic","__v":0,"hidden":false,"sync_unique":"","title":"EHN: Session End","updates":[],"category":"5835938b9a8d971900dd2e38","createdAt":"2016-11-23T15:09:20.127Z","isReference":false,"link_url":"","next":{"pages":[],"description":""},"order":4,"slug":"ehn-session-end","user":"5818a4ecb1e11c1900bf76c3","version":"54930e7c777ff221004a7e70","childrenPages":[]}

EHN: Session End


The **Session End** notification is sent when a payment session has ended. ## Data Fields In addition to the [Common Fields](doc:common-fields), you will receive the following information: [block:parameters] { "data": { "h-0": "Field", "h-1": "Data type : Format", "h-2": "Description", "0-0": "`ORDER_ID` \n*required*", "1-0": "`ORDER_NUMBER` \n*required*", "2-0": "`SESSION_ID` \n*required*", "3-0": "`SESSION_STATUS` \n*required*", "4-0": "`SESSION_STATUS_REASON`\n*required*", "5-0": "`CUSTOM_DATA_COUNT` \n*required*", "6-0": "`CUSTOM_DATA_#_KEY` \n***conditional***", "7-0": "`CUSTOM_DATA_#_VALUE`\n***conditional***", "8-0": "``", "9-0": "``", "1-1": "`string`", "3-1": "`string`", "4-1": "`string`", "7-1": "`string`", "6-1": "`string`", "0-1": "`guid`", "2-1": "`guid`", "5-1": "`int`", "0-2": "Paynova's unique identifier for the order to which this payment belongs.", "1-2": "Your order/PO number for this order.", "2-2": "Paynova's unique payment session ID if this payment was made within a payment session.", "5-2": "Indicates the 1-indexed number of CUSTOM_DATA fields included in this notification.", "6-2": "The key of the key-value pair.\n**Applicable only if CUSTOM_DATA_COUNT > 0.**", "7-2": "The value of the key-value pair.\n**Applicable only if CUSTOM_DATA_COUNT > 0.**", "3-2": "**Possible values:**\n\n> **EXPIRED**\nThe session has expired (timed out).\n> \n> **COMPLETED**\n> The session has been completed.\n> \n> **CANCELLED**\nThe session has been cancelled.", "4-2": "**Possible values:**\n\n> **NONE**\nNo additional information available.\n> \n> **CUSTOMER_CANCELLED_SESSION**\n> The customer actively cancelled the payment.\n> \n> **PAYMENT_COMPLETED**\n> The payment has been completed.\n> \n> **FAILED_PAYMENT_THRESHOLD**\n> The customer exceeded their number of failed attempts.\t\n> \n> **CUSTOMER_CLOSED_BROWSER**\nThe customer closed their browser." }, "cols": 3, "rows": 8 } [/block] [block:api-header] { "type": "basic", "title": "Example - Session End", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "Total-Route-Time: 0\nContent-Length: 392\nConnect-Time: 0\nConnection: close\nContent-Type: application/x-www-form-urlencoded\nPn-Digest: 828C134D4C58A35FFD71C4893D641FFB542CEE6E\nVia: 1.1 vegur\nX-Request-Id: 4011c170-96ee-4db0-b683-a47b2d74cf87\nHost: requestb.in", "language": "text", "name": "Headers" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "CUSTOM_DATA_COUNT: 0\nSESSION_ID: 04156f48-e6d4-45b1-8f62-a37f00cb17c2\nEVENT_TYPE: SESSION_END\nORDER_ID: 3ec05393-4598-484e-8666-a37f00cb0499\nORDER_NUMBER: API-99C91D50-20140806141826\nSESSION_STATUS: COMPLETED\nEVENT_TIMESTAMP: 2016-11-06 12:22:19Z\nDELIVERY_TIMESTAMP: 2016-11-06 12:22:19Z\nMERCHANT_ID: 4999\nDIGEST: 5E716D9AC9554C7B901FE20C0F03798308E3A62F\nSESSION_STATUS_REASON: PAYMENT_COMPLETED", "language": "text", "name": "POST/FORM Parameters" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "CUSTOM_DATA_COUNT=0&DELIVERY_TIMESTAMP=2016-11-06+12%3a22%3a19Z&DIGEST=5E716D9AC9554C7B901FE20C0F03798308E3A62F&EVENT_TIMESTAMP=2016-11-06+12%3a22%3a19Z&EVENT_TYPE=SESSION_END&MERCHANT_ID=4999&ORDER_ID=3ec05393-4598-484e-8666-a37f00cb0499&ORDER_NUMBER=API-99C91D50-20140806141826&SESSION_ID=04156f48-e6d4-45b1-8f62-a37f00cb17c2&SESSION_STATUS=COMPLETED&SESSION_STATUS_REASON=PAYMENT_COMPLETED\n", "language": "text", "name": "RAW Body" } ], "sidebar": true } [/block]
The **Session End** notification is sent when a payment session has ended. ## Data Fields In addition to the [Common Fields](doc:common-fields), you will receive the following information: [block:parameters] { "data": { "h-0": "Field", "h-1": "Data type : Format", "h-2": "Description", "0-0": "`ORDER_ID` \n*required*", "1-0": "`ORDER_NUMBER` \n*required*", "2-0": "`SESSION_ID` \n*required*", "3-0": "`SESSION_STATUS` \n*required*", "4-0": "`SESSION_STATUS_REASON`\n*required*", "5-0": "`CUSTOM_DATA_COUNT` \n*required*", "6-0": "`CUSTOM_DATA_#_KEY` \n***conditional***", "7-0": "`CUSTOM_DATA_#_VALUE`\n***conditional***", "8-0": "``", "9-0": "``", "1-1": "`string`", "3-1": "`string`", "4-1": "`string`", "7-1": "`string`", "6-1": "`string`", "0-1": "`guid`", "2-1": "`guid`", "5-1": "`int`", "0-2": "Paynova's unique identifier for the order to which this payment belongs.", "1-2": "Your order/PO number for this order.", "2-2": "Paynova's unique payment session ID if this payment was made within a payment session.", "5-2": "Indicates the 1-indexed number of CUSTOM_DATA fields included in this notification.", "6-2": "The key of the key-value pair.\n**Applicable only if CUSTOM_DATA_COUNT > 0.**", "7-2": "The value of the key-value pair.\n**Applicable only if CUSTOM_DATA_COUNT > 0.**", "3-2": "**Possible values:**\n\n> **EXPIRED**\nThe session has expired (timed out).\n> \n> **COMPLETED**\n> The session has been completed.\n> \n> **CANCELLED**\nThe session has been cancelled.", "4-2": "**Possible values:**\n\n> **NONE**\nNo additional information available.\n> \n> **CUSTOMER_CANCELLED_SESSION**\n> The customer actively cancelled the payment.\n> \n> **PAYMENT_COMPLETED**\n> The payment has been completed.\n> \n> **FAILED_PAYMENT_THRESHOLD**\n> The customer exceeded their number of failed attempts.\t\n> \n> **CUSTOMER_CLOSED_BROWSER**\nThe customer closed their browser." }, "cols": 3, "rows": 8 } [/block] [block:api-header] { "type": "basic", "title": "Example - Session End", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "Total-Route-Time: 0\nContent-Length: 392\nConnect-Time: 0\nConnection: close\nContent-Type: application/x-www-form-urlencoded\nPn-Digest: 828C134D4C58A35FFD71C4893D641FFB542CEE6E\nVia: 1.1 vegur\nX-Request-Id: 4011c170-96ee-4db0-b683-a47b2d74cf87\nHost: requestb.in", "language": "text", "name": "Headers" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "CUSTOM_DATA_COUNT: 0\nSESSION_ID: 04156f48-e6d4-45b1-8f62-a37f00cb17c2\nEVENT_TYPE: SESSION_END\nORDER_ID: 3ec05393-4598-484e-8666-a37f00cb0499\nORDER_NUMBER: API-99C91D50-20140806141826\nSESSION_STATUS: COMPLETED\nEVENT_TIMESTAMP: 2016-11-06 12:22:19Z\nDELIVERY_TIMESTAMP: 2016-11-06 12:22:19Z\nMERCHANT_ID: 4999\nDIGEST: 5E716D9AC9554C7B901FE20C0F03798308E3A62F\nSESSION_STATUS_REASON: PAYMENT_COMPLETED", "language": "text", "name": "POST/FORM Parameters" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "CUSTOM_DATA_COUNT=0&DELIVERY_TIMESTAMP=2016-11-06+12%3a22%3a19Z&DIGEST=5E716D9AC9554C7B901FE20C0F03798308E3A62F&EVENT_TIMESTAMP=2016-11-06+12%3a22%3a19Z&EVENT_TYPE=SESSION_END&MERCHANT_ID=4999&ORDER_ID=3ec05393-4598-484e-8666-a37f00cb0499&ORDER_NUMBER=API-99C91D50-20140806141826&SESSION_ID=04156f48-e6d4-45b1-8f62-a37f00cb17c2&SESSION_STATUS=COMPLETED&SESSION_STATUS_REASON=PAYMENT_COMPLETED\n", "language": "text", "name": "RAW Body" } ], "sidebar": true } [/block]
{"_id":"583595e73165a52f0087752d","__v":0,"api":{"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[]},"link_external":false,"parentDoc":null,"project":"54930e7c777ff221004a7e6d","updates":[],"version":"54930e7c777ff221004a7e70","category":"5835938b9a8d971900dd2e38","createdAt":"2016-11-23T13:13:11.567Z","isReference":false,"order":5,"slug":"ehn-customer-profile-card-added","title":"EHN: Customer Profile Card Added","body":"The **Customer Profile Card Added** EHN is received when a customer has saved their card within a merchant customer profile using our Aero hosted payment interface.\n\n## Data Fields\n\nIn addition to the [Common Fields](doc:common-fields), you will receive the following information:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`PROFILE_ID`\\n*required*\",\n    \"1-0\": \"`CARD_ID`\\n*required*\",\n    \"2-0\": \"`CARD_BIN`\\n*required*\",\n    \"3-0\": \"`CARD_LAST_FOUR`\\n*required*\",\n    \"4-0\": \"`CARD_BRAND_ID`\\n*required*\",\n    \"5-0\": \"`CARD_BRAND_NAME`\\n*required*\",\n    \"6-0\": \"`CARD_EXPIRATION_MONTH`\\n*required*\",\n    \"7-0\": \"`CARD_EXPIRATION_YEAR`\\n*required*\",\n    \"0-1\": \"`string`\",\n    \"1-1\": \"`string`\",\n    \"2-1\": \"`string(6)`\",\n    \"3-1\": \"`string`\",\n    \"5-1\": \"`string`\",\n    \"4-1\": \"`int`\",\n    \"6-1\": \"`int`\",\n    \"7-1\": \"`int`\",\n    \"0-2\": \"Your unique identifier for the customer's profile.\",\n    \"1-2\": \"Paynova's unique identifier for the profile card.\",\n    \"2-2\": \"The first six digits of the card number.\",\n    \"3-2\": \"The last four digits of the card number.\\n\\n**Constraints:**\\n> Length=4\",\n    \"4-2\": \"Paynova's id for the card brand/scheme.\\n\\n**Possible values:**\\n> **1** - Visa\\n> **2** -MasterCard\\n> **3** - American Express\\n> **4** - Diners Club\\n> **5** - Discover\\n> **7** - JCB\\n> **11** - Dancard\\n> **12** - Maestro (International)\\n> **15** - Laser\\n> **16** - Resurs Card\",\n    \"5-2\": \"Paynova's string representation of the card scheme name.\",\n    \"6-2\": \"The two-digit expiration month of the card.\\n\\n**Constraints:**\\n> Length=2\",\n    \"7-2\": \"The four-digit expiration year of the card.\\n\\n**Constraints:**\\n> Length=4\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example - Customer Profile Card Added\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Connection: close\\nPn-Digest: 1E228ABA773BA6B509564E317B5ED423275A25BB\\nHost: requestb.in\\nTotal-Route-Time: 0\\nVia: 1.1 vegur\\nConnect-Time: 4\\nContent-Length: 367\\nContent-Type: application/x-www-form-urlencoded\\nX-Request-Id: c654d516-6ff8-4083-945e-20817d9ba56c\",\n      \"language\": \"text\",\n      \"name\": \"Headers\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"EVENT_TIMESTAMP: 2016-11-07 12:09:55Z\\nCARD_ID: 5332272e-23cf-4115-a72f-a38000e9707c\\nEVENT_TYPE: CUSTOMER_PROFILE_CARD_ADDED\\nPROFILE_ID: 1\\nMERCHANT_ID: 4999\\nDIGEST: 2E1F77F3688935FC7F4228A3524A30A83BD0063E\\nCARD_EXPIRATION_MONTH: 3\\nDELIVERY_TIMESTAMP: 2016-11-07 12:09:55Z\\nCARD_BRAND_ID: 1\\nCARD_LAST_FOUR: 1111\\nCARD_EXPIRATION_YEAR: 17\\nALREADY_EXISTS: False\\nCARD_BIN: 411111\",\n      \"language\": \"text\",\n      \"name\": \"FORM/POST Parameters\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"ALREADY_EXISTS=False&CARD_BIN=411111&CARD_BRAND_ID=1&CARD_EXPIRATION_MONTH=3&CARD_EXPIRATION_YEAR=17&CARD_ID=5332272e-23cf-4115-a72f-a38000e9707c&CARD_LAST_FOUR=1111&DELIVERY_TIMESTAMP=2016-11-07+12%3a09%3a55Z&DIGEST=2E1F77F3688935FC7F4228A3524A30A83BD0063E&EVENT_TIMESTAMP=2014-08-07+12%3a09%3a55Z&EVENT_TYPE=CUSTOMER_PROFILE_CARD_ADDED&MERCHANT_ID=4999&PROFILE_ID=1\\n\",\n      \"language\": \"text\",\n      \"name\": \"RAW Body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","type":"basic","githubsync":"","hidden":false,"link_url":"","next":{"pages":[],"description":""},"sync_unique":"","user":"5818a4ecb1e11c1900bf76c3","childrenPages":[]}

EHN: Customer Profile Card Added


The **Customer Profile Card Added** EHN is received when a customer has saved their card within a merchant customer profile using our Aero hosted payment interface. ## Data Fields In addition to the [Common Fields](doc:common-fields), you will receive the following information: [block:parameters] { "data": { "0-0": "`PROFILE_ID`\n*required*", "1-0": "`CARD_ID`\n*required*", "2-0": "`CARD_BIN`\n*required*", "3-0": "`CARD_LAST_FOUR`\n*required*", "4-0": "`CARD_BRAND_ID`\n*required*", "5-0": "`CARD_BRAND_NAME`\n*required*", "6-0": "`CARD_EXPIRATION_MONTH`\n*required*", "7-0": "`CARD_EXPIRATION_YEAR`\n*required*", "0-1": "`string`", "1-1": "`string`", "2-1": "`string(6)`", "3-1": "`string`", "5-1": "`string`", "4-1": "`int`", "6-1": "`int`", "7-1": "`int`", "0-2": "Your unique identifier for the customer's profile.", "1-2": "Paynova's unique identifier for the profile card.", "2-2": "The first six digits of the card number.", "3-2": "The last four digits of the card number.\n\n**Constraints:**\n> Length=4", "4-2": "Paynova's id for the card brand/scheme.\n\n**Possible values:**\n> **1** - Visa\n> **2** -MasterCard\n> **3** - American Express\n> **4** - Diners Club\n> **5** - Discover\n> **7** - JCB\n> **11** - Dancard\n> **12** - Maestro (International)\n> **15** - Laser\n> **16** - Resurs Card", "5-2": "Paynova's string representation of the card scheme name.", "6-2": "The two-digit expiration month of the card.\n\n**Constraints:**\n> Length=2", "7-2": "The four-digit expiration year of the card.\n\n**Constraints:**\n> Length=4" }, "cols": 3, "rows": 8 } [/block] [block:api-header] { "type": "basic", "title": "Example - Customer Profile Card Added", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "Connection: close\nPn-Digest: 1E228ABA773BA6B509564E317B5ED423275A25BB\nHost: requestb.in\nTotal-Route-Time: 0\nVia: 1.1 vegur\nConnect-Time: 4\nContent-Length: 367\nContent-Type: application/x-www-form-urlencoded\nX-Request-Id: c654d516-6ff8-4083-945e-20817d9ba56c", "language": "text", "name": "Headers" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "EVENT_TIMESTAMP: 2016-11-07 12:09:55Z\nCARD_ID: 5332272e-23cf-4115-a72f-a38000e9707c\nEVENT_TYPE: CUSTOMER_PROFILE_CARD_ADDED\nPROFILE_ID: 1\nMERCHANT_ID: 4999\nDIGEST: 2E1F77F3688935FC7F4228A3524A30A83BD0063E\nCARD_EXPIRATION_MONTH: 3\nDELIVERY_TIMESTAMP: 2016-11-07 12:09:55Z\nCARD_BRAND_ID: 1\nCARD_LAST_FOUR: 1111\nCARD_EXPIRATION_YEAR: 17\nALREADY_EXISTS: False\nCARD_BIN: 411111", "language": "text", "name": "FORM/POST Parameters" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "ALREADY_EXISTS=False&CARD_BIN=411111&CARD_BRAND_ID=1&CARD_EXPIRATION_MONTH=3&CARD_EXPIRATION_YEAR=17&CARD_ID=5332272e-23cf-4115-a72f-a38000e9707c&CARD_LAST_FOUR=1111&DELIVERY_TIMESTAMP=2016-11-07+12%3a09%3a55Z&DIGEST=2E1F77F3688935FC7F4228A3524A30A83BD0063E&EVENT_TIMESTAMP=2014-08-07+12%3a09%3a55Z&EVENT_TYPE=CUSTOMER_PROFILE_CARD_ADDED&MERCHANT_ID=4999&PROFILE_ID=1\n", "language": "text", "name": "RAW Body" } ], "sidebar": true } [/block]
The **Customer Profile Card Added** EHN is received when a customer has saved their card within a merchant customer profile using our Aero hosted payment interface. ## Data Fields In addition to the [Common Fields](doc:common-fields), you will receive the following information: [block:parameters] { "data": { "0-0": "`PROFILE_ID`\n*required*", "1-0": "`CARD_ID`\n*required*", "2-0": "`CARD_BIN`\n*required*", "3-0": "`CARD_LAST_FOUR`\n*required*", "4-0": "`CARD_BRAND_ID`\n*required*", "5-0": "`CARD_BRAND_NAME`\n*required*", "6-0": "`CARD_EXPIRATION_MONTH`\n*required*", "7-0": "`CARD_EXPIRATION_YEAR`\n*required*", "0-1": "`string`", "1-1": "`string`", "2-1": "`string(6)`", "3-1": "`string`", "5-1": "`string`", "4-1": "`int`", "6-1": "`int`", "7-1": "`int`", "0-2": "Your unique identifier for the customer's profile.", "1-2": "Paynova's unique identifier for the profile card.", "2-2": "The first six digits of the card number.", "3-2": "The last four digits of the card number.\n\n**Constraints:**\n> Length=4", "4-2": "Paynova's id for the card brand/scheme.\n\n**Possible values:**\n> **1** - Visa\n> **2** -MasterCard\n> **3** - American Express\n> **4** - Diners Club\n> **5** - Discover\n> **7** - JCB\n> **11** - Dancard\n> **12** - Maestro (International)\n> **15** - Laser\n> **16** - Resurs Card", "5-2": "Paynova's string representation of the card scheme name.", "6-2": "The two-digit expiration month of the card.\n\n**Constraints:**\n> Length=2", "7-2": "The four-digit expiration year of the card.\n\n**Constraints:**\n> Length=4" }, "cols": 3, "rows": 8 } [/block] [block:api-header] { "type": "basic", "title": "Example - Customer Profile Card Added", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "Connection: close\nPn-Digest: 1E228ABA773BA6B509564E317B5ED423275A25BB\nHost: requestb.in\nTotal-Route-Time: 0\nVia: 1.1 vegur\nConnect-Time: 4\nContent-Length: 367\nContent-Type: application/x-www-form-urlencoded\nX-Request-Id: c654d516-6ff8-4083-945e-20817d9ba56c", "language": "text", "name": "Headers" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "EVENT_TIMESTAMP: 2016-11-07 12:09:55Z\nCARD_ID: 5332272e-23cf-4115-a72f-a38000e9707c\nEVENT_TYPE: CUSTOMER_PROFILE_CARD_ADDED\nPROFILE_ID: 1\nMERCHANT_ID: 4999\nDIGEST: 2E1F77F3688935FC7F4228A3524A30A83BD0063E\nCARD_EXPIRATION_MONTH: 3\nDELIVERY_TIMESTAMP: 2016-11-07 12:09:55Z\nCARD_BRAND_ID: 1\nCARD_LAST_FOUR: 1111\nCARD_EXPIRATION_YEAR: 17\nALREADY_EXISTS: False\nCARD_BIN: 411111", "language": "text", "name": "FORM/POST Parameters" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "ALREADY_EXISTS=False&CARD_BIN=411111&CARD_BRAND_ID=1&CARD_EXPIRATION_MONTH=3&CARD_EXPIRATION_YEAR=17&CARD_ID=5332272e-23cf-4115-a72f-a38000e9707c&CARD_LAST_FOUR=1111&DELIVERY_TIMESTAMP=2016-11-07+12%3a09%3a55Z&DIGEST=2E1F77F3688935FC7F4228A3524A30A83BD0063E&EVENT_TIMESTAMP=2014-08-07+12%3a09%3a55Z&EVENT_TYPE=CUSTOMER_PROFILE_CARD_ADDED&MERCHANT_ID=4999&PROFILE_ID=1\n", "language": "text", "name": "RAW Body" } ], "sidebar": true } [/block]
{"_id":"5835a47c9a8d971900dd2e55","category":"5835938b9a8d971900dd2e38","next":{"pages":[],"description":""},"slug":"ehn-customer-profile-card-removed","__v":0,"api":{"settings":"","auth":"required","params":[],"url":"","results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]}},"createdAt":"2016-11-23T14:15:24.331Z","excerpt":"","link_external":false,"link_url":"","type":"basic","githubsync":"","hidden":false,"isReference":false,"order":6,"sync_unique":"","title":"EHN: Customer Profile Card Removed","version":"54930e7c777ff221004a7e70","body":"The **Customer Profile Card Removed** EHN is received when a saved card has been removed from a merchant's customer profile. This currently only happens when you try to make a payment with an existing card which has expired. The updated expiration dates results in a new card added and the old expired card gets removed.\n\n\n\n## Data Fields\n\nIn addition to the [Common Fields](doc:common-fields), you will receive the following information:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`PROFILE_ID`\\n*required*\",\n    \"1-0\": \"`CARD_ID`\\n*required*\",\n    \"0-1\": \"`string`\",\n    \"1-1\": \"`string`\",\n    \"0-2\": \"Your unique identifier for the customer's profile.\",\n    \"1-2\": \"Paynova's unique identifier for the profile card.\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example - Customer Profile Card Removed\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Total-Route-Time: 0\\nContent-Length: 392\\nConnect-Time: 0\\nConnection: close\\nContent-Type: application/x-www-form-urlencoded\\nPn-Digest: 828C134D4C58A35FFD71C4893D641FFB542CEE6E\\nVia: 1.1 vegur\\nX-Request-Id: 4011c170-96ee-4db0-b683-a47b2d74cf87\\nHost: requestb.in\",\n      \"language\": \"text\",\n      \"name\": \"Headers\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"CUSTOM_DATA_COUNT: 0\\nSESSION_ID: 04156f48-e6d4-45b1-8f62-a37f00cb17c2\\nEVENT_TYPE: SESSION_END\\nORDER_ID: 3ec05393-4598-484e-8666-a37f00cb0499\\nORDER_NUMBER: API-99C91D50-20140806141826\\nSESSION_STATUS: COMPLETED\\nEVENT_TIMESTAMP: 2014-08-06 12:22:19Z\\nDELIVERY_TIMESTAMP: 2014-08-06 12:22:19Z\\nMERCHANT_ID: 4999\\nDIGEST: 5E716D9AC9554C7B901FE20C0F03798308E3A62F\\nSESSION_STATUS_REASON: PAYMENT_COMPLETED\",\n      \"language\": \"text\",\n      \"name\": \"FORM/POST Parameters\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"CUSTOM_DATA_COUNT=0&DELIVERY_TIMESTAMP=2014-08-06+12%3a22%3a19Z&DIGEST=5E716D9AC9554C7B901FE20C0F03798308E3A62F&EVENT_TIMESTAMP=2014-08-06+12%3a22%3a19Z&EVENT_TYPE=SESSION_END&MERCHANT_ID=4999&ORDER_ID=3ec05393-4598-484e-8666-a37f00cb0499&ORDER_NUMBER=API-99C91D50-20140806141826&SESSION_ID=04156f48-e6d4-45b1-8f62-a37f00cb17c2&SESSION_STATUS=COMPLETED&SESSION_STATUS_REASON=PAYMENT_COMPLETED\\n\",\n      \"language\": \"text\",\n      \"name\": \"RAW Body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","parentDoc":null,"project":"54930e7c777ff221004a7e6d","updates":[],"user":"5818a4ecb1e11c1900bf76c3","childrenPages":[]}

EHN: Customer Profile Card Removed


The **Customer Profile Card Removed** EHN is received when a saved card has been removed from a merchant's customer profile. This currently only happens when you try to make a payment with an existing card which has expired. The updated expiration dates results in a new card added and the old expired card gets removed. ## Data Fields In addition to the [Common Fields](doc:common-fields), you will receive the following information: [block:parameters] { "data": { "0-0": "`PROFILE_ID`\n*required*", "1-0": "`CARD_ID`\n*required*", "0-1": "`string`", "1-1": "`string`", "0-2": "Your unique identifier for the customer's profile.", "1-2": "Paynova's unique identifier for the profile card.", "h-0": "Property", "h-1": "Type", "h-2": "Description" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Example - Customer Profile Card Removed", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "Total-Route-Time: 0\nContent-Length: 392\nConnect-Time: 0\nConnection: close\nContent-Type: application/x-www-form-urlencoded\nPn-Digest: 828C134D4C58A35FFD71C4893D641FFB542CEE6E\nVia: 1.1 vegur\nX-Request-Id: 4011c170-96ee-4db0-b683-a47b2d74cf87\nHost: requestb.in", "language": "text", "name": "Headers" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "CUSTOM_DATA_COUNT: 0\nSESSION_ID: 04156f48-e6d4-45b1-8f62-a37f00cb17c2\nEVENT_TYPE: SESSION_END\nORDER_ID: 3ec05393-4598-484e-8666-a37f00cb0499\nORDER_NUMBER: API-99C91D50-20140806141826\nSESSION_STATUS: COMPLETED\nEVENT_TIMESTAMP: 2014-08-06 12:22:19Z\nDELIVERY_TIMESTAMP: 2014-08-06 12:22:19Z\nMERCHANT_ID: 4999\nDIGEST: 5E716D9AC9554C7B901FE20C0F03798308E3A62F\nSESSION_STATUS_REASON: PAYMENT_COMPLETED", "language": "text", "name": "FORM/POST Parameters" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "CUSTOM_DATA_COUNT=0&DELIVERY_TIMESTAMP=2014-08-06+12%3a22%3a19Z&DIGEST=5E716D9AC9554C7B901FE20C0F03798308E3A62F&EVENT_TIMESTAMP=2014-08-06+12%3a22%3a19Z&EVENT_TYPE=SESSION_END&MERCHANT_ID=4999&ORDER_ID=3ec05393-4598-484e-8666-a37f00cb0499&ORDER_NUMBER=API-99C91D50-20140806141826&SESSION_ID=04156f48-e6d4-45b1-8f62-a37f00cb17c2&SESSION_STATUS=COMPLETED&SESSION_STATUS_REASON=PAYMENT_COMPLETED\n", "language": "text", "name": "RAW Body" } ], "sidebar": true } [/block]
The **Customer Profile Card Removed** EHN is received when a saved card has been removed from a merchant's customer profile. This currently only happens when you try to make a payment with an existing card which has expired. The updated expiration dates results in a new card added and the old expired card gets removed. ## Data Fields In addition to the [Common Fields](doc:common-fields), you will receive the following information: [block:parameters] { "data": { "0-0": "`PROFILE_ID`\n*required*", "1-0": "`CARD_ID`\n*required*", "0-1": "`string`", "1-1": "`string`", "0-2": "Your unique identifier for the customer's profile.", "1-2": "Paynova's unique identifier for the profile card.", "h-0": "Property", "h-1": "Type", "h-2": "Description" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Example - Customer Profile Card Removed", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "Total-Route-Time: 0\nContent-Length: 392\nConnect-Time: 0\nConnection: close\nContent-Type: application/x-www-form-urlencoded\nPn-Digest: 828C134D4C58A35FFD71C4893D641FFB542CEE6E\nVia: 1.1 vegur\nX-Request-Id: 4011c170-96ee-4db0-b683-a47b2d74cf87\nHost: requestb.in", "language": "text", "name": "Headers" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "CUSTOM_DATA_COUNT: 0\nSESSION_ID: 04156f48-e6d4-45b1-8f62-a37f00cb17c2\nEVENT_TYPE: SESSION_END\nORDER_ID: 3ec05393-4598-484e-8666-a37f00cb0499\nORDER_NUMBER: API-99C91D50-20140806141826\nSESSION_STATUS: COMPLETED\nEVENT_TIMESTAMP: 2014-08-06 12:22:19Z\nDELIVERY_TIMESTAMP: 2014-08-06 12:22:19Z\nMERCHANT_ID: 4999\nDIGEST: 5E716D9AC9554C7B901FE20C0F03798308E3A62F\nSESSION_STATUS_REASON: PAYMENT_COMPLETED", "language": "text", "name": "FORM/POST Parameters" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "CUSTOM_DATA_COUNT=0&DELIVERY_TIMESTAMP=2014-08-06+12%3a22%3a19Z&DIGEST=5E716D9AC9554C7B901FE20C0F03798308E3A62F&EVENT_TIMESTAMP=2014-08-06+12%3a22%3a19Z&EVENT_TYPE=SESSION_END&MERCHANT_ID=4999&ORDER_ID=3ec05393-4598-484e-8666-a37f00cb0499&ORDER_NUMBER=API-99C91D50-20140806141826&SESSION_ID=04156f48-e6d4-45b1-8f62-a37f00cb17c2&SESSION_STATUS=COMPLETED&SESSION_STATUS_REASON=PAYMENT_COMPLETED\n", "language": "text", "name": "RAW Body" } ], "sidebar": true } [/block]
{"_id":"54cf78c5a082241900f05f9b","link_external":false,"parentDoc":null,"slug":"paymentmethods","updates":["59f32be65e241a001001ba5f","5ae048c330f1350003cdab0c"],"excerpt":"","hidden":false,"project":"54930e7c777ff221004a7e6d","user":"5476eb1df3736008009e9ced","body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Id\",\n    \"h-1\": \"Method Name\",\n    \"h-2\": \"Required Order Type\",\n    \"h-3\": \"Finalization Time Limit\",\n    \"h-4\": \"Max No. of Refunds\",\n    \"h-5\": \"Refund Time Limit\",\n    \"h-6\": \"Countries\",\n    \"h-7\": \"Currencies\",\n    \"h-8\": \"Required Order Type\",\n    \"1-6\": \"Global\",\n    \"1-0\": \"1\",\n    \"1-1\": \"Visa\",\n    \"1-2\": \"Simple\",\n    \"1-3\": \"5 days*\",\n    \"1-4\": \"Up to finalized amount\",\n    \"2-4\": \"Up to finalized amount\",\n    \"3-4\": \"Up to finalized amount\",\n    \"4-4\": \"Up to finalized amount\",\n    \"5-4\": \"Up to finalized amount\",\n    \"2-3\": \"5 days*\",\n    \"3-3\": \"5 days*\",\n    \"4-3\": \"5 days*\",\n    \"5-3\": \"5 days*\",\n    \"2-2\": \"Simple\",\n    \"3-2\": \"Simple\",\n    \"4-2\": \"Simple\",\n    \"5-2\": \"Simple\",\n    \"1-5\": \"1 year\",\n    \"2-5\": \"1 year\",\n    \"3-5\": \"1 year\",\n    \"4-5\": \"1 year\",\n    \"5-5\": \"1 year\",\n    \"2-6\": \"Global\",\n    \"3-6\": \"Global\",\n    \"4-6\": \"Global\",\n    \"5-6\": \"Europe\",\n    \"1-7\": \"All\",\n    \"2-7\": \"All\",\n    \"3-7\": \"All\",\n    \"4-7\": \"All\",\n    \"5-7\": \"Europe\",\n    \"1-8\": \"Simple\",\n    \"2-8\": \"Simple\",\n    \"3-8\": \"Simple\",\n    \"4-8\": \"Simple\",\n    \"5-8\": \"Simple\",\n    \"2-1\": \"MasterCard\",\n    \"3-1\": \"American Express\",\n    \"4-1\": \"Diners Club\",\n    \"5-1\": \"Maestro (International)\",\n    \"2-0\": \"2\",\n    \"3-0\": \"3\",\n    \"4-0\": \"4\",\n    \"5-0\": \"12\",\n    \"0-0\": \"\",\n    \"6-0\": \"\",\n    \"7-0\": \"101\",\n    \"7-1\": \"Nordea (Sweden)\",\n    \"7-2\": \"Simple\",\n    \"7-3\": \"n/a\",\n    \"7-4\": \"Up to paid amount\",\n    \"7-5\": \"6 months\",\n    \"7-6\": \"SE\",\n    \"7-7\": \"SEK\",\n    \"7-8\": \"Simple\",\n    \"8-2\": \"Simple\",\n    \"8-3\": \"n/a\",\n    \"9-3\": \"n/a\",\n    \"9-2\": \"Simple\",\n    \"10-2\": \"Simple\",\n    \"10-3\": \"n/a\",\n    \"11-3\": \"n/a\",\n    \"11-2\": \"Simple\",\n    \"12-2\": \"Simple\",\n    \"12-3\": \"n/a\",\n    \"13-2\": \"Simple\",\n    \"13-3\": \"n/a\",\n    \"14-3\": \"n/a\",\n    \"14-2\": \"Simple\",\n    \"15-2\": \"Simple\",\n    \"15-3\": \"n/a\",\n    \"16-3\": \"n/a\",\n    \"16-2\": \"Simple\",\n    \"8-4\": \"Up to paid amount\",\n    \"9-4\": \"Up to paid amount\",\n    \"10-4\": \"Up to paid amount\",\n    \"11-4\": \"1 (full or partial)\",\n    \"12-4\": \"1 (full or partial)\",\n    \"13-4\": \"Up to paid amount\",\n    \"14-4\": \"Up to paid amount\",\n    \"15-4\": \"Up to paid amount\",\n    \"16-4\": \"Up to paid amount\",\n    \"8-5\": \"6 months\",\n    \"9-5\": \"6 months\",\n    \"10-5\": \"6 months\",\n    \"11-5\": \"6 months\",\n    \"12-5\": \"90 days\",\n    \"13-5\": \"6 months\",\n    \"14-5\": \"6 months\",\n    \"15-5\": \"6 months\",\n    \"16-5\": \"6 months\",\n    \"8-6\": \"SE\",\n    \"9-6\": \"SE\",\n    \"10-6\": \"SE\",\n    \"11-6\": \"NL\",\n    \"12-6\": \"FI\",\n    \"13-6\": \"FI\",\n    \"14-6\": \"FI\",\n    \"15-6\": \"Global\",\n    \"16-6\": \"DK\",\n    \"8-7\": \"SEK\",\n    \"9-7\": \"SEK\",\n    \"10-7\": \"SEK\",\n    \"11-7\": \"EUR\",\n    \"12-7\": \"EUR\",\n    \"13-7\": \"EUR\",\n    \"14-7\": \"EUR\",\n    \"15-7\": \"EUR\",\n    \"16-7\": \"DKK\",\n    \"8-8\": \"Simple\",\n    \"9-8\": \"Simple\",\n    \"10-8\": \"Simple\",\n    \"11-8\": \"Simple\",\n    \"12-8\": \"Simple\",\n    \"13-8\": \"Simple\",\n    \"14-8\": \"Simple\",\n    \"15-8\": \"Simple\",\n    \"16-8\": \"Simple\",\n    \"8-0\": \"102\",\n    \"9-0\": \"103\",\n    \"10-0\": \"104\",\n    \"11-0\": \"110\",\n    \"12-0\": \"113\",\n    \"13-0\": \"114\",\n    \"14-0\": \"115\",\n    \"15-0\": \"117\",\n    \"16-0\": \"121\",\n    \"8-1\": \"Swedbank\",\n    \"9-1\": \"Handelsbanken\",\n    \"10-1\": \"SEB\",\n    \"11-1\": \"iDeal\",\n    \"12-1\": \"Nordea (Finland)\",\n    \"13-1\": \"Aktia\",\n    \"14-1\": \"Danske Bank (Finland)\",\n    \"15-1\": \"Pohjola\",\n    \"16-1\": \"Danske Bank (Denmark)\",\n    \"0-1\": \"**Credit Cards**\",\n    \"6-1\": \"**Internet Banks**\",\n    \"20-1\": \"**E-Accounts/Wallets**\",\n    \"21-0\": \"304\",\n    \"21-1\": \"PayPal\",\n    \"22-0\": \"308\",\n    \"22-1\": \"Masterpass\",\n    \"22-2\": \"Simple\",\n    \"21-2\": \"Simple**\",\n    \"21-3\": \"30 days\",\n    \"22-3\": \"5 days*\",\n    \"21-4\": \"Up to paid amount\",\n    \"22-4\": \"Up to finalized amount\",\n    \"21-5\": \"1 year\",\n    \"22-5\": \"1 year\",\n    \"21-6\": \"Global\",\n    \"22-6\": \"Global\",\n    \"21-7\": \"All\",\n    \"22-7\": \"All\",\n    \"21-8\": \"Simple**\",\n    \"22-8\": \"Simple\",\n    \"23-1\": \"**Paynova Invoice as a Service**\",\n    \"24-0\": \"311\",\n    \"24-1\": \"Invoice/Installment\",\n    \"24-2\": \"Detailed\",\n    \"24-3\": \"n/a\",\n    \"24-4\": \"Up to paid amount\",\n    \"24-5\": \"n/a\",\n    \"24-6\": \"SE\",\n    \"24-7\": \"SEK\",\n    \"24-8\": \"Detailed\",\n    \"0-2\": \"\",\n    \"6-2\": \"\",\n    \"18-0\": \"126\",\n    \"18-1\": \"**Swish**\",\n    \"18-2\": \"Simple\"\n  },\n  \"cols\": 3,\n  \"rows\": 25\n}\n[/block]\n** While these payment methods can be processed with simple orders, we strongly recommend the use of detailed orders to make use of additional features of the payment method.\n\n**The following payment method groups can also be used:**\n\n**0** - Show all available payment methods\n**99** - Show all available cards\n**198** - Show all available internet banks","githubsync":"","isReference":true,"order":1,"type":"basic","category":"54cf74d2a082241900f05f8e","createdAt":"2015-02-02T13:16:53.482Z","api":{"auth":"required","params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":""},"link_url":"","next":{"description":"","pages":[]},"sync_unique":"","title":"Payment Methods","version":"54930e7c777ff221004a7e70","__v":3,"childrenPages":[]}

Payment Methods


[block:parameters] { "data": { "h-0": "Id", "h-1": "Method Name", "h-2": "Required Order Type", "h-3": "Finalization Time Limit", "h-4": "Max No. of Refunds", "h-5": "Refund Time Limit", "h-6": "Countries", "h-7": "Currencies", "h-8": "Required Order Type", "1-6": "Global", "1-0": "1", "1-1": "Visa", "1-2": "Simple", "1-3": "5 days*", "1-4": "Up to finalized amount", "2-4": "Up to finalized amount", "3-4": "Up to finalized amount", "4-4": "Up to finalized amount", "5-4": "Up to finalized amount", "2-3": "5 days*", "3-3": "5 days*", "4-3": "5 days*", "5-3": "5 days*", "2-2": "Simple", "3-2": "Simple", "4-2": "Simple", "5-2": "Simple", "1-5": "1 year", "2-5": "1 year", "3-5": "1 year", "4-5": "1 year", "5-5": "1 year", "2-6": "Global", "3-6": "Global", "4-6": "Global", "5-6": "Europe", "1-7": "All", "2-7": "All", "3-7": "All", "4-7": "All", "5-7": "Europe", "1-8": "Simple", "2-8": "Simple", "3-8": "Simple", "4-8": "Simple", "5-8": "Simple", "2-1": "MasterCard", "3-1": "American Express", "4-1": "Diners Club", "5-1": "Maestro (International)", "2-0": "2", "3-0": "3", "4-0": "4", "5-0": "12", "0-0": "", "6-0": "", "7-0": "101", "7-1": "Nordea (Sweden)", "7-2": "Simple", "7-3": "n/a", "7-4": "Up to paid amount", "7-5": "6 months", "7-6": "SE", "7-7": "SEK", "7-8": "Simple", "8-2": "Simple", "8-3": "n/a", "9-3": "n/a", "9-2": "Simple", "10-2": "Simple", "10-3": "n/a", "11-3": "n/a", "11-2": "Simple", "12-2": "Simple", "12-3": "n/a", "13-2": "Simple", "13-3": "n/a", "14-3": "n/a", "14-2": "Simple", "15-2": "Simple", "15-3": "n/a", "16-3": "n/a", "16-2": "Simple", "8-4": "Up to paid amount", "9-4": "Up to paid amount", "10-4": "Up to paid amount", "11-4": "1 (full or partial)", "12-4": "1 (full or partial)", "13-4": "Up to paid amount", "14-4": "Up to paid amount", "15-4": "Up to paid amount", "16-4": "Up to paid amount", "8-5": "6 months", "9-5": "6 months", "10-5": "6 months", "11-5": "6 months", "12-5": "90 days", "13-5": "6 months", "14-5": "6 months", "15-5": "6 months", "16-5": "6 months", "8-6": "SE", "9-6": "SE", "10-6": "SE", "11-6": "NL", "12-6": "FI", "13-6": "FI", "14-6": "FI", "15-6": "Global", "16-6": "DK", "8-7": "SEK", "9-7": "SEK", "10-7": "SEK", "11-7": "EUR", "12-7": "EUR", "13-7": "EUR", "14-7": "EUR", "15-7": "EUR", "16-7": "DKK", "8-8": "Simple", "9-8": "Simple", "10-8": "Simple", "11-8": "Simple", "12-8": "Simple", "13-8": "Simple", "14-8": "Simple", "15-8": "Simple", "16-8": "Simple", "8-0": "102", "9-0": "103", "10-0": "104", "11-0": "110", "12-0": "113", "13-0": "114", "14-0": "115", "15-0": "117", "16-0": "121", "8-1": "Swedbank", "9-1": "Handelsbanken", "10-1": "SEB", "11-1": "iDeal", "12-1": "Nordea (Finland)", "13-1": "Aktia", "14-1": "Danske Bank (Finland)", "15-1": "Pohjola", "16-1": "Danske Bank (Denmark)", "0-1": "**Credit Cards**", "6-1": "**Internet Banks**", "20-1": "**E-Accounts/Wallets**", "21-0": "304", "21-1": "PayPal", "22-0": "308", "22-1": "Masterpass", "22-2": "Simple", "21-2": "Simple**", "21-3": "30 days", "22-3": "5 days*", "21-4": "Up to paid amount", "22-4": "Up to finalized amount", "21-5": "1 year", "22-5": "1 year", "21-6": "Global", "22-6": "Global", "21-7": "All", "22-7": "All", "21-8": "Simple**", "22-8": "Simple", "23-1": "**Paynova Invoice as a Service**", "24-0": "311", "24-1": "Invoice/Installment", "24-2": "Detailed", "24-3": "n/a", "24-4": "Up to paid amount", "24-5": "n/a", "24-6": "SE", "24-7": "SEK", "24-8": "Detailed", "0-2": "", "6-2": "", "18-0": "126", "18-1": "**Swish**", "18-2": "Simple" }, "cols": 3, "rows": 25 } [/block] ** While these payment methods can be processed with simple orders, we strongly recommend the use of detailed orders to make use of additional features of the payment method. **The following payment method groups can also be used:** **0** - Show all available payment methods **99** - Show all available cards **198** - Show all available internet banks
[block:parameters] { "data": { "h-0": "Id", "h-1": "Method Name", "h-2": "Required Order Type", "h-3": "Finalization Time Limit", "h-4": "Max No. of Refunds", "h-5": "Refund Time Limit", "h-6": "Countries", "h-7": "Currencies", "h-8": "Required Order Type", "1-6": "Global", "1-0": "1", "1-1": "Visa", "1-2": "Simple", "1-3": "5 days*", "1-4": "Up to finalized amount", "2-4": "Up to finalized amount", "3-4": "Up to finalized amount", "4-4": "Up to finalized amount", "5-4": "Up to finalized amount", "2-3": "5 days*", "3-3": "5 days*", "4-3": "5 days*", "5-3": "5 days*", "2-2": "Simple", "3-2": "Simple", "4-2": "Simple", "5-2": "Simple", "1-5": "1 year", "2-5": "1 year", "3-5": "1 year", "4-5": "1 year", "5-5": "1 year", "2-6": "Global", "3-6": "Global", "4-6": "Global", "5-6": "Europe", "1-7": "All", "2-7": "All", "3-7": "All", "4-7": "All", "5-7": "Europe", "1-8": "Simple", "2-8": "Simple", "3-8": "Simple", "4-8": "Simple", "5-8": "Simple", "2-1": "MasterCard", "3-1": "American Express", "4-1": "Diners Club", "5-1": "Maestro (International)", "2-0": "2", "3-0": "3", "4-0": "4", "5-0": "12", "0-0": "", "6-0": "", "7-0": "101", "7-1": "Nordea (Sweden)", "7-2": "Simple", "7-3": "n/a", "7-4": "Up to paid amount", "7-5": "6 months", "7-6": "SE", "7-7": "SEK", "7-8": "Simple", "8-2": "Simple", "8-3": "n/a", "9-3": "n/a", "9-2": "Simple", "10-2": "Simple", "10-3": "n/a", "11-3": "n/a", "11-2": "Simple", "12-2": "Simple", "12-3": "n/a", "13-2": "Simple", "13-3": "n/a", "14-3": "n/a", "14-2": "Simple", "15-2": "Simple", "15-3": "n/a", "16-3": "n/a", "16-2": "Simple", "8-4": "Up to paid amount", "9-4": "Up to paid amount", "10-4": "Up to paid amount", "11-4": "1 (full or partial)", "12-4": "1 (full or partial)", "13-4": "Up to paid amount", "14-4": "Up to paid amount", "15-4": "Up to paid amount", "16-4": "Up to paid amount", "8-5": "6 months", "9-5": "6 months", "10-5": "6 months", "11-5": "6 months", "12-5": "90 days", "13-5": "6 months", "14-5": "6 months", "15-5": "6 months", "16-5": "6 months", "8-6": "SE", "9-6": "SE", "10-6": "SE", "11-6": "NL", "12-6": "FI", "13-6": "FI", "14-6": "FI", "15-6": "Global", "16-6": "DK", "8-7": "SEK", "9-7": "SEK", "10-7": "SEK", "11-7": "EUR", "12-7": "EUR", "13-7": "EUR", "14-7": "EUR", "15-7": "EUR", "16-7": "DKK", "8-8": "Simple", "9-8": "Simple", "10-8": "Simple", "11-8": "Simple", "12-8": "Simple", "13-8": "Simple", "14-8": "Simple", "15-8": "Simple", "16-8": "Simple", "8-0": "102", "9-0": "103", "10-0": "104", "11-0": "110", "12-0": "113", "13-0": "114", "14-0": "115", "15-0": "117", "16-0": "121", "8-1": "Swedbank", "9-1": "Handelsbanken", "10-1": "SEB", "11-1": "iDeal", "12-1": "Nordea (Finland)", "13-1": "Aktia", "14-1": "Danske Bank (Finland)", "15-1": "Pohjola", "16-1": "Danske Bank (Denmark)", "0-1": "**Credit Cards**", "6-1": "**Internet Banks**", "20-1": "**E-Accounts/Wallets**", "21-0": "304", "21-1": "PayPal", "22-0": "308", "22-1": "Masterpass", "22-2": "Simple", "21-2": "Simple**", "21-3": "30 days", "22-3": "5 days*", "21-4": "Up to paid amount", "22-4": "Up to finalized amount", "21-5": "1 year", "22-5": "1 year", "21-6": "Global", "22-6": "Global", "21-7": "All", "22-7": "All", "21-8": "Simple**", "22-8": "Simple", "23-1": "**Paynova Invoice as a Service**", "24-0": "311", "24-1": "Invoice/Installment", "24-2": "Detailed", "24-3": "n/a", "24-4": "Up to paid amount", "24-5": "n/a", "24-6": "SE", "24-7": "SEK", "24-8": "Detailed", "0-2": "", "6-2": "", "18-0": "126", "18-1": "**Swish**", "18-2": "Simple" }, "cols": 3, "rows": 25 } [/block] ** While these payment methods can be processed with simple orders, we strongly recommend the use of detailed orders to make use of additional features of the payment method. **The following payment method groups can also be used:** **0** - Show all available payment methods **99** - Show all available cards **198** - Show all available internet banks
{"_id":"55561a61150ba30d00f4e014","hidden":false,"order":2,"__v":0,"category":"54cf74d2a082241900f05f8e","link_url":"","title":"Country codes","api":{"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"auth":"required","params":[],"url":""},"createdAt":"2015-05-15T16:10:09.886Z","isReference":false,"link_external":false,"project":"54930e7c777ff221004a7e6d","updates":[],"user":"5476eb1df3736008009e9ced","version":"54930e7c777ff221004a7e70","body":"Paynova's API accepts country codes in ISO 3166-1 alpha-2 format (2-letter codes).\n \nHere are some of the most common codes:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Language\",\n    \"h-1\": \"ISO 3166-1 code\",\n    \"0-0\": \"Sweden\",\n    \"1-0\": \"Finland\",\n    \"17-0\": \"Swedish\",\n    \"8-0\": \"German\",\n    \"3-0\": \"Denmark\",\n    \"4-0\": \"Germany\",\n    \"6-0\": \"Finnish\",\n    \"13-0\": \"Norwegian\",\n    \"7-0\": \"French\",\n    \"2-0\": \"Norway\",\n    \"12-0\": \"Korean\",\n    \"16-0\": \"Spanish\",\n    \"10-0\": \"Italian\",\n    \"5-0\": \"Estonian\",\n    \"15-0\": \"Russian\",\n    \"9-0\": \"Greek\",\n    \"18-0\": \"Turkish\",\n    \"11-0\": \"Japanese\",\n    \"14-0\": \"Polish\",\n    \"0-1\": \"SE\",\n    \"1-1\": \"FI\",\n    \"2-1\": \"NO\",\n    \"3-1\": \"DK\",\n    \"4-1\": \"DE\",\n    \"5-1\": \"EST\",\n    \"6-1\": \"FIN\",\n    \"7-1\": \"FRA\",\n    \"8-1\": \"DEU\",\n    \"9-1\": \"ELL\",\n    \"10-1\": \"ITA\",\n    \"11-1\": \"JPN\",\n    \"12-1\": \"KOR\",\n    \"13-1\": \"NOR\",\n    \"14-1\": \"POL\",\n    \"15-1\": \"RUS\",\n    \"16-1\": \"SPA\",\n    \"17-1\": \"SWE\",\n    \"18-1\": \"TUR\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]","githubsync":"","parentDoc":null,"slug":"country-codes","sync_unique":"","type":"basic","excerpt":"","childrenPages":[]}

Country codes


Paynova's API accepts country codes in ISO 3166-1 alpha-2 format (2-letter codes). Here are some of the most common codes: [block:parameters] { "data": { "h-0": "Language", "h-1": "ISO 3166-1 code", "0-0": "Sweden", "1-0": "Finland", "17-0": "Swedish", "8-0": "German", "3-0": "Denmark", "4-0": "Germany", "6-0": "Finnish", "13-0": "Norwegian", "7-0": "French", "2-0": "Norway", "12-0": "Korean", "16-0": "Spanish", "10-0": "Italian", "5-0": "Estonian", "15-0": "Russian", "9-0": "Greek", "18-0": "Turkish", "11-0": "Japanese", "14-0": "Polish", "0-1": "SE", "1-1": "FI", "2-1": "NO", "3-1": "DK", "4-1": "DE", "5-1": "EST", "6-1": "FIN", "7-1": "FRA", "8-1": "DEU", "9-1": "ELL", "10-1": "ITA", "11-1": "JPN", "12-1": "KOR", "13-1": "NOR", "14-1": "POL", "15-1": "RUS", "16-1": "SPA", "17-1": "SWE", "18-1": "TUR" }, "cols": 2, "rows": 5 } [/block]
Paynova's API accepts country codes in ISO 3166-1 alpha-2 format (2-letter codes). Here are some of the most common codes: [block:parameters] { "data": { "h-0": "Language", "h-1": "ISO 3166-1 code", "0-0": "Sweden", "1-0": "Finland", "17-0": "Swedish", "8-0": "German", "3-0": "Denmark", "4-0": "Germany", "6-0": "Finnish", "13-0": "Norwegian", "7-0": "French", "2-0": "Norway", "12-0": "Korean", "16-0": "Spanish", "10-0": "Italian", "5-0": "Estonian", "15-0": "Russian", "9-0": "Greek", "18-0": "Turkish", "11-0": "Japanese", "14-0": "Polish", "0-1": "SE", "1-1": "FI", "2-1": "NO", "3-1": "DK", "4-1": "DE", "5-1": "EST", "6-1": "FIN", "7-1": "FRA", "8-1": "DEU", "9-1": "ELL", "10-1": "ITA", "11-1": "JPN", "12-1": "KOR", "13-1": "NOR", "14-1": "POL", "15-1": "RUS", "16-1": "SPA", "17-1": "SWE", "18-1": "TUR" }, "cols": 2, "rows": 5 } [/block]
{"_id":"550875b22b5ede2f0071addd","api":{"auth":"required","params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"url":""},"createdAt":"2015-03-17T18:42:58.485Z","updates":[],"slug":"language-codes","sync_unique":"","body":"Paynova's API accepts language codes in ISO 639-2 format.\n \nThe following languages are supported:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Language\",\n    \"h-1\": \"ISO 639-2 code\",\n    \"0-0\": \"Chinese\",\n    \"1-0\": \"Danish\",\n    \"17-0\": \"Swedish\",\n    \"8-0\": \"German\",\n    \"3-0\": \"English (UK)\",\n    \"4-0\": \"English (US)\",\n    \"6-0\": \"Finnish\",\n    \"13-0\": \"Norwegian\",\n    \"7-0\": \"French\",\n    \"2-0\": \"Dutch\",\n    \"12-0\": \"Korean\",\n    \"16-0\": \"Spanish\",\n    \"10-0\": \"Italian\",\n    \"5-0\": \"Estonian\",\n    \"15-0\": \"Russian\",\n    \"9-0\": \"Greek\",\n    \"18-0\": \"Turkish\",\n    \"11-0\": \"Japanese\",\n    \"14-0\": \"Polish\",\n    \"0-1\": \"ZHO\",\n    \"1-1\": \"DAN\",\n    \"2-1\": \"NLD\",\n    \"3-1\": \"ENG\",\n    \"4-1\": \"USA\",\n    \"5-1\": \"EST\",\n    \"6-1\": \"FIN\",\n    \"7-1\": \"FRA\",\n    \"8-1\": \"DEU\",\n    \"9-1\": \"ELL\",\n    \"10-1\": \"ITA\",\n    \"11-1\": \"JPN\",\n    \"12-1\": \"KOR\",\n    \"13-1\": \"NOR\",\n    \"14-1\": \"POL\",\n    \"15-1\": \"RUS\",\n    \"16-1\": \"SPA\",\n    \"17-1\": \"SWE\",\n    \"18-1\": \"TUR\"\n  },\n  \"cols\": 2,\n  \"rows\": 19\n}\n[/block]","excerpt":"","hidden":false,"isReference":false,"link_url":"","parentDoc":null,"title":"Language codes","type":"basic","version":"54930e7c777ff221004a7e70","__v":6,"category":"54cf74d2a082241900f05f8e","user":"5476eb1df3736008009e9ced","githubsync":"","link_external":false,"order":3,"project":"54930e7c777ff221004a7e6d","childrenPages":[]}

Language codes


Paynova's API accepts language codes in ISO 639-2 format. The following languages are supported: [block:parameters] { "data": { "h-0": "Language", "h-1": "ISO 639-2 code", "0-0": "Chinese", "1-0": "Danish", "17-0": "Swedish", "8-0": "German", "3-0": "English (UK)", "4-0": "English (US)", "6-0": "Finnish", "13-0": "Norwegian", "7-0": "French", "2-0": "Dutch", "12-0": "Korean", "16-0": "Spanish", "10-0": "Italian", "5-0": "Estonian", "15-0": "Russian", "9-0": "Greek", "18-0": "Turkish", "11-0": "Japanese", "14-0": "Polish", "0-1": "ZHO", "1-1": "DAN", "2-1": "NLD", "3-1": "ENG", "4-1": "USA", "5-1": "EST", "6-1": "FIN", "7-1": "FRA", "8-1": "DEU", "9-1": "ELL", "10-1": "ITA", "11-1": "JPN", "12-1": "KOR", "13-1": "NOR", "14-1": "POL", "15-1": "RUS", "16-1": "SPA", "17-1": "SWE", "18-1": "TUR" }, "cols": 2, "rows": 19 } [/block]
Paynova's API accepts language codes in ISO 639-2 format. The following languages are supported: [block:parameters] { "data": { "h-0": "Language", "h-1": "ISO 639-2 code", "0-0": "Chinese", "1-0": "Danish", "17-0": "Swedish", "8-0": "German", "3-0": "English (UK)", "4-0": "English (US)", "6-0": "Finnish", "13-0": "Norwegian", "7-0": "French", "2-0": "Dutch", "12-0": "Korean", "16-0": "Spanish", "10-0": "Italian", "5-0": "Estonian", "15-0": "Russian", "9-0": "Greek", "18-0": "Turkish", "11-0": "Japanese", "14-0": "Polish", "0-1": "ZHO", "1-1": "DAN", "2-1": "NLD", "3-1": "ENG", "4-1": "USA", "5-1": "EST", "6-1": "FIN", "7-1": "FRA", "8-1": "DEU", "9-1": "ELL", "10-1": "ITA", "11-1": "JPN", "12-1": "KOR", "13-1": "NOR", "14-1": "POL", "15-1": "RUS", "16-1": "SPA", "17-1": "SWE", "18-1": "TUR" }, "cols": 2, "rows": 19 } [/block]
{"_id":"581c90105a425c0f00de985b","project":"54930e7c777ff221004a7e6d","slug":"errorcodes","body":"Below is a list of possible error codes returned by Paynova's API.  Please note that error codes may be added from time-to-time, so take care to ensure that your implementation can handle new/unexpected error codes.  An operation that returns an error number other than `\"0\"` (SUCCESS or PENDING) should be considered a failed operation.\n[block:parameters]\n{\n  \"data\": {\n    \"0-1\": \"SUCCESS\",\n    \"0-0\": \"0\",\n    \"0-2\": \"The operation was successful.\",\n    \"h-0\": \"Error number\",\n    \"h-1\": \"Status Code\",\n    \"h-2\": \"Status Message\",\n    \"1-0\": \"0\",\n    \"1-1\": \"PENDING\",\n    \"1-2\": \"The operation is pending.\\n\\n**Conditions:**\\n> **Only applicable to mobile payments.**\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n##Service Errors\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"-1\",\n    \"0-1\": \"INTERNAL_ERROR\",\n    \"0-2\": \"The specified operation could not be completed at this time; please try your request again later. If the problem persists, please contact Paynova's merchant support at merchantsupport@paynova.com.\",\n    \"1-2\": \"\",\n    \"1-0\": \"-2\",\n    \"1-1\": \"VALIDATION_ERROR\",\n    \"2-0\": \"-3\",\n    \"2-1\": \"HTTP_###\",\n    \"2-2\": \"Our API uses standard HTTP error codes to convey errors such as authentication errors. The status code will contain HTTP_ followed by the HTTP error number (e.g. HTTP_401) and the status message will contain information applicable to the type of error. If you receive this error, the HTTP status code will also be sent back in the HTTP response.\",\n    \"h-0\": \"\",\n    \"h-1\": \"\",\n    \"h-2\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n##Account Errors\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"\",\n    \"h-1\": \"\",\n    \"h-2\": \"\",\n    \"0-0\": \"1000\",\n    \"0-1\": \"MERCHANT_ACCT_READ_ONLY\",\n    \"0-2\": \"The merchant account is currently read-only. This operation requires an active account.\",\n    \"1-0\": \"1001\",\n    \"1-1\": \"CUST_ACCT_NOT_ELIGIBLE\",\n    \"1-2\": \"The customer's account is currently not eligible to make payments.\",\n    \"2-0\": \"1002\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n##Profile Errors\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"2000\",\n    \"0-1\": \"CUST_PROF_NOT_FOUND\",\n    \"0-2\": \"The specified customer profile was not found.\",\n    \"1-0\": \"2001\",\n    \"1-1\": \"CUST_CARD_NOT_FOUND\",\n    \"1-2\": \"The specified profile card was not found in the customer's profile.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n##Order & Payment Errors\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"3000\",\n    \"0-1\": \"ORDER_NOT_FOUND\",\n    \"0-2\": \"The specified order was not found.\",\n    \"1-0\": \"3001\",\n    \"1-1\": \"LINE_ITEMS_NOT_ALLOWED\",\n    \"1-2\": \"You are not allowed to specify line items for this request because no line items were specified in the original order (simple order).\",\n    \"2-0\": \"3002\",\n    \"2-1\": \"FINALIZE_AMT_EXCEEDED\",\n    \"2-2\": \"The total amount you have specified in your finalize call is greater than the available balance to finalize.  Existing annulments and finalizations which are in a pending state also count against the available balance.\",\n    \"3-0\": \"3003\",\n    \"3-1\": \"LINE_ITEMS_REQUIRED\",\n    \"3-2\": \"This operation requires that line items be specified for detailed orders when the total amount specified does not equal the original order total amount.\",\n    \"4-0\": \"3004\",\n    \"4-1\": \"ORDER_ANNULLED\",\n    \"4-2\": \"The operation cannot be completed because the order is currently in an annulled state.\",\n    \"5-0\": \"3005\",\n    \"5-1\": \"ORDER_COMPLETED\",\n    \"5-2\": \"The operation cannot be completed because the order is currently in a completed state.\",\n    \"6-0\": \"3006\",\n    \"6-1\": \"PAYMENT_NOT_FOUND\",\n    \"6-2\": \"The specified payment could not be found for the given order.\",\n    \"7-0\": \"3007\",\n    \"7-1\": \"PAYMENT_COMPLETED\",\n    \"7-2\": \"The operation cannot be completed because the payment is currently in a completed state.\",\n    \"8-0\": \"3008\",\n    \"8-1\": \"PAYMENT_CANCELLED\",\n    \"8-2\": \"The operation cannot be completed because the payment is currently in a cancelled state.\",\n    \"9-0\": \"3009\",\n    \"9-1\": \"INVALID_CURRENCY\",\n    \"9-2\": \"The specified currency is invalid.\",\n    \"10-0\": \"3010\",\n    \"10-1\": \"INVALID_BILL_TO_COUNTRY\",\n    \"10-2\": \"The specified bill-to country is invalid\",\n    \"11-0\": \"3011\",\n    \"11-1\": \"INVALID_SHIP_TO_COUNTRY\",\n    \"11-2\": \"The specified ship-to country is invalid.\",\n    \"12-0\": \"3012\",\n    \"12-1\": \"CANNOT_FINALIZE_PAYMENT\",\n    \"12-2\": \"The payment provider implementation indicated that the payment cannot be finalized in its current state.\",\n    \"13-0\": \"3013\",\n    \"13-1\": \"CANNOT_REFUND_PAYMENT\",\n    \"13-2\": \"The payment provider implementation indicated that the payment cannot be refunded in its current state.\",\n    \"14-0\": \"3014\",\n    \"14-1\": \"PAYMENT_NOT_COMPLETED\",\n    \"14-2\": \"The operation cannot be completed because the payment is not currently in a completed state.\",\n    \"15-0\": \"3015\",\n    \"15-1\": \"REFUND_AMT_EXCEEDED\",\n    \"15-2\": \"The total amount you have specified in your refund call is greater than the available balance to refund (total finalized amount - total refunds). Existing refunds which are in a pending state also count against the available balance.\",\n    \"16-0\": \"3016\",\n    \"16-1\": \"PAYMENT_ANULLED\",\n    \"16-2\": \"The operation cannot be completed because the payment is currently in an annulled state.\",\n    \"17-0\": \"3017\",\n    \"17-1\": \"ANULL_AMT_EXCEEDED\",\n    \"17-2\": \"The total amount you have specified in your annul call is greater than the available balance to annul.  Existing annulments and finalizations which are in a pending state also count against the available balance.\",\n    \"18-0\": \"3018\",\n    \"18-1\": \"CANNOT_ANULL_AUTHORIZATION\",\n    \"18-2\": \"The payment provider implementation indicated that the authorization cannot be annulled in its current state.\",\n    \"19-0\": \"3019\",\n    \"19-1\": \"PAYMENT_NOT_AUTHORIZED\",\n    \"19-2\": \"The operation cannot be completed because no portion of the payment is currently in an authorized state.\",\n    \"20-0\": \"3020\",\n    \"20-1\": \"CANNOT_AUTHORIZE_PAYMENT\",\n    \"20-2\": \"The payment provider implementation indicated that the payment cannot be authorized based on the information provided.\",\n    \"21-0\": \"3021\",\n    \"21-1\": \"DUPLICATE_ORDER\",\n    \"21-2\": \"An authorized or completed order already exists within the last 60 minutes for this order number and total amount combination.\",\n    \"22-0\": \"3022\",\n    \"22-1\": \"PAYABLE_AMT_EXCEEDED\",\n    \"22-2\": \"The total amount specified in your request is greater than the remaining payable amount on the order.\"\n  },\n  \"cols\": 3,\n  \"rows\": 23\n}\n[/block]\n##Initialize Payment Errors\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"4000\",\n    \"0-1\": \"INVALID_INTERFACE_ID\",\n    \"0-2\": \"The specified interface id is invalid.\",\n    \"1-0\": \"4003\",\n    \"1-1\": \"INVALID_PMT_CHAN_FOR_IFACE\",\n    \"1-2\": \"Payment channel '...' is invalid for interface '...'.\",\n    \"2-0\": \"4004\",\n    \"2-1\": \"INVALID_PMT_MTD_FOR_IFACE\",\n    \"2-2\": \"Payment method '...' is invalid for interface '...'.\",\n    \"3-0\": \"4005\",\n    \"3-1\": \"INVALID_PMT_CHAN\",\n    \"3-2\": \"Payment channel '...' is invalid.\",\n    \"4-0\": \"4006\",\n    \"4-1\": \"INVALID_PMT_MTD_FOR_PMT_CHAN\",\n    \"4-2\": \"Payment method '...' is invalid for payment channel '...'.\",\n    \"5-0\": \"4007\",\n    \"5-1\": \"INVALID_CUST_LANGUAGE_CODE\",\n    \"5-2\": \"The specified customer language code is invalid.\",\n    \"6-0\": \"4008\",\n    \"6-1\": \"INVALID_PMT_MTD_ID\",\n    \"6-2\": \"Payment method '...' is invalid.\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n##Processing Errors\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"5000\",\n    \"0-1\": \"GENERAL_DECLINE\",\n    \"0-2\": \"The operation was declined by the bank or processor.\\n\\nSee the bottom of this page for detailed information about general declines.\",\n    \"1-0\": \"5001\",\n    \"1-1\": \"CARD_EXPIRED\",\n    \"1-2\": \"The specified card has expired.\",\n    \"2-0\": \"5002\",\n    \"2-1\": \"COULD_NOT_DETERMINE_PMT_MTD\",\n    \"2-2\": \"We could not determine the payment method to be used in this payment.\",\n    \"3-0\": \"5003\",\n    \"3-1\": \"COULD_NOT_DETERMINE_PMT_ROUTE\",\n    \"3-2\": \"No payment route could be found that meets the criteria of this transaction.\",\n    \"4-0\": \"5004\",\n    \"4-1\": \"COULD_NOT_DETERMINE_ADDR_PROVIDER\",\n    \"4-2\": \"Ensure address provider is configured.\",\n    \"5-0\": \"5005\",\n    \"5-1\": \"ADDR_LOOKUP_PROCESSOR\",\n    \"5-2\": \"Generic failure in processor for address lookup.\",\n    \"6-0\": \"5006\",\n    \"6-1\": \"NO_MATCH\",\n    \"6-2\": \"The operation yielded no result.\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n\n##Authentication Errors\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"6000\",\n    \"0-1\": \"CAN_NOT_INITIATE_AUTHENTICATION_SESSION\",\n    \"0-2\": \"An error occurred while attempting to initiate an authentication session.\",\n    \"1-0\": \"6001\",\n    \"1-1\": \"CAN_NOT_CHECK_AUTHENTICATION_SESSION\",\n    \"1-2\": \"An error occurred while checking an authentication session.\",\n    \"2-0\": \"6002\",\n    \"2-1\": \"CAN_NOT_GET_LIST_OF_AUTH_PROVIDERS\",\n    \"2-2\": \"An error occurred while retrieving the list of authentication providers.\",\n    \"3-0\": \"6003\",\n    \"3-1\": \"TOO_MANY_REQUESTS\",\n    \"3-2\": \"Checks for provider '...' was called with an interval of '...'ms which is lower than the allowed rate '...'ms.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n**General Declines** \n\nBelow is a list of all possible outcomes within the \"GENERAL_DECLINE\" error.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"AddressMismatch\",\n    \"0-1\": \"\\\"Provided address does not match the address on file for the customer.\\\"\",\n    \"1-0\": \"EmailMismatch\",\n    \"1-1\": \"\\\"Provided e-mail address does not match the e-mail address on file for the customer.\\\"\",\n    \"2-0\": \"CreditDeclined\",\n    \"2-1\": \"\\\"The customer was declined credit for this transaction.\\\"\",\n    \"3-0\": \"BillToAndShipToMismatch\",\n    \"3-1\": \"\\\"The billing and shipping addresses must match for this transaction.\\\"\",\n    \"4-0\": \"DuplicateTransaction\",\n    \"4-1\": \"\\\"The processor indicated that this is a duplicate transaction.\\\"\",\n    \"5-0\": \"InternalError\",\n    \"5-1\": \"\\\"The processor experienced an internal error.\\\"\",\n    \"6-0\": \"TaxCalculationDifference\",\n    \"6-1\": \"\\\"The processor indicated that there is a calculation mismatch in the received tax/VAT values for one or more order lines.\\\"\",\n    \"7-0\": \"GovernmentIdIsInvalid\",\n    \"7-1\": \"\\\"The processor indicated that the government id is invalid.\\\"\",\n    \"8-0\": \"OrderLineIdNotUnique\",\n    \"9-0\": \"OrderLineIdNotUniquePerOperation\",\n    \"10-0\": \"OperationDidNotResultInAnyUpdates\",\n    \"11-0\": \"DifferentLineItemIds\",\n    \"12-0\": \"CannotUpdateOrderInvoiceNotUpdatable\",\n    \"13-0\": \"OrderLineIdNotFound\",\n    \"14-0\": \"RefundAmountGreaterThanOrderTotal\",\n    \"8-1\": \"\\\"The processor indicated that the operation would result in a non-unique order line ID.\\\"\",\n    \"9-1\": \"\\\"Updating order lines requires unique line ID's per update operation type.\\\"\",\n    \"10-1\": \"\\\"The processor indicated that the operation would not result in any updates.\\\"\",\n    \"11-1\": \"\\\"Value should match value of nested LineItem.Id.\\\"\",\n    \"12-1\": \"\\\"The operation cannot be completed because the order has invoices in a non-updatable state.\\\"\",\n    \"13-1\": \"\\\"The processor indicated that the specified LineItem.Id does not exist.\\\"\",\n    \"14-1\": \"\\\"The processor indicated that the update would result in a refund amount greater than the order total.\\\"\",\n    \"h-0\": \"Error Code\",\n    \"h-1\": \"Error Message\"\n  },\n  \"cols\": 2,\n  \"rows\": 15\n}\n[/block]","createdAt":"2016-11-04T13:41:36.575Z","excerpt":"","isReference":true,"next":{"pages":[],"description":""},"parentDoc":null,"sync_unique":"","githubsync":"","link_external":false,"link_url":"","type":"basic","hidden":false,"order":4,"user":"5818a4ecb1e11c1900bf76c3","version":"54930e7c777ff221004a7e70","__v":1,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","auth":"required","params":[],"url":""},"category":"54cf74d2a082241900f05f8e","title":"Error Codes","updates":["59f32c95542706002481266b"],"childrenPages":[]}

Error Codes


Below is a list of possible error codes returned by Paynova's API. Please note that error codes may be added from time-to-time, so take care to ensure that your implementation can handle new/unexpected error codes. An operation that returns an error number other than `"0"` (SUCCESS or PENDING) should be considered a failed operation. [block:parameters] { "data": { "0-1": "SUCCESS", "0-0": "0", "0-2": "The operation was successful.", "h-0": "Error number", "h-1": "Status Code", "h-2": "Status Message", "1-0": "0", "1-1": "PENDING", "1-2": "The operation is pending.\n\n**Conditions:**\n> **Only applicable to mobile payments.**" }, "cols": 3, "rows": 2 } [/block] ##Service Errors [block:parameters] { "data": { "0-0": "-1", "0-1": "INTERNAL_ERROR", "0-2": "The specified operation could not be completed at this time; please try your request again later. If the problem persists, please contact Paynova's merchant support at merchantsupport@paynova.com.", "1-2": "", "1-0": "-2", "1-1": "VALIDATION_ERROR", "2-0": "-3", "2-1": "HTTP_###", "2-2": "Our API uses standard HTTP error codes to convey errors such as authentication errors. The status code will contain HTTP_ followed by the HTTP error number (e.g. HTTP_401) and the status message will contain information applicable to the type of error. If you receive this error, the HTTP status code will also be sent back in the HTTP response.", "h-0": "", "h-1": "", "h-2": "" }, "cols": 3, "rows": 3 } [/block] ##Account Errors [block:parameters] { "data": { "h-0": "", "h-1": "", "h-2": "", "0-0": "1000", "0-1": "MERCHANT_ACCT_READ_ONLY", "0-2": "The merchant account is currently read-only. This operation requires an active account.", "1-0": "1001", "1-1": "CUST_ACCT_NOT_ELIGIBLE", "1-2": "The customer's account is currently not eligible to make payments.", "2-0": "1002" }, "cols": 3, "rows": 3 } [/block] ##Profile Errors [block:parameters] { "data": { "0-0": "2000", "0-1": "CUST_PROF_NOT_FOUND", "0-2": "The specified customer profile was not found.", "1-0": "2001", "1-1": "CUST_CARD_NOT_FOUND", "1-2": "The specified profile card was not found in the customer's profile." }, "cols": 3, "rows": 2 } [/block] ##Order & Payment Errors [block:parameters] { "data": { "0-0": "3000", "0-1": "ORDER_NOT_FOUND", "0-2": "The specified order was not found.", "1-0": "3001", "1-1": "LINE_ITEMS_NOT_ALLOWED", "1-2": "You are not allowed to specify line items for this request because no line items were specified in the original order (simple order).", "2-0": "3002", "2-1": "FINALIZE_AMT_EXCEEDED", "2-2": "The total amount you have specified in your finalize call is greater than the available balance to finalize. Existing annulments and finalizations which are in a pending state also count against the available balance.", "3-0": "3003", "3-1": "LINE_ITEMS_REQUIRED", "3-2": "This operation requires that line items be specified for detailed orders when the total amount specified does not equal the original order total amount.", "4-0": "3004", "4-1": "ORDER_ANNULLED", "4-2": "The operation cannot be completed because the order is currently in an annulled state.", "5-0": "3005", "5-1": "ORDER_COMPLETED", "5-2": "The operation cannot be completed because the order is currently in a completed state.", "6-0": "3006", "6-1": "PAYMENT_NOT_FOUND", "6-2": "The specified payment could not be found for the given order.", "7-0": "3007", "7-1": "PAYMENT_COMPLETED", "7-2": "The operation cannot be completed because the payment is currently in a completed state.", "8-0": "3008", "8-1": "PAYMENT_CANCELLED", "8-2": "The operation cannot be completed because the payment is currently in a cancelled state.", "9-0": "3009", "9-1": "INVALID_CURRENCY", "9-2": "The specified currency is invalid.", "10-0": "3010", "10-1": "INVALID_BILL_TO_COUNTRY", "10-2": "The specified bill-to country is invalid", "11-0": "3011", "11-1": "INVALID_SHIP_TO_COUNTRY", "11-2": "The specified ship-to country is invalid.", "12-0": "3012", "12-1": "CANNOT_FINALIZE_PAYMENT", "12-2": "The payment provider implementation indicated that the payment cannot be finalized in its current state.", "13-0": "3013", "13-1": "CANNOT_REFUND_PAYMENT", "13-2": "The payment provider implementation indicated that the payment cannot be refunded in its current state.", "14-0": "3014", "14-1": "PAYMENT_NOT_COMPLETED", "14-2": "The operation cannot be completed because the payment is not currently in a completed state.", "15-0": "3015", "15-1": "REFUND_AMT_EXCEEDED", "15-2": "The total amount you have specified in your refund call is greater than the available balance to refund (total finalized amount - total refunds). Existing refunds which are in a pending state also count against the available balance.", "16-0": "3016", "16-1": "PAYMENT_ANULLED", "16-2": "The operation cannot be completed because the payment is currently in an annulled state.", "17-0": "3017", "17-1": "ANULL_AMT_EXCEEDED", "17-2": "The total amount you have specified in your annul call is greater than the available balance to annul. Existing annulments and finalizations which are in a pending state also count against the available balance.", "18-0": "3018", "18-1": "CANNOT_ANULL_AUTHORIZATION", "18-2": "The payment provider implementation indicated that the authorization cannot be annulled in its current state.", "19-0": "3019", "19-1": "PAYMENT_NOT_AUTHORIZED", "19-2": "The operation cannot be completed because no portion of the payment is currently in an authorized state.", "20-0": "3020", "20-1": "CANNOT_AUTHORIZE_PAYMENT", "20-2": "The payment provider implementation indicated that the payment cannot be authorized based on the information provided.", "21-0": "3021", "21-1": "DUPLICATE_ORDER", "21-2": "An authorized or completed order already exists within the last 60 minutes for this order number and total amount combination.", "22-0": "3022", "22-1": "PAYABLE_AMT_EXCEEDED", "22-2": "The total amount specified in your request is greater than the remaining payable amount on the order." }, "cols": 3, "rows": 23 } [/block] ##Initialize Payment Errors [block:parameters] { "data": { "0-0": "4000", "0-1": "INVALID_INTERFACE_ID", "0-2": "The specified interface id is invalid.", "1-0": "4003", "1-1": "INVALID_PMT_CHAN_FOR_IFACE", "1-2": "Payment channel '...' is invalid for interface '...'.", "2-0": "4004", "2-1": "INVALID_PMT_MTD_FOR_IFACE", "2-2": "Payment method '...' is invalid for interface '...'.", "3-0": "4005", "3-1": "INVALID_PMT_CHAN", "3-2": "Payment channel '...' is invalid.", "4-0": "4006", "4-1": "INVALID_PMT_MTD_FOR_PMT_CHAN", "4-2": "Payment method '...' is invalid for payment channel '...'.", "5-0": "4007", "5-1": "INVALID_CUST_LANGUAGE_CODE", "5-2": "The specified customer language code is invalid.", "6-0": "4008", "6-1": "INVALID_PMT_MTD_ID", "6-2": "Payment method '...' is invalid." }, "cols": 3, "rows": 7 } [/block] ##Processing Errors [block:parameters] { "data": { "0-0": "5000", "0-1": "GENERAL_DECLINE", "0-2": "The operation was declined by the bank or processor.\n\nSee the bottom of this page for detailed information about general declines.", "1-0": "5001", "1-1": "CARD_EXPIRED", "1-2": "The specified card has expired.", "2-0": "5002", "2-1": "COULD_NOT_DETERMINE_PMT_MTD", "2-2": "We could not determine the payment method to be used in this payment.", "3-0": "5003", "3-1": "COULD_NOT_DETERMINE_PMT_ROUTE", "3-2": "No payment route could be found that meets the criteria of this transaction.", "4-0": "5004", "4-1": "COULD_NOT_DETERMINE_ADDR_PROVIDER", "4-2": "Ensure address provider is configured.", "5-0": "5005", "5-1": "ADDR_LOOKUP_PROCESSOR", "5-2": "Generic failure in processor for address lookup.", "6-0": "5006", "6-1": "NO_MATCH", "6-2": "The operation yielded no result." }, "cols": 3, "rows": 7 } [/block] ##Authentication Errors [block:parameters] { "data": { "0-0": "6000", "0-1": "CAN_NOT_INITIATE_AUTHENTICATION_SESSION", "0-2": "An error occurred while attempting to initiate an authentication session.", "1-0": "6001", "1-1": "CAN_NOT_CHECK_AUTHENTICATION_SESSION", "1-2": "An error occurred while checking an authentication session.", "2-0": "6002", "2-1": "CAN_NOT_GET_LIST_OF_AUTH_PROVIDERS", "2-2": "An error occurred while retrieving the list of authentication providers.", "3-0": "6003", "3-1": "TOO_MANY_REQUESTS", "3-2": "Checks for provider '...' was called with an interval of '...'ms which is lower than the allowed rate '...'ms." }, "cols": 3, "rows": 4 } [/block] **General Declines** Below is a list of all possible outcomes within the "GENERAL_DECLINE" error. [block:parameters] { "data": { "0-0": "AddressMismatch", "0-1": "\"Provided address does not match the address on file for the customer.\"", "1-0": "EmailMismatch", "1-1": "\"Provided e-mail address does not match the e-mail address on file for the customer.\"", "2-0": "CreditDeclined", "2-1": "\"The customer was declined credit for this transaction.\"", "3-0": "BillToAndShipToMismatch", "3-1": "\"The billing and shipping addresses must match for this transaction.\"", "4-0": "DuplicateTransaction", "4-1": "\"The processor indicated that this is a duplicate transaction.\"", "5-0": "InternalError", "5-1": "\"The processor experienced an internal error.\"", "6-0": "TaxCalculationDifference", "6-1": "\"The processor indicated that there is a calculation mismatch in the received tax/VAT values for one or more order lines.\"", "7-0": "GovernmentIdIsInvalid", "7-1": "\"The processor indicated that the government id is invalid.\"", "8-0": "OrderLineIdNotUnique", "9-0": "OrderLineIdNotUniquePerOperation", "10-0": "OperationDidNotResultInAnyUpdates", "11-0": "DifferentLineItemIds", "12-0": "CannotUpdateOrderInvoiceNotUpdatable", "13-0": "OrderLineIdNotFound", "14-0": "RefundAmountGreaterThanOrderTotal", "8-1": "\"The processor indicated that the operation would result in a non-unique order line ID.\"", "9-1": "\"Updating order lines requires unique line ID's per update operation type.\"", "10-1": "\"The processor indicated that the operation would not result in any updates.\"", "11-1": "\"Value should match value of nested LineItem.Id.\"", "12-1": "\"The operation cannot be completed because the order has invoices in a non-updatable state.\"", "13-1": "\"The processor indicated that the specified LineItem.Id does not exist.\"", "14-1": "\"The processor indicated that the update would result in a refund amount greater than the order total.\"", "h-0": "Error Code", "h-1": "Error Message" }, "cols": 2, "rows": 15 } [/block]
Below is a list of possible error codes returned by Paynova's API. Please note that error codes may be added from time-to-time, so take care to ensure that your implementation can handle new/unexpected error codes. An operation that returns an error number other than `"0"` (SUCCESS or PENDING) should be considered a failed operation. [block:parameters] { "data": { "0-1": "SUCCESS", "0-0": "0", "0-2": "The operation was successful.", "h-0": "Error number", "h-1": "Status Code", "h-2": "Status Message", "1-0": "0", "1-1": "PENDING", "1-2": "The operation is pending.\n\n**Conditions:**\n> **Only applicable to mobile payments.**" }, "cols": 3, "rows": 2 } [/block] ##Service Errors [block:parameters] { "data": { "0-0": "-1", "0-1": "INTERNAL_ERROR", "0-2": "The specified operation could not be completed at this time; please try your request again later. If the problem persists, please contact Paynova's merchant support at merchantsupport@paynova.com.", "1-2": "", "1-0": "-2", "1-1": "VALIDATION_ERROR", "2-0": "-3", "2-1": "HTTP_###", "2-2": "Our API uses standard HTTP error codes to convey errors such as authentication errors. The status code will contain HTTP_ followed by the HTTP error number (e.g. HTTP_401) and the status message will contain information applicable to the type of error. If you receive this error, the HTTP status code will also be sent back in the HTTP response.", "h-0": "", "h-1": "", "h-2": "" }, "cols": 3, "rows": 3 } [/block] ##Account Errors [block:parameters] { "data": { "h-0": "", "h-1": "", "h-2": "", "0-0": "1000", "0-1": "MERCHANT_ACCT_READ_ONLY", "0-2": "The merchant account is currently read-only. This operation requires an active account.", "1-0": "1001", "1-1": "CUST_ACCT_NOT_ELIGIBLE", "1-2": "The customer's account is currently not eligible to make payments.", "2-0": "1002" }, "cols": 3, "rows": 3 } [/block] ##Profile Errors [block:parameters] { "data": { "0-0": "2000", "0-1": "CUST_PROF_NOT_FOUND", "0-2": "The specified customer profile was not found.", "1-0": "2001", "1-1": "CUST_CARD_NOT_FOUND", "1-2": "The specified profile card was not found in the customer's profile." }, "cols": 3, "rows": 2 } [/block] ##Order & Payment Errors [block:parameters] { "data": { "0-0": "3000", "0-1": "ORDER_NOT_FOUND", "0-2": "The specified order was not found.", "1-0": "3001", "1-1": "LINE_ITEMS_NOT_ALLOWED", "1-2": "You are not allowed to specify line items for this request because no line items were specified in the original order (simple order).", "2-0": "3002", "2-1": "FINALIZE_AMT_EXCEEDED", "2-2": "The total amount you have specified in your finalize call is greater than the available balance to finalize. Existing annulments and finalizations which are in a pending state also count against the available balance.", "3-0": "3003", "3-1": "LINE_ITEMS_REQUIRED", "3-2": "This operation requires that line items be specified for detailed orders when the total amount specified does not equal the original order total amount.", "4-0": "3004", "4-1": "ORDER_ANNULLED", "4-2": "The operation cannot be completed because the order is currently in an annulled state.", "5-0": "3005", "5-1": "ORDER_COMPLETED", "5-2": "The operation cannot be completed because the order is currently in a completed state.", "6-0": "3006", "6-1": "PAYMENT_NOT_FOUND", "6-2": "The specified payment could not be found for the given order.", "7-0": "3007", "7-1": "PAYMENT_COMPLETED", "7-2": "The operation cannot be completed because the payment is currently in a completed state.", "8-0": "3008", "8-1": "PAYMENT_CANCELLED", "8-2": "The operation cannot be completed because the payment is currently in a cancelled state.", "9-0": "3009", "9-1": "INVALID_CURRENCY", "9-2": "The specified currency is invalid.", "10-0": "3010", "10-1": "INVALID_BILL_TO_COUNTRY", "10-2": "The specified bill-to country is invalid", "11-0": "3011", "11-1": "INVALID_SHIP_TO_COUNTRY", "11-2": "The specified ship-to country is invalid.", "12-0": "3012", "12-1": "CANNOT_FINALIZE_PAYMENT", "12-2": "The payment provider implementation indicated that the payment cannot be finalized in its current state.", "13-0": "3013", "13-1": "CANNOT_REFUND_PAYMENT", "13-2": "The payment provider implementation indicated that the payment cannot be refunded in its current state.", "14-0": "3014", "14-1": "PAYMENT_NOT_COMPLETED", "14-2": "The operation cannot be completed because the payment is not currently in a completed state.", "15-0": "3015", "15-1": "REFUND_AMT_EXCEEDED", "15-2": "The total amount you have specified in your refund call is greater than the available balance to refund (total finalized amount - total refunds). Existing refunds which are in a pending state also count against the available balance.", "16-0": "3016", "16-1": "PAYMENT_ANULLED", "16-2": "The operation cannot be completed because the payment is currently in an annulled state.", "17-0": "3017", "17-1": "ANULL_AMT_EXCEEDED", "17-2": "The total amount you have specified in your annul call is greater than the available balance to annul. Existing annulments and finalizations which are in a pending state also count against the available balance.", "18-0": "3018", "18-1": "CANNOT_ANULL_AUTHORIZATION", "18-2": "The payment provider implementation indicated that the authorization cannot be annulled in its current state.", "19-0": "3019", "19-1": "PAYMENT_NOT_AUTHORIZED", "19-2": "The operation cannot be completed because no portion of the payment is currently in an authorized state.", "20-0": "3020", "20-1": "CANNOT_AUTHORIZE_PAYMENT", "20-2": "The payment provider implementation indicated that the payment cannot be authorized based on the information provided.", "21-0": "3021", "21-1": "DUPLICATE_ORDER", "21-2": "An authorized or completed order already exists within the last 60 minutes for this order number and total amount combination.", "22-0": "3022", "22-1": "PAYABLE_AMT_EXCEEDED", "22-2": "The total amount specified in your request is greater than the remaining payable amount on the order." }, "cols": 3, "rows": 23 } [/block] ##Initialize Payment Errors [block:parameters] { "data": { "0-0": "4000", "0-1": "INVALID_INTERFACE_ID", "0-2": "The specified interface id is invalid.", "1-0": "4003", "1-1": "INVALID_PMT_CHAN_FOR_IFACE", "1-2": "Payment channel '...' is invalid for interface '...'.", "2-0": "4004", "2-1": "INVALID_PMT_MTD_FOR_IFACE", "2-2": "Payment method '...' is invalid for interface '...'.", "3-0": "4005", "3-1": "INVALID_PMT_CHAN", "3-2": "Payment channel '...' is invalid.", "4-0": "4006", "4-1": "INVALID_PMT_MTD_FOR_PMT_CHAN", "4-2": "Payment method '...' is invalid for payment channel '...'.", "5-0": "4007", "5-1": "INVALID_CUST_LANGUAGE_CODE", "5-2": "The specified customer language code is invalid.", "6-0": "4008", "6-1": "INVALID_PMT_MTD_ID", "6-2": "Payment method '...' is invalid." }, "cols": 3, "rows": 7 } [/block] ##Processing Errors [block:parameters] { "data": { "0-0": "5000", "0-1": "GENERAL_DECLINE", "0-2": "The operation was declined by the bank or processor.\n\nSee the bottom of this page for detailed information about general declines.", "1-0": "5001", "1-1": "CARD_EXPIRED", "1-2": "The specified card has expired.", "2-0": "5002", "2-1": "COULD_NOT_DETERMINE_PMT_MTD", "2-2": "We could not determine the payment method to be used in this payment.", "3-0": "5003", "3-1": "COULD_NOT_DETERMINE_PMT_ROUTE", "3-2": "No payment route could be found that meets the criteria of this transaction.", "4-0": "5004", "4-1": "COULD_NOT_DETERMINE_ADDR_PROVIDER", "4-2": "Ensure address provider is configured.", "5-0": "5005", "5-1": "ADDR_LOOKUP_PROCESSOR", "5-2": "Generic failure in processor for address lookup.", "6-0": "5006", "6-1": "NO_MATCH", "6-2": "The operation yielded no result." }, "cols": 3, "rows": 7 } [/block] ##Authentication Errors [block:parameters] { "data": { "0-0": "6000", "0-1": "CAN_NOT_INITIATE_AUTHENTICATION_SESSION", "0-2": "An error occurred while attempting to initiate an authentication session.", "1-0": "6001", "1-1": "CAN_NOT_CHECK_AUTHENTICATION_SESSION", "1-2": "An error occurred while checking an authentication session.", "2-0": "6002", "2-1": "CAN_NOT_GET_LIST_OF_AUTH_PROVIDERS", "2-2": "An error occurred while retrieving the list of authentication providers.", "3-0": "6003", "3-1": "TOO_MANY_REQUESTS", "3-2": "Checks for provider '...' was called with an interval of '...'ms which is lower than the allowed rate '...'ms." }, "cols": 3, "rows": 4 } [/block] **General Declines** Below is a list of all possible outcomes within the "GENERAL_DECLINE" error. [block:parameters] { "data": { "0-0": "AddressMismatch", "0-1": "\"Provided address does not match the address on file for the customer.\"", "1-0": "EmailMismatch", "1-1": "\"Provided e-mail address does not match the e-mail address on file for the customer.\"", "2-0": "CreditDeclined", "2-1": "\"The customer was declined credit for this transaction.\"", "3-0": "BillToAndShipToMismatch", "3-1": "\"The billing and shipping addresses must match for this transaction.\"", "4-0": "DuplicateTransaction", "4-1": "\"The processor indicated that this is a duplicate transaction.\"", "5-0": "InternalError", "5-1": "\"The processor experienced an internal error.\"", "6-0": "TaxCalculationDifference", "6-1": "\"The processor indicated that there is a calculation mismatch in the received tax/VAT values for one or more order lines.\"", "7-0": "GovernmentIdIsInvalid", "7-1": "\"The processor indicated that the government id is invalid.\"", "8-0": "OrderLineIdNotUnique", "9-0": "OrderLineIdNotUniquePerOperation", "10-0": "OperationDidNotResultInAnyUpdates", "11-0": "DifferentLineItemIds", "12-0": "CannotUpdateOrderInvoiceNotUpdatable", "13-0": "OrderLineIdNotFound", "14-0": "RefundAmountGreaterThanOrderTotal", "8-1": "\"The processor indicated that the operation would result in a non-unique order line ID.\"", "9-1": "\"Updating order lines requires unique line ID's per update operation type.\"", "10-1": "\"The processor indicated that the operation would not result in any updates.\"", "11-1": "\"Value should match value of nested LineItem.Id.\"", "12-1": "\"The operation cannot be completed because the order has invoices in a non-updatable state.\"", "13-1": "\"The processor indicated that the specified LineItem.Id does not exist.\"", "14-1": "\"The processor indicated that the update would result in a refund amount greater than the order total.\"", "h-0": "Error Code", "h-1": "Error Message" }, "cols": 2, "rows": 15 } [/block]
{"_id":"54cf752ba082241900f05f8f","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"url":"","settings":""},"excerpt":"","slug":"payment-page-layouts","sync_unique":"","user":"5476eb1df3736008009e9ced","__v":3,"category":"54cf74d2a082241900f05f8e","createdAt":"2015-02-02T13:01:31.370Z","link_url":"","order":5,"project":"54930e7c777ff221004a7e6d","githubsync":"","hidden":false,"parentDoc":null,"type":"basic","body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Paynova_Responsive_2\",\n    \"2-0\": \"Paynova_Mobile_1\",\n    \"1-0\": \"Paynova_Fullpage_1\",\n    \"h-0\": \"Layout code\",\n    \"h-1\": \"Name\",\n    \"h-2\": \"Description\",\n    \"0-1\": \"Responsive\",\n    \"1-1\": \"Full page\",\n    \"2-1\": \"Mobile\",\n    \"2-2\": \"jQuery mobile layout for card payments\",\n    \"0-2\": \"Fully responsive layout for all devices\",\n    \"1-2\": \"Simple full page layout for devices with larger screens (desktop, laptop, tablet)\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","isReference":true,"link_external":false,"title":"Payment page layouts","updates":[],"version":"54930e7c777ff221004a7e70","next":{"description":"","pages":[]},"childrenPages":[]}

Payment page layouts


[block:parameters] { "data": { "0-0": "Paynova_Responsive_2", "2-0": "Paynova_Mobile_1", "1-0": "Paynova_Fullpage_1", "h-0": "Layout code", "h-1": "Name", "h-2": "Description", "0-1": "Responsive", "1-1": "Full page", "2-1": "Mobile", "2-2": "jQuery mobile layout for card payments", "0-2": "Fully responsive layout for all devices", "1-2": "Simple full page layout for devices with larger screens (desktop, laptop, tablet)" }, "cols": 3, "rows": 3 } [/block]
[block:parameters] { "data": { "0-0": "Paynova_Responsive_2", "2-0": "Paynova_Mobile_1", "1-0": "Paynova_Fullpage_1", "h-0": "Layout code", "h-1": "Name", "h-2": "Description", "0-1": "Responsive", "1-1": "Full page", "2-1": "Mobile", "2-2": "jQuery mobile layout for card payments", "0-2": "Fully responsive layout for all devices", "1-2": "Simple full page layout for devices with larger screens (desktop, laptop, tablet)" }, "cols": 3, "rows": 3 } [/block]
{"_id":"5511711b6fccf32500018c16","category":"54cf74d2a082241900f05f8e","version":"54930e7c777ff221004a7e70","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required"},"excerpt":"","githubsync":"","link_url":"","sync_unique":"","title":"POST-redirect","__v":5,"body":"When using a hosted payment page, Paynova will POST-redirect the customer back to your server upon completion of the payment session using one of the URLs provided in **Initialize Payment**.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"POST fields\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Data type & format\",\n    \"h-2\": \"Description\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"`ORDER_ID`\\n*required*\",\n    \"1-0\": \"`SESSION_ID`\\n*required*\",\n    \"0-1\": \"`guid`\",\n    \"1-1\": \"`guid`\",\n    \"0-3\": \"Paynova's unique id for the order.\",\n    \"1-3\": \"Paynova's unique id for the current payment session.\",\n    \"2-0\": \"`ORDER_NUMBER`\\n*required*\",\n    \"3-0\": \"`SESSION_STATUS`\\n*required*\",\n    \"4-0\": \"`SESSION_STATUS_ID`\\n*required*\",\n    \"5-0\": \"`CUSTOM_DATA_COUNT`\\n*required*\",\n    \"6-0\": \"`CUSTOM_DATA_#_KEY`\\n*required*\",\n    \"7-0\": \"`CUSTOM_DATA_#_VALUE`\\n*required*\",\n    \"8-0\": \"`CURRENCY_CODE`\\n*required*\",\n    \"9-0\": \"`PAYMENT_COUNT`\\n*required*\",\n    \"10-0\": \"`PAYMENT_#_STATUS`\\n*required*\",\n    \"11-0\": \"`PAYMENT_#_STATUS_ID`\\n*required*\",\n    \"12-0\": \"`PAYMENT_#_TRANSACTION_ID`\\n*required*\",\n    \"13-0\": \"`PAYMENT_#_AMOUNT`\\n*required*\",\n    \"14-0\": \"`PAYMENT_#_PAYMENT_METHOD_ID`\\n*required*\",\n    \"15-0\": \"`PAYMENT_#_PAYMENT_METHOD_NAME`\\n*required*\",\n    \"16-0\": \"`PAYMENT_#_ACQUIRER_ID`\\n*required*\",\n    \"17-0\": \"`PAYMENT_#_ACQUIRER_REFERENCE_ID`\\n***conditional***\",\n    \"18-0\": \"`PAYMENT_#_CARD_FIRST_FOUR`\\n***conditional***\",\n    \"19-0\": \"`PAYMENT_#_CARD_LAST_FOUR`\\n***conditional***\",\n    \"20-0\": \"`PAYMENT_#_TIMESTAMP`\\n*required*\",\n    \"0-2\": \"Paynova's unique identifier for the order.\",\n    \"1-2\": \"Paynova's unique identifier for the current payment session.\",\n    \"2-2\": \"Your order number.\",\n    \"3-2\": \"The current status of the payment session. \\n\\n**Possible values:**\\n\\n**0** -\\tNew\\t\\nThe payment session is new.\\n\\n**1** -\\tCompleted\\nAll payments have been completed beneath the session.\\n\\n**2** -\\tCancelled\\t\\nThe payment session has been cancelled.\\n\\n**3** - \\tExpired\\t\\nThe payment session has expired.\",\n    \"4-2\": \"Paynova's ID for the session status, according to the table above for SESSION_STATUS.\",\n    \"5-2\": \"The number of custom data fields present in the request.\",\n    \"6-2\": \"The key of the custom data field.\",\n    \"7-2\": \"The value of the custom data field.\",\n    \"8-2\": \"The currency code of the transactions taken place.\",\n    \"2-1\": \"`string`\",\n    \"3-1\": \"`string`\",\n    \"4-1\": \"`int`\",\n    \"5-1\": \"`int`\",\n    \"6-1\": \"`string`\",\n    \"7-1\": \"`string`\",\n    \"8-1\": \"`string (3)`\",\n    \"9-1\": \"`int`\",\n    \"10-1\": \"`string`\",\n    \"11-1\": \"`int`\",\n    \"12-1\": \"`long (18)`\",\n    \"13-1\": \"`decimal (#.##)`\",\n    \"14-1\": \"`int`\",\n    \"15-1\": \"`string`\",\n    \"16-1\": \"`int (4)`\",\n    \"17-1\": \"`string`\",\n    \"18-1\": \"`string (4)`\",\n    \"19-1\": \"`string (4)`\",\n    \"20-1\": \"`timestamp: YYYY-MM-DD HH:MM:SSZ`\",\n    \"9-2\": \"The number of payments present in the request.\",\n    \"10-2\": \"The current status of the payment. \\n\\n**Possible values:**\\n\\n\\n**0** -\\tPending\\t\\nThe payment is pending.\\n\\n**1** - \\tCompleted \\nThe payment has been fully paid.\\n\\n**2** - \\tCancelled\\nThe payment has been cancelled.\\n\\n**3** - \\tFailed\\nThe payment failed.\\n\\n**4** - \\tAuthorized\\t\\nThe payment is authorized (finalize or annul required).\\n\\n**5** - \\tPartiallyCompleted\\nThe payment is partially paid.\\n\\n**6** - \\tAnnulled\\nThe payment has been annulled.\",\n    \"11-2\": \"Paynova's ID for the payment status, according to the table above for PAYMENT_#_STATUS.\",\n    \"12-2\": \"Paynova's unique transaction id for the payment.\",\n    \"13-2\": \"The amount of the transaction, two decimal points, decimal point as separator. \\n**Example:** `123.45`\",\n    \"14-2\": \"Paynova's ID of the payment method that was used/attempted for this payment.\",\n    \"15-2\": \"The textual name of the payment method.\",\n    \"16-2\": \"Paynova's ID for the acquirer over which the transaction was processed.\",\n    \"17-2\": \"The transaction reference id that the customer should see on their statement. Note that not all payment methods will have a value here for all payment statuses.\",\n    \"18-2\": \"The first four digits of the card number.\\n\\n**Conditions:**\\n> Only applicable for card payments..\",\n    \"19-2\": \"The last four digits of the card number.\\n\\n**Conditions:**\\n> Only applicable for card payments.\",\n    \"20-2\": \"UTC timestamp of the time the payment was created.\",\n    \"2-3\": \"Your order number.\",\n    \"3-3\": \"The current status of the payment session. See [] page for possible values.\",\n    \"5-3\": \"The number of custom data fields present in the request.\",\n    \"6-3\": \"The key of the custom data field.\",\n    \"7-3\": \"The value of the custom data field.\",\n    \"8-3\": \"The currency code of the transactions taken place.\",\n    \"9-3\": \"The number of payments present in the request.\",\n    \"10-3\": \"The current status of the payment. See [] page for possible values.\",\n    \"12-3\": \"Paynova's unique transaction id for the payment.\",\n    \"13-3\": \"The amount of the transaction, two decimal points, decimal point as separator. Example: \\\"123.45\\\".\",\n    \"14-3\": \"Paynova's id of the payment method that was used/attempted for this payment.\",\n    \"15-3\": \"The textual name of the payment method.\",\n    \"16-3\": \"Paynova's id for the acquirer over which the transaction was processed.\",\n    \"17-3\": \"The transaction reference id that the customer should see on their statement. Note that not all payment methods will have a value here for all payment statuses.\",\n    \"18-3\": \"**Only applicable for card payments.** The first four digits of the card number.\",\n    \"19-3\": \"**Only applicable for card payments.** The first four digits of the card number.\",\n    \"20-3\": \"UTC timestamp of the time the payment was created.\"\n  },\n  \"cols\": 3,\n  \"rows\": 21\n}\n[/block]\n## DCC: Additional fields\n\nIf DCC (Dynamic Currency Conversion) is used, the following fields will also be sent.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`PAYMENT_#_DCC_AMOUNT`\\n*required*\",\n    \"1-0\": \"`PAYMENT_#_DCC_CURRENCY_CODE`\\n*required*\",\n    \"2-0\": \"`PAYMENT_#_DCC_EXCHANGE_RATE`\\n*required*\",\n    \"3-0\": \"`PAYMENT_#_DCC_EXCHANGE_RATE_SOURCE_NAME`\\n*required*\",\n    \"4-0\": \"`PAYMENT_#_DCC_EXCHANGE_RATE_SOURCE_TIME_STAMP`\\n*required*\",\n    \"5-0\": \"`PAYMENT_#_DCC_PROVIDER`\\n*required*\",\n    \"6-0\": \"`PAYMENT_#_DCC_COMMISSION_PERCENTAGE`\\n*required*\",\n    \"0-1\": \"`decimal`\",\n    \"1-1\": \"`string (3)`\",\n    \"2-1\": \"`decimal`\",\n    \"3-1\": \"`string`\",\n    \"4-1\": \"`timestamp: YYYY-MM-DD HH:MM:SSZ`\",\n    \"5-1\": \"`string`\",\n    \"6-1\": \"`decimal`\",\n    \"0-2\": \"The amount the customer paid in their home currency.\",\n    \"1-2\": \"The converted currency the customer paid in.\",\n    \"2-2\": \"The exchange rate at which the currency conversion took place.\",\n    \"3-2\": \"The source bank of the exchange rate.\",\n    \"4-2\": \"UTC timestamp of the time the exchange rate was sourced.\",\n    \"5-2\": \"The DCC provider name.\",\n    \"6-2\": \"The commission (markup) percentage of the currency conversion.\",\n    \"0-3\": \"The amount the customer paid in their home currency.\",\n    \"1-3\": \"The converted currency the customer paid in.\",\n    \"2-3\": \"The exchange rate at which the currency conversion took place.\",\n    \"3-3\": \"The source bank of the exchange rate.\",\n    \"4-3\": \"UTC timestamp of the time the exchange rate was sourced.\",\n    \"5-3\": \"The DCC provider name.\",\n    \"6-3\": \"The commission (markup) percentage of the currency conversion.\",\n    \"h-0\": \"Field Name\",\n    \"h-1\": \"Data Type : Format\",\n    \"h-2\": \"Description\",\n    \"h-3\": \"Description\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n## Calculating the DIGEST\n\nThe DIGEST is calculated from the parameters included in the POST like this:\nStart with this string:\nORDER_ID;SESSION_ID;ORDER_NUMBER;SESSION_STATUS;CURRENCY_CODE;\nand then for each payment (1…n) you append:\nPAYMENT_#_STATUS;PAYMENT_#_TRANSACTION_ID;PAYMENT_#_AMOUNT;\nThen append the secret key to the end.\nCalculate a SHA1 based on the UTF-8 encoded bytes of that string and convert it to upper case, then you should have the same digest.","hidden":false,"order":6,"parentDoc":null,"slug":"post-redirect","type":"basic","user":"5476eb1df3736008009e9ced","createdAt":"2015-03-24T14:13:47.641Z","isReference":false,"link_external":false,"next":{"pages":[],"description":""},"project":"54930e7c777ff221004a7e6d","updates":[],"childrenPages":[]}

POST-redirect


When using a hosted payment page, Paynova will POST-redirect the customer back to your server upon completion of the payment session using one of the URLs provided in **Initialize Payment**. [block:api-header] { "type": "basic", "title": "POST fields" } [/block] [block:parameters] { "data": { "h-0": "Field name", "h-1": "Data type & format", "h-2": "Description", "h-3": "Description", "0-0": "`ORDER_ID`\n*required*", "1-0": "`SESSION_ID`\n*required*", "0-1": "`guid`", "1-1": "`guid`", "0-3": "Paynova's unique id for the order.", "1-3": "Paynova's unique id for the current payment session.", "2-0": "`ORDER_NUMBER`\n*required*", "3-0": "`SESSION_STATUS`\n*required*", "4-0": "`SESSION_STATUS_ID`\n*required*", "5-0": "`CUSTOM_DATA_COUNT`\n*required*", "6-0": "`CUSTOM_DATA_#_KEY`\n*required*", "7-0": "`CUSTOM_DATA_#_VALUE`\n*required*", "8-0": "`CURRENCY_CODE`\n*required*", "9-0": "`PAYMENT_COUNT`\n*required*", "10-0": "`PAYMENT_#_STATUS`\n*required*", "11-0": "`PAYMENT_#_STATUS_ID`\n*required*", "12-0": "`PAYMENT_#_TRANSACTION_ID`\n*required*", "13-0": "`PAYMENT_#_AMOUNT`\n*required*", "14-0": "`PAYMENT_#_PAYMENT_METHOD_ID`\n*required*", "15-0": "`PAYMENT_#_PAYMENT_METHOD_NAME`\n*required*", "16-0": "`PAYMENT_#_ACQUIRER_ID`\n*required*", "17-0": "`PAYMENT_#_ACQUIRER_REFERENCE_ID`\n***conditional***", "18-0": "`PAYMENT_#_CARD_FIRST_FOUR`\n***conditional***", "19-0": "`PAYMENT_#_CARD_LAST_FOUR`\n***conditional***", "20-0": "`PAYMENT_#_TIMESTAMP`\n*required*", "0-2": "Paynova's unique identifier for the order.", "1-2": "Paynova's unique identifier for the current payment session.", "2-2": "Your order number.", "3-2": "The current status of the payment session. \n\n**Possible values:**\n\n**0** -\tNew\t\nThe payment session is new.\n\n**1** -\tCompleted\nAll payments have been completed beneath the session.\n\n**2** -\tCancelled\t\nThe payment session has been cancelled.\n\n**3** - \tExpired\t\nThe payment session has expired.", "4-2": "Paynova's ID for the session status, according to the table above for SESSION_STATUS.", "5-2": "The number of custom data fields present in the request.", "6-2": "The key of the custom data field.", "7-2": "The value of the custom data field.", "8-2": "The currency code of the transactions taken place.", "2-1": "`string`", "3-1": "`string`", "4-1": "`int`", "5-1": "`int`", "6-1": "`string`", "7-1": "`string`", "8-1": "`string (3)`", "9-1": "`int`", "10-1": "`string`", "11-1": "`int`", "12-1": "`long (18)`", "13-1": "`decimal (#.##)`", "14-1": "`int`", "15-1": "`string`", "16-1": "`int (4)`", "17-1": "`string`", "18-1": "`string (4)`", "19-1": "`string (4)`", "20-1": "`timestamp: YYYY-MM-DD HH:MM:SSZ`", "9-2": "The number of payments present in the request.", "10-2": "The current status of the payment. \n\n**Possible values:**\n\n\n**0** -\tPending\t\nThe payment is pending.\n\n**1** - \tCompleted \nThe payment has been fully paid.\n\n**2** - \tCancelled\nThe payment has been cancelled.\n\n**3** - \tFailed\nThe payment failed.\n\n**4** - \tAuthorized\t\nThe payment is authorized (finalize or annul required).\n\n**5** - \tPartiallyCompleted\nThe payment is partially paid.\n\n**6** - \tAnnulled\nThe payment has been annulled.", "11-2": "Paynova's ID for the payment status, according to the table above for PAYMENT_#_STATUS.", "12-2": "Paynova's unique transaction id for the payment.", "13-2": "The amount of the transaction, two decimal points, decimal point as separator. \n**Example:** `123.45`", "14-2": "Paynova's ID of the payment method that was used/attempted for this payment.", "15-2": "The textual name of the payment method.", "16-2": "Paynova's ID for the acquirer over which the transaction was processed.", "17-2": "The transaction reference id that the customer should see on their statement. Note that not all payment methods will have a value here for all payment statuses.", "18-2": "The first four digits of the card number.\n\n**Conditions:**\n> Only applicable for card payments..", "19-2": "The last four digits of the card number.\n\n**Conditions:**\n> Only applicable for card payments.", "20-2": "UTC timestamp of the time the payment was created.", "2-3": "Your order number.", "3-3": "The current status of the payment session. See [] page for possible values.", "5-3": "The number of custom data fields present in the request.", "6-3": "The key of the custom data field.", "7-3": "The value of the custom data field.", "8-3": "The currency code of the transactions taken place.", "9-3": "The number of payments present in the request.", "10-3": "The current status of the payment. See [] page for possible values.", "12-3": "Paynova's unique transaction id for the payment.", "13-3": "The amount of the transaction, two decimal points, decimal point as separator. Example: \"123.45\".", "14-3": "Paynova's id of the payment method that was used/attempted for this payment.", "15-3": "The textual name of the payment method.", "16-3": "Paynova's id for the acquirer over which the transaction was processed.", "17-3": "The transaction reference id that the customer should see on their statement. Note that not all payment methods will have a value here for all payment statuses.", "18-3": "**Only applicable for card payments.** The first four digits of the card number.", "19-3": "**Only applicable for card payments.** The first four digits of the card number.", "20-3": "UTC timestamp of the time the payment was created." }, "cols": 3, "rows": 21 } [/block] ## DCC: Additional fields If DCC (Dynamic Currency Conversion) is used, the following fields will also be sent. [block:parameters] { "data": { "0-0": "`PAYMENT_#_DCC_AMOUNT`\n*required*", "1-0": "`PAYMENT_#_DCC_CURRENCY_CODE`\n*required*", "2-0": "`PAYMENT_#_DCC_EXCHANGE_RATE`\n*required*", "3-0": "`PAYMENT_#_DCC_EXCHANGE_RATE_SOURCE_NAME`\n*required*", "4-0": "`PAYMENT_#_DCC_EXCHANGE_RATE_SOURCE_TIME_STAMP`\n*required*", "5-0": "`PAYMENT_#_DCC_PROVIDER`\n*required*", "6-0": "`PAYMENT_#_DCC_COMMISSION_PERCENTAGE`\n*required*", "0-1": "`decimal`", "1-1": "`string (3)`", "2-1": "`decimal`", "3-1": "`string`", "4-1": "`timestamp: YYYY-MM-DD HH:MM:SSZ`", "5-1": "`string`", "6-1": "`decimal`", "0-2": "The amount the customer paid in their home currency.", "1-2": "The converted currency the customer paid in.", "2-2": "The exchange rate at which the currency conversion took place.", "3-2": "The source bank of the exchange rate.", "4-2": "UTC timestamp of the time the exchange rate was sourced.", "5-2": "The DCC provider name.", "6-2": "The commission (markup) percentage of the currency conversion.", "0-3": "The amount the customer paid in their home currency.", "1-3": "The converted currency the customer paid in.", "2-3": "The exchange rate at which the currency conversion took place.", "3-3": "The source bank of the exchange rate.", "4-3": "UTC timestamp of the time the exchange rate was sourced.", "5-3": "The DCC provider name.", "6-3": "The commission (markup) percentage of the currency conversion.", "h-0": "Field Name", "h-1": "Data Type : Format", "h-2": "Description", "h-3": "Description" }, "cols": 3, "rows": 7 } [/block] ## Calculating the DIGEST The DIGEST is calculated from the parameters included in the POST like this: Start with this string: ORDER_ID;SESSION_ID;ORDER_NUMBER;SESSION_STATUS;CURRENCY_CODE; and then for each payment (1…n) you append: PAYMENT_#_STATUS;PAYMENT_#_TRANSACTION_ID;PAYMENT_#_AMOUNT; Then append the secret key to the end. Calculate a SHA1 based on the UTF-8 encoded bytes of that string and convert it to upper case, then you should have the same digest.
When using a hosted payment page, Paynova will POST-redirect the customer back to your server upon completion of the payment session using one of the URLs provided in **Initialize Payment**. [block:api-header] { "type": "basic", "title": "POST fields" } [/block] [block:parameters] { "data": { "h-0": "Field name", "h-1": "Data type & format", "h-2": "Description", "h-3": "Description", "0-0": "`ORDER_ID`\n*required*", "1-0": "`SESSION_ID`\n*required*", "0-1": "`guid`", "1-1": "`guid`", "0-3": "Paynova's unique id for the order.", "1-3": "Paynova's unique id for the current payment session.", "2-0": "`ORDER_NUMBER`\n*required*", "3-0": "`SESSION_STATUS`\n*required*", "4-0": "`SESSION_STATUS_ID`\n*required*", "5-0": "`CUSTOM_DATA_COUNT`\n*required*", "6-0": "`CUSTOM_DATA_#_KEY`\n*required*", "7-0": "`CUSTOM_DATA_#_VALUE`\n*required*", "8-0": "`CURRENCY_CODE`\n*required*", "9-0": "`PAYMENT_COUNT`\n*required*", "10-0": "`PAYMENT_#_STATUS`\n*required*", "11-0": "`PAYMENT_#_STATUS_ID`\n*required*", "12-0": "`PAYMENT_#_TRANSACTION_ID`\n*required*", "13-0": "`PAYMENT_#_AMOUNT`\n*required*", "14-0": "`PAYMENT_#_PAYMENT_METHOD_ID`\n*required*", "15-0": "`PAYMENT_#_PAYMENT_METHOD_NAME`\n*required*", "16-0": "`PAYMENT_#_ACQUIRER_ID`\n*required*", "17-0": "`PAYMENT_#_ACQUIRER_REFERENCE_ID`\n***conditional***", "18-0": "`PAYMENT_#_CARD_FIRST_FOUR`\n***conditional***", "19-0": "`PAYMENT_#_CARD_LAST_FOUR`\n***conditional***", "20-0": "`PAYMENT_#_TIMESTAMP`\n*required*", "0-2": "Paynova's unique identifier for the order.", "1-2": "Paynova's unique identifier for the current payment session.", "2-2": "Your order number.", "3-2": "The current status of the payment session. \n\n**Possible values:**\n\n**0** -\tNew\t\nThe payment session is new.\n\n**1** -\tCompleted\nAll payments have been completed beneath the session.\n\n**2** -\tCancelled\t\nThe payment session has been cancelled.\n\n**3** - \tExpired\t\nThe payment session has expired.", "4-2": "Paynova's ID for the session status, according to the table above for SESSION_STATUS.", "5-2": "The number of custom data fields present in the request.", "6-2": "The key of the custom data field.", "7-2": "The value of the custom data field.", "8-2": "The currency code of the transactions taken place.", "2-1": "`string`", "3-1": "`string`", "4-1": "`int`", "5-1": "`int`", "6-1": "`string`", "7-1": "`string`", "8-1": "`string (3)`", "9-1": "`int`", "10-1": "`string`", "11-1": "`int`", "12-1": "`long (18)`", "13-1": "`decimal (#.##)`", "14-1": "`int`", "15-1": "`string`", "16-1": "`int (4)`", "17-1": "`string`", "18-1": "`string (4)`", "19-1": "`string (4)`", "20-1": "`timestamp: YYYY-MM-DD HH:MM:SSZ`", "9-2": "The number of payments present in the request.", "10-2": "The current status of the payment. \n\n**Possible values:**\n\n\n**0** -\tPending\t\nThe payment is pending.\n\n**1** - \tCompleted \nThe payment has been fully paid.\n\n**2** - \tCancelled\nThe payment has been cancelled.\n\n**3** - \tFailed\nThe payment failed.\n\n**4** - \tAuthorized\t\nThe payment is authorized (finalize or annul required).\n\n**5** - \tPartiallyCompleted\nThe payment is partially paid.\n\n**6** - \tAnnulled\nThe payment has been annulled.", "11-2": "Paynova's ID for the payment status, according to the table above for PAYMENT_#_STATUS.", "12-2": "Paynova's unique transaction id for the payment.", "13-2": "The amount of the transaction, two decimal points, decimal point as separator. \n**Example:** `123.45`", "14-2": "Paynova's ID of the payment method that was used/attempted for this payment.", "15-2": "The textual name of the payment method.", "16-2": "Paynova's ID for the acquirer over which the transaction was processed.", "17-2": "The transaction reference id that the customer should see on their statement. Note that not all payment methods will have a value here for all payment statuses.", "18-2": "The first four digits of the card number.\n\n**Conditions:**\n> Only applicable for card payments..", "19-2": "The last four digits of the card number.\n\n**Conditions:**\n> Only applicable for card payments.", "20-2": "UTC timestamp of the time the payment was created.", "2-3": "Your order number.", "3-3": "The current status of the payment session. See [] page for possible values.", "5-3": "The number of custom data fields present in the request.", "6-3": "The key of the custom data field.", "7-3": "The value of the custom data field.", "8-3": "The currency code of the transactions taken place.", "9-3": "The number of payments present in the request.", "10-3": "The current status of the payment. See [] page for possible values.", "12-3": "Paynova's unique transaction id for the payment.", "13-3": "The amount of the transaction, two decimal points, decimal point as separator. Example: \"123.45\".", "14-3": "Paynova's id of the payment method that was used/attempted for this payment.", "15-3": "The textual name of the payment method.", "16-3": "Paynova's id for the acquirer over which the transaction was processed.", "17-3": "The transaction reference id that the customer should see on their statement. Note that not all payment methods will have a value here for all payment statuses.", "18-3": "**Only applicable for card payments.** The first four digits of the card number.", "19-3": "**Only applicable for card payments.** The first four digits of the card number.", "20-3": "UTC timestamp of the time the payment was created." }, "cols": 3, "rows": 21 } [/block] ## DCC: Additional fields If DCC (Dynamic Currency Conversion) is used, the following fields will also be sent. [block:parameters] { "data": { "0-0": "`PAYMENT_#_DCC_AMOUNT`\n*required*", "1-0": "`PAYMENT_#_DCC_CURRENCY_CODE`\n*required*", "2-0": "`PAYMENT_#_DCC_EXCHANGE_RATE`\n*required*", "3-0": "`PAYMENT_#_DCC_EXCHANGE_RATE_SOURCE_NAME`\n*required*", "4-0": "`PAYMENT_#_DCC_EXCHANGE_RATE_SOURCE_TIME_STAMP`\n*required*", "5-0": "`PAYMENT_#_DCC_PROVIDER`\n*required*", "6-0": "`PAYMENT_#_DCC_COMMISSION_PERCENTAGE`\n*required*", "0-1": "`decimal`", "1-1": "`string (3)`", "2-1": "`decimal`", "3-1": "`string`", "4-1": "`timestamp: YYYY-MM-DD HH:MM:SSZ`", "5-1": "`string`", "6-1": "`decimal`", "0-2": "The amount the customer paid in their home currency.", "1-2": "The converted currency the customer paid in.", "2-2": "The exchange rate at which the currency conversion took place.", "3-2": "The source bank of the exchange rate.", "4-2": "UTC timestamp of the time the exchange rate was sourced.", "5-2": "The DCC provider name.", "6-2": "The commission (markup) percentage of the currency conversion.", "0-3": "The amount the customer paid in their home currency.", "1-3": "The converted currency the customer paid in.", "2-3": "The exchange rate at which the currency conversion took place.", "3-3": "The source bank of the exchange rate.", "4-3": "UTC timestamp of the time the exchange rate was sourced.", "5-3": "The DCC provider name.", "6-3": "The commission (markup) percentage of the currency conversion.", "h-0": "Field Name", "h-1": "Data Type : Format", "h-2": "Description", "h-3": "Description" }, "cols": 3, "rows": 7 } [/block] ## Calculating the DIGEST The DIGEST is calculated from the parameters included in the POST like this: Start with this string: ORDER_ID;SESSION_ID;ORDER_NUMBER;SESSION_STATUS;CURRENCY_CODE; and then for each payment (1…n) you append: PAYMENT_#_STATUS;PAYMENT_#_TRANSACTION_ID;PAYMENT_#_AMOUNT; Then append the secret key to the end. Calculate a SHA1 based on the UTF-8 encoded bytes of that string and convert it to upper case, then you should have the same digest.
{"_id":"55561d2fea5e120d001884ac","category":"54cf74d2a082241900f05f8e","link_external":false,"link_url":"","updates":[],"user":"5476eb1df3736008009e9ced","__v":1,"api":{"url":"","auth":"required","params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"githubsync":"","project":"54930e7c777ff221004a7e6d","sync_unique":"","title":"Currency codes","createdAt":"2015-05-15T16:22:07.370Z","isReference":false,"order":7,"parentDoc":null,"type":"basic","version":"54930e7c777ff221004a7e70","body":"Paynova API uses currency codes in ISO 4217 format. Both alpha-3 and numerical codes are supported:\n\nThe following currency codes are currently supported by Paynova:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"ISO\",\n    \"h-1\": \"Alpha-3\",\n    \"h-2\": \"E*\",\n    \"h-3\": \"Name\",\n    \"0-0\": \"840\",\n    \"0-1\": \"USD\",\n    \"0-2\": \"2\",\n    \"0-3\": \"United States Dollar\",\n    \"1-2\": \"2\",\n    \"2-2\": \"2\",\n    \"3-2\": \"2\",\n    \"4-2\": \"2\",\n    \"5-2\": \"2\",\n    \"6-2\": \"2\",\n    \"1-1\": \"EUR\",\n    \"1-0\": \"978\",\n    \"1-3\": \"European Euro\",\n    \"2-0\": \"826\",\n    \"2-1\": \"GBP\",\n    \"2-3\": \"British Pound\",\n    \"3-0\": \"752\",\n    \"3-1\": \"SEK\",\n    \"3-3\": \"Swedish Krona\",\n    \"4-3\": \"Norwegian Krone\",\n    \"5-3\": \"Danish Krone\",\n    \"4-0\": \"578\",\n    \"4-1\": \"NOK\",\n    \"5-1\": \"DKK\",\n    \"5-0\": \"208\",\n    \"6-0\": \"756\",\n    \"6-1\": \"CHF\",\n    \"6-3\": \"Swiss Franc\",\n    \"7-3\": \"Australian Dollar\",\n    \"8-3\": \"New Zealand Dollar\",\n    \"9-3\": \"Hong Kong Dollar\",\n    \"7-2\": \"2\",\n    \"8-2\": \"2\",\n    \"9-2\": \"2\",\n    \"7-1\": \"AUD\",\n    \"8-1\": \"NZD\",\n    \"9-1\": \"HKD\",\n    \"7-0\": \"036\",\n    \"8-0\": \"554\",\n    \"9-0\": \"344\",\n    \"10-0\": \"702\",\n    \"10-1\": \"SGD\",\n    \"10-2\": \"2\",\n    \"10-3\": \"Singapore Dollar\",\n    \"11-0\": \"124\",\n    \"11-1\": \"CAD\",\n    \"11-2\": \"2\",\n    \"11-3\": \"Canadian Dollar\",\n    \"12-3\": \"Polish Zloty\",\n    \"13-3\": \"Turkish Lira\",\n    \"12-2\": \"2\",\n    \"13-2\": \"2\",\n    \"14-3\": \"Chinese Yuan\",\n    \"15-3\": \"Japanese Yen\",\n    \"14-2\": \"2\",\n    \"15-2\": \"0\",\n    \"16-3\": \"Israeli New Sheqel\",\n    \"16-2\": \"2\",\n    \"16-1\": \"ILS\",\n    \"15-1\": \"JPY\",\n    \"14-1\": \"CNY\",\n    \"13-1\": \"TRY\",\n    \"12-1\": \"PLN\",\n    \"12-0\": \"985\",\n    \"13-0\": \"949\",\n    \"14-0\": \"156\",\n    \"15-0\": \"392\",\n    \"16-0\": \"376\"\n  },\n  \"cols\": 4,\n  \"rows\": 17\n}\n[/block]\n*The number of digits after the decimal separator.","excerpt":"","hidden":false,"next":{"description":"","pages":[]},"slug":"currency-codes","childrenPages":[]}

Currency codes


Paynova API uses currency codes in ISO 4217 format. Both alpha-3 and numerical codes are supported: The following currency codes are currently supported by Paynova: [block:parameters] { "data": { "h-0": "ISO", "h-1": "Alpha-3", "h-2": "E*", "h-3": "Name", "0-0": "840", "0-1": "USD", "0-2": "2", "0-3": "United States Dollar", "1-2": "2", "2-2": "2", "3-2": "2", "4-2": "2", "5-2": "2", "6-2": "2", "1-1": "EUR", "1-0": "978", "1-3": "European Euro", "2-0": "826", "2-1": "GBP", "2-3": "British Pound", "3-0": "752", "3-1": "SEK", "3-3": "Swedish Krona", "4-3": "Norwegian Krone", "5-3": "Danish Krone", "4-0": "578", "4-1": "NOK", "5-1": "DKK", "5-0": "208", "6-0": "756", "6-1": "CHF", "6-3": "Swiss Franc", "7-3": "Australian Dollar", "8-3": "New Zealand Dollar", "9-3": "Hong Kong Dollar", "7-2": "2", "8-2": "2", "9-2": "2", "7-1": "AUD", "8-1": "NZD", "9-1": "HKD", "7-0": "036", "8-0": "554", "9-0": "344", "10-0": "702", "10-1": "SGD", "10-2": "2", "10-3": "Singapore Dollar", "11-0": "124", "11-1": "CAD", "11-2": "2", "11-3": "Canadian Dollar", "12-3": "Polish Zloty", "13-3": "Turkish Lira", "12-2": "2", "13-2": "2", "14-3": "Chinese Yuan", "15-3": "Japanese Yen", "14-2": "2", "15-2": "0", "16-3": "Israeli New Sheqel", "16-2": "2", "16-1": "ILS", "15-1": "JPY", "14-1": "CNY", "13-1": "TRY", "12-1": "PLN", "12-0": "985", "13-0": "949", "14-0": "156", "15-0": "392", "16-0": "376" }, "cols": 4, "rows": 17 } [/block] *The number of digits after the decimal separator.
Paynova API uses currency codes in ISO 4217 format. Both alpha-3 and numerical codes are supported: The following currency codes are currently supported by Paynova: [block:parameters] { "data": { "h-0": "ISO", "h-1": "Alpha-3", "h-2": "E*", "h-3": "Name", "0-0": "840", "0-1": "USD", "0-2": "2", "0-3": "United States Dollar", "1-2": "2", "2-2": "2", "3-2": "2", "4-2": "2", "5-2": "2", "6-2": "2", "1-1": "EUR", "1-0": "978", "1-3": "European Euro", "2-0": "826", "2-1": "GBP", "2-3": "British Pound", "3-0": "752", "3-1": "SEK", "3-3": "Swedish Krona", "4-3": "Norwegian Krone", "5-3": "Danish Krone", "4-0": "578", "4-1": "NOK", "5-1": "DKK", "5-0": "208", "6-0": "756", "6-1": "CHF", "6-3": "Swiss Franc", "7-3": "Australian Dollar", "8-3": "New Zealand Dollar", "9-3": "Hong Kong Dollar", "7-2": "2", "8-2": "2", "9-2": "2", "7-1": "AUD", "8-1": "NZD", "9-1": "HKD", "7-0": "036", "8-0": "554", "9-0": "344", "10-0": "702", "10-1": "SGD", "10-2": "2", "10-3": "Singapore Dollar", "11-0": "124", "11-1": "CAD", "11-2": "2", "11-3": "Canadian Dollar", "12-3": "Polish Zloty", "13-3": "Turkish Lira", "12-2": "2", "13-2": "2", "14-3": "Chinese Yuan", "15-3": "Japanese Yen", "14-2": "2", "15-2": "0", "16-3": "Israeli New Sheqel", "16-2": "2", "16-1": "ILS", "15-1": "JPY", "14-1": "CNY", "13-1": "TRY", "12-1": "PLN", "12-0": "985", "13-0": "949", "14-0": "156", "15-0": "392", "16-0": "376" }, "cols": 4, "rows": 17 } [/block] *The number of digits after the decimal separator.
{"_id":"54cf78259d09bb0d00a17ab4","link_url":"","slug":"customdata","type":"basic","githubsync":"","isReference":false,"link_external":false,"order":1,"parentDoc":null,"project":"54930e7c777ff221004a7e6d","excerpt":"","body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`key`\",\n    \"0-1\": \"`string`\",\n    \"1-0\": \"`value`\",\n    \"0-2\": \"The key identifying the value pair.\",\n    \"1-1\": \"`string`\",\n    \"1-2\": \"The value.\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","sync_unique":"","updates":[],"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","params":[]},"category":"54cf2964a9e1cf0d005c8a12","createdAt":"2015-02-02T13:14:13.046Z","hidden":false,"next":{"pages":[],"description":""},"title":"customData","user":"5476eb1df3736008009e9ced","__v":1,"version":"54930e7c777ff221004a7e70","childrenPages":[]}

customData


[block:parameters] { "data": { "0-0": "`key`", "0-1": "`string`", "1-0": "`value`", "0-2": "The key identifying the value pair.", "1-1": "`string`", "1-2": "The value.", "h-0": "Property", "h-1": "Type", "h-2": "Description" }, "cols": 3, "rows": 2 } [/block]
[block:parameters] { "data": { "0-0": "`key`", "0-1": "`string`", "1-0": "`value`", "0-2": "The key identifying the value pair.", "1-1": "`string`", "1-2": "The value.", "h-0": "Property", "h-1": "Type", "h-2": "Description" }, "cols": 3, "rows": 2 } [/block]
{"_id":"54cf29734acee20d001e5315","category":"54cf2964a9e1cf0d005c8a12","createdAt":"2015-02-02T07:38:27.020Z","excerpt":"","project":"54930e7c777ff221004a7e6d","slug":"customer","sync_unique":"","updates":[],"api":{"settings":"","url":"","auth":"required","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]}},"body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`customerId`\\n***conditional***\",\n    \"0-1\": \"`string`\",\n    \"2-0\": \"`emailAddress`\\n***conditional***\",\n    \"4-0\": \"`name`\",\n    \"5-0\": \"`homeTelephone`\",\n    \"6-0\": \"`workTelephone`\",\n    \"7-0\": \"`mobileTelephone`\",\n    \"5-1\": \"`string`\",\n    \"6-1\": \"`string`\",\n    \"7-1\": \"`string`\",\n    \"4-1\": \"[`nameAndAddress`:fa-external-link-square:](doc:nameandaddress)\",\n    \"2-1\": \"`string`\",\n    \"0-2\": \"Your unique identifier for the customer.\\n\\n**Conditions:**\\nRequired for certain payment methods, and if fraud screening is used.\\n\\n**Example:** `\\\"1\\\"`\",\n    \"2-2\": \"The customer's e-mail address.\\n\\n**Conditions:**\\nRequired for certain payment methods, and if fraud screening is used.\\n\\n**Example:** `\\\"fakturademo@paynova.com\\\"`\",\n    \"4-2\": \"The name of the customer and/or company.\\n\\n**Example:** `\\\"CHRISTOPHER WILLIAMS\\\"`\",\n    \"5-2\": \"The customer's home telephone number including the national prefix.\\n\\n**Example:**  `\\\"+46 8 555 55 55\\\"`\",\n    \"6-2\": \"The customer's work telephone number including the national prefix.\\n\\n**Example:**  `\\\"+46 8 555 55 55\\\"`\",\n    \"7-2\": \"The customer's mobile telephone number including the national prefix.\\n\\n **Example:** `\\\"+46 8 555 55 55\\\"`\",\n    \"8-0\": \"\",\n    \"8-1\": \"\",\n    \"8-2\": \"\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"1-0\": \"`governmentId`\\n***conditional***\",\n    \"1-1\": \"`string(12)`\",\n    \"1-2\": \"For Sweden: The customer's 12 digit personnummer, with or without a dash.\\n\\n**Conditions:**\\nRequired for invoice purchases.\\n\\n**Examples:** `\\\"198901157993\\\"`, `\\\"19890115-7993\\\"`\",\n    \"3-0\": \"`taxIdentificationNumber`\\n***conditional***\",\n    \"3-1\": \"`string(14)`\",\n    \"3-2\": \"The 14 character tax identification number for the company. \\n\\n**Conditions:**\\n> Required for B2B Invoice\\n\\n**Example:** `\\\"SE550123451205\\\"`\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]","parentDoc":null,"type":"basic","__v":1,"hidden":false,"isReference":true,"link_external":false,"version":"54930e7c777ff221004a7e70","githubsync":"","link_url":"","next":{"description":"","pages":[]},"order":2,"title":"customer","user":"5476eb1df3736008009e9ced","childrenPages":[]}

customer


[block:parameters] { "data": { "0-0": "`customerId`\n***conditional***", "0-1": "`string`", "2-0": "`emailAddress`\n***conditional***", "4-0": "`name`", "5-0": "`homeTelephone`", "6-0": "`workTelephone`", "7-0": "`mobileTelephone`", "5-1": "`string`", "6-1": "`string`", "7-1": "`string`", "4-1": "[`nameAndAddress`:fa-external-link-square:](doc:nameandaddress)", "2-1": "`string`", "0-2": "Your unique identifier for the customer.\n\n**Conditions:**\nRequired for certain payment methods, and if fraud screening is used.\n\n**Example:** `\"1\"`", "2-2": "The customer's e-mail address.\n\n**Conditions:**\nRequired for certain payment methods, and if fraud screening is used.\n\n**Example:** `\"fakturademo@paynova.com\"`", "4-2": "The name of the customer and/or company.\n\n**Example:** `\"CHRISTOPHER WILLIAMS\"`", "5-2": "The customer's home telephone number including the national prefix.\n\n**Example:** `\"+46 8 555 55 55\"`", "6-2": "The customer's work telephone number including the national prefix.\n\n**Example:** `\"+46 8 555 55 55\"`", "7-2": "The customer's mobile telephone number including the national prefix.\n\n **Example:** `\"+46 8 555 55 55\"`", "8-0": "", "8-1": "", "8-2": "", "h-0": "Property", "h-1": "Type", "h-2": "Description", "1-0": "`governmentId`\n***conditional***", "1-1": "`string(12)`", "1-2": "For Sweden: The customer's 12 digit personnummer, with or without a dash.\n\n**Conditions:**\nRequired for invoice purchases.\n\n**Examples:** `\"198901157993\"`, `\"19890115-7993\"`", "3-0": "`taxIdentificationNumber`\n***conditional***", "3-1": "`string(14)`", "3-2": "The 14 character tax identification number for the company. \n\n**Conditions:**\n> Required for B2B Invoice\n\n**Example:** `\"SE550123451205\"`" }, "cols": 3, "rows": 8 } [/block]
[block:parameters] { "data": { "0-0": "`customerId`\n***conditional***", "0-1": "`string`", "2-0": "`emailAddress`\n***conditional***", "4-0": "`name`", "5-0": "`homeTelephone`", "6-0": "`workTelephone`", "7-0": "`mobileTelephone`", "5-1": "`string`", "6-1": "`string`", "7-1": "`string`", "4-1": "[`nameAndAddress`:fa-external-link-square:](doc:nameandaddress)", "2-1": "`string`", "0-2": "Your unique identifier for the customer.\n\n**Conditions:**\nRequired for certain payment methods, and if fraud screening is used.\n\n**Example:** `\"1\"`", "2-2": "The customer's e-mail address.\n\n**Conditions:**\nRequired for certain payment methods, and if fraud screening is used.\n\n**Example:** `\"fakturademo@paynova.com\"`", "4-2": "The name of the customer and/or company.\n\n**Example:** `\"CHRISTOPHER WILLIAMS\"`", "5-2": "The customer's home telephone number including the national prefix.\n\n**Example:** `\"+46 8 555 55 55\"`", "6-2": "The customer's work telephone number including the national prefix.\n\n**Example:** `\"+46 8 555 55 55\"`", "7-2": "The customer's mobile telephone number including the national prefix.\n\n **Example:** `\"+46 8 555 55 55\"`", "8-0": "", "8-1": "", "8-2": "", "h-0": "Property", "h-1": "Type", "h-2": "Description", "1-0": "`governmentId`\n***conditional***", "1-1": "`string(12)`", "1-2": "For Sweden: The customer's 12 digit personnummer, with or without a dash.\n\n**Conditions:**\nRequired for invoice purchases.\n\n**Examples:** `\"198901157993\"`, `\"19890115-7993\"`", "3-0": "`taxIdentificationNumber`\n***conditional***", "3-1": "`string(14)`", "3-2": "The 14 character tax identification number for the company. \n\n**Conditions:**\n> Required for B2B Invoice\n\n**Example:** `\"SE550123451205\"`" }, "cols": 3, "rows": 8 } [/block]
{"_id":"54cf783b4acee20d001e53db","slug":"errors","body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`errorcode`\\n*required*\",\n    \"1-0\": \"`fieldName`\\n*required*\",\n    \"2-0\": \"`message`\\n*required*\",\n    \"0-1\": \"`string`\",\n    \"1-1\": \"`string`\",\n    \"2-1\": \"`string`\",\n    \"0-2\": \"A short textual representation of the type of error incurred. \\n\\n**Example:** `\\\"NotNull\\\"`, `\\\"GreaterThan\\\"`\",\n    \"1-2\": \"The name of the field/property for which the validation error was incurred.\\n\\n**Example:** `\\\"CurrencyCode\\\"`\",\n    \"2-2\": \"A detailed description of the validation error.\\n\\n**Example:** `\\\"message\\\": \\\"'Currency Code' must be between 2 and 3 characters. You entered 5 characters.\\\"`\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","isReference":false,"parentDoc":null,"updates":[],"__v":1,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","params":[]},"createdAt":"2015-02-02T13:14:35.509Z","order":3,"project":"54930e7c777ff221004a7e6d","title":"errors","user":"5476eb1df3736008009e9ced","version":"54930e7c777ff221004a7e70","category":"54cf2964a9e1cf0d005c8a12","githubsync":"","link_url":"","next":{"description":"","pages":[]},"sync_unique":"","type":"basic","excerpt":"","hidden":false,"link_external":false,"childrenPages":[]}

errors


[block:parameters] { "data": { "0-0": "`errorcode`\n*required*", "1-0": "`fieldName`\n*required*", "2-0": "`message`\n*required*", "0-1": "`string`", "1-1": "`string`", "2-1": "`string`", "0-2": "A short textual representation of the type of error incurred. \n\n**Example:** `\"NotNull\"`, `\"GreaterThan\"`", "1-2": "The name of the field/property for which the validation error was incurred.\n\n**Example:** `\"CurrencyCode\"`", "2-2": "A detailed description of the validation error.\n\n**Example:** `\"message\": \"'Currency Code' must be between 2 and 3 characters. You entered 5 characters.\"`", "h-0": "Property", "h-1": "Type", "h-2": "Description" }, "cols": 3, "rows": 3 } [/block]
[block:parameters] { "data": { "0-0": "`errorcode`\n*required*", "1-0": "`fieldName`\n*required*", "2-0": "`message`\n*required*", "0-1": "`string`", "1-1": "`string`", "2-1": "`string`", "0-2": "A short textual representation of the type of error incurred. \n\n**Example:** `\"NotNull\"`, `\"GreaterThan\"`", "1-2": "The name of the field/property for which the validation error was incurred.\n\n**Example:** `\"CurrencyCode\"`", "2-2": "A detailed description of the validation error.\n\n**Example:** `\"message\": \"'Currency Code' must be between 2 and 3 characters. You entered 5 characters.\"`", "h-0": "Property", "h-1": "Type", "h-2": "Description" }, "cols": 3, "rows": 3 } [/block]
{"_id":"54cf784c9d09bb0d00a17ab7","type":"basic","body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`interfaceId`\\n*required*\",\n    \"0-1\": \"`int`\",\n    \"1-0\": \"`displayLineItems`\",\n    \"1-1\": \"`boolean`\",\n    \"2-0\": \"`themeName`\",\n    \"2-1\": \"`string`\",\n    \"3-0\": \"`layoutName`\",\n    \"3-1\": \"`string`\",\n    \"4-0\": \"`customerLanguageCode`\\n*required*\",\n    \"4-1\": \"`string(3)`\",\n    \"5-0\": \"`urlRedirectSuccess`\\n*required*\",\n    \"5-1\": \"`string`\",\n    \"6-0\": \"`urlRedirectCancel`\\n*required*\",\n    \"6-1\": \"`string`\",\n    \"7-0\": \"`urlRedirectPending`\\n*required*\",\n    \"7-1\": \"`string`\",\n    \"8-0\": \"`urlCallback`\",\n    \"8-1\": \"`string`\",\n    \"0-2\": \"The ID of the web interface to use.\\n\\n**Constraints:**\\n> Currently, the only value accepted is 5 for our Aero interface.\\n\\n**Example:** `5`\",\n    \"1-2\": \"Indicates whether or not order line-items should be displayed to the customer. \\n\\n**Constraints:**\\n> The default for this parameter is `true` if you send line items and `false` if you do not send line items.\\n\\n**Examples:** `true`, `false`\",\n    \"2-2\": \"The name of your custom hosted theme at Paynova.\\n \\n> this field only applies to merchants who have setup a custom theme with us and specifying an invalid value will result in your payment page not rendering properly.\",\n    \"3-2\": \"The name of the layout to use. \\n\\nSee [Payment page layouts](doc:payment-page-layouts) for available layouts.\",\n    \"4-2\": \"The three-letter language code identifying the language that the payment interface should be displayed to the customer in.\\n\\n**Example:** `\\\"SWE\\\"`\",\n    \"5-2\": \"The URL on your website to which we should redirect the customer upon successful payment.\\n\\n**Example:** `\\\"http://myshop.com/success\\\"`\",\n    \"6-2\": \"The URL on your website to which we should redirect the customer upon the customer cancelling payment or running out of payment attempts.\\n\\n**Example:** `\\\"http://myshop.com/cancel\\\"`\",\n    \"7-2\": \"The URL on your website to which we should redirect the customer upon a payment being in either an indeterminable or pending state. Payment methods which are not \\\"real-time\\\" (for example, Laschrift/ELV, Überweisung) use this status.\\n\\n**Example:** `\\\"http://myshop.com/pending\\\"`\",\n    \"8-2\": \"A URL to your system which we can send Event Hook Notifications (EHNs) to. If this parameter is provided, it will be used instead of any statically configured EHN URLs.\\n\\n**Example:** `\\\"http://requestb.in/osdj3jos\\\"`\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]","category":"54cf2964a9e1cf0d005c8a12","createdAt":"2015-02-02T13:14:52.308Z","githubsync":"","hidden":false,"next":{"description":"","pages":[]},"slug":"interfaceoptions","updates":[],"version":"54930e7c777ff221004a7e70","__v":1,"isReference":true,"sync_unique":"","title":"interfaceOptions","excerpt":"","parentDoc":null,"project":"54930e7c777ff221004a7e6d","api":{"auth":"required","params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":""},"link_external":false,"link_url":"","order":4,"user":"5476eb1df3736008009e9ced","childrenPages":[]}

interfaceOptions


[block:parameters] { "data": { "0-0": "`interfaceId`\n*required*", "0-1": "`int`", "1-0": "`displayLineItems`", "1-1": "`boolean`", "2-0": "`themeName`", "2-1": "`string`", "3-0": "`layoutName`", "3-1": "`string`", "4-0": "`customerLanguageCode`\n*required*", "4-1": "`string(3)`", "5-0": "`urlRedirectSuccess`\n*required*", "5-1": "`string`", "6-0": "`urlRedirectCancel`\n*required*", "6-1": "`string`", "7-0": "`urlRedirectPending`\n*required*", "7-1": "`string`", "8-0": "`urlCallback`", "8-1": "`string`", "0-2": "The ID of the web interface to use.\n\n**Constraints:**\n> Currently, the only value accepted is 5 for our Aero interface.\n\n**Example:** `5`", "1-2": "Indicates whether or not order line-items should be displayed to the customer. \n\n**Constraints:**\n> The default for this parameter is `true` if you send line items and `false` if you do not send line items.\n\n**Examples:** `true`, `false`", "2-2": "The name of your custom hosted theme at Paynova.\n \n> this field only applies to merchants who have setup a custom theme with us and specifying an invalid value will result in your payment page not rendering properly.", "3-2": "The name of the layout to use. \n\nSee [Payment page layouts](doc:payment-page-layouts) for available layouts.", "4-2": "The three-letter language code identifying the language that the payment interface should be displayed to the customer in.\n\n**Example:** `\"SWE\"`", "5-2": "The URL on your website to which we should redirect the customer upon successful payment.\n\n**Example:** `\"http://myshop.com/success\"`", "6-2": "The URL on your website to which we should redirect the customer upon the customer cancelling payment or running out of payment attempts.\n\n**Example:** `\"http://myshop.com/cancel\"`", "7-2": "The URL on your website to which we should redirect the customer upon a payment being in either an indeterminable or pending state. Payment methods which are not \"real-time\" (for example, Laschrift/ELV, Überweisung) use this status.\n\n**Example:** `\"http://myshop.com/pending\"`", "8-2": "A URL to your system which we can send Event Hook Notifications (EHNs) to. If this parameter is provided, it will be used instead of any statically configured EHN URLs.\n\n**Example:** `\"http://requestb.in/osdj3jos\"`", "h-0": "Property", "h-1": "Type", "h-2": "Description" }, "cols": 3, "rows": 9 } [/block]
[block:parameters] { "data": { "0-0": "`interfaceId`\n*required*", "0-1": "`int`", "1-0": "`displayLineItems`", "1-1": "`boolean`", "2-0": "`themeName`", "2-1": "`string`", "3-0": "`layoutName`", "3-1": "`string`", "4-0": "`customerLanguageCode`\n*required*", "4-1": "`string(3)`", "5-0": "`urlRedirectSuccess`\n*required*", "5-1": "`string`", "6-0": "`urlRedirectCancel`\n*required*", "6-1": "`string`", "7-0": "`urlRedirectPending`\n*required*", "7-1": "`string`", "8-0": "`urlCallback`", "8-1": "`string`", "0-2": "The ID of the web interface to use.\n\n**Constraints:**\n> Currently, the only value accepted is 5 for our Aero interface.\n\n**Example:** `5`", "1-2": "Indicates whether or not order line-items should be displayed to the customer. \n\n**Constraints:**\n> The default for this parameter is `true` if you send line items and `false` if you do not send line items.\n\n**Examples:** `true`, `false`", "2-2": "The name of your custom hosted theme at Paynova.\n \n> this field only applies to merchants who have setup a custom theme with us and specifying an invalid value will result in your payment page not rendering properly.", "3-2": "The name of the layout to use. \n\nSee [Payment page layouts](doc:payment-page-layouts) for available layouts.", "4-2": "The three-letter language code identifying the language that the payment interface should be displayed to the customer in.\n\n**Example:** `\"SWE\"`", "5-2": "The URL on your website to which we should redirect the customer upon successful payment.\n\n**Example:** `\"http://myshop.com/success\"`", "6-2": "The URL on your website to which we should redirect the customer upon the customer cancelling payment or running out of payment attempts.\n\n**Example:** `\"http://myshop.com/cancel\"`", "7-2": "The URL on your website to which we should redirect the customer upon a payment being in either an indeterminable or pending state. Payment methods which are not \"real-time\" (for example, Laschrift/ELV, Überweisung) use this status.\n\n**Example:** `\"http://myshop.com/pending\"`", "8-2": "A URL to your system which we can send Event Hook Notifications (EHNs) to. If this parameter is provided, it will be used instead of any statically configured EHN URLs.\n\n**Example:** `\"http://requestb.in/osdj3jos\"`", "h-0": "Property", "h-1": "Type", "h-2": "Description" }, "cols": 3, "rows": 9 } [/block]
{"_id":"54cf78864acee20d001e53dd","parentDoc":null,"title":"lineItem","type":"basic","user":"5476eb1df3736008009e9ced","body":"The line items included in the order (what the customer is paying for). You may include as many line items as required to specify the order.\n\n##Example XML:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\n<lineItems>\\n  <lineItem>...1...</lineItem>\\n  <lineItem>...2...</lineItem>\\n</lineItems>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"\",\n  \"body\": \"Each line item must be placed within its own lineItem element.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"**It is highly recommended that you always send in complete line item information**. Several payment methods, especially invoicing methods, require complete line information and you will not be able to use these methods if lines are not provided.\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`id`\\n*required*\",\n    \"0-1\": \"`string(1-50)`\",\n    \"1-0\": \"`articleNumber`\\n*required*\",\n    \"1-1\": \"`string(1-50)`\",\n    \"2-0\": \"`name`\\n*required*\",\n    \"2-1\": \"`string(1-255)`\",\n    \"3-0\": \"`description`\",\n    \"3-1\": \"`string(1-255)`\",\n    \"4-0\": \"`productUrl`\",\n    \"4-1\": \"`string`\",\n    \"6-0\": \"`quantity`\\n*required*\",\n    \"6-1\": \"`decimal`\",\n    \"7-0\": \"`unitMeasure`\\n*required*\",\n    \"7-1\": \"`string`\",\n    \"8-0\": \"`unitAmountExcludingTax`\\n*required*\",\n    \"8-1\": \"`decimal`\",\n    \"9-1\": \"`decimal`\",\n    \"9-0\": \"`taxPercent`\\n*required*\",\n    \"10-0\": \"`totalLineTaxAmount`\\n*required*\",\n    \"10-1\": \"`decimal`\",\n    \"11-0\": \"`totalLineAmount`\\n*required*\",\n    \"11-1\": \"`decimal`\",\n    \"12-0\": \"`travelData`\",\n    \"12-1\": \"`travelData`\",\n    \"0-2\": \"The ID for this line item. This value must be unique per collection of line items.\\n\\n**Example:** `\\\"1\\\"`\",\n    \"1-2\": \"The article/product number for the item being sold.\\n\\n**Example:** `\\\"10\\\"`\",\n    \"2-2\": \"The name of the item being sold.    \\n\\n**Constraints:**\\n> **Maximum length for Invoice as a Service orders = 50.**\\n\\n**Example:** `\\\"Test product\\\"`\",\n    \"3-2\": \"The description of the item being sold.\\n\\n\\n**Example:** `\\\"Product description goes here\\\"`\\n\\n**For invoice as a service we recommend a maximum of 75 characters.**\",\n    \"4-2\": \"The URL on your website to the item being sold.\\n\\n**Example:** `\\\"http://myshop.com/products/1000\\\"`\",\n    \"6-2\": \"The number of items being sold at this price.\\n\\n**Example:** `4.00`\",\n    \"7-2\": \"The unit of measure of the product/service being sold.\\n\\n**Examples:** `\\\"meters\\\"`, `\\\"pieces\\\"`, `\\\"st\\\"`\",\n    \"8-2\": \"The price of each unit, excluding tax.\\n\\n**Example:** `20.00`\",\n    \"9-2\": \"The tax/VAT percentage for the item being sold.\\n\\n**Acceptable VAT rates for Sweden:** `0.00`, `6.00`, `12.00`, `25.00`\",\n    \"10-2\": \"The total tax/VAT amount charged for this line.\\n\\n**Example:** `20.00`\",\n    \"11-2\": \"The total amount charged for this line, including tax/VAT (quantity * unitAmountExcludingTax + calculated tax).\\n\\n**Example:** `100.00`\",\n    \"12-2\": \"Due to the complexity and industry-specific nature of this element it's description is not included on this page.  If you would like to provide this information, please review the TravelData service type description for details.\",\n    \"5-0\": \"`components`\",\n    \"5-1\": \"`components`\",\n    \"5-2\": \"Components of the line item\\n\\nOnly the following two cases are permitted:\\n1. `TaxPercent`, `TotalLineTaxAmount`, `UnitAmountExcludingTax`\\nsupplied only for lineItem and not for any component\\n\\n2. `totalComponentAmount`, `TaxPercent`, `TotalComponentTaxAmount`, `UnitAmountExcludingTax` supplied for all components. In this case, only `TotalLineTaxAmount` should be specified on the line item level.\\n\\n**Example**\\n```\\n\\t\\t    \\\"id\\\": 2,\\n\\t\\t    \\\"articleNumber\\\": \\\"123\\\",\\n\\t\\t    \\\"name\\\": \\\"Test component 25%\\\",\\n\\t\\t    \\\"description\\\": \\\"Test component 25%\\\",\\n\\t\\t    \\\"productUrl\\\": \\\"http://www.paynova.com\\\",\\n\\t\\t    \\\"quantity\\\": 1,\\n\\t\\t    \\\"unitMeasure\\\": \\\"st\\\",\\n\\t\\t    \\\"unitAmountExcludingTax\\\": 100.00,\\n\\t\\t    \\\"taxPercent\\\": 25.00,\\n\\t\\t    \\\"totalComponentTaxAmount\\\": 25.00,\\n\\t\\t    \\\"totalComponentAmount\\\": 125.00\\t \\n```\"\n  },\n  \"cols\": 3,\n  \"rows\": 13\n}\n[/block]","api":{"auth":"required","params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"createdAt":"2015-02-02T13:15:50.809Z","githubsync":"","hidden":false,"isReference":true,"updates":[],"version":"54930e7c777ff221004a7e70","next":{"description":"","pages":[]},"order":5,"excerpt":"","category":"54cf2964a9e1cf0d005c8a12","link_external":false,"link_url":"","project":"54930e7c777ff221004a7e6d","slug":"lineitem","sync_unique":"","__v":1,"childrenPages":[]}

lineItem


The line items included in the order (what the customer is paying for). You may include as many line items as required to specify the order. ##Example XML: [block:code] { "codes": [ { "code": "\n<lineItems>\n <lineItem>...1...</lineItem>\n <lineItem>...2...</lineItem>\n</lineItems>", "language": "xml" } ] } [/block] [block:callout] { "type": "info", "title": "", "body": "Each line item must be placed within its own lineItem element." } [/block] [block:callout] { "type": "warning", "body": "**It is highly recommended that you always send in complete line item information**. Several payment methods, especially invoicing methods, require complete line information and you will not be able to use these methods if lines are not provided." } [/block] [block:parameters] { "data": { "0-0": "`id`\n*required*", "0-1": "`string(1-50)`", "1-0": "`articleNumber`\n*required*", "1-1": "`string(1-50)`", "2-0": "`name`\n*required*", "2-1": "`string(1-255)`", "3-0": "`description`", "3-1": "`string(1-255)`", "4-0": "`productUrl`", "4-1": "`string`", "6-0": "`quantity`\n*required*", "6-1": "`decimal`", "7-0": "`unitMeasure`\n*required*", "7-1": "`string`", "8-0": "`unitAmountExcludingTax`\n*required*", "8-1": "`decimal`", "9-1": "`decimal`", "9-0": "`taxPercent`\n*required*", "10-0": "`totalLineTaxAmount`\n*required*", "10-1": "`decimal`", "11-0": "`totalLineAmount`\n*required*", "11-1": "`decimal`", "12-0": "`travelData`", "12-1": "`travelData`", "0-2": "The ID for this line item. This value must be unique per collection of line items.\n\n**Example:** `\"1\"`", "1-2": "The article/product number for the item being sold.\n\n**Example:** `\"10\"`", "2-2": "The name of the item being sold. \n\n**Constraints:**\n> **Maximum length for Invoice as a Service orders = 50.**\n\n**Example:** `\"Test product\"`", "3-2": "The description of the item being sold.\n\n\n**Example:** `\"Product description goes here\"`\n\n**For invoice as a service we recommend a maximum of 75 characters.**", "4-2": "The URL on your website to the item being sold.\n\n**Example:** `\"http://myshop.com/products/1000\"`", "6-2": "The number of items being sold at this price.\n\n**Example:** `4.00`", "7-2": "The unit of measure of the product/service being sold.\n\n**Examples:** `\"meters\"`, `\"pieces\"`, `\"st\"`", "8-2": "The price of each unit, excluding tax.\n\n**Example:** `20.00`", "9-2": "The tax/VAT percentage for the item being sold.\n\n**Acceptable VAT rates for Sweden:** `0.00`, `6.00`, `12.00`, `25.00`", "10-2": "The total tax/VAT amount charged for this line.\n\n**Example:** `20.00`", "11-2": "The total amount charged for this line, including tax/VAT (quantity * unitAmountExcludingTax + calculated tax).\n\n**Example:** `100.00`", "12-2": "Due to the complexity and industry-specific nature of this element it's description is not included on this page. If you would like to provide this information, please review the TravelData service type description for details.", "5-0": "`components`", "5-1": "`components`", "5-2": "Components of the line item\n\nOnly the following two cases are permitted:\n1. `TaxPercent`, `TotalLineTaxAmount`, `UnitAmountExcludingTax`\nsupplied only for lineItem and not for any component\n\n2. `totalComponentAmount`, `TaxPercent`, `TotalComponentTaxAmount`, `UnitAmountExcludingTax` supplied for all components. In this case, only `TotalLineTaxAmount` should be specified on the line item level.\n\n**Example**\n```\n\t\t \"id\": 2,\n\t\t \"articleNumber\": \"123\",\n\t\t \"name\": \"Test component 25%\",\n\t\t \"description\": \"Test component 25%\",\n\t\t \"productUrl\": \"http://www.paynova.com\",\n\t\t \"quantity\": 1,\n\t\t \"unitMeasure\": \"st\",\n\t\t \"unitAmountExcludingTax\": 100.00,\n\t\t \"taxPercent\": 25.00,\n\t\t \"totalComponentTaxAmount\": 25.00,\n\t\t \"totalComponentAmount\": 125.00\t \n```" }, "cols": 3, "rows": 13 } [/block]
The line items included in the order (what the customer is paying for). You may include as many line items as required to specify the order. ##Example XML: [block:code] { "codes": [ { "code": "\n<lineItems>\n <lineItem>...1...</lineItem>\n <lineItem>...2...</lineItem>\n</lineItems>", "language": "xml" } ] } [/block] [block:callout] { "type": "info", "title": "", "body": "Each line item must be placed within its own lineItem element." } [/block] [block:callout] { "type": "warning", "body": "**It is highly recommended that you always send in complete line item information**. Several payment methods, especially invoicing methods, require complete line information and you will not be able to use these methods if lines are not provided." } [/block] [block:parameters] { "data": { "0-0": "`id`\n*required*", "0-1": "`string(1-50)`", "1-0": "`articleNumber`\n*required*", "1-1": "`string(1-50)`", "2-0": "`name`\n*required*", "2-1": "`string(1-255)`", "3-0": "`description`", "3-1": "`string(1-255)`", "4-0": "`productUrl`", "4-1": "`string`", "6-0": "`quantity`\n*required*", "6-1": "`decimal`", "7-0": "`unitMeasure`\n*required*", "7-1": "`string`", "8-0": "`unitAmountExcludingTax`\n*required*", "8-1": "`decimal`", "9-1": "`decimal`", "9-0": "`taxPercent`\n*required*", "10-0": "`totalLineTaxAmount`\n*required*", "10-1": "`decimal`", "11-0": "`totalLineAmount`\n*required*", "11-1": "`decimal`", "12-0": "`travelData`", "12-1": "`travelData`", "0-2": "The ID for this line item. This value must be unique per collection of line items.\n\n**Example:** `\"1\"`", "1-2": "The article/product number for the item being sold.\n\n**Example:** `\"10\"`", "2-2": "The name of the item being sold. \n\n**Constraints:**\n> **Maximum length for Invoice as a Service orders = 50.**\n\n**Example:** `\"Test product\"`", "3-2": "The description of the item being sold.\n\n\n**Example:** `\"Product description goes here\"`\n\n**For invoice as a service we recommend a maximum of 75 characters.**", "4-2": "The URL on your website to the item being sold.\n\n**Example:** `\"http://myshop.com/products/1000\"`", "6-2": "The number of items being sold at this price.\n\n**Example:** `4.00`", "7-2": "The unit of measure of the product/service being sold.\n\n**Examples:** `\"meters\"`, `\"pieces\"`, `\"st\"`", "8-2": "The price of each unit, excluding tax.\n\n**Example:** `20.00`", "9-2": "The tax/VAT percentage for the item being sold.\n\n**Acceptable VAT rates for Sweden:** `0.00`, `6.00`, `12.00`, `25.00`", "10-2": "The total tax/VAT amount charged for this line.\n\n**Example:** `20.00`", "11-2": "The total amount charged for this line, including tax/VAT (quantity * unitAmountExcludingTax + calculated tax).\n\n**Example:** `100.00`", "12-2": "Due to the complexity and industry-specific nature of this element it's description is not included on this page. If you would like to provide this information, please review the TravelData service type description for details.", "5-0": "`components`", "5-1": "`components`", "5-2": "Components of the line item\n\nOnly the following two cases are permitted:\n1. `TaxPercent`, `TotalLineTaxAmount`, `UnitAmountExcludingTax`\nsupplied only for lineItem and not for any component\n\n2. `totalComponentAmount`, `TaxPercent`, `TotalComponentTaxAmount`, `UnitAmountExcludingTax` supplied for all components. In this case, only `TotalLineTaxAmount` should be specified on the line item level.\n\n**Example**\n```\n\t\t \"id\": 2,\n\t\t \"articleNumber\": \"123\",\n\t\t \"name\": \"Test component 25%\",\n\t\t \"description\": \"Test component 25%\",\n\t\t \"productUrl\": \"http://www.paynova.com\",\n\t\t \"quantity\": 1,\n\t\t \"unitMeasure\": \"st\",\n\t\t \"unitAmountExcludingTax\": 100.00,\n\t\t \"taxPercent\": 25.00,\n\t\t \"totalComponentTaxAmount\": 25.00,\n\t\t \"totalComponentAmount\": 125.00\t \n```" }, "cols": 3, "rows": 13 } [/block]
{"_id":"54cf7895a082241900f05f96","excerpt":"","sync_unique":"","type":"basic","category":"54cf2964a9e1cf0d005c8a12","order":6,"version":"54930e7c777ff221004a7e70","hidden":false,"isReference":true,"next":{"description":"","pages":[]},"user":"5476eb1df3736008009e9ced","__v":1,"body":"## Name\nThe name of the customer and/or company.\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`companyName`\",\n    \"0-1\": \"`string(1-50)`\",\n    \"1-0\": \"`title`\",\n    \"1-1\": \"`string(1-10)`\",\n    \"2-0\": \"`firstName`\",\n    \"2-1\": \"`string(1-50)`\",\n    \"3-0\": \"`middleNames`\",\n    \"3-1\": \"`string(1-100)`\",\n    \"4-0\": \"`lastName`\",\n    \"4-1\": \"`string(1-50)`\",\n    \"5-0\": \"`suffix`\",\n    \"5-1\": \"`string(1-10)`\",\n    \"0-2\": \"The company's name, if the purchase is being made on behalf of a company.\\n\\n**Example:** `\\\"Paynova AB\\\"`\",\n    \"1-2\": \"The title. \\n\\n**Example:** `\\\"Mr.\\\", \\\"Mrs.\\\".`\",\n    \"2-2\": \"The first name (given name).\\n\\n**Example:** `\\\"Christopher\\\"`\",\n    \"3-2\": \"The middle names.\\n\\n**Example:** `\\\"Carl\\\"`\",\n    \"4-2\": \"The last name (surname).\\n\\n**Example:** `\\\"Williams\\\"`\",\n    \"5-2\": \"The name's suffix.\\n\\n**Example:** `\\\"Jr.\\\"`, `\\\"Sr.\\\"`\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n\n## Address \nThe bill-to/ship-to address.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`street1`\",\n    \"0-1\": \"`string`\",\n    \"1-0\": \"`street2`\",\n    \"1-1\": \"`string`\",\n    \"2-0\": \"`street3`\",\n    \"2-1\": \"`string`\",\n    \"3-0\": \"`street4`\",\n    \"3-1\": \"`string`\",\n    \"4-0\": \"`city`\",\n    \"4-1\": \"`string`\",\n    \"5-0\": \"`postalCode`\",\n    \"5-1\": \"`string`\",\n    \"6-0\": \"`regionCode`\",\n    \"6-1\": \"`string`\",\n    \"7-0\": \"`countryCode`\",\n    \"7-1\": \"`string(2-3)`\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"The street address, line 1.\\n**Example:** `\\\"TESTSTREET1\\\"`\",\n    \"1-2\": \"The street address, line 2.\\n\\n**Example:** `\\\"TESTSTREET1\\\"`\",\n    \"2-2\": \"The street address, line 3.\\n\\n**Example:** `\\\"TESTSTREET1\\\"`\",\n    \"3-2\": \"The street address, line 4.\\n\\n**Example:** `\\\"TESTSTREET1\\\"`\",\n    \"4-2\": \"The city.\\n\\n**Example:** `\\\"Stockholm\\\"`\",\n    \"5-2\": \"The postal/zip code.\\n\\n**Example:** `\\\"26151\\\"`\",\n    \"6-2\": \"The region code/state code.\",\n    \"7-2\": \"The country code. This may be the two-letter (alpha-2) or the three-letter (alpha-3) code.\\n\\n**Examples:** `\\\"SE\\\"`, `\\\"SWE\\\"`.\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]","githubsync":"","link_external":false,"link_url":"","parentDoc":null,"project":"54930e7c777ff221004a7e6d","slug":"nameandaddress","api":{"auth":"required","params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"createdAt":"2015-02-02T13:16:05.888Z","title":"nameAndAddress","updates":[],"childrenPages":[]}

nameAndAddress


## Name The name of the customer and/or company. [block:parameters] { "data": { "0-0": "`companyName`", "0-1": "`string(1-50)`", "1-0": "`title`", "1-1": "`string(1-10)`", "2-0": "`firstName`", "2-1": "`string(1-50)`", "3-0": "`middleNames`", "3-1": "`string(1-100)`", "4-0": "`lastName`", "4-1": "`string(1-50)`", "5-0": "`suffix`", "5-1": "`string(1-10)`", "0-2": "The company's name, if the purchase is being made on behalf of a company.\n\n**Example:** `\"Paynova AB\"`", "1-2": "The title. \n\n**Example:** `\"Mr.\", \"Mrs.\".`", "2-2": "The first name (given name).\n\n**Example:** `\"Christopher\"`", "3-2": "The middle names.\n\n**Example:** `\"Carl\"`", "4-2": "The last name (surname).\n\n**Example:** `\"Williams\"`", "5-2": "The name's suffix.\n\n**Example:** `\"Jr.\"`, `\"Sr.\"`", "h-0": "Property", "h-1": "Type", "h-2": "Description" }, "cols": 3, "rows": 6 } [/block] ## Address The bill-to/ship-to address. [block:parameters] { "data": { "0-0": "`street1`", "0-1": "`string`", "1-0": "`street2`", "1-1": "`string`", "2-0": "`street3`", "2-1": "`string`", "3-0": "`street4`", "3-1": "`string`", "4-0": "`city`", "4-1": "`string`", "5-0": "`postalCode`", "5-1": "`string`", "6-0": "`regionCode`", "6-1": "`string`", "7-0": "`countryCode`", "7-1": "`string(2-3)`", "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-2": "The street address, line 1.\n**Example:** `\"TESTSTREET1\"`", "1-2": "The street address, line 2.\n\n**Example:** `\"TESTSTREET1\"`", "2-2": "The street address, line 3.\n\n**Example:** `\"TESTSTREET1\"`", "3-2": "The street address, line 4.\n\n**Example:** `\"TESTSTREET1\"`", "4-2": "The city.\n\n**Example:** `\"Stockholm\"`", "5-2": "The postal/zip code.\n\n**Example:** `\"26151\"`", "6-2": "The region code/state code.", "7-2": "The country code. This may be the two-letter (alpha-2) or the three-letter (alpha-3) code.\n\n**Examples:** `\"SE\"`, `\"SWE\"`." }, "cols": 3, "rows": 8 } [/block]
## Name The name of the customer and/or company. [block:parameters] { "data": { "0-0": "`companyName`", "0-1": "`string(1-50)`", "1-0": "`title`", "1-1": "`string(1-10)`", "2-0": "`firstName`", "2-1": "`string(1-50)`", "3-0": "`middleNames`", "3-1": "`string(1-100)`", "4-0": "`lastName`", "4-1": "`string(1-50)`", "5-0": "`suffix`", "5-1": "`string(1-10)`", "0-2": "The company's name, if the purchase is being made on behalf of a company.\n\n**Example:** `\"Paynova AB\"`", "1-2": "The title. \n\n**Example:** `\"Mr.\", \"Mrs.\".`", "2-2": "The first name (given name).\n\n**Example:** `\"Christopher\"`", "3-2": "The middle names.\n\n**Example:** `\"Carl\"`", "4-2": "The last name (surname).\n\n**Example:** `\"Williams\"`", "5-2": "The name's suffix.\n\n**Example:** `\"Jr.\"`, `\"Sr.\"`", "h-0": "Property", "h-1": "Type", "h-2": "Description" }, "cols": 3, "rows": 6 } [/block] ## Address The bill-to/ship-to address. [block:parameters] { "data": { "0-0": "`street1`", "0-1": "`string`", "1-0": "`street2`", "1-1": "`string`", "2-0": "`street3`", "2-1": "`string`", "3-0": "`street4`", "3-1": "`string`", "4-0": "`city`", "4-1": "`string`", "5-0": "`postalCode`", "5-1": "`string`", "6-0": "`regionCode`", "6-1": "`string`", "7-0": "`countryCode`", "7-1": "`string(2-3)`", "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-2": "The street address, line 1.\n**Example:** `\"TESTSTREET1\"`", "1-2": "The street address, line 2.\n\n**Example:** `\"TESTSTREET1\"`", "2-2": "The street address, line 3.\n\n**Example:** `\"TESTSTREET1\"`", "3-2": "The street address, line 4.\n\n**Example:** `\"TESTSTREET1\"`", "4-2": "The city.\n\n**Example:** `\"Stockholm\"`", "5-2": "The postal/zip code.\n\n**Example:** `\"26151\"`", "6-2": "The region code/state code.", "7-2": "The country code. This may be the two-letter (alpha-2) or the three-letter (alpha-3) code.\n\n**Examples:** `\"SE\"`, `\"SWE\"`." }, "cols": 3, "rows": 8 } [/block]
{"_id":"54cf78e69d09bb0d00a17aba","link_url":"","sync_unique":"","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":""},"category":"54cf2964a9e1cf0d005c8a12","link_external":false,"user":"5476eb1df3736008009e9ced","__v":1,"isReference":false,"project":"54930e7c777ff221004a7e6d","type":"basic","updates":[],"hidden":false,"next":{"description":"","pages":[]},"slug":"profilecard","excerpt":"","githubsync":"","order":8,"parentDoc":null,"title":"profileCard","body":"The profile card use in the payment. If the payment is to be performed on a stored profile card, this parameter is required.\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`cardId`\\n*required*\",\n    \"0-1\": \"`guid`\",\n    \"0-2\": \"Paynova's unique id for the card stored in the customer profile.\\n\\n**Example:** `\\\"a61e7be3-deb2-4b20-89ba-a39a00b3f669\\\"`\",\n    \"1-2\": \"Depending on the payment channel and your acquiring agreement, the card CVC (three or four digit security code) may be required. Paynova will inform you if you are required to send this information.\\n\\n**Example:** `\\\"111\\\"`\",\n    \"1-0\": \"`cvc`\\n***conditional***\",\n    \"1-1\": \"`string`\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","createdAt":"2015-02-02T13:17:26.058Z","version":"54930e7c777ff221004a7e70","childrenPages":[]}

profileCard


The profile card use in the payment. If the payment is to be performed on a stored profile card, this parameter is required. [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`cardId`\n*required*", "0-1": "`guid`", "0-2": "Paynova's unique id for the card stored in the customer profile.\n\n**Example:** `\"a61e7be3-deb2-4b20-89ba-a39a00b3f669\"`", "1-2": "Depending on the payment channel and your acquiring agreement, the card CVC (three or four digit security code) may be required. Paynova will inform you if you are required to send this information.\n\n**Example:** `\"111\"`", "1-0": "`cvc`\n***conditional***", "1-1": "`string`" }, "cols": 3, "rows": 2 } [/block]
The profile card use in the payment. If the payment is to be performed on a stored profile card, this parameter is required. [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`cardId`\n*required*", "0-1": "`guid`", "0-2": "Paynova's unique id for the card stored in the customer profile.\n\n**Example:** `\"a61e7be3-deb2-4b20-89ba-a39a00b3f669\"`", "1-2": "Depending on the payment channel and your acquiring agreement, the card CVC (three or four digit security code) may be required. Paynova will inform you if you are required to send this information.\n\n**Example:** `\"111\"`", "1-0": "`cvc`\n***conditional***", "1-1": "`string`" }, "cols": 3, "rows": 2 } [/block]
{"_id":"54cf78faa082241900f05f9e","hidden":false,"next":{"description":"","pages":[]},"slug":"profilecarddetails","type":"basic","createdAt":"2015-02-02T13:17:46.398Z","body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`cardId`\\n*required*\",\n    \"0-2\": \"Paynova's unique identifier for the profile card stored within a customer profile. This id should be used for subsequent requests to Paynova involving profile card payments.\\n\\n**Example:** `\\\"\\\"a61e7be3-deb2-4b20-89ba-a39a00b3f669\\\"`\",\n    \"1-0\": \"`expirationYear`\\n*required*\",\n    \"1-2\": \"The four-digit expiration year of the card.\\n\\n**Example:** `20`\",\n    \"2-0\": \"`expirationMonth`\",\n    \"2-2\": \"The two-digit expiration month of the card.\\n\\n**Example:** `10`\",\n    \"3-0\": \"`firstSix`\\n*required*\",\n    \"3-2\": \"The first six digits of the card number (BIN/IIN).\\n\\n**Example:** `\\\"555555\\\"`\",\n    \"4-0\": \"`lastFour`\\n*required*\",\n    \"4-1\": \"`string(4)`\",\n    \"4-2\": \"The last four digits of the card number.\\n\\n**Example:** `\\\"4444\\\"`\",\n    \"0-1\": \"`guid`\",\n    \"1-1\": \"`int`\",\n    \"2-1\": \"`int`\",\n    \"3-1\": \"`string(6)`\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","link_url":"","category":"54cf2964a9e1cf0d005c8a12","githubsync":"","isReference":false,"link_external":false,"project":"54930e7c777ff221004a7e6d","sync_unique":"","title":"profileCardDetails","__v":1,"updates":[],"excerpt":"","order":9,"parentDoc":null,"user":"5476eb1df3736008009e9ced","version":"54930e7c777ff221004a7e70","api":{"settings":"","url":"","auth":"required","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]}},"childrenPages":[]}

profileCardDetails


[block:parameters] { "data": { "0-0": "`cardId`\n*required*", "0-2": "Paynova's unique identifier for the profile card stored within a customer profile. This id should be used for subsequent requests to Paynova involving profile card payments.\n\n**Example:** `\"\"a61e7be3-deb2-4b20-89ba-a39a00b3f669\"`", "1-0": "`expirationYear`\n*required*", "1-2": "The four-digit expiration year of the card.\n\n**Example:** `20`", "2-0": "`expirationMonth`", "2-2": "The two-digit expiration month of the card.\n\n**Example:** `10`", "3-0": "`firstSix`\n*required*", "3-2": "The first six digits of the card number (BIN/IIN).\n\n**Example:** `\"555555\"`", "4-0": "`lastFour`\n*required*", "4-1": "`string(4)`", "4-2": "The last four digits of the card number.\n\n**Example:** `\"4444\"`", "0-1": "`guid`", "1-1": "`int`", "2-1": "`int`", "3-1": "`string(6)`", "h-0": "Property", "h-1": "Type", "h-2": "Description" }, "cols": 3, "rows": 5 } [/block]
[block:parameters] { "data": { "0-0": "`cardId`\n*required*", "0-2": "Paynova's unique identifier for the profile card stored within a customer profile. This id should be used for subsequent requests to Paynova involving profile card payments.\n\n**Example:** `\"\"a61e7be3-deb2-4b20-89ba-a39a00b3f669\"`", "1-0": "`expirationYear`\n*required*", "1-2": "The four-digit expiration year of the card.\n\n**Example:** `20`", "2-0": "`expirationMonth`", "2-2": "The two-digit expiration month of the card.\n\n**Example:** `10`", "3-0": "`firstSix`\n*required*", "3-2": "The first six digits of the card number (BIN/IIN).\n\n**Example:** `\"555555\"`", "4-0": "`lastFour`\n*required*", "4-1": "`string(4)`", "4-2": "The last four digits of the card number.\n\n**Example:** `\"4444\"`", "0-1": "`guid`", "1-1": "`int`", "2-1": "`int`", "3-1": "`string(6)`", "h-0": "Property", "h-1": "Type", "h-2": "Description" }, "cols": 3, "rows": 5 } [/block]
{"_id":"54cf79209d09bb0d00a17abc","category":"54cf2964a9e1cf0d005c8a12","excerpt":"","githubsync":"","isReference":false,"parentDoc":null,"title":"profilePaymentOptions","link_external":false,"order":10,"slug":"profilepaymentoptions","updates":[],"user":"5476eb1df3736008009e9ced","api":{"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required"},"link_url":"","sync_unique":"","__v":1,"body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`profileId`\\n*required*\",\n    \"1-0\": \"`profileCard`\\n***conditional***\",\n    \"2-0\": \"`displaySaveProfileCardOption`\",\n    \"2-1\": \"`boolean`\",\n    \"1-1\": \"[`profileCard`:fa-external-link-square:](doc:profilecard)\",\n    \"0-1\": \"`string`\",\n    \"1-2\": \"The profile card used in the payment. \\n\\n**Conditions:** \\n> If the payment is to be performed on a stored profile card, this parameter is required.\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"Your identifier for the customer profile.\\n\\n**Example:** `\\\"1\\\"`\",\n    \"2-2\": \"If you would like the customer to choose whether or not to save their card in your customer profile on Paynova's page, then set this option to `true`. The logic works as follows:\\n<ul>\\n<li>If you provide a profile id in profilePaymentOptions and this value is `false`, the card will be saved and the customer will not be presented with an option on Paynova's payment page.</li>\\n\\n<li>If you provide a profile id in profilePaymentOptions and this value is not present (null), the card will be saved.</li>\\n\\n<li>If you provide a profile id in profilePaymentOptions and this value is `true`, the customer will be presented with the option to choose whether or not they want their card saved on Paynova's payment page.\\nIf the customer opts to save their card, you will receive a profile card identifier after the payment has been completed (assuming the customer pays with a card), otherwise the card will not be saved to the customer's profile and you will not receive an identifier.</li>\\n</ul>\\n\\n**Examples:** `true`, `false`\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","createdAt":"2015-02-02T13:18:24.270Z","hidden":false,"next":{"description":"","pages":[]},"project":"54930e7c777ff221004a7e6d","type":"basic","version":"54930e7c777ff221004a7e70","childrenPages":[]}

profilePaymentOptions


[block:parameters] { "data": { "0-0": "`profileId`\n*required*", "1-0": "`profileCard`\n***conditional***", "2-0": "`displaySaveProfileCardOption`", "2-1": "`boolean`", "1-1": "[`profileCard`:fa-external-link-square:](doc:profilecard)", "0-1": "`string`", "1-2": "The profile card used in the payment. \n\n**Conditions:** \n> If the payment is to be performed on a stored profile card, this parameter is required.", "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-2": "Your identifier for the customer profile.\n\n**Example:** `\"1\"`", "2-2": "If you would like the customer to choose whether or not to save their card in your customer profile on Paynova's page, then set this option to `true`. The logic works as follows:\n<ul>\n<li>If you provide a profile id in profilePaymentOptions and this value is `false`, the card will be saved and the customer will not be presented with an option on Paynova's payment page.</li>\n\n<li>If you provide a profile id in profilePaymentOptions and this value is not present (null), the card will be saved.</li>\n\n<li>If you provide a profile id in profilePaymentOptions and this value is `true`, the customer will be presented with the option to choose whether or not they want their card saved on Paynova's payment page.\nIf the customer opts to save their card, you will receive a profile card identifier after the payment has been completed (assuming the customer pays with a card), otherwise the card will not be saved to the customer's profile and you will not receive an identifier.</li>\n</ul>\n\n**Examples:** `true`, `false`" }, "cols": 3, "rows": 3 } [/block]
[block:parameters] { "data": { "0-0": "`profileId`\n*required*", "1-0": "`profileCard`\n***conditional***", "2-0": "`displaySaveProfileCardOption`", "2-1": "`boolean`", "1-1": "[`profileCard`:fa-external-link-square:](doc:profilecard)", "0-1": "`string`", "1-2": "The profile card used in the payment. \n\n**Conditions:** \n> If the payment is to be performed on a stored profile card, this parameter is required.", "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-2": "Your identifier for the customer profile.\n\n**Example:** `\"1\"`", "2-2": "If you would like the customer to choose whether or not to save their card in your customer profile on Paynova's page, then set this option to `true`. The logic works as follows:\n<ul>\n<li>If you provide a profile id in profilePaymentOptions and this value is `false`, the card will be saved and the customer will not be presented with an option on Paynova's payment page.</li>\n\n<li>If you provide a profile id in profilePaymentOptions and this value is not present (null), the card will be saved.</li>\n\n<li>If you provide a profile id in profilePaymentOptions and this value is `true`, the customer will be presented with the option to choose whether or not they want their card saved on Paynova's payment page.\nIf the customer opts to save their card, you will receive a profile card identifier after the payment has been completed (assuming the customer pays with a card), otherwise the card will not be saved to the customer's profile and you will not receive an identifier.</li>\n</ul>\n\n**Examples:** `true`, `false`" }, "cols": 3, "rows": 3 } [/block]
{"_id":"581b5c7a5798c01b0030d691","excerpt":"","githubsync":"","hidden":false,"link_external":false,"sync_unique":"","updates":[],"next":{"pages":[],"description":""},"order":11,"parentDoc":null,"project":"54930e7c777ff221004a7e6d","slug":"paymentchannelid","body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"ID\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"1\",\n    \"0-1\": \"Web payment.\",\n    \"1-0\": \"2\",\n    \"1-1\": \"Mail/Telephone Order, used for payments accepted over the telephone or via the mail.\",\n    \"2-0\": \"7\",\n    \"2-1\": \"Recurring/Subscription, used for non-customer initiated payments for subscriptions.\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","createdAt":"2016-11-03T15:49:14.397Z","link_url":"","user":"5818a4ecb1e11c1900bf76c3","type":"basic","version":"54930e7c777ff221004a7e70","__v":0,"api":{"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","auth":"required","params":[]},"category":"54cf2964a9e1cf0d005c8a12","isReference":false,"title":"paymentChannelId","childrenPages":[]}

paymentChannelId


[block:parameters] { "data": { "h-0": "ID", "h-1": "Description", "0-0": "1", "0-1": "Web payment.", "1-0": "2", "1-1": "Mail/Telephone Order, used for payments accepted over the telephone or via the mail.", "2-0": "7", "2-1": "Recurring/Subscription, used for non-customer initiated payments for subscriptions." }, "cols": 2, "rows": 3 } [/block]
[block:parameters] { "data": { "h-0": "ID", "h-1": "Description", "0-0": "1", "0-1": "Web payment.", "1-0": "2", "1-1": "Mail/Telephone Order, used for payments accepted over the telephone or via the mail.", "2-0": "7", "2-1": "Recurring/Subscription, used for non-customer initiated payments for subscriptions." }, "cols": 2, "rows": 3 } [/block]
{"_id":"581b64d739b05c1b00693863","excerpt":"","link_url":"","user":"5818a4ecb1e11c1900bf76c3","category":"54cf2964a9e1cf0d005c8a12","githubsync":"","isReference":false,"order":12,"__v":0,"createdAt":"2016-11-03T16:24:55.801Z","hidden":false,"link_external":false,"parentDoc":null,"title":"companyOrPersonName","type":"basic","updates":[],"api":{"url":"","results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[]},"version":"54930e7c777ff221004a7e70","next":{"pages":[],"description":""},"project":"54930e7c777ff221004a7e6d","slug":"name","sync_unique":"","body":"The name of the customer and/or company.\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`companyName`\",\n    \"1-0\": \"`title`\",\n    \"2-0\": \"`firstName`\",\n    \"3-0\": \"`middleNames`\",\n    \"4-0\": \"`lastName`\",\n    \"5-0\": \"`suffix`\",\n    \"0-1\": \"`string(1-50)`\",\n    \"1-1\": \"`string(1-10)`\",\n    \"2-1\": \"`string(1-50)`\",\n    \"3-1\": \"`string(1-100)`\",\n    \"4-1\": \"`string(1-50)`\",\n    \"5-1\": \"`string(1-10)`\",\n    \"0-2\": \"The company's name, if the purchase is being made on behalf of a company.\\n\\n**Example:** `\\\"Paynova AB\\\"`\",\n    \"1-2\": \"The title.\\n\\n**Examples:** `\\\"Mr.\\\"`, `\\\"Mrs.\\\"`\",\n    \"2-2\": \"The first name (given name).\\n\\n**Example:** `\\\"Christopher\\\"`\",\n    \"3-2\": \"The middle names.\\n\\n**Example:** `\\\"Carl\\\"`\",\n    \"4-2\": \"The last name (surname).\\n\\n**Example:** `\\\"Williams\\\"`\",\n    \"5-2\": \"The name's suffix. \\n\\n\\n**Examples:** `\\\"Jr.\\\"`, `\\\"Sr.\\\"`\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]","childrenPages":[]}

companyOrPersonName


The name of the customer and/or company. [block:parameters] { "data": { "0-0": "`companyName`", "1-0": "`title`", "2-0": "`firstName`", "3-0": "`middleNames`", "4-0": "`lastName`", "5-0": "`suffix`", "0-1": "`string(1-50)`", "1-1": "`string(1-10)`", "2-1": "`string(1-50)`", "3-1": "`string(1-100)`", "4-1": "`string(1-50)`", "5-1": "`string(1-10)`", "0-2": "The company's name, if the purchase is being made on behalf of a company.\n\n**Example:** `\"Paynova AB\"`", "1-2": "The title.\n\n**Examples:** `\"Mr.\"`, `\"Mrs.\"`", "2-2": "The first name (given name).\n\n**Example:** `\"Christopher\"`", "3-2": "The middle names.\n\n**Example:** `\"Carl\"`", "4-2": "The last name (surname).\n\n**Example:** `\"Williams\"`", "5-2": "The name's suffix. \n\n\n**Examples:** `\"Jr.\"`, `\"Sr.\"`" }, "cols": 3, "rows": 6 } [/block]
The name of the customer and/or company. [block:parameters] { "data": { "0-0": "`companyName`", "1-0": "`title`", "2-0": "`firstName`", "3-0": "`middleNames`", "4-0": "`lastName`", "5-0": "`suffix`", "0-1": "`string(1-50)`", "1-1": "`string(1-10)`", "2-1": "`string(1-50)`", "3-1": "`string(1-100)`", "4-1": "`string(1-50)`", "5-1": "`string(1-10)`", "0-2": "The company's name, if the purchase is being made on behalf of a company.\n\n**Example:** `\"Paynova AB\"`", "1-2": "The title.\n\n**Examples:** `\"Mr.\"`, `\"Mrs.\"`", "2-2": "The first name (given name).\n\n**Example:** `\"Christopher\"`", "3-2": "The middle names.\n\n**Example:** `\"Carl\"`", "4-2": "The last name (surname).\n\n**Example:** `\"Williams\"`", "5-2": "The name's suffix. \n\n\n**Examples:** `\"Jr.\"`, `\"Sr.\"`" }, "cols": 3, "rows": 6 } [/block]
{"_id":"581c8f4d5a425c0f00de985a","hidden":false,"isReference":false,"link_external":false,"parentDoc":null,"title":"status","user":"5818a4ecb1e11c1900bf76c3","api":{"auth":"required","params":[],"url":"","results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"excerpt":"","githubsync":"","__v":0,"order":13,"project":"54930e7c777ff221004a7e6d","type":"basic","body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`isSuccess`\\n*required*\",\n    \"0-1\": \"`boolean`\",\n    \"1-0\": \"`errorNumber`\\n*required*\",\n    \"1-1\": \"`int`\",\n    \"2-0\": \"`statusKey`\\n*required*\",\n    \"2-1\": \"`string`\",\n    \"3-0\": \"`statusMessage`\\n*required*\",\n    \"3-1\": \"`string`\",\n    \"4-0\": \"`errors`\",\n    \"4-1\": \"[`errors`:fa-external-link-square:](doc:errors)\",\n    \"0-2\": \"Indicates whether or not the operation was successful.\\n\\n**Examples:** `true`, `false`\",\n    \"1-2\": \"A numeric identifier indicating the operation's status. For successful operations, this value will always be `0` (zero). For more information, see the [Error Codes](doc:errorcodes) page\\n\\n**Example:** `0`\",\n    \"2-2\": \"A short textual representation of the operation's status. For successful operations, this value will always be `\\\"SUCCESS\\\"`. For more information, see the [Error Codes](doc:errorcodes) page.\\n\\n**Example:** `\\\"SUCCESS\\\"`\",\n    \"3-2\": \"A detailed description of the operation's status.\\n\\n**Example:** `\\\"The operation was successful.\\\"`\",\n    \"4-2\": \"Detailed information about the error(s).\\n\\n**Example:** \\n```\\n{ \\n\\\"errorCode\\\": \\\"Predicate\\\",\\n\\\"fieldName\\\": \\\"PaymentChannelId\\\",\\n \\\"message\\\": \\\"When authorizing a recurring payment, the payment channel Id must be set to '7' (recurring) or left unspecified.\\\"\\n }\\n```\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","category":"54cf2964a9e1cf0d005c8a12","createdAt":"2016-11-04T13:38:21.308Z","link_url":"","next":{"pages":[],"description":""},"slug":"status","sync_unique":"","updates":[],"version":"54930e7c777ff221004a7e70","childrenPages":[]}

status


[block:parameters] { "data": { "0-0": "`isSuccess`\n*required*", "0-1": "`boolean`", "1-0": "`errorNumber`\n*required*", "1-1": "`int`", "2-0": "`statusKey`\n*required*", "2-1": "`string`", "3-0": "`statusMessage`\n*required*", "3-1": "`string`", "4-0": "`errors`", "4-1": "[`errors`:fa-external-link-square:](doc:errors)", "0-2": "Indicates whether or not the operation was successful.\n\n**Examples:** `true`, `false`", "1-2": "A numeric identifier indicating the operation's status. For successful operations, this value will always be `0` (zero). For more information, see the [Error Codes](doc:errorcodes) page\n\n**Example:** `0`", "2-2": "A short textual representation of the operation's status. For successful operations, this value will always be `\"SUCCESS\"`. For more information, see the [Error Codes](doc:errorcodes) page.\n\n**Example:** `\"SUCCESS\"`", "3-2": "A detailed description of the operation's status.\n\n**Example:** `\"The operation was successful.\"`", "4-2": "Detailed information about the error(s).\n\n**Example:** \n```\n{ \n\"errorCode\": \"Predicate\",\n\"fieldName\": \"PaymentChannelId\",\n \"message\": \"When authorizing a recurring payment, the payment channel Id must be set to '7' (recurring) or left unspecified.\"\n }\n```" }, "cols": 3, "rows": 5 } [/block]
[block:parameters] { "data": { "0-0": "`isSuccess`\n*required*", "0-1": "`boolean`", "1-0": "`errorNumber`\n*required*", "1-1": "`int`", "2-0": "`statusKey`\n*required*", "2-1": "`string`", "3-0": "`statusMessage`\n*required*", "3-1": "`string`", "4-0": "`errors`", "4-1": "[`errors`:fa-external-link-square:](doc:errors)", "0-2": "Indicates whether or not the operation was successful.\n\n**Examples:** `true`, `false`", "1-2": "A numeric identifier indicating the operation's status. For successful operations, this value will always be `0` (zero). For more information, see the [Error Codes](doc:errorcodes) page\n\n**Example:** `0`", "2-2": "A short textual representation of the operation's status. For successful operations, this value will always be `\"SUCCESS\"`. For more information, see the [Error Codes](doc:errorcodes) page.\n\n**Example:** `\"SUCCESS\"`", "3-2": "A detailed description of the operation's status.\n\n**Example:** `\"The operation was successful.\"`", "4-2": "Detailed information about the error(s).\n\n**Example:** \n```\n{ \n\"errorCode\": \"Predicate\",\n\"fieldName\": \"PaymentChannelId\",\n \"message\": \"When authorizing a recurring payment, the payment channel Id must be set to '7' (recurring) or left unspecified.\"\n }\n```" }, "cols": 3, "rows": 5 } [/block]
{"_id":"583423d1285145190063e7d9","user":"5818a4ecb1e11c1900bf76c3","body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`bookingReference`\",\n    \"0-1\": \"`string`\",\n    \"0-2\": \"The booking reference number for the entire booking.\",\n    \"1-0\": \"`travelSegments`\",\n    \"1-1\": \"[`travelSegment`:fa-external-link-square:](doc:travelsegment)\",\n    \"1-2\": \"The travel segments which are included in this booking.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","createdAt":"2016-11-22T10:54:09.981Z","excerpt":"","isReference":false,"order":14,"title":"TravelData","type":"basic","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","auth":"required","params":[],"url":""},"category":"54cf2964a9e1cf0d005c8a12","githubsync":"","next":{"pages":[],"description":""},"project":"54930e7c777ff221004a7e6d","updates":[],"__v":0,"hidden":false,"link_url":"","slug":"traveldata","version":"54930e7c777ff221004a7e70","link_external":false,"parentDoc":null,"sync_unique":"","childrenPages":[]}

TravelData


[block:parameters] { "data": { "0-0": "`bookingReference`", "0-1": "`string`", "0-2": "The booking reference number for the entire booking.", "1-0": "`travelSegments`", "1-1": "[`travelSegment`:fa-external-link-square:](doc:travelsegment)", "1-2": "The travel segments which are included in this booking." }, "cols": 3, "rows": 2 } [/block]
[block:parameters] { "data": { "0-0": "`bookingReference`", "0-1": "`string`", "0-2": "The booking reference number for the entire booking.", "1-0": "`travelSegments`", "1-1": "[`travelSegment`:fa-external-link-square:](doc:travelsegment)", "1-2": "The travel segments which are included in this booking." }, "cols": 3, "rows": 2 } [/block]
{"_id":"583423df88081719004118c3","isReference":false,"sync_unique":"","api":{"settings":"","auth":"required","params":[],"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]}},"excerpt":"","githubsync":"","hidden":false,"link_url":"","next":{"pages":[],"description":""},"user":"5818a4ecb1e11c1900bf76c3","createdAt":"2016-11-22T10:54:23.296Z","body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`segmentType`\\n*required*\",\n    \"0-1\": \"`TravelSegmentType`\",\n    \"0-2\": \"The means of travel. The possible values are according to the following table:\",\n    \"1-0\": \"`departureDate`\\n*required*\",\n    \"1-2\": \"The scheduled departure date for this segment, in the format YYYY-MM-DD. \\n\\n**Example:** `\\\"2016-11-23\\\"`\",\n    \"1-1\": \"`string`\",\n    \"2-0\": \"`departureTime`\\n*required*\",\n    \"2-2\": \"The scheduled departure time for this segment, in the format HH:MM, using the 24-hour time format. \\n\\n**Example:** `\\\"19:55\\\"`\",\n    \"2-1\": \"`string`\",\n    \"3-0\": \"`departureCountryCode`\\n*required*\",\n    \"3-1\": \"`string(2-3)`\",\n    \"3-2\": \"The country in which the departure station/airport for this segment is in. This may be the two-letter (alpha-2), three-letter (alpha-3) code or the ISO country number as per ISO 3166-1.\\n\\n**Example:** `\\\"SWE\\\"`, `\\\"SE\\\"`\",\n    \"4-0\": \"`departureStationCode`\\n***conditional***\",\n    \"4-1\": \"`string`\",\n    \"4-2\": \"The identifier for the rail station which this segment is departing from.\\n\\n**Conditions:**\\n> Only applicable to and required for RAIL segments.\",\n    \"5-0\": \"`departureAirportCode`\\n***conditional***\",\n    \"5-1\": \"`string`\",\n    \"5-2\": \"The IATA or ICAO airport or city code of the departure airport for this segment, in the format` <authority>:<code>`.\\nFor example, if you were sending the code for Arlanda airport in Stockholm, Sweden, you would send:\\nFor IATA you would send: \\\"IATA:ARN\\\"\\nFor ICAO you would send: \\\"ICAO:ESSA\\\"\\nNote: Only applicable to and required for AIR segments.\",\n    \"6-0\": \"`arrivalDate`\\n*required*\",\n    \"6-1\": \"`string`\",\n    \"6-2\": \"The scheduled arrival time for this segment, in the format HH:MM, using the 24-hour time format.\\n\\n**Example:** `\\\"19:55\\\"`\",\n    \"7-0\": \"`arrivalCountryCode`\\n*required*\",\n    \"7-1\": \"`string`\",\n    \"7-2\": \"The country in which the destination station/airport for this segment is in. This may be the two-letter (alpha-2), three-letter (alpha-3) code or the ISO country number as per ISO 3166-1.\\n\\n**Examples:**\\n`\\\"SE\\\"`,`\\\"SWE\\\"`\",\n    \"8-0\": \"`arrivalStationCode`\\n***conditional***\",\n    \"8-1\": \"`string`\",\n    \"8-2\": \"The identifier for the arrival rail station of this segment.\\n\\n**Conditions:** \\n> Only applicable to and required for RAIL segments.\",\n    \"9-0\": \"`arrivalAirportCode`\\n***conditional***\",\n    \"9-1\": \"`string`\",\n    \"9-2\": \"The IATA or ICAO airport or city code of the arrival airport for this segment, in the format `<authority>:<code>`.\\nFor example, if you were sending the code for Arlanda airport in Stockholm, Sweden, you would send:\\nFor IATA you would send: \\\"IATA:ARN\\\"\\nFor ICAO you would send: \\\"ICAO:ESSA\\\"\\n\\n**Conditions:** \\n> Only applicable to and required for AIR segments.\",\n    \"10-0\": \"`carrierDesignator`\",\n    \"10-1\": \"`string`\",\n    \"11-0\": \"`tickets`\\n*required*\",\n    \"11-1\": \"[`travelticket`:fa-external-link-square:](doc:travelticket)\",\n    \"10-2\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\n}\n[/block]","category":"54cf2964a9e1cf0d005c8a12","link_external":false,"parentDoc":null,"project":"54930e7c777ff221004a7e6d","__v":0,"slug":"travelsegment","title":"TravelSegment","type":"basic","updates":[],"version":"54930e7c777ff221004a7e70","order":15,"childrenPages":[]}

TravelSegment


[block:parameters] { "data": { "0-0": "`segmentType`\n*required*", "0-1": "`TravelSegmentType`", "0-2": "The means of travel. The possible values are according to the following table:", "1-0": "`departureDate`\n*required*", "1-2": "The scheduled departure date for this segment, in the format YYYY-MM-DD. \n\n**Example:** `\"2016-11-23\"`", "1-1": "`string`", "2-0": "`departureTime`\n*required*", "2-2": "The scheduled departure time for this segment, in the format HH:MM, using the 24-hour time format. \n\n**Example:** `\"19:55\"`", "2-1": "`string`", "3-0": "`departureCountryCode`\n*required*", "3-1": "`string(2-3)`", "3-2": "The country in which the departure station/airport for this segment is in. This may be the two-letter (alpha-2), three-letter (alpha-3) code or the ISO country number as per ISO 3166-1.\n\n**Example:** `\"SWE\"`, `\"SE\"`", "4-0": "`departureStationCode`\n***conditional***", "4-1": "`string`", "4-2": "The identifier for the rail station which this segment is departing from.\n\n**Conditions:**\n> Only applicable to and required for RAIL segments.", "5-0": "`departureAirportCode`\n***conditional***", "5-1": "`string`", "5-2": "The IATA or ICAO airport or city code of the departure airport for this segment, in the format` <authority>:<code>`.\nFor example, if you were sending the code for Arlanda airport in Stockholm, Sweden, you would send:\nFor IATA you would send: \"IATA:ARN\"\nFor ICAO you would send: \"ICAO:ESSA\"\nNote: Only applicable to and required for AIR segments.", "6-0": "`arrivalDate`\n*required*", "6-1": "`string`", "6-2": "The scheduled arrival time for this segment, in the format HH:MM, using the 24-hour time format.\n\n**Example:** `\"19:55\"`", "7-0": "`arrivalCountryCode`\n*required*", "7-1": "`string`", "7-2": "The country in which the destination station/airport for this segment is in. This may be the two-letter (alpha-2), three-letter (alpha-3) code or the ISO country number as per ISO 3166-1.\n\n**Examples:**\n`\"SE\"`,`\"SWE\"`", "8-0": "`arrivalStationCode`\n***conditional***", "8-1": "`string`", "8-2": "The identifier for the arrival rail station of this segment.\n\n**Conditions:** \n> Only applicable to and required for RAIL segments.", "9-0": "`arrivalAirportCode`\n***conditional***", "9-1": "`string`", "9-2": "The IATA or ICAO airport or city code of the arrival airport for this segment, in the format `<authority>:<code>`.\nFor example, if you were sending the code for Arlanda airport in Stockholm, Sweden, you would send:\nFor IATA you would send: \"IATA:ARN\"\nFor ICAO you would send: \"ICAO:ESSA\"\n\n**Conditions:** \n> Only applicable to and required for AIR segments.", "10-0": "`carrierDesignator`", "10-1": "`string`", "11-0": "`tickets`\n*required*", "11-1": "[`travelticket`:fa-external-link-square:](doc:travelticket)", "10-2": "" }, "cols": 3, "rows": 12 } [/block]
[block:parameters] { "data": { "0-0": "`segmentType`\n*required*", "0-1": "`TravelSegmentType`", "0-2": "The means of travel. The possible values are according to the following table:", "1-0": "`departureDate`\n*required*", "1-2": "The scheduled departure date for this segment, in the format YYYY-MM-DD. \n\n**Example:** `\"2016-11-23\"`", "1-1": "`string`", "2-0": "`departureTime`\n*required*", "2-2": "The scheduled departure time for this segment, in the format HH:MM, using the 24-hour time format. \n\n**Example:** `\"19:55\"`", "2-1": "`string`", "3-0": "`departureCountryCode`\n*required*", "3-1": "`string(2-3)`", "3-2": "The country in which the departure station/airport for this segment is in. This may be the two-letter (alpha-2), three-letter (alpha-3) code or the ISO country number as per ISO 3166-1.\n\n**Example:** `\"SWE\"`, `\"SE\"`", "4-0": "`departureStationCode`\n***conditional***", "4-1": "`string`", "4-2": "The identifier for the rail station which this segment is departing from.\n\n**Conditions:**\n> Only applicable to and required for RAIL segments.", "5-0": "`departureAirportCode`\n***conditional***", "5-1": "`string`", "5-2": "The IATA or ICAO airport or city code of the departure airport for this segment, in the format` <authority>:<code>`.\nFor example, if you were sending the code for Arlanda airport in Stockholm, Sweden, you would send:\nFor IATA you would send: \"IATA:ARN\"\nFor ICAO you would send: \"ICAO:ESSA\"\nNote: Only applicable to and required for AIR segments.", "6-0": "`arrivalDate`\n*required*", "6-1": "`string`", "6-2": "The scheduled arrival time for this segment, in the format HH:MM, using the 24-hour time format.\n\n**Example:** `\"19:55\"`", "7-0": "`arrivalCountryCode`\n*required*", "7-1": "`string`", "7-2": "The country in which the destination station/airport for this segment is in. This may be the two-letter (alpha-2), three-letter (alpha-3) code or the ISO country number as per ISO 3166-1.\n\n**Examples:**\n`\"SE\"`,`\"SWE\"`", "8-0": "`arrivalStationCode`\n***conditional***", "8-1": "`string`", "8-2": "The identifier for the arrival rail station of this segment.\n\n**Conditions:** \n> Only applicable to and required for RAIL segments.", "9-0": "`arrivalAirportCode`\n***conditional***", "9-1": "`string`", "9-2": "The IATA or ICAO airport or city code of the arrival airport for this segment, in the format `<authority>:<code>`.\nFor example, if you were sending the code for Arlanda airport in Stockholm, Sweden, you would send:\nFor IATA you would send: \"IATA:ARN\"\nFor ICAO you would send: \"ICAO:ESSA\"\n\n**Conditions:** \n> Only applicable to and required for AIR segments.", "10-0": "`carrierDesignator`", "10-1": "`string`", "11-0": "`tickets`\n*required*", "11-1": "[`travelticket`:fa-external-link-square:](doc:travelticket)", "10-2": "" }, "cols": 3, "rows": 12 } [/block]