Billing
Human only

Request a refund for one prepaid gift

Human only: A signed-in owner or admin does this in the browser at gtmswag.com. API keys and OAuth connections receive 403 HUMAN_APPROVAL_REQUIRED with a url to hand to that person. For a live prepaid checkout item that is still unused; send the checkout's current financialRevision as expectedRevision. Repeating it returns the same request.

post/campaign-checkouts/{id}/items/{recipientId}/refund

Request

  • Base URL: https://gtmswag.com/api/v1
  • URL: https://gtmswag.com/api/v1/campaign-checkouts/{id}/items/{recipientId}/refund
  • Auth: API key in cookie gtm_session

Path parameters

idstring required

Campaign checkout ID (cbo_).

recipientIdstring required

The item's recipientId from GET /billing/checkouts/{id}/items.

Request body

expectedRevisioninteger required

The checkout's current financialRevision.

Response

Success: {"data": FundingRefundRequest}.

Changes

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