STstuut
cash-app

Preview Remittance Request Endpoint

Preview Remittance Request

Returns what would happen if a remittance request were sent for this bank transaction, including rendered email preview with actual transaction/customer data. Read-only — no emails are sent and no records are created.

get/v2/cash-app/outreach/remittance-request/preview

Request

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

Query parameters

bank_transaction_idstring required

The bank transaction ID to preview a remittance request for.

partner_idstring required

The partner ID to preview with.

Response

Successful Response

can_sendboolean required
recipient_emailstring nullable required
partner_namestring nullable required
sender_emailstring nullable required
cc_emailsstring[] required
preview_subjectstring nullable required
preview_bodystring nullable required
skip_reasonstring nullable required

Changes

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