HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Authorize an existing payment method by its id with a specified amount.

Description of request parameters

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

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.

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