v1
latestOpenAPI 3.0.12026-07-24168217310.4 KBPaymentMethods
Create Payment Method
post/Sites/{siteId}/PaymentMethods
Path parameters
siteIdinteger required
The site identifier
Request body
customerIdstring required
type'Stripe' | 'AuthorizeNet' | 'Test' | 'PayPal' | 'Braintree' | 'CyberSource' | 'Undefined' | 'Other' | 'Nmi' | 'PayaV1' | 'TrustCommerce' | 'Square' | 'Sage' | 'CyberSourceV2' | 'Checkout' | 'PaypalV2' | 'Shopify' | 'PayPalV3' | 'Airwallex'
gatewayCustomerIdstring nullable
gatewayPaymentIdstring nullable
descriptionstring required
expirationstring nullable
lastFourDigitsstring nullable
billingFirstNamestring nullable
billingLastNamestring nullable
billingStreet1string nullable
billingStreet2string nullable
billingCitystring nullable
billingStatestring nullable
billingPostcodestring nullable
billingCountrystring nullable
billingCompanystring nullable
isDefaultboolean nullable
gatewayPaymentType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32
Response
Success
idinteger
status'Active' | 'Expired' | 'Revoked' | 'Invalid'
createdUtcstring date-time
updatedUtcstring date-time
expirationDatestring date-time nullable
customerIdstring required
type'Stripe' | 'AuthorizeNet' | 'Test' | 'PayPal' | 'Braintree' | 'CyberSource' | 'Undefined' | 'Other' | 'Nmi' | 'PayaV1' | 'TrustCommerce' | 'Square' | 'Sage' | 'CyberSourceV2' | 'Checkout' | 'PaypalV2' | 'Shopify' | 'PayPalV3' | 'Airwallex'
gatewayCustomerIdstring nullable
gatewayPaymentIdstring nullable
descriptionstring required
expirationstring nullable
lastFourDigitsstring nullable
billingFirstNamestring nullable
billingLastNamestring nullable
billingStreet1string nullable
billingStreet2string nullable
billingCitystring nullable
billingStatestring nullable
billingPostcodestring nullable
billingCountrystring nullable
billingCompanystring nullable
isDefaultboolean nullable
gatewayPaymentType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32