Sale With Payment Method Id
Processes a sale transaction using a previously stored payment method, referenced by its unique ID. This is a one-step payment operation that authorizes and captures funds in a single call.
You must provide the paymentMethodId, along with invoice, and amount details.
This endpoint is commonly used for charging returning customers, subscriptions, or quick-pay scenarios where the user has already saved a card, or ACH account. The payment can be either one-time or it can include data to define the initial transaction in a recurring or installment stream. This allows the networks to tie subsequent transactions back to the original approval, ensuring a seamless and efficient payment process.
It improves security and user experience by avoiding the need to re-enter payment data.
Quick Starts:
Related Links:
Authorizations
Path Parameters
The unique identifier for the payment method information
Body
Invoice information for this payment.
Show child attributes
Show child attributes
The unique identifier of the customer.
1 <= x <= 1000000000Determine whether to return raw processor data in the response.
Allows the merchant to define a dynamic descriptor, which appears in the payment statement. For dynamic descriptor, special configuration is required.
Processors supporting this feature: Nuvei, WorldPay, BridgePay, EPX, Paymentech, PaymentLync.
Show child attributes
Show child attributes
Report Groups could be used to separate your transactions into different categories, so you can view the financial reports by your specific report group names (Worldpay only).
Network processing information.
Processors supporting this feature: Adyen, Nuvei, WorldPay, TSYS, BridgePay, Paymentech, PaymentLync.
Show child attributes
Show child attributes
Decrypted package online payment cryptogram for a digital wallet.
512Response
OK
The unique identifier of the customer.
1 <= x <= 1000000000The unique identifier of the invoice.
1 <= x <= 1000000000Merchant's unique identifier for the invoice.
100Merchant's unique identifier for the payment method.
100The identifier returned for Visa, Mastercard, and Discover transactions. Visa and Discover use this value to link subsequent payments in a recurring/installment stream back to the initial transaction. You must include this value in the request message (originalNetworkTransactionId element) for subsequent recurring payments.
100The current status of the invoice.
Possible values: Paid, Pending, Noncollectable, Failed, OneTimePaymentPending, RetryPending.
100The status of the invoice attempt.
Possible values: Success, Fail, Pending, RetrySuccess, RetryFail, RetryPending.
100The message returned directly from payment processor or a special message provided by system.
500The amount information for the payment.
Show child attributes
Show child attributes
The unique identifier for the payment method information.
1 <= x <= 1000000000Specifies the type of payment method used for the transaction. Examples include CreditCard (1), Ach (2), GooglePay (3) and ApplePay (4).
1 <= x <= 1000000000The name of the processor by which the transaction was processed.
100The merchant account ID (MID) of the processor by which the transaction was processed.
100Conditional. The value is returned if includeRawProcessorResponse = true. This field contains the raw data received from the processor after attempting to bill this payment. It does not contain any sensitive information. The field value is a string with the serialized response from the processor in JSON format.
10000The details of credit card payment method.
Show child attributes
Show child attributes
The processor response message.
500The processor response code.
10UTC timestamp of the payment processor response (format: YYYY-MM-DDThh:mm:ss).
40Transaction authorization code.
20Payment Processor Transaction Id.
100Standardized internal response code indicating the outcome of the request.
10Message providing additional details about the response code.
500