Get tax compliance report for all recipients
Get tax compliance report for all recipients
Authorization
apiKey Merchant API key. Publishable keys (pk_test_* / pk_live_) are safe for browser/frontend use and carry a limited scope set (sessions, payment_instruments, customers, orders writes; products, product_prices, payment_links reads). Secret keys (sk_test_ / sk_live_*) grant full admin access and must only be used server-side.
In: header
Query Parameters
501 <= value <= 50000 <= value"not_requested" | "requested" | "received" | "expired" | "verified"Filter recipients whose W-9 expires within 30 days
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://loading/v1/api/treasury/recipients/tax-report"{
"success": true,
"timestamp": "2019-08-24T14:15:22Z",
"data": null,
"message": "string",
"pagination": {
"total": 0,
"limit": 1,
"offset": 0,
"has_more": true,
"truncated": true,
"cursors": {
"first": "string",
"last": "string"
}
}
}{
"success": false,
"timestamp": "2019-08-24T14:15:22Z",
"error": {
"code": "string",
"message": "string",
"details": null
}
}{
"success": false,
"timestamp": "2019-08-24T14:15:22Z",
"error": {
"code": "string",
"message": "string",
"details": null
}
}{
"success": false,
"timestamp": "2019-08-24T14:15:22Z",
"error": {
"code": "string",
"message": "string",
"details": null
}
}Get recipient invitation status (public)
Public endpoint. Resolves a token to its invitation status (valid/expired/accepted/not_found) and, when valid, the company name and recipient name — used by the accept-invite page to render the correct state and merchant branding before the recipient submits anything. Also returns `payment` — the deferred send attached to the invitation as `{ amount_cents, currency, memo }` — for valid and accepted invitations only, and only while the send has not reached a terminal failure; `null` in every other case. Note that `memo` is merchant-authored and recipient-visible.
List recipients
List recipients