curl --request POST \
  --url https://api-sandbox.revolv3.com/api/Payments/sale \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-revolv3-token: <api-key>' \
  --data '
{
  "networkProcessing": null,
  "paymentMethod": {
    "billingAddress": null,
    "creditCard": {
      "paymentAccountNumber": "4111111111111111",
      "expirationDate": "0835",
      "securityCode": null,
      "networkToken": null
    },
    "ach": null,
    "googlePay": null,
    "applePay": null,
    "merchantPaymentMethodRefId": null,
    "billingFirstName": "Joe",
    "billingLastName": "Doe",
    "billingFullName": null
  },
  "threeDS": null,
  "customerId": null,
  "includeRawProcessorResponse": false,
  "invoice": {
    "merchantInvoiceRefId": null,
    "orderProcessingChannel": null,
    "ecommercePlatformUrl": null,
    "amount": {
      "currency": "USD",
      "value": 30.99
    }
  },
  "dynamicDescriptor": null,
  "reportGroup": null
}
'

{
  "customerId": 1,
  "invoiceId": 1234,
  "merchantInvoiceRefId": "1234-5678-9101",
  "merchantPaymentMethodRefId": null,
  "networkTransactionId": "70deed0c-fe49-44d1-8237-dd907f30df1b",
  "invoiceStatus": "Paid",
  "invoiceAttemptStatus": "Success",
  "message": "Approved",
  "amount": {
    "currency": "USD",
    "value": 30.99
  },
  "paymentMethodId": 1,
  "paymentMethodTypeId": 1,
  "paymentProcessor": "WorldPay",
  "processorMerchantId": "700010",
  "rawResponse": "Processor raw response (without parsing on Revolv3 side)",
  "paymentMethodCreditCardDetails": {
    "binNumber": "411111",
    "paymentLast4Digit": "1111",
    "paymentExpirationDate": "0835",
    "accountUpdateMessage": null,
    "accountUpdateDateTime": null,
    "accountUpdateCode": null,
    "paymentAccountNumber": null
  },
  "responseMessage": "Approved",
  "responseCode": "00",
  "processorResponseDateTime": null,
  "authCode": null,
  "processorTransactionId": null,
  "revolv3ResponseCode": null,
  "revolv3ResponseMessage": null
}

Payments

Sale With Payment Method Details

Processes a direct sale transaction using full payment method details (e.g., card number, expiry, CVV, ACH info). This is a one-step charge operation — the payment is authorized and captured immediately.

You must provide customer and invoice details along with raw payment data. This method is typically used by PCI-compliant merchants who collect and transmit sensitive payment data from their own secure front end. Use this endpoint when a tokenized method is not yet available, or when the payment is initiated for a new customer.

⚠️ PCI DSS compliance is required to handle raw card or bank account data directly.

Quick Starts:

Make a Payment

Related Links:

POST

api

Payments

sale

curl --request POST \
  --url https://api-sandbox.revolv3.com/api/Payments/sale \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-revolv3-token: <api-key>' \
  --data '
{
  "networkProcessing": null,
  "paymentMethod": {
    "billingAddress": null,
    "creditCard": {
      "paymentAccountNumber": "4111111111111111",
      "expirationDate": "0835",
      "securityCode": null,
      "networkToken": null
    },
    "ach": null,
    "googlePay": null,
    "applePay": null,
    "merchantPaymentMethodRefId": null,
    "billingFirstName": "Joe",
    "billingLastName": "Doe",
    "billingFullName": null
  },
  "threeDS": null,
  "customerId": null,
  "includeRawProcessorResponse": false,
  "invoice": {
    "merchantInvoiceRefId": null,
    "orderProcessingChannel": null,
    "ecommercePlatformUrl": null,
    "amount": {
      "currency": "USD",
      "value": 30.99
    }
  },
  "dynamicDescriptor": null,
  "reportGroup": null
}
'

