API Reference

Create a Recipient

post
https://connect.sandbox.plastiq.com/api/recipients
Body Params

Recipient to create

string
required
uuid
required
businessAddress
object
required
contact
required
receivingMethod
required
payer
object
biller
object
string

Consumer defined ID that will be attached to this resource

metadata
object

Additional Recipient information to support operational requirements

Headers
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.

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.

string

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

string

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

string

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

string

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

string

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

Responses

Updated about 2 years ago

Language
Credentials
Bearer
token
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 years ago