PIpismo
Bulk payment files

Upload bulk file

This endpoint enables you to manage the upload of bulk files along with their corresponding signature data in the request header.

<b>Detailed flow:</b>

  1. The client sends a request with the bulk file as the body and signature in the Signature header. The signature header is formatted as keyId="{key_id}",signature="{signature_base64}". The parameters key_id and signature_base64 are specified in the parameters section.
  2. The server processes the request and responds with a 200 OK status, indicating the file upload request is complete.

For detailed instructions, refer to File signature and encryption.

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

<b>Note</b>: Pismo reserves the right to offer this endpoint only for single-tenant clients, reach out to your Pismo representative for more information.

put/corporate/v1/bulk-payments/{bulkId}

Request

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

Path parameters

bulkIdstring required

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

Headers

signaturestring required

The Signature header includes two fields: keyId and signature. The keyId represents the public key ID used to verify the request, while signature contains the the base64-encoded cryptographic signature of the request body, created using the private key associated with the keyId.

Request body application/octet-stream

string binary required

Response

OK

string required

Ok

Example response

"OK"

Changes

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