CreddotDocsCreddot Docs

Request a full or partial collection refund

Creates a REQUESTED refund for admin review. This call never dispatches funds directly.

POST
/api/v1/refunds/transactions/{transactionId}

Creates a REQUESTED refund for admin review. This call never dispatches funds directly.

Authorization

api-key
headerx-api-key<token>

Your API key: ck_test_... for test mode, ck_live_... for live. Send it with x-api-secret (or Authorization: Bearer ).

Path Parameters

transactionId*string

Header Parameters

x-api-secret?string

Recommended: API secret sent over HTTPS. You may send it as Authorization: Bearer instead. If supplied, x-timestamp and x-signature are not required.

x-timestamp?string

Legacy signed mode: Unix time in milliseconds; maximum clock skew five minutes.

x-signature?string

Legacy signed mode: HMAC-SHA256(secret, timestamp.METHOD.url.idempotencyKey.bodyHash).

x-idempotency-key*string

1–128 letters/digits or ._:-. Same key and payload replay for 24 hours; conflicting, in-flight, or expired keys return 409. Never change a key to retry an uncertain payment.

Request Body

application/json
  1. body
amountMinor?string

Positive integer minor units. Defaults to the remaining refundable amount.

reason*string
Length5 <= length <= 500

Response Body

Refund request created.

Example Request
curl -X POST 'https://api.creddot.com/api/v1/refunds/transactions/string' \  -H 'x-idempotency-key: string' \  -H 'Content-Type: application/json' \  -d '{  "reason": "string"}'
Example Response
Empty