Skip to main content

Documentation Index

Fetch the complete documentation index at: https://api.corpay.com/llms.txt

Use this file to discover all available pages before exploring further.

Fleet API offers three webhook types to help you keep your systems up to date without polling: card status updates, card creation, and card replacement. Each webhook follows the same pattern: first, you register a target URL using a dedicated POST endpoint, and when you no longer need updates, you remove the subscription with the matching DELETE endpoint. The separate notification pages describe the payload sent to your endpoint for each event type.  
  1. Use card status update webhooks when you need to react to lifecycle changes such as a card being activated or blocked. These subscriptions are registered per cardIdentifier, so each card must be subscribed separately. The notification payload includes the card identifier, the previous and new status, and the timestamp of the change.  
  2. Use card creation webhooks when you want to receive the details of newly created cards automatically after an order is placed. Registration is based on customerAccountNumber and orderReference, and the docs note that it should be done immediately after card order because processing completes quickly. The notification includes the customer account number and a cards array with card details such as cardIdentifier, status, driver, vehicle, restrictions, products, and delivery information.  
  3. Use card replacement webhooks when you need to keep internal or customer-facing systems aligned after a card has been replaced. These subscriptions are also created per original cardIdentifier. The notification includes both the original cardIdentifier and the newCardIdentifier, together with the replacement card details.  
Across all three webhook types, registration supports a target_url, optional HMAC signing, and max_retries. If HMAC was enabled during registration, the de-registration request also requires the HMAC settings. The card-creation and card-replacement registration pages also note fallback APIs for retrieving the same data if a webhook response is missed.