Onboarding API

Onboarding API

API Documentation

Senest redigeret:

Onboarding is an extension of OnlineFundraising improving the way organisations, telemarketing and F2F agencies work together.

To extract data we kindly refer to our DataSet API with which you can retrieve DataSets assigned with the dataSetType: “onboarding-app” as this example:

{
  "dataSetGuid": "e3bfa46f-41c0-4b5b-bd1f-xxxxxxxxxxxx",
  "merchantId": "xxx",
  "createdTs": "2021-01-22 13:19:39 +0100",
  "updatedTs": "2021-01-22 13:20:38 +0100",
  "jsonElement": {
    "dataSetType": "onboarding-app",
    "session": {
      "sessionGuid": "34b0ef0d-7c44-4cc5-a58c-xxxxxxxxxxxx",
      "createdTs": "2021-01-22 13:19:39 +0100",
      "status": "Processing",
      "serviceType": "SignUpRecurring",
      "completionChannel": "PaymentSessionHandler",
      "metaData": {
        "...": "..."
      },
      "merchantId": "...",
      "agencyId": "...",
      "userGuid": "7dfe0e14-d2d2-4b7d-96ef-xxxxxxxxxxxx",
      "campaignGuid": "704c76a6-2e61-44ff-a471-xxxxxxxxxxxx",
      "workflowGuid": "951bfb01-15c0-40a3-b470-xxxxxxxxxxxx",
      "dataSetGuid": "e3bfa46f-41c0-4b5b-bd1f-xxxxxxxxxxxx",
      "communicationCollectionGuid": "37f61da6-2367-4581-8661-xxxxxxxxxxxx",
      "leadGuid": "abd4cdd5-a0d0-4f93-baf8-xxxxxxxxxxxx",
      "externalLeadId": "...",
      "contactData": {
        "...": "..."
      },
      "agreementData": {
        "name": "...",
        "unit": "pcs",
        "amount": "50.0",
        "amountVat": "0.0",
        "unitPrice": "50.0",
        "amountTotal": "50.0",
        "currencyCode": "DKK",
        "scheduleType": "Monthly",
        "agreementType": "Personal",
        "taxDeductable": true,
        "vatPercentage": "0.0",
        "defaultQuantity": 1,
        "paymentRequired": false,
        "scheduleBaseTier": 2,
        "scheduleFixedDay": 1,
        "scheduleEveryOther": 1,
        "scheduleCalendarUnit": "Month",
        "purposeAccountingCode": "...",
        "communicationCollectionGuid": "37f61da6-2367-4581-8661-xxxxxxxxxxxx"
      },
      "subscriptionData": {
        "startDate": "2021-02-01"
      },
      "paymentMethodData": {
        "paymentMethodType": "MobilePaySubscriptions"
      },
      "paymentSessionGuid": "d25eda89-794e-41d3-a12f-xxxxxxxxxxxx",
      "processingBegunTs": "2021-01-22 13:19:38 +0100"
    },
    "campaign": {
      "campaignGuid": "704c76a6-2e61-44ff-a471-xxxxxxxxxxxx",
      "createdTs": "2021-01-21 09:32:19 +0100",
      "active": true,
      "name": "...",
      "description": "b198572a-c35b-eb11-a812-xxxxxxxxxxxx",
      "firstDate": "2021-01-20 00:00:00 +0100",
      "lastDate": "2021-02-17 00:00:00 +0100",
      "merchantId": "...",
      "agencyId": "...",
      "workflowGuid": "951bfb01-15c0-40a3-b470-xxxxxxxxxxxx"
    },
    "workflow": {
      "workflowGuid": "951bfb01-15c0-40a3-b470-xxxxxxxxxxxx",
      "name": "...",
      "merchantId": "...",
      "createdTs": "2020-04-16 16:27:06 +0200",
      "active": true,
      "serviceType": "SignUp",
      "signUpProducts": [
        {
          "uuid": 0,
          "collapsed": false,
          "amountTotal": "",
          "paymentType": "Recurring",
          "productName": "...",
          "currencyCode": "DKK",
          "agreementName": "...",
          "agreementType": "Personal",
          "taxDeductable": true,
          "paymentRequired": false,
          "scheduleEveryOther": 1,
          "scheduleCalendarUnit": "Month",
          "paymentMethodTypeCard": false,
          "paymentMethodTypeTest": false,
          "purposeAccountingCode": "...",
          "scheduleStartTypeFirst": true,
          "scheduleStartTypeCustom": false,
          "scheduleStartWithOneOff": true,
          "paymentMethodTypeMobilePay": true,
          "communicationCollectionGuid": "37f61da6-2367-4581-8661-xxxxxxxxxxxx",
          "paymentMethodTypeBetalingsservice": true
        },
        {
          "uuid": 1,
          "collapsed": false,
          "paymentType": "Recurring",
          "productName": "...",
          "currencyCode": "DKK",
          "agreementName": "...",
          "agreementType": "Personal",
          "taxDeductable": true,
          "paymentRequired": false,
          "scheduleEveryOther": 1,
          "scheduleCalendarUnit": "Month",
          "paymentMethodTypeCard": false,
          "paymentMethodTypeTest": false,
          "purposeAccountingCode": "...",
          "scheduleStartTypeFirst": true,
          "scheduleStartWithOneOff": true,
          "paymentMethodTypeMobilePay": true,
          "communicationCollectionGuid": "37f61da6-2367-4581-8661-xxxxxxxxxxxx",
          "paymentMethodTypeBetalingsservice": true
        }
      ],
      "contactDataFields": [
        {
          "name": "firstName",
          "uuid": 0,
          "label": "",
          "required": false,
          "hiddenToEndUser": false
        },
        {
          "name": "lastName",
          "uuid": 1,
          "label": "",
          "required": false,
          "hiddenToEndUser": false
        },
        {
          "name": "email",
          "uuid": 2,
          "label": "",
          "required": false,
          "hiddenToEndUser": false
        },
        {
          "name": "msisdn",
          "uuid": 3,
          "label": "",
          "required": false,
          "hiddenToEndUser": false
        },
        {
          "name": "nationalId",
          "uuid": 8,
          "label": "",
          "required": false,
          "hiddenToEndUser": false
        },
        {
          "name": "address",
          "uuid": 4,
          "label": "",
          "required": false,
          "hiddenToEndUser": false
        },
        {
          "name": "postCode",
          "uuid": 5,
          "label": "",
          "required": false,
          "hiddenToEndUser": false
        },
        {
          "name": "city",
          "uuid": 6,
          "label": "",
          "required": false,
          "hiddenToEndUser": false
        },
        {
          "name": "externalId",
          "uuid": 7,
          "label": "",
          "required": false,
          "hiddenToEndUser": false
        }
      ],
      "metaDataFields": [
        {
          "name": "...",
          "uuid": 1,
          "label": "...",
          "value": "...",
          "options": "",
          "readonly": true,
          "required": false,
          "inputType": "text",
          "hiddenToEndUser": false
        }
      ],
      "checkoutMessage": "Hej. Tak for samtalen. Verificerer aftalen ved at tilgå dette link:",
      "urlShortener": "GIIV",
      "senderAlias": "..."
    },
    "formResult": {
      "firstName": "...",
      "lastName": "...",
      "msisdn": "...",
      "externalId": "...",
      "name": "...",
      "phone": "...",
      "aidk_channel": "...",
      "amount": "50",
      "agreementName": "...",
      "communicationCollectionGuid": "37f61da6-2367-4581-8661-xxxxxxxxxxxx",
      "currencyCode": "DKK",
      "paymentType": "Recurring",
      "paymentMethodType": "MobilePay",
      "purposeAccountingCode": "...",
      "taxDeductable": true,
      "paymentTypeTranslated": "Betalingsaftale",
      "recurringStart": "first",
      "recurringFrequency": "monthly",
      "recurringFrequencyTranslated": "Månedligt",
      "recurringStartDate": "2021-02-01",
      "queryString": "..."
    },
    "paymentSessionResult": {
      "paymentMethodTypes": [],
      "paymentSessionGuid": "d25eda89-794e-41d3-a12f-xxxxxxxxxxxx",
      "merchantId": "...",
      "createdTs": "2021-01-22 13:19:39 +0100",
      "state": "Complete",
      "initialUserRedirectUrl": "https://paymentsession.api.v1.onlinefundraising.dk/preWait.html?paymentSessionGuid=d25eda89-794e-41d3-a12f-xxxxxxxxxxxx",
      "redirectToGatewayUrl": "https://open.mobilepay.dk:443/usersettings-landing-website/?token=...&countryCode=DK&product=RecurringPayments",
      "redirectReturnFromGatewayUrl": "https://paymentsession.api.v1.onlinefundraising.dk/postWait.html?paymentSessionGuid=d25eda89-794e-41d3-a12f-xxxxxxxxxxxx",
      "finalRedirectUrl": "https://onboarding.onlinefundraising.dk/result?campaignGuid=704c76a6-2e61-44ff-a471-xxxxxxxxxxxx&externalLeadId=...&paymentSessionGuid=d25eda89-794e-41d3-a12f-xxxxxxxxxxxx&state=Complete&dataSetGuid=e3bfa46f-41c0-4b5b-bd1f-xxxxxxxxxxxx",
      "dataSetGuid": "e3bfa46f-41c0-4b5b-bd1f-xxxxxxxxxxxx",
      "paymentGatewaySubscriptionReferenceId": "...",
      "expectedCallbacksLeft": 0,
      "postProcessedTs": "2021-01-22 13:20:37 +0100",
      "contactGuidResult": "07719262-76c0-4dd4-aff8-xxxxxxxxxxxx",
      "paymentMethodGuidResult": "60959d4e-afba-4740-aa6b-xxxxxxxxxxxx",
      "agreementGuidResult": "392b16a3-7c36-442c-8992-xxxxxxxxxxxx",
      "subscriptionGuidResult": "948c70d9-671c-4255-8629-xxxxxxxxxxxx",
      "sessionOptions": {
        "intent": "CreatePaymentMethod",
        "avoidPopup": true,
        "dataSetGuid": "e3bfa46f-41c0-4b5b-bd1f-xxxxxxxxxxxx",
        "communicationCollectionGuid": "37f61da6-2367-4581-8661-xxxxxxxxxxxx",
        "paymentMethodType": "MobilePaySubscriptions",
        "paymentType": "Recurring",
        "amount": 50.0,
        "currencyCode": "DKK",
        "plan": "...",
        "msisdn": "...",
        "frequency": "Monthly",
        "useBsApi": false,
        "useBsLandingPage": false,
        "callbackUrl": "https://onboarding.api.v1.onlinefundraising.dk/callback/34b0ef0d-7c44-4cc5-a58c-xxxxxxxxxxxx",
        "successReturnPageUrl": "https://onboarding.onlinefundraising.dk/result?campaignGuid=704c76a6-2e61-44ff-a471-xxxxxxxxxxxx&externalLeadId=...",
        "errorReturnPageUrl": "https://onboarding.onlinefundraising.dk/result?campaignGuid=704c76a6-2e61-44ff-a471-xxxxxxxxxxxx&externalLeadId=...",
        "contact": {
          "...": "..."
        },
        "agreement": {
          "name": "...",
          "agreementType": "Personal",
          "defaultQuantity": 1,
          "unit": "pcs",
          "unitPrice": 50.0,
          "amount": 50.0,
          "amountVat": 0.0,
          "amountTotal": 50.0,
          "taxDeductable": true,
          "vatPercentage": 0.0,
          "currencyCode": "DKK",
          "paymentRequired": false,
          "scheduleType": "Monthly",
          "scheduleBaseTier": 2,
          "scheduleFixedDay": 1,
          "scheduleEveryOther": 1,
          "scheduleCalendarUnit": "Month",
          "purposeAccountingCode": "...",
          "dataSetGuid": "e3bfa46f-41c0-4b5b-bd1f-xxxxxxxxxxxx",
          "communicationCollectionGuid": "37f61da6-2367-4581-8661-xxxxxxxxxxxx"
        },
        "subscription": {
          "dataSetGuid": "e3bfa46f-41c0-4b5b-bd1f-xxxxxxxxxxxx",
          "startDate": "2021-02-01"
        }
      }
    }
  }
}