API Docs
API referencePayment requests

Delete a payment request

DELETE/api/v2/payment-requests/{id}

Allowed while status is draft. A finalized request is cancelled instead. A deleted request is gone from the API: every endpoint answers 404 PAYMENT_REQUEST_NOT_FOUND for it, and lists do not include it. Its customId is free again. Needs payment-requests:write.

Path Parameters

id*string

The payment request id (payment_request_…) or your customId.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v2/payment-requests/payment_request_0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e"
{  "object": "payment_request",  "id": "payment_request_0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e",  "deleted": true}

Update a payment request PATCH

Allowed while `status` is `draft`. A body with only `tags` is allowed in every status. An omitted field is unchanged; `payer` is replaced as a whole. Needs `payment-requests:write`.

Finalize a payment request POST

Moves a `draft` to `open`. For a `counterparty` payer, Talentir issues the invoice in your team's name and the response carries it in `invoice`. For an `email` payer, the invoice follows when the payer enters their billing details on `paymentUrl`. Talentir emails nothing; use `send` for that. After this, only `tags` can change, and the request cannot be deleted. Needs `payment-requests:write`.