HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Initiate a payment. 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.

The required argument for this endpoint are payment method ID and invoice.

Description of request parameters

customerId
Optional

Unique identifier for the customer.

No validation rules

invoice
Required

Invoice.

No validation rules

merchantInvoiceRefId
Optional

Merchant's unique identifier for the invoice.

No validation rules

amount
Required

The amount information for the payment.

No validation rules

currency
Optional. Default - USD

The three-character ISO currency code (currently only USD is supported).

Validation rules:
  • Must be 3 characters in length.

value
Required

The amount information for the payment.

Validation rules:
  • Must NOT be less than zero

dynamicDescriptor
Optional

Allows the merchant to define a dynamic descriptor, which appears in the payment statement. For dynamic descriptor, special configuration is required. For more information, please contact Revolv3 Support Team.


subMerchantId
Optional

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

No validation rules

subMerchantName
Optional

The merchant name, as is displayed for the transaction on the consumer’s card statement. For payment facilitator only, the maximum length of the parameter is 22, and might consist of the following structure: Prefix*-
where:
Prefix – The PayFac prefix, approved by processor.
* – A fixed character.
- – Sub-merchant name.

Recommended! An alternative method to define a prefix is by configuring it through the Revolv3 Portal. For more information, please contact Revolv3 Support Team.

No validation rules

subMerchantPhone
Optional

The merchant (sub-merchant for payment facilitators) contact information, as is displayed for the transaction on the consumer’s card statement. It can also be an email address.

No validation rules

countryCode
Optional

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

No validation rules

city
Optional

City.

Validation rules:
  • Maximum length of 20 characters.

networkProcessing
Optional

Network processing information.

No validation rules

processingType
Optional

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.

Validation rules:
  • Possible values: initialInstallment, initialRecurring, installment, recurring.

originalNetworkTransactionId
Optional

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) Visa, Mastercard or Discover recurring/installment payments.

No validation rules

Language
Click Try It! to start a request and see the response here!