Get programme details

Introduction

We recommend implementing a dynamic connection to Programmes, as their number and parameters may change over time. Your application should begin by retrieving the necessary details for the Programme you intend to use when creating a Payment Request.

Get programme details by Id

You can retrieve the details of a specific programme if you already have its identifier.

GET https://api.staging.vitesse.io/v1/payment-initiation/programmes

{
  "ProgrammeId": "e15ac418-dba0-4993-814b-5dba24ff77ad",
  "Status": "Created",
  "Name": "Programme 1",
  "Description": "Description",
  "PaymentLimit": null,
  "EligiblePaymentMethods": [
    "Card"
  ],
  "EligibleAccountIds": null,
  "EligibleAccounts": [
    {
      "AccountId": 123,
      "Name": "Account 1",
      "CurrencyCode": "GBP",
      "MaxAmount": null,
      "MaxAmountCurrencyCode": null
    }
  ],
  "EligibleVerifications": [
    {
      "VerificationMethodType": "Code",
      "IsDefault": true
    },
    {
      "VerificationMethodId": "f917b317-2c90-4eee-bb0f-5c3026b3d741",
      "VerificationMethodType": "Passphrase",
      "IsDefault": false
    }
  ],
  "EligibleTrustMethods": [
    {
      "TrustMethodId": "policy-number",
      "Name": "Policy Number",
      "IsMandatory": true,
      "Instructions": "Instructions"
    }
  ],
  "Branding": {
    "InsurerName": "Insurer name",
    "ClaimAdministratorName": "Administrator name",
    "LogoUrl": "https://test.io/logo.png",
    "Instructions": "Instructions",
    "PhoneNumber": "+44111111111",
    "EmailAddress": "[email protected]",
    "WebUrl": "https://test.io"
  },
  "AdditionalSettings": {
    "LinkExpirationPeriodInDays": 7
  },
  "NotificationSettings": null
}

List all programmes

You can list all available programs to find the best fit in the context of your application.

GET https://api.staging.vitesse.io/v1/payment-initiation/programmes/{id}

Response

{
  "Data": [
    {
      "ProgrammeId": "42ea67d3-30d9-4143-848a-15cd59878ccd",
      "Status": "Active",
      "Name": "Programme 1",
			... all programme parameters...
    },
    {
      "ProgrammeId": "9f3c2a71-bb45-4b0f-ae72-6c82b8f94a13",
      "Status": "Active",
      "Name": "Programme 2",
			... all programme parameters...
    }
		... other programmes...
	]
}