Skip to main content
Authorize With Payment Method Details
curl --request POST \
  --url https://api.revolv3.com/api/Payments/authorization \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --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": "863C1926-FB74-4822-96C7-C09A049FC702",
    "dsTransactionId": "831d6f87-3e33-45e2-8c8e-1f1d8f5f0c8d",
    "threeDsVersion": "2.1.0"
  },
  "networkProcessing": {
    "processingType": "InitialRecurring",
    "originalNetworkTransactionId": null
  },
  "amount": {
    "currency": "USD",
    "value": 30.99
  },
  "orderProcessingChannel": null,
  "dynamicDescriptor": null,
  "includeRawProcessorResponse": false
}
'
{
  "networkTransactionId": "42b6d42b-18c5-4f0d-a114-6b29a770b32f",
  "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
    }
  },
  "paymentProcessor": null,
  "processorMerchantId": null,
  "responseMessage": "Approved",
  "responseCode": "000",
  "rawResponse": null,
  "message": null
}

Authorizations

​
Authorization
string
header
required

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

Body

​
amount
object
required

The amount information for the payment.

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

​
networkProcessing
object

Network processing information.

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

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

​
includeRawProcessorResponse
boolean
default:false

Determine whether to return raw processor data in the response.

​
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

Response

OK

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

​
paymentMethodAuthorizationId
integer<int64>

Unique identifier for a previously pre-authorized payment method.

​
paymentMethod
object

The payment method information for the payment.

​
paymentProcessor
string

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

​
processorMerchantId
string

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

​
responseMessage
string

The processor response message.

​
responseCode
string

The processor response code.

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

​
message
string

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