01.software Docs

membershipRefundResult

Use the SDK for application integration. This read-only reference covers Commerce, Customer Auth, Membership and Events.

All HTTP operations
POST
/api/memberships/{id}/refund-result

Tenant delegated HMAC over exact raw bytes with timestamp and delivery ID; body membershipId must exactly equal path id. Missing/foreign membership, wrong delegated method or signature is denied before ledger action. Duplicate deliveries return received=true,duplicate=true; valid response is not independent provider verification.

Authorization

membershipSignature
headerx-membership-signature<token>

HMAC of the exact raw body, timestamp and delivery ID using the tenant delegated billing secret. Requires x-membership-timestamp and x-membership-delivery-id as well; no bearer credential substitutes for this proof.

Path Parameters

id*string

Document ID

Header Parameters

x-membership-timestamp*string
Length1 <= length
x-membership-delivery-id*string
Length1 <= length

Request Body

application/json
  1. body
kind*"refund-result"
Value in"refund-result"
membershipId*string
Length1 <= length
chargeIdempotencyKey*string
Length1 <= length
refundedAmount*integer
Range0 <= value <= 9007199254740991
pgRefundId?string
Length1 <= length
disputed?boolean

Response Body

Actual shaped success body

application/json
  1. response
received*true
Value intrue
duplicate?true
Value intrue

Examples may be generated from schemas; they are illustrative, not recorded successful API calls. Example snippets may omit required authentication headers.

Example Request
curl -X POST 'https://api.01.software/api/memberships/string/refund-result' \  -H 'x-membership-timestamp: string' \  -H 'x-membership-delivery-id: string' \  -H 'Content-Type: application/json' \  -d '{  "kind": "refund-result",  "membershipId": "string",  "chargeIdempotencyKey": "string",  "refundedAmount": 0}'
Example Response
{  "received": true,  "duplicate": true}