Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/deluxe-paymentmethods-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: DPP Gateway Experience Paymentmethods API
version: '1'
description: This application will be useful to perform payments with multiple payment methods, Creating customers with in DPP
x-provenance:
method: derived
derived_from: RAML 1.0 published by Deluxe at https://developer.deluxe.com/api-ref/api/merchant-services/
derived_on: '2026-08-13'
note: Faithful mechanical conversion of the provider-published RAML 1.0 definition and its rendered request/response parameter and example documents. No operation, field, schema or example in this file was authored by API Evangelist.
servers:
- url: https://api.deluxe.com/dpp/v1
description: Production (default routing path)
- url: https://api.deluxe.com/dpp/v1/gateway
description: Production (legacy routing path)
- url: https://sandbox.api.deluxe.com/dpp/v1
description: Sandbox / test environment
security:
- bearerAuth: []
tags:
- name: paymentmethods
paths:
/paymentmethods:
post:
operationId: createPaymentMethod
summary: Create Payment Method
tags:
- paymentmethods
description: 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 number and routing number), and the billing address. Additionally, you must specify the customer ID associated with the payment method. The API will store these details securely for future transactions.
requestBody:
required: true
content:
application/json:
schema:
description: Request DataType
type: object
properties:
customerId:
description: Unique identifier for a customer
type: number
examples:
- 4321
paymentMethod:
description: payment method details
oneOf:
- description: Object to hold card details
type: object
properties:
card:
description: Object to hold card details
type: object
properties:
card:
description: Card Number
type: string
minLength: 12
maxLength: 19
examples:
- '4111111111111110'
expiry:
description: Card Expiration Month and Year
type: string
pattern: ^(0[1-9]|1[0-2])\/\d{2}$
examples:
- 11/26
required:
- card
- expiry
billingAddress:
description: Billing Information
type: object
properties:
firstName:
description: Customer's first name
type: string
maxLength: 100
examples:
- Jane
lastName:
description: Customer's last name
type: string
maxLength: 100
examples:
- Doe
address:
description: Customer's address
type: string
maxLength: 250
examples:
- 123 Main St
address2:
description: Customer's address line 2
type: string
maxLength: 100
examples:
- Apt 5
postalCode:
description: Customer's postal/zip code
type: string
maxLength: 50
examples:
- '94111'
city:
description: Customer's city
type: string
maxLength: 50
examples:
- San Francisco
state:
description: Customer's state/province
type: string
maxLength: 25
examples:
- CA
country:
description: Customer's country
type: string
maxLength: 25
examples:
- USA
phone:
description: Customer's phone number
type: string
pattern: ^(\+\d{1,3}[\s-]?)?\(?\d{3}\)?[\s-]?\d{3}[\s-]?\d{4}$
maxLength: 17
examples:
- 650-555-1234
email:
description: Customer's email address
type: string
pattern: ^([a-zA-Z0-9.!#$\%&'*+-=?^_`{|}~]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,})$
maxLength: 250
examples:
- jane@email.com
additionalProperties: false
- description: Object to hold ACH information such as bank account number, routing number, and account type (e.g., Checking or Savings). Includes optional billing address to support verification and regulatory compliance. Enables secure account-based transactions for direct debit payments.
type: object
properties:
ach:
description: Object to hold ACH information such as bank account number, routing number, and account type (e.g., Checking or Savings). Includes optional billing address to support verification and regulatory compliance. Enables secure account-based transactions for direct debit payments.
type: object
properties:
accountNumber:
description: Bank account number
type: string
minLength: 1
maxLength: 20
examples:
- '987654321'
routingNumber:
description: Bank Routing Number
type: string
minLength: 8
maxLength: 9
examples:
- '123456789'
accountType:
description: Account Type - Checking/Savings
type: string
enum:
- Checking
- Savings
examples:
- Checking
required:
- accountNumber
- routingNumber
billingAddress:
description: Billing Address details includes name, street address, city, postal code, country, and optional contact information like phone and email. These fields support payment verification, fraud prevention, and customer record enrichment, making it easier to integrate with billing, invoicing, compliance systems.
type: object
properties:
firstName:
description: Customer's first name
type: string
maxLength: 100
examples:
- Jane
lastName:
description: Customer's last name
type: string
maxLength: 100
examples:
- Doe
address:
description: Customer's address
type: string
maxLength: 250
examples:
- 123 Main St
address2:
description: Customer's address line 2
type: string
maxLength: 100
examples:
- Apt 5
postalCode:
description: Customer's postal/zip code
type: string
maxLength: 50
examples:
- '94111'
city:
description: Customer's city
type: string
maxLength: 50
examples:
- San Francisco
state:
description: Customer's state/province
type: string
maxLength: 25
examples:
- CA
country:
description: Customer's country
type: string
maxLength: 25
examples:
- USA
phone:
description: Customer's phone number
type: string
pattern: ^(\+\d{1,3}[\s-]?)?\(?\d{3}\)?[\s-]?\d{3}[\s-]?\d{4}$
maxLength: 17
examples:
- 650-555-1234
email:
description: Customer's email address
type: string
pattern: ^([a-zA-Z0-9.!#$\%&'*+-=?^_`{|}~]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,})$
maxLength: 250
examples:
- jane@email.com
additionalProperties: false
- description: Object to hold cryptogram data such as tokenized transaction values and billing address. It supports secure transmission of card or bank details using encrypted strings, enabling safe, compliant digital payments across banking and e-commerce environments. Ideal for tokenization workflows requiring enhanced data protection and minimal exposure of sensitive financial information.
type: object
properties:
cryptogram:
description: Object to hold cryptogram data such as tokenized transaction values and billing address. It supports secure transmission of card or bank details using encrypted strings, enabling safe, compliant digital payments across banking and e-commerce environments. Ideal for tokenization workflows requiring enhanced data protection and minimal exposure of sensitive financial information.
type: object
properties:
cryptogram:
description: Tokenized string that passes Card or Bank details for transaction
type: string
examples:
- 6cd3ef836ce141b789b5755ca3f353f1
required:
- cryptogram
billingAddress:
description: Billing Address details includes name, street address, city, postal code, country, and optional contact information like phone and email. These fields support payment verification, fraud prevention, and customer record enrichment, making it easier to integrate with billing, invoicing, compliance systems.
type: object
properties:
firstName:
description: Customer's first name
type: string
maxLength: 100
examples:
- Jane
lastName:
description: Customer's last name
type: string
maxLength: 100
examples:
- Doe
address:
description: Customer's address
type: string
maxLength: 250
examples:
- 123 Main St
address2:
description: Customer's address line 2
type: string
maxLength: 100
examples:
- Apt 5
postalCode:
description: Customer's postal/zip code
type: string
maxLength: 50
examples:
- '94111'
city:
description: Customer's city
type: string
maxLength: 50
examples:
- San Francisco
state:
description: Customer's state/province
type: string
maxLength: 25
examples:
- CA
country:
description: Customer's country
type: string
maxLength: 25
examples:
- USA
phone:
description: Customer's phone number
type: string
pattern: ^(\+\d{1,3}[\s-]?)?\(?\d{3}\)?[\s-]?\d{3}[\s-]?\d{4}$
maxLength: 17
examples:
- 650-555-1234
email:
description: Customer's email address
type: string
pattern: ^([a-zA-Z0-9.!#$\%&'*+-=?^_`{|}~]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,})$
maxLength: 250
examples:
- jane@email.com
additionalProperties: false
- description: Object to hold token details
type: object
properties:
token:
description: Object to hold token details
type: object
properties:
token:
description: Tokenized string for Card details
type: string
maxLength: 20
examples:
- '1234567890123450'
expiry:
description: Card Expiration Month and Year
type: string
examples:
- 10/25
required:
- expiry
- token
billingAddress:
description: Billing Information
type: object
properties:
firstName:
description: Customer's first name
type: string
maxLength: 100
examples:
- Jane
lastName:
description: Customer's last name
type: string
maxLength: 100
examples:
- Doe
address:
description: Customer's address
type: string
maxLength: 250
examples:
- 123 Main St
address2:
description: Customer's address line 2
type: string
maxLength: 100
examples:
- Apt 5
postalCode:
description: Customer's postal/zip code
type: string
maxLength: 50
examples:
- '94111'
city:
description: Customer's city
type: string
maxLength: 50
examples:
- San Francisco
state:
description: Customer's state/province
type: string
maxLength: 25
examples:
- CA
country:
description: Customer's country
type: string
maxLength: 25
examples:
- USA
phone:
description: Customer's phone number
type: string
pattern: ^(\+\d{1,3}[\s-]?)?\(?\d{3}\)?[\s-]?\d{3}[\s-]?\d{4}$
maxLength: 17
examples:
- 650-555-1234
email:
description: Customer's email address
type: string
pattern: ^([a-zA-Z0-9.!#$\%&'*+-=?^_`{|}~]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,})$
maxLength: 250
examples:
- jane@email.com
additionalProperties: false
- description: Object to hold ACH token information such as a tokenized string representing bank details. Includes billing address for validation and compliance support. Useful for secure ACH transactions in digital payment workflows, enabling reduced exposure of sensitive banking information and streamlined account-based processing.
type: object
properties:
achToken:
description: Object to hold ACH token information such as a tokenized string representing bank details. Includes billing address for validation and compliance support. Useful for secure ACH transactions in digital payment workflows, enabling reduced exposure of sensitive banking information and streamlined account-based processing.
type: object
properties:
token:
description: Tokenized string for ACH details
type: string
maxLength: 40
examples:
- k|1235673473|4567890123450
required:
- token
billingAddress:
description: Billing Address details includes name, street address, city, postal code, country, and optional contact information like phone and email. These fields support payment verification, fraud prevention, and customer record enrichment, making it easier to integrate with billing, invoicing, compliance systems.
type: object
properties:
firstName:
description: Customer's first name
type: string
maxLength: 100
examples:
- Jane
lastName:
description: Customer's last name
type: string
maxLength: 100
examples:
- Doe
address:
description: Customer's address
type: string
maxLength: 250
examples:
- 123 Main St
address2:
description: Customer's address line 2
type: string
maxLength: 100
examples:
- Apt 5
postalCode:
description: Customer's postal/zip code
type: string
maxLength: 50
examples:
- '94111'
city:
description: Customer's city
type: string
maxLength: 50
examples:
- San Francisco
state:
description: Customer's state/province
type: string
maxLength: 25
examples:
- CA
country:
description: Customer's country
type: string
maxLength: 25
examples:
- USA
phone:
description: Customer's phone number
type: string
pattern: ^(\+\d{1,3}[\s-]?)?\(?\d{3}\)?[\s-]?\d{3}[\s-]?\d{4}$
maxLength: 17
examples:
- 650-555-1234
email:
description: Customer's email address
type: string
pattern: ^([a-zA-Z0-9.!#$\%&'*+-=?^_`{|}~]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,})$
maxLength: 250
examples:
- jane@email.com
additionalProperties: false
required:
- customerId
- paymentMethod
example:
customerId: 11989
paymentMethod:
accNickName: anusha
isActive: false
card:
card: '374245455400126'
expiry: 05/26
billingAddress:
state: CA
address: 123 Main St
lastName: Doe
firstName: Jane
email: jane@email.com
country: USA
phone: 650-555-1234
city: San Francisco
address2: Apt 5
postalCode: '94111'
responses:
'200':
description: Successful response
content:
application/json:
schema:
description: Response parameters for the API
type: object
properties:
paymentMethodId:
description: Unique identifier for a payment method (ACH or Card)
type: string
pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
examples:
- d10f860c-ab05-4002-86b3-b4a707d9a999
customerId:
description: Unique identifier for a customer
type: number
examples:
- 4321
requestId:
description: Unique identifier for an API call
type: string
pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
examples:
- a2406639-8692-4e1c-978d-1805eb13efdf
required:
- customerId
- paymentMethodId
- requestId
example:
customerId: 123
paymentMethodId: dc4017fd-5b14-1496-3274-298337c01289
requestId: 056e9055-cf2d-48c3-93db-918e3ec583d0
'401':
description: 'Unauthorized: invalid token, expired token, or connection error when connecting to the authorization server.'
'403':
description: 'Forbidden: invalid client application credentials.'
/paymentmethods/{paymentMethodId}:
patch:
operationId: modifyPaymentMethod
summary: Modify Payment Method
tags:
- paymentmethods
description: 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 number and routing number), and the billing address. Additionally, you need to provide the customer ID to identify which payment method to update. The API ensures that all changes are applied securely to the specified payment method.
parameters:
- name: paymentMethodId
in: path
required: true
schema:
type: string
description: Path parameter paymentMethodId.
- name: partnerToken
in: header
required: true
schema:
type: string
pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
examples:
- 80ae9a4a-5efd-412e-89b9-532f2ab2f817
description: Unique Merchant Identifier for API Calls
example: 80ae9a4a-5efd-412e-89b9-532f2ab2f817
- name: requestId
in: header
required: false
schema:
type: string
pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
examples:
- 56ae9a4a-5efd-412e-89b9-532f2ab2f275
description: 'Unique request identifier in GUID format included in the header, used to trace and correlate API calls across systems.
> **Note:** We strongly recommend including the `requestId` header in every API request. This unique GUID helps trace and correlate API calls across systems, ensuring better observability and troubleshooting.'
example: 56ae9a4a-5efd-412e-89b9-532f2ab2f275
requestBody:
required: true
content:
application/json:
schema:
description: Request DataType
type: object
properties:
customerId:
description: Unique identifier for a customer
type: number
examples:
- 4321
paymentMethod:
description: Payment method details
oneOf:
- description: Object to hold card details
type: object
properties:
card:
description: Card details
type: object
properties:
card:
description: Card Number
type: string
minLength: 12
maxLength: 19
examples:
- '4111111111111110'
expiry:
description: Card Expiration Month and Year
type: string
pattern: ^(0[1-9]|1[0-2])\/\d{2}$
examples:
- 11/26
required:
- expiry
billingAddress:
description: Billing Information
type: object
properties:
firstName:
description: Customer's first name
type: string
maxLength: 100
examples:
- Jane
lastName:
description: Customer's last name
type: string
maxLength: 100
examples:
- Doe
address:
description: Customer's address
type: string
maxLength: 250
examples:
- 123 Main St
address2:
description: Customer's address line 2
type: string
maxLength: 100
examples:
- Apt 5
postalCode:
description: Customer's postal/zip code
type: string
maxLength: 50
examples:
- '94111'
city:
description: Customer's city
type: string
maxLength: 50
examples:
- San Francisco
state:
description: Customer's state/province
type: string
maxLength: 25
examples:
- CA
country:
description: Customer's country
type: string
maxLength: 25
examples:
- USA
phone:
description: Customer's phone number
type: string
pattern: ^(\+\d{1,3}[\s-]?)?\(?\d{3}\)?[\s-]?\d{3}[\s-]?\d{4}$
maxLength: 17
examples:
- 650-555-1234
email:
description: Customer's email address
type: string
pattern: ^([a-zA-Z0-9.!#$\%&'*+-=?^_`{|}~]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,})$
maxLength: 250
examples:
- jane@email.com
# --- truncated at 32 KB (106 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/deluxe/refs/heads/main/openapi/deluxe-paymentmethods-api-openapi.yml