Across 11 paths, the API surfaces 15 operations — 2 DELETE, 3 GET, 7 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
Payment Methods 15
Payment methods represents payment method details associated with a customer account.
POST
/v1/payment-methods
Create a payment method
POST_PaymentMethods8 params→ 200
POST
/v1/payment-methods/decryption
Create an Apple Pay payment method
POST_PaymentMethodsDecryption8 params→ 200
PUT
/v1/payment-methods/{payment-method-id}
Update a payment method
PUT_PaymentMethod8 params→ 200
GET
/v1/payment-methods/{payment-method-id}
Retrieve a payment method
GET_PaymentMethod7 params→ 200
DELETE
/v1/payment-methods/{payment-method-id}
Delete a payment method
DELETE_PaymentMethods7 params→ 200
PUT
/v1/payment-methods/{payment-method-id}/verify
Verify a payment method
PUT_VerifyPaymentMethods6 params→ 200
PUT
/v1/payment-methods/{payment-method-id}/scrub
Scrub a payment method
PUT_ScrubPaymentMethods7 params→ 200
POST
/v1/payment-methods/{payment-method-id}/profiles
Create a stored credential profile
POST_CreateStoredCredentialProfile9 params→ 200
GET
/v1/payment-methods/{payment-method-id}/profiles
List stored credential profiles of a payment method
The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are CreatePaymentMethodCreditCard (14 properties), POSTPMMandateInfo (13 properties), CreatePaymentMethodACH (12 properties), POSTPaymentMethodDecryption (11 properties). Each schema is shown below with its type and property counts.
CommonResponseType
object
3 properties
PUTPMAccountHolderInfo
object
The account holder information. This field is not supported in updating Credit Card Reference Transaction payment methods.
8 properties
POSTCreatePaymentSessionResponse
object
1 property
GETPaymentMethodResponseACH
object
5 properties
POSTPaymentMethodDecryption
object
11 properties3 required
POSTPMMandateInfo
object
The mandate information for the Credit Card, Apple Pay, Google Pay, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. The following mand…
13 properties
POSTPaymentMethodRequest
CreatePaymentMethodCreditCard
object
14 properties
CreatePaymentMethodCardholderInfo
object
Container for cardholder information. This container field is required for credit card payment methods. The nested cardHolderName field is required.
9 properties1 required
GETPaymentMethodResponsePayPal
object
3 properties
GetStoredCredentialProfilesResponse
object
2 properties
CreatePMPayPalECPayPalNativeECPayPalCP
object
2 properties
GETPaymentMethodResponseBankTransfer
object
7 properties
CreateStoredCredentialProfileRequest
object
9 properties3 required
DELETEUnresigerApplePayDomainResponse
object
1 property
POSTRegisterApplePayDomainRequest
object
1 property1 required
PaymentMethodObjectCustomFields
object
Container for custom fields of a payment method object.
PUTPaymentMethodRequest
POSTPaymentMethodResponse
PUTPaymentMethodResponse
object
2 properties
CreatePaymentMethodBankTransfer
object
11 properties
POSTRegisterApplePayDomainResponse
object
4 properties
POSTPaymentMethodResponseDecryption
object
4 properties
PUTPaymentMethodObjectCustomFields
object
Container for custom fields of a payment method object.
PUTVerifyPaymentMethodType
object
4 properties
CreatePaymentMethodApplePayAdyen
object
1 property
POSTCreatePaymentSessionRequest
object
6 properties4 required
PUTVerifyPaymentMethodResponseType
object
2 properties
GETPaymentMethodResponse
GETPMAccountHolderInfo
object
The account holder information.
9 properties
ModifiedStoredCredentialProfileResponse
object
3 properties
CreatePaymentMethodGooglePayAdyenChase
object
1 property
GETPaymentMethodResponseGooglePay
object
5 properties
CreatePaymentMethodPayPalAdaptive
object
1 property
GETListApplePayDomainsResponse
object
2 properties
GETPaymentMethodResponseCreditCard
object
4 properties
GETPaymentMethodResponseApplePay
object
5 properties
CreatePaymentMethodACH
object
12 properties
PUTPMCreditCardInfo
object
3 properties
CreatePaymentMethodCCReferenceTransaction
object
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
