Create a Recipient

post

https://connect.sandbox.plastiq.com/api/recipients

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Recipient to create

businessName

string

required

categoryId

uuid

required

businessAddress

object

required

contact

required

receivingMethod

required

payer

object

biller

object

externalId

string

^[-a-zA-Z0-9_~.]*$

Consumer defined ID that will be attached to this resource

metadata

object

Additional Recipient information to support operational requirements

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

`businessAddress` is rejected, `errors[0].field` is
`businessAddress` and `errors[0].details` describes the reason. `errors` contains a single item; if
more than one address problem is found, they are combined in that one `details` string. Other rejected
requests return the generic `Bad request` details without `field`.

`details` is informational and may change; rely on `errors[0].field` to identify the field to fix. It
uses internal field names: `addressLine1` = `line1`, `stateOrProvince` = `state`, `zip` = `postalCode`.

Address Line 1 (`businessAddress.line1`) rules include:

At least 2 characters (any country).

When `businessAddress.country` is `US`, at least one letter (A-Z), e.g. `12345` and `#100` are rejected.

200Recipient created successfully

401Unauthorized

403Forbidden

500Internal Server Error