curl --request POST \
  --url https://api.revolv3.com/api/Payments/sale/{paymentMethodId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "networkProcessing": null,
  "customerId": null,
  "includeRawProcessorResponse": false,
  "invoice": {
    "merchantInvoiceRefId": null,
    "orderProcessingChannel": null,
    "amount": {
      "currency": "USD",
      "value": 100
    }
  },
  "dynamicDescriptor": null
}
'

{
  "customerId": 1,
  "invoiceId": 563,
  "merchantInvoiceRefId": "1234-5678-9101",
  "merchantPaymentMethodRefId": "#1234567890",
  "networkTransactionId": "600200756888390",
  "invoiceStatus": "Paid",
  "invoiceAttemptStatus": "Success",
  "message": "Approved",
  "amount": {
    "currency": "USD",
    "value": 30.99
  },
  "paymentMethodId": 8453,
  "paymentMethodTypeId": 0,
  "paymentProcessor": "Nuvei",
  "processorMerchantId": "4398673209738",
  "rawResponse": "Processor raw response (without parsing on Revolv3 side)",
  "paymentMethodCreditCardDetails": null,
  "responseMessage": null,
  "responseCode": null
}

Payments

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:

Make a Payment

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

paymentMethodId

integer<int64>

required

The unique identifier for the payment method information

Body

invoice

object

required

Show child attributes

invoice.amount

object

required

Show child attributes

invoice.amount.value

number<double>

required

The amount information for the payment. Must NOT be less than zero.

invoice.amount.currency

enum<string>

Available options:

USD,

AED,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CHF,

CLP,

CNH,

CNY,

COP,

CRC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LYD,

MAD,

MDL,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLE,

SOS,

SRD,

STN,

SVC,

SZL,

THB,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VEF,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW,

AFN,

KPW,

LRD,

LSL,

STD,

SYP,

TJS,

ZMK,

ZWD,

SLL,

MGA,

HRK,

CDF,

BTN,

BIF

invoice.merchantInvoiceRefId

string | null

Merchant's unique identifier for the invoice.

invoice.orderProcessingChannel

enum<string>

Specifies the sales channel through which the shopper provides their card details.

Ecommerce - Internet or electronic commerce transaction. Moto - Single mail or telephone order transaction.

Processors supporting this feature: WorldPay, BridgePay. For other processors, Ecommerce is used by default.

Available options:

Ecommerce,

Moto

customerId

integer<int64> | null

The unique identifier of the customer.

includeRawProcessorResponse

boolean | null

default:false

Determine whether to return raw processor data in the response.

dynamicDescriptor

object

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, Paymentech, PaymentLync.

Show child attributes

dynamicDescriptor.subMerchantId

string | null

The internal merchant's ID, which is sent to the relevant card scheme.

dynamicDescriptor.subMerchantName

string | null

The merchant name, as is displayed for the transaction on the consumer’s card statement. For payment facilitator only, might consist of the following structure: [Prefix]*[Sub Merchant Name] - where:

[Prefix] – The PayFac prefix, approved by processor.
'*' – A fixed character.
[Sub Merchant Name] – The sub-merchant name. For example: aaa*name

Recommended! An alternative method to define a prefix is by configuring it through the Revolv3 Portal.

Nuvei processor: the maximum length of the parameter is 22. Possible prefix length 3 or 5 or 7 or 12 characters. WorldPay processor: if the value is specified, it must be between 4 and 25 characters. Possible prefix length 3 or 7 or 12 characters. Field accepts numbers, letters and special characters as follows: ampersand, asterisk (zero or one), comma, dash, period, space, or pound sign. BridgePay processor: the maximum length of the parameter is 46.

dynamicDescriptor.subMerchantPhone

string | null

The merchant (sub-merchant for payment facilitators) contact information, as is displayed for the transaction on the consumer’s card statement.

Nuvei processor: the maximum length of the parameter is 13. It can also be an email address. WorldPay processor: the maximum length of the parameter is 13. Field accepts only numbers. BridgePay processor: the maximum length of the parameter is 13.

dynamicDescriptor.countryCode

string | null

The payment facilitator's sub-merchant's 2-letter ISO country code.

dynamicDescriptor.city

string | null

City.

networkProcessing

object

Network processing information.

Processors supporting this feature: Adyen, Nuvei, WorldPay, TSYS, BridgePay, Paymentech, PaymentLync.

Show child attributes

networkProcessing.processingType

enum<string>

Processing type is used to define the initial or subsequent transaction in a recurring or installment stream.

If no value is supplied, a transaction is considered a one-time payment and will not be linked to the initial one.

Available options:

InitialRecurring,

Recurring,

InitialInstallment,

Installment

networkProcessing.originalNetworkTransactionId

string | null

Element defines the networkTransactionId returned in the response messages for Visa, Mastercard, and Discover Auth/Sale transactions. You must include this element and the original value returned for subsequent (after the initial) recurring/installment payments.

Response

customerId

integer<int64> | null

The unique identifier of the customer.

invoiceId

integer<int64>

The unique identifier of the invoice.

merchantInvoiceRefId

string | null

Merchant's unique identifier for the invoice.

merchantPaymentMethodRefId

string | null

Merchant's unique identifier for the payment method.

networkTransactionId

string | null

The 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.

invoiceStatus

string | null

The current status of the invoice.

Possible values: Paid, Void, Pending, Recycle, Noncollectable, Refund, OneTimePaymentPending, PartialRefund, BatchPending, CapturePending, RefundPending, RefundDeclined, RefundFailed, RetryPending, RecurringPending.

invoiceAttemptStatus

string | null

The status of the invoice attempt.

Possible values: Success, Fail, Pending, RetrySuccess, RetryFail, RetryPending.

message

string | null

The message returned directly from payment processor or a special message provided by system.

amount

object

Show child attributes

amount.currency

string

The three-character ISO currency code.

amount.value

number<double>

The amount of the transaction.

paymentMethodId

integer<int64>

The unique identifier for the payment method information.

paymentMethodTypeId

integer<int64>

Specifies the type of payment method used for the transaction. Examples include CreditCard (1), Ach (2), GooglePay (3) and ApplePay (4).

paymentProcessor

string | null

The name of the processor by which the transaction was processed.

processorMerchantId

string | null

The merchant account ID (MID) of the processor by which the transaction was processed.

rawResponse

string | null

Conditional. 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.

paymentMethodCreditCardDetails

object

Can be null

The details of credit card payment method.

Show child attributes

paymentMethodCreditCardDetails.binNumber

string | null

paymentMethodCreditCardDetails.paymentLast4Digit

string | null

paymentMethodCreditCardDetails.paymentExpirationDate

string | null

paymentMethodCreditCardDetails.accountUpdateMessage

string | null

paymentMethodCreditCardDetails.accountUpdateDateTime

string | null

responseMessage

string | null

The processor response message.

responseCode

string | null

The processor response code.

Sale With Payment Method Details Capture

⌘I

AccountVerification

Authentication

Checkout

Customers

Invoices

PaymentMethod

Payments

Subscriptions

Sale With Payment Method Id

Authorizations

Path Parameters

Body

Response