curl --request POST \
  --url https://api-sandbox.revolv3.com/api/Payments/authorization \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-revolv3-token: <api-key>' \
  --data '
{
  "paymentMethod": {
    "billingAddress": {
      "addressId": null,
      "addressLine1": "100 Main",
      "addressLine2": null,
      "city": "Santa Ana",
      "state": "CA",
      "postalCode": "91111",
      "phoneNumber": null,
      "email": null,
      "country": "US"
    },
    "creditCard": {
      "paymentAccountNumber": "4111111111111111",
      "expirationDate": "1025",
      "securityCode": null,
      "networkToken": null
    },
    "ach": null,
    "googlePay": null,
    "applePay": null,
    "merchantPaymentMethodRefId": null,
    "billingFirstName": "Joe",
    "billingLastName": "Doe",
    "billingFullName": null
  },
  "threeDS": {
    "cavv": "BaW3Ymk=",
    "xid": null,
    "dsTransactionId": "831d6f87-3e33-45e2-8c8e-1f1d8f5f0c8d",
    "threeDsVersion": "2.1.0"
  },
  "networkProcessing": {
    "processingType": "InitialRecurring",
    "originalNetworkTransactionId": null
  },
  "amount": {
    "currency": "USD",
    "value": 30.99
  },
  "orderProcessingChannel": null,
  "ecommercePlatformUrl": "example.com",
  "dynamicDescriptor": null,
  "includeRawProcessorResponse": false,
  "reportGroup": null,
  "merchantInvoiceRefId": "1234-5678-9101"
}
'

{
  "networkTransactionId": "f8dd75aa-3cb7-4693-8b95-1651ca354378",
  "paymentMethodAuthorizationId": 1,
  "paymentMethod": {
    "paymentMethodId": 1,
    "billingAddressId": 1,
    "billingAddress": {
      "addressId": 1,
      "addressLine1": "1 Default Street",
      "addressLine2": null,
      "city": "Los Angeles",
      "state": "CA",
      "postalCode": "90210",
      "phoneNumber": null,
      "email": null,
      "country": "US"
    },
    "billingFirstName": "John",
    "billingLastName": "Doe",
    "merchantPaymentMethodRefId": "custom-payment-method-ref-id-001",
    "paymentMethodAchDetails": null,
    "paymentMethodCreditCardDetails": {
      "binNumber": "411111",
      "paymentLast4Digit": "1111",
      "paymentExpirationDate": "0835",
      "accountUpdateMessage": null,
      "accountUpdateDateTime": null,
      "accountUpdateCode": null,
      "paymentAccountNumber": null
    }
  },
  "paymentProcessor": null,
  "processorMerchantId": null,
  "responseMessage": "Approved",
  "responseCode": "000",
  "rawResponse": null,
  "message": null,
  "processorResponseDateTime": null,
  "authCode": null,
  "processorTransactionId": null,
  "revolv3ResponseCode": null,
  "revolv3ResponseMessage": null,
  "merchantInvoiceRefId": "1234-5678-9101"
}

Payments

Authorize With Payment Method Details

Performs a payment authorization using raw payment method details (e.g., card number, expiration date, CVV, or bank account info), without capturing the funds immediately. This is typically used when you want to place a hold on the customer’s account — for example, to confirm availability of funds before fulfillment or booking.

You must provide the full payment data along with invoice details. The payment is validated with the processor, and if successful, an authorization is created and stored for later capture or reversal.

This endpoint is intended for PCI-compliant merchants, as it involves transmitting sensitive payment data directly.

The authorization can later be captured using the Capture endpoint or voided via Reverse Authorization.

POST

api

Payments

authorization

