Create a payment method

post

https://api.revaly.co/payment-methods/create

Create and store a payment method in the vault. Supports both credit card details
and gatewayPaymentMethodIds from supported payment processors.

Payment Method Types:

creditCard: Credit card details that will be tokenized and stored
gatewayPaymentMethodId: Pre-existing gatewayPaymentMethodId from a supported payment gateway

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to create a new payment method

paymentMethodType

string

enum

required

Type of payment method to create:

creditCard: Use raw credit card details that will be tokenized
gatewayPaymentMethodId: Use an existing token from a supported payment gateway

Allowed:

customerId

string | null

Unique identifier for the customer

paymentMethod

object

Payment method details. Which fields are required depends on the payment-method type of the request: creditCard requires a cardholder name (fullName, or firstName together with lastName) plus creditCard.number/expiryMonth/expiryYear; gatewayPaymentMethodId requires gatewayPaymentMethod.gatewayPaymentMethodId and merchantAccountReferenceId; vaultToken requires vaultPaymentMethod.vaultToken plus the request-level customerId. When billing a stored payment method, supply paymentMethodId alone.

Headers

X-Api-Version

string

enum

Defaults to 2.0

Selects the RAP API version for this request. New integrations should pin 2.1 (identical to 2.0 today; future refinements land there). Omit to use the base version (2.0). A value naming an unsupported version — including an empty value — returns HTTP 400; if the header is sent, it must name a supported version. See the API description for the full version policy.

Allowed:

Responses

200Payment method successfully created

400Bad request - invalid parameters or request body. Validation failures carry a details object keyed by the offending fields; business-rule rejections may carry error alone.

401Unauthorized - invalid or missing API key

403Forbidden - the authenticated principal is not permitted to perform this action

422Unprocessable entity - validation succeeded but the request cannot be processed

500Internal server error

503Service unavailable - upstream dependency temporarily unavailable