# Corpay Platform

## Docs

- [Access transaction data only](https://api.corpay.com/access-transaction-data-only.md)
- [AI-driven development](https://api.corpay.com/ai-driven-development.md)
- [Block a card](https://api.corpay.com/api-reference/card/block-a-card.md): Temporarily block the card.
- [Cancel a card](https://api.corpay.com/api-reference/card/cancel-a-card.md): Cancel the card permanently.
- [Get a card](https://api.corpay.com/api-reference/card/get-a-card.md): Retrieve a single card by its Corpay card identifier.
- [Get replaced card details](https://api.corpay.com/api-reference/card/get-replaced-card-details.md): Given an old card identifier, return the new card identifier and card details after replace card request has been done.  This API can be used in case of failure obtaining data from webhook for replaced card.
- [Lodge a card into app](https://api.corpay.com/api-reference/card/lodge-a-card-into-app.md): Lodge a physical card into the app and obtain the EV card number, keyIdentifier, and cardNumber. Lodging of card will be done based on provided visual card number.
- [Order cards](https://api.corpay.com/api-reference/card/order-cards.md): Order one or more cards for a customer. The process is asynchronous and returns an order reference. The identifiers required in this request can be obtained from the Master Data APIs. The Card Order process will take up to 24-36 hrs to complete the order.
- [Replace a card](https://api.corpay.com/api-reference/card/replace-a-card.md): Block and replace a card, optionally modifying card parameters. If card parameters are not provided, the replaced card contains exact same properties as original card.
- [Request PIN reprint](https://api.corpay.com/api-reference/card/request-pin-reprint.md): Request a PIN letter reprint to the supplied card delivery address.
- [Search cards](https://api.corpay.com/api-reference/card/search-cards.md): Search for cards by customer, order reference, and pagination. Sorting can be applied on card status. Default sorting includes Active cards on top.
- [Unblock a card](https://api.corpay.com/api-reference/card/unblock-a-card.md): Unblock a previously blocked card.
- [Block a customer](https://api.corpay.com/api-reference/customer/block-a-customer.md): Temporary Block a customer account (e.g., due to non-payment).
- [Close a customer permanently](https://api.corpay.com/api-reference/customer/close-a-customer-permanently.md): Close a customer account permanently.
- [Create sub customer](https://api.corpay.com/api-reference/customer/create-sub-customer.md): Create a sub-customer either under customer by supplying the 'Customer Account Number' in the request, or under the top-level customer if not provided in request. The system returns the 'Customer Account Number' of the newly created customer.  Sub-customers can be created only up to two levels below…
- [Get a customer](https://api.corpay.com/api-reference/customer/get-a-customer.md): Retrieve the full customer profile by Corpay customer account number. Customer's MAIN address and contact is returned in response.
- [Get card types for a customer](https://api.corpay.com/api-reference/customer/get-card-types-for-a-customer.md): Return the card types available/assigned to a specific customer.
- [List customers](https://api.corpay.com/api-reference/customer/list-customers.md): List subaccounts under the top-level account with pagination.
- [Unblock (reactivate) a customer](https://api.corpay.com/api-reference/customer/unblock-reactivate-a-customer.md): Reactivate a previously blocked customer account.
- [Update customer details](https://api.corpay.com/api-reference/customer/update-customer-details.md): Update mutable attributes of a customer (name, contact, and address). Address and contact updates are updated against MAIN Address and contact of customer.
- [Get a charging session](https://api.corpay.com/api-reference/ev-session/get-a-charging-session.md): Returns charging session details
- [Get a location](https://api.corpay.com/api-reference/geosearch/get-a-location.md): Returns detailed location data for a single charging location, with optional pricing context. Only one of keyIdentifier or fleetId can be provided in a single request. If none are provided, default prices are returned.
- [Search locations within a rectangle](https://api.corpay.com/api-reference/geosearch/search-locations-within-a-rectangle.md): Search for charging locations within a specified rectangle defined by two diagonal points. The rectangle coordinates are passed via the `topLatitude`, `bottomLatitude`, `leftLongitude`, and `rightLongitude` query parameters; the request body contains only filters and options. Returns up to 300 locat…
- [Get master data](https://api.corpay.com/api-reference/master/get-master-data.md): Return master/reference data required for card operations based on top level customer (card types, categories, products, statuses, reasons, groups, regions, countries).
- [Start a remote charging session](https://api.corpay.com/api-reference/remote-charging/start-a-remote-charging-session.md): Starts a remote charging session with the given charging key on the given connector.
- [Stop a remote charging session](https://api.corpay.com/api-reference/remote-charging/stop-a-remote-charging-session.md): Stops the given remote charging session. Only sessions started remotely can be remotely stopped.
- [Get transactions for a card](https://api.corpay.com/api-reference/transaction/get-transactions-for-a-card.md): Retrieve transactions for a single card with filters and pagination. ProductIds identifies the Products from the Corpay System. Note: after a user stopped the session, a transaction might take up to 10 minutes to be available via the transactions endpoints.
- [Get transactions for a customer](https://api.corpay.com/api-reference/transaction/get-transactions-for-a-customer.md): Retrieve transactions across all cards under a customer with filters and pagination. ProductIds and CardIdentifiers are Identifiers of Product and Card from Corpay System. Note: after a user stopped the session, a transaction might take up to 10 minutes to be available via the transactions endpoints…
- [Card creation notification](https://api.corpay.com/api-reference/webhooks/card-creation-notification.md): Sent to the consumer's registered target URL whenever a card’s are created.
- [Card replaced notification](https://api.corpay.com/api-reference/webhooks/card-replaced-notification.md): Sent to the consumer's registered target URL whenever a card is replaced.
- [Card status update notification](https://api.corpay.com/api-reference/webhooks/card-status-update-notification.md): Sent to the consumer's registered target URL whenever a card’s status changes.
- [De-Register for card status updates.](https://api.corpay.com/api-reference/webhooks/de-register-for-card-status-updates.md): To stop receiving card status updates from Corpay system, de-register for webhook using Card Identifier. for each card the de-registration needs to be done separately. if hmac_enabled was set true during register then hmac_secret and hmac_enabled flag is needed.  max_retries value by default it set…
- [De-Register for getting details of newly created cards.](https://api.corpay.com/api-reference/webhooks/de-register-for-getting-details-of-newly-created-cards.md): Once the newly created cards are received against order reference, use the API to de register webhook for the Order Reference. for each card order the registration needs to be done separately. if hmac_enabled was enabled during registration then hmac_secret and hmac_enabled flag is needed.  max_retr…
- [De-Register for receiving replaced card information.](https://api.corpay.com/api-reference/webhooks/de-register-for-receiving-replaced-card-information.md): To stop receiving replaced card data from Corpay system, register for webhook using Card Identifier of original card. for each card the registration needs to be done separately. if hmac_enabled was enabled during registration then hmac_secret and hmac_enabled flag is needed.  max_retries value by de…
- [Register for card status updates](https://api.corpay.com/api-reference/webhooks/register-for-card-status-updates.md): To get card status updates from Corpay system, register for webhook using Card Identifier. for each card the registration needs to be done separately. if hmac_enabled is set true then hmac_secret is needed.  max_retries value by default it set to 1. Upon updates on card status, the data that is shar…
- [Register for getting details of newly created cards.](https://api.corpay.com/api-reference/webhooks/register-for-getting-details-of-newly-created-cards.md): To get newly ordered cards data from Corpay system, register for webhook using Customer Account Number and Order reference (Which was part of response of card order API). Please note, the registration needs to be done immediately after card order. If registration process has failed and consumer has…
- [Register for receiving replaced card information.](https://api.corpay.com/api-reference/webhooks/register-for-receiving-replaced-card-information.md): To get replaced card data from Corpay system, register for webhook using Card Identifier of original card. for each card the registration needs to be done separately. if hmac_enabled is set true then hmac_secret is needed.  max_retries value by default it set to 1. If registration process has failed…
- [Authentication](https://api.corpay.com/authentication.md): Learn how to authenticate and securely access the APIs.
- [Build a driver app](https://api.corpay.com/build-a-driver-app.md)
- [Build a fleet portal](https://api.corpay.com/build-a-fleet-portal.md)
- [Card types](https://api.corpay.com/card-types.md)
- [Changelog](https://api.corpay.com/changelog.md)
- [ERP-led account and card management](https://api.corpay.com/erp-led-account-and-card-management.md)
- [EV network integration](https://api.corpay.com/ev-network-integration.md)
- [Fleet API overview](https://api.corpay.com/fleet-api-overview.md)
- [Overview](https://api.corpay.com/fleet-api-reference-overview.md): Build fleet products that move faster with Corpay's Fleet API. This page gives you a quick overview of what is covered in the Fleet API reference.
- [Functional Error Codes](https://api.corpay.com/functional-error-codes.md)
- [Integrate EV charging network into the car](https://api.corpay.com/integrate-ev-charging-network-into-the-car.md)
- [Key concepts](https://api.corpay.com/key-concepts.md)
- [Getting started](https://api.corpay.com/overview.md)
- [Performance](https://api.corpay.com/performance.md)
- [Rate limits](https://api.corpay.com/rate-limits.md)
- [Overview](https://api.corpay.com/use-cases.md)
- [Webhooks](https://api.corpay.com/webhooks.md)

## OpenAPI Specs

- [openapi](https://api.corpay.com/openapi.json)
- [fleet-openapi](https://api.corpay.com/fleet-openapi.yaml)
- [drive-api-upstream](https://api.corpay.com/drive-api-upstream.json)