curl --request POST \
  --url https://api-sandbox.revolv3.com/api/Payments/authorization \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-revolv3-token: <api-key>' \
  --data '
{
  "paymentMethod": {
    "billingAddress": {
      "addressId": null,
      "addressLine1": "100 Main",
      "addressLine2": null,
      "city": "Santa Ana",
      "state": "CA",
      "postalCode": "91111",
      "phoneNumber": null,
      "email": null,
      "country": "US"
    },
    "creditCard": {
      "paymentAccountNumber": "4111111111111111",
      "expirationDate": "1025",
      "securityCode": null,
      "networkToken": null
    },
    "ach": null,
    "googlePay": null,
    "applePay": null,
    "merchantPaymentMethodRefId": null,
    "billingFirstName": "Joe",
    "billingLastName": "Doe",
    "billingFullName": null
  },
  "threeDS": {
    "cavv": "BaW3Ymk=",
    "xid": null,
    "dsTransactionId": "831d6f87-3e33-45e2-8c8e-1f1d8f5f0c8d",
    "threeDsVersion": "2.1.0"
  },
  "networkProcessing": {
    "processingType": "InitialRecurring",
    "originalNetworkTransactionId": null
  },
  "amount": {
    "currency": "USD",
    "value": 30.99
  },
  "orderProcessingChannel": null,
  "ecommercePlatformUrl": "example.com",
  "dynamicDescriptor": null,
  "includeRawProcessorResponse": false,
  "reportGroup": null,
  "merchantInvoiceRefId": "1234-5678-9101"
}
'

{
  "networkTransactionId": "f8dd75aa-3cb7-4693-8b95-1651ca354378",
  "paymentMethodAuthorizationId": 1,
  "paymentMethod": {
    "paymentMethodId": 1,
    "billingAddressId": 1,
    "billingAddress": {
      "addressId": 1,
      "addressLine1": "1 Default Street",
      "addressLine2": null,
      "city": "Los Angeles",
      "state": "CA",
      "postalCode": "90210",
      "phoneNumber": null,
      "email": null,
      "country": "US"
    },
    "billingFirstName": "John",
    "billingLastName": "Doe",
    "merchantPaymentMethodRefId": "custom-payment-method-ref-id-001",
    "paymentMethodAchDetails": null,
    "paymentMethodCreditCardDetails": {
      "binNumber": "411111",
      "paymentLast4Digit": "1111",
      "paymentExpirationDate": "0835",
      "accountUpdateMessage": null,
      "accountUpdateDateTime": null,
      "accountUpdateCode": null,
      "paymentAccountNumber": null
    }
  },
  "paymentProcessor": null,
  "processorMerchantId": null,
  "responseMessage": "Approved",
  "responseCode": "000",
  "rawResponse": null,
  "message": null,
  "processorResponseDateTime": null,
  "authCode": null,
  "processorTransactionId": null,
  "revolv3ResponseCode": null,
  "revolv3ResponseMessage": null,
  "merchantInvoiceRefId": "1234-5678-9101"
}

Authorizations

x-revolv3-token

string

header

required

Body

amount

object

required

The amount information for the 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

networkProcessing

object

Network processing information.

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

Show child attributes

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

ecommercePlatformUrl

string

The merchant's storefront or e-commerce platform URL or domain from which the transaction originates. If provided, this value will be sent to the processor (TSYS only) as the Acceptor URL Address. If not provided, the value configured in Merchant Details (E-Commerce Platform URL) will be used. If neither is available, the request is sent to TSYS without the Acceptor URL Address.

Maximum string length: 100

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

includeRawProcessorResponse

boolean

default:false

Determine whether to return raw processor data in the response.

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

merchantInvoiceRefId

string

Merchant's unique identifier for the invoice.

Maximum string length: 100

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

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

paymentMethodAuthorizationId

integer<int64>

Unique identifier for a previously pre-authorized payment method.

Required range: 1 <= x <= 1000000000

paymentMethod

object

The payment method information for the payment.

Show child attributes

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

responseMessage

string

The processor response message.

Maximum string length: 500

responseCode

string

The processor response code.

Maximum string length: 10

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

message

string

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

Maximum string length: 500

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

merchantInvoiceRefId

string

Merchant's unique identifier for the invoice.

Maximum string length: 100

AccountVerification

Authentication

Checkout

Customers

Invoices

PaymentMethod

Payments

Subscriptions

Authorize With Payment Method Details

Authorizations

Body

Response