Onboarding API

Onboarding API

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” as this example:

{
    "dataSetGuid": "4e6c4a00-314f-4370-b6c5-xxxxxxxxxxxx",
    "merchantId": "onlinefundraising",
    "createdTs": "2022-07-12 09:00:14 +0200",
    "updatedTs": "2022-07-12 09:00:39 +0200",
    "sourceType": "onboarding",
    "sourceGuid": "86338d0c-5c08-4312-85c6-xxxxxxxxxxxx",
    "isTransactional": true,
    "isThirdParty": false,
    "jsonElement": {
        "workflow": {
            "workflowGuid": "42b7b297-4589-42cf-867f-xxxxxxxxxxxx",
            "name": "Callcenter",
            "merchantId": "onlinefundraising",
            "createdTs": "2020-09-21 13:56:04 +0200",
            "active": true,
            "serviceType": "SignUp",
            "signUpProducts": [
                {
                    "uuid": 0,
                    "collapsed": false,
                    "paymentType": "Recurring",
                    "productName": "Membership",
                    "currencyCode": "DKK",
                    "scheduleType": "Monthly",
                    "agreementName": "Membership",
                    "agreementType": "Personal",
                    "taxDeductable": false,
                    "paymentRequired": false,
                    "expiresAfterDate": {},
                    "scheduleEveryOther": 1,
                    "agreementDescription": "Mange tak for din støtte.",
                    "scheduleCalendarUnit": "Month",
                    "paymentMethodTypeCard": false,
                    "paymentMethodTypeTest": false,
                    "scheduleStartTypeFirst": true,
                    "scheduleStartTypeCustom": false,
                    "paymentMethodTypeMobilePay": true,
                    "communicationCollectionGuid": "403fa411-aefb-49bd-b499-xxxxxxxxxxxx",
                    "paymentMethodTypeBetalingsservice": true
                }
            ],
            "contactDataFields": [
                {
                    "name": "firstName",
                    "uuid": 0,
                    "label": "Fornavn",
                    "required": true,
                    "hiddenToEndUser": false
                }
            ],
            "metaDataFields": [
                {
                    "name": "Underskriftsindsamling",
                    "label": "Underskriftsindsamling",
                    "value": "Yes",
                    "options": "",
                    "readonly": false,
                    "required": false,
                    "inputType": "hidden"
                }
            ],
            "checkoutMessage": "Hej, Tak for din interesse og opbakning.",
            "urlShortener": "GIIV",
            "senderAlias": "OF"
        },
        "campaign": {
            "campaignGuid": "e793c63e-a8c0-452a-8070-xxxxxxxxxxxx",
            "createdTs": "2020-09-22 11:54:12 +0200",
            "active": true,
            "name": "Intern - Kanvas ",
            "firstDate": "2020-10-01 00:00:00 +0200",
            "lastDate": "2023-01-01 00:00:00 +0100",
            "merchantId": "onlinefundraising",
            "agencyId": "callcenter",
            "workflowGuid": "42b7b297-4589-42cf-867f-xxxxxxxxxxxx"
        },
        "session": {
            "sessionGuid": "fdbb744f-f241-49f2-98c3-xxxxxxxxxxxx",
            "createdTs": "2023-02-10 13:44:59 +0100",
            "status": "Completed",
            "serviceType": "SignUpRecurring",
            "completionChannel": "PaymentSessionHandler",
            "merchantId": "onlinefundraising",
            "agencyId": "callcenter",
            "userGuid": "8cc2119d-486b-4f4d-96cd-xxxxxxxxxxxx",
            "userName": "John",
            "campaignGuid": "e793c63e-a8c0-452a-8070-xxxxxxxxxxxx",
            "workflowGuid": "42b7b297-4589-42cf-867f-xxxxxxxxxxxx",
            "leadGuid": "cd150cbb-9d73-450c-ac05-xxxxxxxxxxxx",
            "externalLeadId": "xxxxxxxxxxxx",
            "contactData": {
                "firstName": "John"
            },
            "agreementData": {
                "name": "Membership",
                "unit": "pcs",
                "state": "Available",
                "amount": "75.00",
                "amountVat": "0.00",
                "unitPrice": "75.00",
                "amountTotal": "75.00",
                "description": "Mange tak for din støtte.",
                "currencyCode": "DKK",
                "scheduleType": "Monthly",
                "agreementType": "Personal",
                "taxDeductable": false,
                "vatPercentage": "0.00",
                "defaultQuantity": 1,
                "paymentRequired": false,
                "scheduleBaseTier": 3,
                "scheduleFixedDay": 1,
                "scheduleEveryOther": 1,
                "scheduleCalendarUnit": "Month",
                "communicationCollectionGuid": "403fa411-aefb-49bd-b499-xxxxxxxxxxxx"
            },
            "subscriptionData": {
                "startDate": "2023-03-01"
            },
            "paymentMethodData": {
                "paymentMethodType": "Betalingsservice"
            },
            "metaData": {
                "Underskriftsindsamling": "Yes"
            },
            "completedTs": "2023-02-10 13:45:43 +0100",
            "dataSetGuid": "60bbdc9c-1f2e-49ef-9448-xxxxxxxxxxxx",
            "communicationCollectionGuid": "403fa411-aefb-49bd-b499-xxxxxxxxxxxx",
            "paymentSessionGuid": "08a18891-3672-4e8e-868e-xxxxxxxxxxxx"
        },
        "formResult": {
            "name": "John Doe",
            "email": "john.doe@yourdomain.tld",
            "Underskriftsindsamling": "Yes"
        },
        "formFields": [
            {
                "inputType": "text",
                "label": "Name",
                "name": "name",
                "value": "John Doe"
            },
            {
                "inputType": "email",
                "label": "Email",
                "name": "email",
                "value": "john.doe@yourdomain.tld"
            },
            {
                "inputType": "text",
                "label": "Underskriftsindsamling",
                "name": "Underskriftsindsamling",
                "value": "Yes"
            }
        ],
        "paymentSessionResult": {
            "postProcessedTs": "2019-12-31 15:59:59 +0100",
            "postProcessingErrorTs": "2019-12-31 15:59:59 +0100",
            "postProcessingErrorDescription": "",
            "contactGuidResult": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
            "paymentMethodGuidResult": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
            "agreementGuidResult": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
            "subscriptionGuidResult": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
            "paymentGuidResult": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx"
        }
    }
}

 

Was this article helpful?

0 out of 0 found this helpful