Bulk payment files

Create AES key (encrypted response)

Create an Advanced Encryption Standard (AES) key using bulk ID.<br>

This endpoint uses JSON Web Encryption (JWE) to encrypt the response body at the message level. It takes a public_key_id, which refers to the public key you have already uploaded to the Pismo platform. Pismo uses this key to encrypt the response payload in accordance with the standard JWE protocol. To decrypt the response, you must use the corresponding private key. For information about file encryption and AES keys, refer to the File encryption section in <i>File signature and encryption</i>.

The decrypted plaintext is a JSON object with fields:

{
  "aes_key": "245ca959580cae6317c8f8215cbae42c8b98bbf30d9f222b92db30df81a06f91"
  "iv": "7b75d3b5a25e9651e69245fa844cf3ec"
}

To understand how bulk file payment processing works, refer to the bulk file-based payment processing guide.

put/corporate/v2/bulk-payments/encryption-keys/{bulkId}

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/corporate/v2/bulk-payments/encryption-keys/{bulkId}
  • Auth
    HTTP bearer

Path parameters

bulkIdstring required

ID of the existing bulk payment file. This ID is client-generated.

Request body

public_key_idstring required

ID of the public key. Only digits, letters, hyphens, and underscores are allowed, and cannot exceed 60 characters.

Example request

{
  "public_key_id": "string"
}

Response

Create AES key response

Changes

No recorded changes to this operation across all 1 revision of this API.