Page tree
Skip to end of metadata
Go to start of metadata

Create a Manual Payment or Process a Credit Card Payment.

Required Input

  • CustomerID As Integer – a valid Rev.io Customer ID.
  • Amount As Decimal – amount of the payment to be recorded (or processed and recorded).
  • Type As String – Manual Payment or Credit Card Payment
    • MANUAL – used for recording a cash, check, etc Payment only.
    • CREDIT_CARD – processes a Credit Card Payment, and if successful, records in Rev.io.
    • ACH – Processes an ACH payment, and if successful, records in Rev.io.
    • MANUAL_ELECTRONIC – Make a manual electronic payment. This is only to be used if a payment is taken outside of Rev.io using a merchant profile setup in Rev.io and the payment needs to be recorded in Rev.io. This makes it appear as if Rev.io took the payment electronically, however Rev.io will not actually process the payment itself. A payment taken in this manner will be able to be reversed or voided in Rev.io through normal means.

Optional/Conditional Input

  • Options
    • AgentID As Integer– Optional - when specified, the customer created will be associated with this Agent. Cannot use with AgentNumber.
    • AgentNumber As String – Optional - when specified, the customer created will be associated with this Agent. Cannot use with AgentID.
    • Method As String – Optional – when blank, will default to API or the type of credit card being processed (e.g. AMEX, DINERS, DISCOVER, VISA, MASTERCARD).
    • ReceivedDate As Date – For MANUAL Payments, optional. Defaults to today if not specified. For CREDIT_CARD Payments, prohibited. Will be set to today.
    • ReferenceNumber As String – For MANUAL Payments, optional. Defaults to blank if not specified. For CREDIT_CARD Payments, prohibited. Will be set to the Merchant Gateway's TransactionId. Required for MANUAL_ELECTRONIC payments.
  • CreditCard
    • CreditCardNumber As String – Credit Card Number.
    • ExpirationDate As Date – Credit card expiration date.
    • NameOnCard As String – optional depending upon your Merchant Gateway account.
    • Choice of one of the following (Note: not specifying an option uses the billing address on the customer's account):
      • ZipCode As String – optional depending upon your Merchant Gateway account (Note: some Merchant Gateways require more information than the ZipCode.  Use Address in that case.)
      • Address – An address
        • ID As Integer – Unused
        • FirstName As String – Unused
        • LastName As String – Unused
        • Address1 As String – Billing address, first line.
        • Address2 As String – Billing address, second line.
        • City As String – Billing address city.
        • State As String – Billing address state.
        • Zip As String – Billing zip code (first 5 digits only).
        • Zip4 As String - Billing +4 portion of zip code.
        • Country As String – 3 character Country ISO code.
    • CVV2 As String – optional depending upon your Merchant Gateway account.
    • PaymentAccountID As Integer – an existing credit card payment account to use for the payment. Note: this payment account must be associated with the Customer ID specified, and if used, none of the other fields in CreditCard are required.
  • ACH
    • NameOnAccount As String Name on banking account
    • AccountNumber As String Banking account number
    • RoutingNumber As String Nine digit bank code
    • Type As String CHECKING or SAVINGS
    • PaymentAccountID As Integer – an existing ACH payment account to use for the payment. Note: this payment account must be associated with the Customer ID specified, and if used, none of the other fields in ACH are required.
  • ManualElectronic
    • AuthCode As String – The Authorization Code returned from the merchant gateway.
    • EbillingProfileID As Integer – The payment account to record the payment for. Note that this payment account must be associated with the Customer ID specified.
    • MerchantProfileID As Integer – Required if an Rev.io is not storing subscription information for the payment profile.

Output

  • ID As Integer – Payment_ID from Rev.io if the Payment was created successfully.
  • Options
    • Returns the Options passed into the Request, with any modifications added.
  • CreditCardResult
    • Only returns on CREDIT_CARD types.
    • Message As String – Message from the Merchant Gateway.
    • TransactionNumber As String – TransactionId from the Merchant Gateway.
    • AuthCode As String – Authorization Code from the Merchant Gateway.
    • Approved As Boolean – True if the Payment was processed successfully, False if not.
    • EBillingProfileID As Integer – Identifies the EBillingProfile created on the customer's account in Rev.io to store the Credit Card information securely.
    • MerchantProfileID As Integer – Identifies the Merchant Profile (Settings > Merchant Profiles) used to process this transaction.
    • PaymentLogID As Integer – Identifies the PaymentLog created internally by Rev.io for this transaction.

Optional Output

  • Options
    • AgentID As Integer
    • Method As String
    • AgentNumber As String
    • ReceivedDate As DateTime
    • ReferenceNumber As String
  • CreditCard Result
    • Message As String
    • TransactionNumber As String
    • AuthCode As String
    • Approved As Boolean
    • EbillingProfile As Integer
    • MerchantProfileID As Integer
    • PaymentLogID As Integer
  • ACH Result
    • Message As String
    • TransactionNumber As String
    • AuthCode As String
    • Approved As Boolean
    • EBillingProfileID As Integer
    • MerchantProfileID As Integer
    • PaymentLogID As Integer


  • No labels