Submit a transfer proposal

post

https://api.preview.overledger.dev/satp-sandbox/transfer/proposal

Allows the initiating gateway to send a transfer proposal.

Body Params

version

string

required

SAT protocol Version (major, minor).

messageType

string

enum

required

The type of message, fixed to 'urn:ietf:satp:msgtype:transfer-proposal-msg'.

Allowed:

sessionId

string

required

A unique identifier chosen by the client to identify the current session.

transferContextId

string

required

A unique identifier used to identify the current transfer session at the application layer.

transferInitClaim

object

required

The set of artifacts and parameters as the basis for the current transfer. Set up during the transfer initialization stage.

transferInitClaimFormat

string

required

The format of the transfer initialization claim.

gatewayAndNetworkCapabilities

object

required

The set of origin gateway and network parameters reported by the client to the server.

clientSignature

string

required

The client's signature over the message.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Transfer proposal message recieved

400Bad request

500Internal server error