Confirm a retailer claim payout

Requires Authorization: Bearer

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

API preview — rollout pending

This contract is published for integration planning. These endpoints are not yet deployed or enabled for partner use. Mulberry will confirm availability separately for staging and production.

See Submit claims through the API for authorization, examples, retries, and payout reconciliation.

Path Params
string
required

Mulberry claim UUID returned in data.id or CLAIM_UPDATE data.claim.id.

Body Params
string
required
length between 1 and 128

Your stable payment reference, unique across all claims for this retailer. Reuse it and identical payment details after any timeout.

string
required
^(0|[1-9][0-9]{0,7})\.[0-9]{2}$

Positive amount with exactly two decimal places, encoded as a string. Must equal the full authorized payout_amount; partial and additional payouts are not supported.

string
required
^[A-Z]{3}$

Three-letter uppercase currency, exactly matching the claim.

date-time
required

ISO 8601 timestamp with timezone when the customer was paid. Must be on or after retailer_payout_authorized_at and at most five minutes in the future.

Responses

400

Invalid JSON, field, query, attachment or multipart request. Extra input fields are rejected.

401

Missing or invalid private retailer bearer token.

403

Private retailer token required or the separate partner claims API access has not been enabled by Mulberry.

404

Claim, warranty or covered item not found within this retailer's visible orders.

409

Claim not approved for retailer payout, amount/currency does not match, payment reference reused with different details, or claim already has a different final payout confirmation.

413

Entire request exceeds 10 MiB (including multipart overhead).

503

Temporary storage/conversion failure or another request is processing this claim. Retry the identical request with backoff; do not change external_claim_id.

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json