Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    ClientKey ClientKey Route
  • Response Parameters

    View Response Codes
    Name Type Description
    Instructions FundingInstructionResponse [] Collection of Funding Instruction response type
  • Request Example

    Request URL
    GET /partnerintegration/v1/fundinginstructions/{ClientKey}
  • Response Example

    Response body
    {
      "Instructions": [
        {
          "AccountKey": "-TGN6RMFpRj4YKsR5JsB2A==",
          "PeriodicTransfers": [
            {
              "Amount": 10,
              "Currency": "USD",
              "EndDate": "2024-12-01T00:00:00Z",
              "FromAccount": "TEST_ACC_1",
              "FromAccountName": "Test Account 1",
              "FromAccountType": "TEST_TYPE",
              "Interval": "1y",
              "ReferenceId": "123REF",
              "StartDate": "2024-01-01T00:00:00Z"
            },
            {
              "Amount": 100,
              "Currency": "DKK",
              "EndDate": "2025-12-01T00:00:00Z",
              "FromAccount": "TEST_ACC_2",
              "FromAccountName": "Test Account 2",
              "FromAccountType": "TEST_TYPE",
              "Interval": "1m",
              "ReferenceId": "456REF",
              "StartDate": "2024-01-01T00:00:00Z"
            }
          ],
          "SubAccountAllocation": [
            {
              "AccountKey": "fDuBSI7De78mg1nnONi4ag==",
              "Allocation": 50,
              "AllocationUnit": "Amount"
            },
            {
              "AccountKey": "s7SOpbxiM0nCMWMBxwU1RA==",
              "Allocation": 50,
              "AllocationUnit": "Amount"
            }
          ]
        }
      ]
    }