Decline transfer offer
Contract and client context
Operation: decline_transfer_offer · HTTP: POST /v1/transfers/offers/{offer_id}/decline
Use an operator-supplied registry base URL. Request execution is disabled in this documentation explorer. Generated request snippets are templates, not signed or authorized submissions.
Exact operation definition
{
"operationId": "decline_transfer_offer",
"parameters": [
{
"description": "Transfer offer identifier",
"in": "path",
"name": "offer_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Required route-scoped idempotency key",
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransferDeclineRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransferOffer"
}
}
},
"description": "Declined transfer offer"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Session missing or invalid"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Recipient or capability mismatch"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Offer expired or already decided"
}
},
"security": [
{
"siwsSession": []
},
{
"siwsCookie": []
}
],
"tags": [
"entries"
]
}Resolve schema references against the complete OpenAPI document. Standalone schemas and hashes are generated from the same checked-in source.
/v1/transfers/offers/{offer_id}/declineOpaque capability-bearing MARS session issued by an enabled authentication profile.
In: header
Path Parameters
Transfer offer identifier
Header Parameters
Required route-scoped idempotency key
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body for declining a transfer offer.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/transfers/offers/string/decline" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{}'{ "createdAt": "2019-08-24T14:15:22Z", "entryDid": "string", "entrySequence": 0, "expiresAt": "2019-08-24T14:15:22Z", "offerId": "string", "ownerDid": "string", "ownerSignature": { "algorithm": "string", "created": "string", "keyId": "string", "value": "string" }, "recipientDid": "string", "status": "offered"}