Batched Boarding Results Webhook

Summary

Understanding when an application has successfully boarded, or received errors when attempting to board, helps the application process move smoothly. No matter how many boarding services you have configured, this webhook fires one time to encompass all boarding results.

NOTE: This webhook will trigger when all the boarding service results have completed.


Response Schema

FieldTypeDescription
MerchantApplicationIdIntegerThe merchant application id
InfiniceptApplicationIdStringThe merchant application UUID created by Infinicept
InfiniceptMerchantIdentifierStringThe merchant application UUID created by Infinicept
ExternalApplicationIdStringThe unique id created by the Payfac and set when the merchant application is created via API.
ExternalApplicationIdentifierStringThe unique id created by the Payfac and set when the merchant application is created via API.
MerchantIdentifierStringThis field will either match the ExternalApplicationIdentifier or MerchantApplicationId if ExternalApplicationIdentifier is null.
ApplicationStatusStringValues include 1 = Approved, 2 = Acquirer Review, and 7 = Approved and Boarded.
ApplicationStatusLabelStringValues include Approved, Acquirer Review, and Approved and Boarded.
BoardingResultsURLString
BoardingResultsArray
BoardingServiceTitleStringThe title of the boarding service.
StatusIntegerThe boarding status. Values include 1 = WaitingOnResponse, 2 = NeedsAttention, 3 = Declined, and 4 = Completed.
BoardingResults.DetailsObjectContains the details of the processor boarding attempt. See the examples of processor-specific details in the table below.

Worldpay Details

FieldTypeDescription
FUSERStringThe email address used to fill out the application
COMPLETEDIntegerIndicates whether or not the boarding was successful
BOARDINGREASONStringThe boarding reason
MIDIntegerThe merchant identifier
REQUESTIDStringThe unique Worldpay request id. The can be sent to Worldpay for troubleshooting assistance.
OutgoingRequestJSONStringThe request that was sent to Worldpay
RESOURCEIDString
FUNDINGSCHEDULEStringThe merchant application's funding configuration
ECHECKCOMPANYNUMBERStringThe eCheck Company Number is supplied when eCheck VAS is enabled
PROCESSED_DATETIMEStringThe date and time stamp the application was processed
GATEWAYIDIntegerWorldpay's unique account id
ACCOUNTTOKENStringThe Worldpay secret token used for authentication
ACCEPTORIDIntegerThe Worldpay Express AcceptorID, which is required processing Express transactions. This is usually the same value as the MID.


Example Response

The example webhook response below describes a merchant application that has successfully boarded to Worldpay (previously Vantiv Core) and to Infinicept's Backoffice platform.

{
	"MerchantApplicationId": 3699,
	"InfiniceptApplicationId": "d52a00ac-46e4-4884-9010-bb00c29cded8",
	"InfiniceptMerchantIdentifier": "d52a00ac-46e4-4884-9010-bb00c29cded8",
	"ExternalApplicationId": null,
	"ExternalApplicationIdentifier": null,
	"MerchantIdentifier": "3699",
	"ApplicationStatus": 7,
	"ApplicationStatusLabel": "ApprovedAndBoarded",
	"BoardingResultsURL": "https://dev.merchantapp.io/coreboarding/CoBrands/MerchantUW?applicationId=3699",
	"BoardingResults": [
		{
			"BoardingServiceTitle": "Vantiv Core",
			"Status": 4,
			"Details": {
				"FUSER": "[email protected]",
				"COMPLETED": "1",
				"BOARDINGREASON": "Successfully boarded.",
				"MID": "4445035948975",
				"REQUESTID": "e9d0d70b-abb0-4545-b0ba-18282ff0f56e",
				"OutgoingRequestJSON": "{\"id\":null,\"mid\":null,\"uuid\":\"9fc066bf-67ad-473d-8a67-7d6e6098298d\",\"chainCode\":\"123ABC\",\"federalTaxId\":\"111111111\",\"legalName\":\"A Good Merchant\",\"dbaName\":\"Child 3\",\"billingDescriptor\":\"ABC*A Good Merchant3\",\"ownershipType\":\"LLC\",\"businessType\":\"Restaurant\",\"mccCode\":\"1234\",\"businessEstablishedDate\":\"2000-01-01\",\"websiteUrl\":\"http://www.infinicept.com\",\"owners\":[{\"type\":\"ControlOwner\",\"title\":\"\",\"firstName\":\"Karen\",\"middleInitial\":\"L\",\"lastName\":\"Johnson\",\"phoneNumber\":\"3023622542\",\"phoneNumberExt\":null,\"faxNumber\":null,\"email\":\"[email protected]\",\"ownershipPercentage\":null,\"ssn\":\"111111111\",\"dob\":\"1985-09-26\",\"addressLine1\":\"2216 Archwood Avenue\",\"addressLine2\":\"Unit 401C\",\"city\":\"Rock Springs\",\"state\":\"WY\",\"postalCode\":\"82901\",\"postalCodeExtension\":null,\"issuedIds\":null,\"country\":\"US\"}],\"contacts\":[{\"type\":\"CustomerService\",\"title\":null,\"firstName\":\"Karen\",\"middleInitial\":\"E\",\"lastName\":\"Johnson\",\"phoneNumber\":\"3023622542\",\"phoneNumberExt\":\"1234\",\"email\":\"[email protected]\",\"faxNumber\":null}],\"addresses\":[{\"type\":\"Physical\",\"addressLine1\":\"2216 Archwood Avenue\",\"addressLine2\":\"Unit 401C\",\"city\":\"Rock Springs\",\"state\":\"WY\",\"postalCode\":\"82901\",\"postalCodeExtension\":null,\"country\":\"US\"}],\"defaultBankAccount\":{\"accountNumber\":\"123123123\",\"routingNumber\":\"234234234\"}}",
				"RESOURCEID": "110276963",
				"FUNDINGSCHEDULE": "PayfacFunded",
				"ECHECKCOMPANYNUMBER": "436957",
				"__PROCESSED_DATETIME__": "3/27/2020 5:42:04 PM",
				"GATEWAYID": "1059511",
				"ACCOUNTTOKEN": "EEFC646B331CA86ADEF40D001ABF26D3EBB39C9DE022E75D4FE0E25F76C36B92B59B7201",
				"ACCEPTORID": "4445035948975"
			}
		},
		{
			"BoardingServiceTitle": "Infinicept BackOffice",
			"Status": 4,
			"Details": {
				"FUSER": "[email protected]",
				"COMPLETED": "1",
				"BOARDINGREASON": "Successfully boarded.",
				"__PROCESSED_DATETIME__": "3/27/2020 5:43:06 PM",
				"OUTGOINGJSON": "",
				"APIRESPONSE": "{\"commandFingerprint\":\"05847c74-1295-4151-9615-3570e8e3126a\",\"status\":0,\"createTime\":\"2020-03-27T17:43:14.7245269+00:00\",\"endTime\":null,\"error\":null,\"message\":null}",
				"APISTATUSCODE": "OK"
			}
		}
	]
}