MARS documentation
API reference

Get transfer offer

Contract and client context

Operation: get_transfer_offer · HTTP: GET /v1/transfers/offers/{offer_id}

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": "get_transfer_offer",
  "parameters": [
    {
      "description": "Transfer offer identifier",
      "in": "path",
      "name": "offer_id",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/TransferOffer"
          }
        }
      },
      "description": "Transfer offer"
    },
    "404": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Offer not found"
    }
  },
  "tags": [
    "entries"
  ]
}

Resolve schema references against the complete OpenAPI document. Standalone schemas and hashes are generated from the same checked-in source.

GET/v1/transfers/offers/{offer_id}

Path Parameters

offer_id*string

Transfer offer identifier

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/transfers/offers/string"
{  "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"}