Purchases

Issue a full or partial refund for a purchase. Roles: admin.

Changed on
post/api/purchases/{purchaseId}/refund

Request

  • Base URL
    https://api.mobilecoach.org (the document declares no server; this is the origin it was published from)
  • URL
    https://api.mobilecoach.org/api/purchases/{purchaseId}/refund
  • Auth
    AuthToken (a scheme the document does not define)

Path parameters

purchaseIdinteger required

Query parameters

localestring

Request body */*

refundAmountinteger required

Response

OK

successboolean
errorstring

Changes

  • 6e5d224eed9bRevision changes
    • warning

      added the new AGE enum value to the ///// response property for the response status

    • warning

      added the new GREATER_THAN_OR_EQUALS enum value to the ///// response property for the response status

    • warning

      added the new LESS_THAN_OR_EQUALS enum value to the ///// response property for the response status

  • 887e7398ca4aRevision changes
    • info

      added the optional property ///// to the response with the status