Plastiq
API integration

create_a_plastiq_payment_method

Create a Plastiq payment method (Bank Account or Card) for a payer. Returns the created payment method including id, type, status, data, externalId, and statusReasons. Required: type, data.

list_all_plastiq_payment_methods

List Plastiq payment methods for a payer. Returns payment method records including id, type, status, data, externalId, and statusReasons. Required: payerId.

get_single_plastiq_payment_method_by_id

Retrieve a single Plastiq payment method by id. Returns the payment method object including id, type, status, data, externalId, and statusReasons. Required: id, payerId.

update_a_plastiq_payment_method_by_id

Update a Plastiq payment method by id. Returns the updated payment method including id, type, status, data, externalId, and statusReasons. Required: id, type, data, payer.

create_a_plastiq_recipient

Create a plastiq Recipient for payment disbursement via ACH, EFT, Check, or Wire. Returns: id, status, createdAt, businessName, contact, receivingMethod. Required: contact (with at least email or phone) and receivingMethod (with type). Supply payer.id to scope the recipient to a single payer.

list_all_plastiq_recipients

List plastiq Recipients associated with a given payer. Returns per recipient: id, businessName, contact, receivingMethod, status, createdAt. Required: payerId.

get_single_plastiq_recipient_by_id

Get a single plastiq Recipient by id. Returns: id, businessName, contact, receivingMethod, status, createdAt. Required: id. Optionally filter by payerId to resolve payer-scoped recipients.

update_a_plastiq_recipient_by_id

Update an existing plastiq Recipient by id using partial (PATCH) semantics — supply only the fields to change. Returns: id, businessName, contact, receivingMethod, status, createdAt. Required: id.

list_all_plastiq_categories

List all supported Recipient Categories in Plastiq Connect. Returns category objects with vendor-specific fields; consult the Plastiq Connect docs for the full field-level breakdown. Categories are read-only — they cannot be created, updated, or deleted.

create_a_plastiq_client_secret

Create a plastiq Client Secret for authenticating requests from the browser with prebuilt widgets or the Connect Workflows Checkout experience. Optionally scope the secret to an existing Payer by supplying payer.id; omit the body entirely to create a non-scoped secret. Returns: payer. Client Secrets expire 30 minutes after creation.

plastiq_billers_search

Search Plastiq billers by business name. Returns a list of biller groups each containing groupId and a billers array of individual biller records with id, businessName, groupId, businessAddress, and categoryId. Required: name.

get_single_plastiq_biller_by_id

Get a single Plastiq biller by id. Returns the biller record including id, businessName, groupId, businessAddress (with line1, city, state, postalCode, country), and categoryId. Required: id.

list_all_plastiq_billers

List Plastiq billers by business name. Returns a list of biller groups each containing groupId and a billers array of individual biller records with id, businessName, groupId, businessAddress, and categoryId. Required: name.

create_a_plastiq_document

Upload a document to Plastiq and receive a pre-signed S3 upload URL for the file. Returns: uploadURL and metadata (containing AWS signing fields such as Key, bucket, and X-Amz-Signature). Required: type, fileType, filename, payer.

create_a_plastiq_payer

Create a new payer in plastiq. Returns the created payer including id, externalId, businessName, contact, businessAddress, createdAt, status, hasIdentityDocuments, identityDocuments, and metadata. Required: contact (must supply either email or phone).

get_single_plastiq_payer_by_id

Retrieve a single plastiq payer by id. Returns the payer object including id, externalId, businessName, contact, businessAddress, createdAt, status, hasIdentityDocuments, identityDocuments, and metadata. Required: id.

update_a_plastiq_payer_by_id

Update an existing plastiq payer by id. Returns the updated payer object including id, externalId, businessName, contact, businessAddress, createdAt, status, hasIdentityDocuments, identityDocuments, and metadata. Required: id.

create_a_plastiq_payment

Create a plastiq payment from a Payment Intent — reference an existing intent by paymentIntent.id, or supply paymentMethod and recipient for inline intent creation. Returns: id, status, sourceAmount, targetAmount, fees, deliveryDate, createdAt, statusReasons. Required: payer.

list_all_plastiq_payments

List plastiq payments for a given payer. Returns: id, status, sourceAmount, targetAmount, fees, deliveryDate, createdAt per payment. Required: payerId.

get_single_plastiq_payment_by_id

Get a single plastiq payment by id. Returns: id, status, sourceAmount, targetAmount, fees, details, deliveryDate, createdAt, statusReasons, sourceDescriptor, targetDescriptor. Required: id, payerId.

create_a_plastiq_payment_refund

Create a refund or cancellation for an existing plastiq payment. Returns: status (REFUNDED or REFUND_FAILED) indicating whether the refund succeeded. Required: payment_id, payer.

create_a_plastiq_payment_intent

Create a Plastiq payment intent, staging a payment for execution. Returns the created intent including id, status, sourceAmount, targetAmount, fees, paymentMethod, recipient, payer, deliveryDate, createdAt, expiresAt, deliveryOptions, details, warnings, and statusReasons. Required: paymentMethod, recipient, payer.

get_single_plastiq_payment_intent_by_id

Retrieve a single Plastiq payment intent by id. Returns the full payment intent including id, status, sourceAmount, targetAmount, fees, paymentMethod, recipient, payer, details, warnings, statusReasons, deliveryDate, createdAt, expiresAt, and deliveryOptions. Required: id, payerId.

update_a_plastiq_payment_intent_by_id

Update a Plastiq payment intent by id. Returns the updated intent including id, status, sourceAmount, targetAmount, fees, paymentMethod, recipient, payer, details, warnings, statusReasons, deliveryDate, createdAt, expiresAt, and deliveryOptions. Required: id.

list_all_plastiq_webhooks

List Plastiq webhook notifications, optionally filtered by date range. Returns each notification's payload (containing id, event, and data sub-fields such as object, state, timestamp, and payer) and status. Use startDate and endDate to narrow results.

create_a_plastiq_single_use_client_secret

Create a single-use Client Secret in plastiq to be shared with a browser widget for tokenizing sensitive data such as credit card numbers. Returns: clientSecret. Required: payer. The secret expires after 60 seconds.