Skip to main content

Get Disbursement Options Response

This endpoint is initiated by the Disbursement partner on the LA as a response to Get Disbursement Options returning all Disbursement Products available.

Request Body
metadata object REQUIRED

Metadata specific to each API request.

version string REQUIRED
originatorOrgId string

The organisation id on the Participant Registry.

originatorParticipantId string

The participant id on the Participant Registry. This will be different for every role under the same organisation.

timestamp string REQUIRED
traceId string REQUIRED
requestId string REQUIRED

UUID used to tie request and response and for idempotency

productData object REQUIRED

Product Metadata specific to each API request.

productId string REQUIRED

The product id on the Product Registry.

productNetworkId string

The product network id on the Product Registry.

productId string
disbursementProducts object[]
id string REQUIRED
name string REQUIRED
description string REQUIRED
price string REQUIRED
thumbnail string
images string[]
tags string[]
currency string REQUIRED
quantity object
value string
unit string
Responses
200

Acknowledgement of Request Received

Schema OPTIONAL
error string
traceId string
timestamp string