STstuut
cash-app

Send Remittance Request Endpoint

Send Remittance Request

Sends a remittance request email for the given bank transaction. Creates a CashAppOutreach record tracking the result. Accepts optional custom subject and body to override template.

post/v2/cash-app/outreach/remittance-request

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

subjectstring required
bodystring required
bank_transaction_idstring required

Bank transaction ID this email is about

partner_idstring required

Partner ID to send email to

email_sender_idstring nullable

Optional email sender ID to use. If not provided, uses the user's default email sender.

recipient_emailsstring[] nullable

Addresses to send the request to.

recipient_emailstring nullable

Deprecated: use recipient_emails. Read only when recipient_emails is omitted.

cc_emailsstring[] nullable

Explicit CC list. When provided, overrides the default (template CCs + assignee). Omit to fall back to defaults.

Response

Successful Response

created_atstring date-time required
modified_atstring date-time nullable required
idstring required
outreach_type'payment_receipt' | 'remittance_request' required
status'pending' | 'suggested' | 'sent' | 'failed' | 'skipped' required
skip_reasonstring nullable required

The reason the outreach was skipped, if applicable.

bank_transaction_idstring nullable required

The bank transaction this outreach is associated with (used for remittance requests).

payment_idstring nullable required

The payment this outreach is associated with.

partner_idstring required

The partner this outreach is sent to.

email_idstring nullable required

The email record created for this outreach, if sent.

objectstring required

String representing the object's type. Objects of the same type share the same value.

Changes

No recorded changes to this operation across all 1 revision of this API.