Skip to main content
Version: Next

TransferRequestMessageSchema

@typestringrequired
Example: TransferRequestMessage
consumerPidstringrequired
Example: consumer-pid-123
agreementIdstringrequired
Example: agreement-id-456
formatstringrequired
Example: application/json
dataAddress object
@typestringrequired
Example: DataAddress
endpointTypestringrequired
Example: http
endpointstringrequired
Example: https://api.example.com
endpointProperties object[]
  • Array [
  • @typestringrequired
    Example: EndpointProperty
    namestringrequired
    Example: endpointName
    valuestringrequired
    Example: endpointValue
  • ]
  • callbackAddressstringrequired
    Example: https://callback.example.com
    TransferRequestMessageSchema
    {
    "@type": "TransferRequestMessage",
    "consumerPid": "consumer-pid-123",
    "agreementId": "agreement-id-456",
    "format": "application/json",
    "dataAddress": {
    "@type": "DataAddress",
    "endpointType": "http",
    "endpoint": "https://api.example.com",
    "endpointProperties": [
    {
    "@type": "EndpointProperty",
    "name": "name",
    "value": "value"
    }
    ]
    },
    "callbackAddress": "https://callback.example.com"
    }