# Merchant Services

The Deluxe Merchant Services API provides a comprehensive suite of payment processing capabilities that enable businesses to manage the complete transaction lifecycle securely and efficiently. From payment initiation and authorization to refunds, recurring billing, customer management, and batch settlement, the platform supports a wide range of payment workflows across card-present and card-not-present environments.
The API includes specialized resources for Payments, EMV transactions, Refunds, Subscriptions, Payment Methods, Customers, Batches, Payment Links, and Events. Together, these services support multiple payment types, including cards, ACH, vault-based payments, cryptograms, network tokens, and recurring billing models. Designed for flexibility, security, and scalability, the platform helps businesses streamline payment operations, enhance customer experiences, and maintain compliance across diverse payment scenarios.


## Servers

Production
```
https://api.deluxe.com/dpp/v1
```

Sandbox
```
https://sandbox.api.deluxe.com/dpp/v1
```

## Security

### SecuritySchemas.oidcEnforcement

This API supports OpenID Connect OAuth 2.0 for authenticating all API requests.


Type: oauth2
Token URL: https://api.deluxe.com/secservices/oauth2/v2/token
Scopes:

## Download OpenAPI description

 - [Merchant Services](https://developer.deluxe.com/_bundle/products/merchant-services/api/dpp-gateway-exp/@v2.0.0/openapi.yaml)

## Payments

 - [POST /payments](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/payments/createpayment.md): The Payments resource in the API is a comprehensive service that manages essential payment operations, processing sales, handling recurring payments, authorizing transactions, capturing funds, and voi
 - [POST /payments/cancel](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/payments/cancelpayment.md): Use this API to cancel a payment that is still in process and has not yet been settled. This endpoint is typically used to void transactions on the same day they are initiated, before the batch closur
 - [POST /payments/authorize](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/payments/authorizepayment.md): Submits a payment authorization request to reserve the specified amount on the customer's payment method. This authorization process ensures that the funds are available but does not complete the tran
 - [POST /payments/complete](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/payments/completepayment.md): Use this API to finalize a previously authorized payment or to add a tip to the original transaction. This endpoint allows you to capture or complete an amount that is either equal to or less than the
 - [POST /payments/search](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/payments/searchpayments.md): This API endpoint is used to search and retrieve a list of payments, providing details about each payment for a given data range. The response indicates whether the search was successful or if there w
## EMV

 - [POST /emv/payment](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/emv/emvpayments.md): Initiates a sale or authorization on a physical EMV device by sending the `deviceId`, `amount`, and a `callbackUrl`. The terminal processes the transaction and returns a simple in‑API response, while
 - [POST /emv/refund](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/emv/emvrefunds.md): Initiates a stand‑alone refund on a physical EMV device by providing the `deviceId`, `amount`, and a `callbackUrl`. The terminal processes the refund and returns a simple in‑API response, while the de
 - [GET /emv/devices](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/emv/emvdeviceslist.md): Retrieves a list of all devices associated with the partnerToken provided in the request.
 - [POST /emv/devices/{deviceId}/refresh](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/emv/emvdevicerefreshbyid.md): Refreshes the device of the specified deviceId along with the associated partnerToken provided in the request.
 - [GET /emv/devicedetails/{deviceId}](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/emv/emvdevicedetailsbyid.md): Retrieves the details of the specified deviceId along with the associated partnerToken provided in the request.
## Refunds

 - [POST /refunds](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/refunds/createrefund.md): Processes refunds through a single endpoint supporting multiple use cases. For standard refunds, provide the paymentId and refund amount. For standalone refunds, specify the refund amount and payment
## Subscriptions

 - [POST /subscriptions](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/subscriptions/createsubscription.md): This API endpoint creates a new subscription for a customer with the specified payment and billing details. You need to provide the following information payment type, amount (including currency), pay
 - [PATCH /subscriptions/{subscriptionId}](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/subscriptions/modifysubscription.md): This API endpoint modifies an existing subscription identified by the subscriptionId passed in the URL. You must provide the customer’s ID, the payment method ID, and updated subscription details incl
## Payment Methods

 - [POST /paymentmethods](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/payment-methods/createpaymentmethod.md): This API endpoint allows you to create a new payment method for a customer. You need to provide details including a nickname for the payment method, its active status, ACH information (such as account
 - [PATCH /paymentmethods/{paymentMethodId}](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/payment-methods/modifypaymentmethod.md): This API endpoint allows you to update an existing payment method for a customer. You can modify details such as the payment method nickname, its active status, ACH information (including account numb
 - [POST /paymentmethods/token](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/payment-methods/generatetoken.md): This API endpoint generates a secure token for a payment method, which can be used for future transactions without storing sensitive payment details directly. The input requires credit card informatio
 - [POST /paymentmethods/avs](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/payment-methods/verifyaddress.md): Initiates an Address Verification Service (AVS) check for the provided billing address.This request will validate the address details (e.g., street address, zip code) and return a response indicating
 - [POST /paymentmethods/surcharge](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/payment-methods/checksurcharge.md): This API endpoint allows you to verify the surcharge associated to merchant for the given payment methods such as card, token, vault and cryptogram. The input requires a payment method and optional am
## Customers

 - [POST /customers](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/customers/createcustomer.md): The Create Customer API allows you to add a new customer to the system by providing their personal and contact information, including name, address, phone number, and email. Additionally, you can also
 - [GET /customers](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/customers/getallcustomers.md): The Get Customers API retrieves a list of all customers along with their associated details. Each customer record includes basic information such as name, address, contact details, and email. Addition
 - [PATCH /customers/{customerId}](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/customers/modifyspecificcustomer.md): The Modify Customer API allows you to update the details of an existing customer. You can modify the customer’s personal information, such as their first and last name, address, phone number, and emai
 - [GET /customers/{customerId}](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/customers/getspecificcustomer.md): This API retrieves the details of a specific customer using their unique identifier, including name, address, contact details, and email. It also returns the customer's shipping address, stored paymen
 - [DELETE /customers/{customerId}](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/customers/deletespecificcustomer.md): Deletes the customer identified by the given customer ID and permanently removes all associated records, including personal details,contact information,email,payment methods and subscriptions. > **Not
 - [GET /customers/{customerId}/paymentmethods/{paymentMethodId}](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/customers/getcustomerspaymentmethod.md): This API endpoint allows you to get an existing payment method for a customer. The payment details such as orderId, batchNumber, SubscriptionId (if applicable), fee, token details, account response da
 - [DELETE /customers/{customerId}/paymentmethods/{paymentMethodId}](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/customers/deletecustomerspaymentmethod.md): Delete an existing payment method for a customer.All upcoming payments linked to this payment method will also be deleted. > **Note:** - Once a payment method is deleted, all the upcoming payments lin
## Close Batch

 - [POST /batches](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/close-batch/closebatch.md): The Close Batch API endpoint finalizes and closes a transaction batch, sending notifications based on the provided email addresses. Input includes emails for success notifications, failure notificatio
## Payment Link

 - [POST /paymentlinks](https://developer.deluxe.com/products/merchant-services/api/dpp-gateway-exp/openapi/payment-link/createpaymentlink.md): The Create Payment Link API endpoint generates a customized URL that can be shared with customers to accept online payments. It allows the specification of payment details, customer information, order
