Skip to content

Instrument API

Chris edited this page Oct 31, 2019 · 4 revisions

Customers want to pay for their services using the payment methods they prefer. With the RevOps payment instruments API, you have the flexibility to define payment instruments on a per-customer basis, whether credit cards, ACH, or direct bank integrations with Plaid. RevOps integrates with popular billing providers and automatically manages your payment plans and invoicing.

Instrument Properties

Prop Type Description Tokenized
method PropTypes.oneOf(['ach', 'credit-card', 'plaid']) The primary method used for paying.
currency PropTypes.string The currency to be used for the instrument
isPrimary ProptTypes.bool Whether RevOps should set this as the primary payment instrument. Is set automatically when it is the only instrument on the account
country PropTypes.string Payment instruments country of origin
holderName PropTypes.string Name on the account.
cardNumber PropTypes.string Number on the credit card
cardExpdate PropTypes.shape({ month: PropTypes.string, year: PropTypes.string }) Date of Expiration on the credit card.
bankName PropTypes.string Name of Bank Institution
routingNumber PropTypes.string Routing number of issuing bank
accountNumber PropTypes.string Account number of issuing bank
postalCode PropTypes.string The postal code needed for the instrument
Clone this wiki locally