Skip to main content
POST
Request delivery details from a vendor

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

vendorId
string
required

ID of the vendor

Body

application/json

Recipient email addresses and optional settings controlling which delivery methods the hosted form offers

emails
string[]

Email addresses to send the request to. When omitted, Nickel emails the addresses on the vendor record.

allowedDeliveryMethods
enum<string>[]

Allow-list of delivery methods the hosted form offers the vendor. WIRE is international wire (SWIFT), for vendors banking outside the US. Must include ACH — bank transfer is always available. Whether CHECK is allowed is saved on the vendor (the dashboard's Require ACH setting) — leaving it out keeps check off for this vendor's later links and for check addresses imported from QuickBooks, and including it turns check back on. Omitting the field keeps the vendor's saved setting — ["ACH", "CHECK"] unless check has been turned off.

Available options:
ACH,
CHECK,
WIRE
plaidRequired
boolean

When true, the vendor must verify their bank account by logging into it through Plaid instead of typing routing and account numbers manually. Defaults to false.

Response

Successful operation

url
string | null