Convenient Checkout Internal Webhooks (v2)

Download OpenAPI specification:Download

CCGLeads: CCGLeads@ds.uhc.com Terms of Service

wallet-merchant-service

Webhook events emitted by the Merchant Service for merchant lifecycle actions

merchant-created-event Webhook

Emitted when POST /merchants returns 200 OK. Payload contains the complete merchant profile at the time of creation, including both vendorMerchants[].paymentMethods[] (source of truth) and paymentMethodSettings (computed projection).

Request Body schema: application/json

	object Full merchant profile at the time of the event. type: object (MerchantResponse) nullable: No sourceMapping: Computed — snapshot of merchant state post-save
	object (MerchantGroupData) The merchant group associated with the merchant.

Responses

Request samples

Payload

Content type

application/json

{"merchant": {"id": "9489b357-a0a1-4196-a3c9-1244de090640",
"merchantGroupId": "3cf34cba-ffec-48fb-b7ca-09977db1077a",
"name": "Acme Health",
"vendorMerchants": [{"vendor": "STRIPE",
"vendorMerchantId": "acct_1NiY8rIgxHxRIfDJ",
"paymentMethods": [{"type": "CARD",
"channels": [{"type": "WEBFORM",
"order": 1,
"enabled": true
},
{"type": "APPLE_PAY",
"order": 2,
"enabled": true
},
{"type": "EMAIL",
"order": 3,
"enabled": true
},
{"type": "TEXT",
"order": 4,
"enabled": true
}
],
"cardCategories": [{"type": "MANUFACTURER_CARD",
"label": "Copay Card"
}
]
}
]
},
{"vendor": "OPTUM_BANK",
"vendorMerchantId": "acct_9Z8Y7X6W",
"paymentMethods": [{"type": "BANK_ACCOUNT",
"channels": [{"type": "WEBFORM",
"order": 1,
"enabled": true
}
],
"cardCategories": null
}
]
}
],
"paymentMethodSettings": {"paymentMethod": [{"type": "CARD",
"channels": [{"type": "WEBFORM",
"order": 1,
"enabled": true
},
{"type": "APPLE_PAY",
"order": 2,
"enabled": true
},
{"type": "EMAIL",
"order": 3,
"enabled": true
},
{"type": "TEXT",
"order": 4,
"enabled": true
}
],
"cardCategories": [{"type": "MANUFACTURER_CARD",
"label": "Copay Card"
}
]
},
{"type": "BANK_ACCOUNT",
"channels": [{"type": "WEBFORM",
"order": 1,
"enabled": true
}
],
"cardCategories": null
}
]
},
"settings": {"paymentMetadataKeys": ["accountId",
"checkoutId",
"patientId",
"merchantId"
],
"telephonicEntryEnabled": true,
"payoutReportsEnabled": true,
"senderEmailAddresses": [{"emailAddress": "payments@ccg.optum.com",
"verified": false,
"defaultEmail": true
}
],
"features": {"property1": true,
"property2": false
},
"splitTender": {"enabled": true
}
},
"enterpriseSettings": [{"precedence": 1,
"customerSearchCriteria": [{"value": {"property1": "value1"
},
"merchantSearchKey": "accountId",
"enterpriseSearchKey": "memberId",
"enterpriseValueKey": "memberNumber",
"merchantMetadataKey": "patientId",
"enterpriseResponseSearchPath": "data.members[0].id",
"precedence": 1,
"required": true
}
]
}
],
"clientIds": ["client-123"
],
"merchantAccAdGroup": "merchant-acme-admins"
},
"merchantGroup": {"id": "3cf34cba-ffec-48fb-b7ca-09977db1077a",
"name": "Acme Health Group"
}
}

merchant-updated-event Webhook

Emitted when PATCH /merchants returns 200 OK. Payload contains the complete merchant profile after the update, including both vendorMerchants[].paymentMethods[] (source of truth) and paymentMethodSettings (computed projection).

Request Body schema: application/json

	object Full merchant profile at the time of the event. type: object (MerchantResponse) nullable: No sourceMapping: Computed — snapshot of merchant state post-save
	object (MerchantGroupData) The merchant group associated with the merchant.

Responses

Request samples

Payload

Content type

application/json

{"merchant": {"id": "9489b357-a0a1-4196-a3c9-1244de090640",
"merchantGroupId": "3cf34cba-ffec-48fb-b7ca-09977db1077a",
"name": "Acme Health",
"vendorMerchants": [{"vendor": "STRIPE",
"vendorMerchantId": "acct_1NiY8rIgxHxRIfDJ",
"paymentMethods": [{"type": "CARD",
"channels": [{"type": "WEBFORM",
"order": 1,
"enabled": true
},
{"type": "APPLE_PAY",
"order": 2,
"enabled": true
},
{"type": "GOOGLE_PAY",
"order": 3,
"enabled": true
},
{"type": "EMAIL",
"order": 4,
"enabled": true
}
],
"cardCategories": [{"type": "MANUFACTURER_CARD",
"label": "Copay Card"
}
]
}
]
},
{"vendor": "OPTUM_BANK",
"vendorMerchantId": "acct_9Z8Y7X6W",
"paymentMethods": [{"type": "BANK_ACCOUNT",
"channels": [{"type": "WEBFORM",
"order": 1,
"enabled": true
}
],
"cardCategories": null
}
]
}
],
"paymentMethodSettings": {"paymentMethod": [{"type": "CARD",
"channels": [{"type": "WEBFORM",
"order": 1,
"enabled": true
},
{"type": "APPLE_PAY",
"order": 2,
"enabled": true
},
{"type": "GOOGLE_PAY",
"order": 3,
"enabled": true
},
{"type": "EMAIL",
"order": 4,
"enabled": true
}
],
"cardCategories": [{"type": "MANUFACTURER_CARD",
"label": "Copay Card"
}
]
},
{"type": "BANK_ACCOUNT",
"channels": [{"type": "WEBFORM",
"order": 1,
"enabled": true
}
],
"cardCategories": null
}
]
},
"settings": {"paymentMetadataKeys": ["accountId",
"checkoutId",
"patientId",
"merchantId"
],
"telephonicEntryEnabled": true,
"payoutReportsEnabled": true,
"senderEmailAddresses": [{"emailAddress": "payments@ccg.optum.com",
"verified": false,
"defaultEmail": true
}
],
"features": {"property1": true,
"property2": false
},
"splitTender": {"enabled": true
}
},
"enterpriseSettings": [{"precedence": 1,
"customerSearchCriteria": [{"value": {"property1": "value1"
},
"merchantSearchKey": "accountId",
"enterpriseSearchKey": "memberId",
"enterpriseValueKey": "memberNumber",
"merchantMetadataKey": "patientId",
"enterpriseResponseSearchPath": "data.members[0].id",
"precedence": 1,
"required": true
}
]
}
],
"clientIds": ["client-123"
],
"merchantAccAdGroup": "merchant-acme-admins"
},
"merchantGroup": {"id": "3cf34cba-ffec-48fb-b7ca-09977db1077a",
"name": "Acme Health Group"
}
}