01.software Docs

membershipChargeResult

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

All HTTP operations
POST
/api/memberships/{id}/charge-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

Exact preprocessing input, not the normalized output union. Paid valid advisories are strict-unknown fields; malformed advisories are discarded. Unknown non-advisory keys are rejected.

kind*"charge-result"
Value in"charge-result"
idempotencyKey*string
Length1 <= length
membershipId*string
Length1 <= length
status*"paid"
Value in"paid"
amount*integer
Range0 <= value <= 9007199254740991
currency*string
Length3 <= length <= 3
pgPaymentId*string
Length1 <= length
declineCategory?not (string)
declineEvidence?not (MembershipDeclineEvidence)

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/charge-result' \  -H 'x-membership-timestamp: string' \  -H 'x-membership-delivery-id: string' \  -H 'Content-Type: application/json' \  -d '{  "kind": "charge-result",  "idempotencyKey": "string",  "membershipId": "string",  "status": "paid",  "amount": 0,  "currency": "str",  "pgPaymentId": "string"}'
Example Response
{  "received": true,  "duplicate": true}