Skip to main content
Sale With Payment Method Details
curl --request POST \
  --url https://api.revolv3.com/api/Payments/sale \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
  "networkProcessing": {
    "processingType": "InitialRecurring",
    "originalNetworkTransactionId": null
  },
  "paymentMethod": {
    "paymentMethodTypes": [
      "CreditCard"
    ],
    "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,
      "processingMethodType": "CreditCard"
    },
    "ach": null,
    "googlePay": null,
    "applePay": null,
    "merchantPaymentMethodRefId": null,
    "billingFirstName": "Joe",
    "billingLastName": "Doe",
    "billingFullName": null
  },
  "customerId": 1,
  "includeRawProcessorResponse": false,
  "invoice": {
    "merchantInvoiceRefId": "123456789",
    "orderProcessingChannel": null,
    "amount": {
      "currency": "USD",
      "value": 30.99
    }
  },
  "dynamicDescriptor": null
}'
{
  "customerId": 1,
  "invoiceId": 1,
  "merchantInvoiceRefId": "1234-5678-9101",
  "merchantPaymentMethodRefId": null,
  "networkTransactionId": "afc584ce-372b-4107-b57a-835a5020b730",
  "invoiceStatus": "Paid",
  "invoiceAttemptStatus": "Success",
  "message": "Approved",
  "amount": {
    "currency": "USD",
    "value": 30.99
  },
  "paymentMethodId": 1,
  "paymentMethodTypeId": 0,
  "paymentProcessor": null,
  "processorMerchantId": null,
  "rawResponse": "Processor raw response (without parsing on Revolv3 side)",
  "paymentMethodCreditCardDetails": null,
  "responseMessage": null,
  "responseCode": null
}

Authorizations

​
Authorization
string
header
required

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

Body

​
invoice
object
required
​
paymentMethod
object
required
​
customerId
integer | 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.

​
networkProcessing
object

Response

OK

​
customerId
integer | null

The unique identifier of the customer.

​
invoiceId
integer

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
​
paymentMethodId
integer

The unique identifier for the payment method information.

​
paymentMethodTypeId
integer

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.

​
responseMessage
string | null

The processor response message.

​
responseCode
string | null

The processor response code.