Create a Client Secret for use with Connect Workflows

post

https://connect.sandbox.plastiq.com/api/v2/client-secrets

Body Params

Include a payerId to initialize a workflow for a specific payer. Omit the payerId to initialize a workflow starting with payer creation. The Client Secret expires after 30 minutes.

payer

object

Headers

Trace-Id

string

A valid UUID (V4) for tracing requests. Will be returned as a header. If not present or invalid, a generated UUID will be returned.

End-User-Agent

string

A string representing the User Agent of the end user. Recommended for compliance. Required only when the request is not coming from the end user's browser.

End-User-Ip

string

The IP address of the end user. Recommended for compliance.

End-User-OS

string

The Operating System of the end user. Recommended for compliance.

End-User-Device-Id

string

A unique identifier for the end user's device. Recommended for compliance.

End-User-Device-Manufacturer

string

The manufacturer of the device used by the end user. Recommended for compliance.

End-User-Device-Model

string

The device model used by the end user. Recommended for compliance.

Responses

200Client Secret created successfully

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error