{
  "customerId": 1,
  "invoiceId": 1234,
  "merchantInvoiceRefId": "1234-5678-9101",
  "merchantPaymentMethodRefId": null,
  "networkTransactionId": "70deed0c-fe49-44d1-8237-dd907f30df1b",
  "invoiceStatus": "Paid",
  "invoiceAttemptStatus": "Success",
  "message": "Approved",
  "amount": {
    "currency": "USD",
    "value": 30.99
  },
  "paymentMethodId": 1,
  "paymentMethodTypeId": 1,
  "paymentProcessor": "WorldPay",
  "processorMerchantId": "700010",
  "rawResponse": "Processor raw response (without parsing on Revolv3 side)",
  "paymentMethodCreditCardDetails": {
    "binNumber": "411111",
    "paymentLast4Digit": "1111",
    "paymentExpirationDate": "0835",
    "accountUpdateMessage": null,
    "accountUpdateDateTime": null,
    "accountUpdateCode": null,
    "paymentAccountNumber": null
  },
  "responseMessage": "Approved",
  "responseCode": "00",
  "processorResponseDateTime": null,
  "authCode": null,
  "processorTransactionId": null,
  "revolv3ResponseCode": null,
  "revolv3ResponseMessage": null
}

Authorizations

x-revolv3-token

string

header

required

Body

invoice

object

required

Invoice information for this payment.

Show child attributes

paymentMethod

object

required

Payment method information for this payment.

Supported payment methods:

Credit card
ACH*
Google Pay*

Only one payment method type should be provided with a transaction. *Supported only for specific processors.

Show child attributes

customerId

integer<int64>

The unique identifier of the customer.

Required range: 1 <= x <= 1000000000

includeRawProcessorResponse

boolean

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

Show child attributes

reportGroup

string

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

networkProcessing

object

Network processing information.

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

Show child attributes

threeDS

object

3-D Secure is an additional authentication protocol for online card payments that allows the issuing bank to verify that the transaction is initiated by the legitimate cardholder.

Processors supporting this feature: WorldPay, TSYS, and Nuvei.

Show child attributes

Response

customerId

integer<int64>

The unique identifier of the customer.

Required range: 1 <= x <= 1000000000

invoiceId

integer<int64>

The unique identifier of the invoice.

Required range: 1 <= x <= 1000000000

merchantInvoiceRefId

string

Merchant's unique identifier for the invoice.

Maximum string length: 100

merchantPaymentMethodRefId

string

Merchant's unique identifier for the payment method.

Maximum string length: 100

networkTransactionId

string

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.

Maximum string length: 100

invoiceStatus

string

The current status of the invoice.

Possible values: Paid, Pending, Noncollectable, Failed, OneTimePaymentPending, RetryPending.

Maximum string length: 100

invoiceAttemptStatus

string

The status of the invoice attempt.

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

Maximum string length: 100

message

string

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

Maximum string length: 500

amount

object

The amount information for the payment.

Show child attributes

paymentMethodId

integer<int64>

The unique identifier for the payment method information.

Required range: 1 <= x <= 1000000000

paymentMethodTypeId

integer<int64>

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

Required range: 1 <= x <= 1000000000

paymentProcessor

string

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

Maximum string length: 100

processorMerchantId

string

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

Maximum string length: 100

rawResponse

string

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.

Maximum string length: 10000

paymentMethodCreditCardDetails

object | null

The details of credit card payment method.

Show child attributes

responseMessage

string

The processor response message.

Maximum string length: 500

responseCode

string

The processor response code.

Maximum string length: 10

processorResponseDateTime

string<date-time>

UTC timestamp of the payment processor response (format: YYYY-MM-DDThh:mm:ss).

Maximum string length: 40

authCode

string

Transaction authorization code.

Maximum string length: 20

processorTransactionId

string

Payment Processor Transaction Id.

Maximum string length: 100

revolv3ResponseCode

string

Standardized internal response code indicating the outcome of the request.

Maximum string length: 10

revolv3ResponseMessage

string

Message providing additional details about the response code.

Maximum string length: 500

AccountVerification

Authentication

Checkout

Customers

Invoices

PaymentMethod

Payments

Subscriptions

Sale With Payment Method Details

Authorizations

Body

Response