{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"param-encryption (resource)","type":"basic","slug":"param-encryption","excerpt":"","body":"The `param-encryption` resource contains the parameters to be encrypted in the request and the encrypted string in the response. The encrypted string can then be included in the checkout page URL, as the value of the `enc` parameter.\n\n###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"0-0\": \"`parameters`\",\n    \"0-1\": \"container\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"A container of [parameter](doc:parameter) properties.\",\n    \"0-2\": \"**Required**\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\n}\n[/block]\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`decrypted-token`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"A string representing a collection of encrypted [Hosted Checkout parameters](https://support.bluesnap.com/docs/hosted-checkout-parameters) or [Hosted Payment Page parameters](https://support.bluesnap.com/docs/hosted-payment-page-parameters).\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]","updates":[],"order":7,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5fa1893ed2a2370028d24245","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Encrypt/Decrypt Parameters","slug":"encrypt-parameters","order":8,"from_sync":false,"reference":true,"_id":"5fa1893ed2a2370028d24226","version":"5fa1893ed2a2370028d24282","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2016-05-17T12:18:45.712Z","__v":0},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"version":"8976-Tools","version_clean":"8976.0.0-Tools","codename":"3.36 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5fa1893ed2a2370028d2421e","5fa1893ed2a2370028d2421f","5fa1893ed2a2370028d24220","5fa1893ed2a2370028d24221","5fa1893ed2a2370028d24222","5fa1893ed2a2370028d24223","5fa1893ed2a2370028d24224","5fa1893ed2a2370028d24225","5fa1893ed2a2370028d24226","5fa1893ed2a2370028d24227","5fa1893ed2a2370028d24228","5fa1893ed2a2370028d24229","5b34c737e0dca2000311de6a","5fa1893ed2a2370028d2422a","5fa1893ed2a2370028d2422b","5fa1893ed2a2370028d2422c","5fa1893ed2a2370028d2422d","5fa1893ed2a2370028d2422e","5fa1893ed2a2370028d2422f","5fa18956dd369d003cb51fc6"],"_id":"5fa1893ed2a2370028d24282","project":"57336fd5a6a9c40e00e13a0b","__v":1,"forked_from":"5f4d276c4ff932005f3e3b86","createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z"},"createdAt":"2016-06-23T17:55:24.050Z","githubsync":"","__v":0}

BlueSnap Reporting & Tools

Reporting API

Custom Reporting API

3D Secure

Account Updater

Bank Directory

Convert Currency

Embedded Checkout

Encrypt/Decrypt Parameters

Hosted Payment Fields

Logos & Images

Payment Request Button

Retrieve Card Info

Retrieve Payment Methods

Secured Payment Collector

SEPA Direct Debit

User Management

Wallets

param-encryption (resource)

The param-encryption resource contains the parameters to be encrypted in the request and the encrypted string in the response. The encrypted string can then be included in the checkout page URL, as the value of the enc parameter.

Request

Property Name
Type
Required
Description

parameters

container

Required

A container of parameter properties.

Response

Property Name
Type
Description

decrypted-token

string

A string representing a collection of encrypted Hosted Checkout parameters or Hosted Payment Page parameters.