VOvopay
Credit Card Endpoints

credit-card/charge

This endpoint is to create a credit card transaction to fund your VoPay account, charging the amount specified to the credit card linked to the provided CreditCardToken.

If a ClientAccountID is provided, the client account's default credit card will be used for the transaction.

Note: You must first generate a CreditCardToken using the /credit-card/generate-embed-url endpoint.

post/credit-card/charge

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/credit-card/charge
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ClientAccountIDstring

Client Account ID

ContactIDstring

The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.

CreditCardTokenstring required

The token identifying the credit card to charge (returned from /credit-card/generate-embed-url).

Amountnumber required

The amount to charge from the customer's credit card.

Currencystring

3 character currency code for the currency to be charged into the customer credit card. If this is not specified the transaction will use the account's local currency (CAD).

Countrystring

Customer's country specified using full country name or ISO 3166-1 alpha-2 code. If this is not specified the transaction will use the local country (CA).

ClientReferenceNumberstring

Optional reference number for the transaction.

IdempotencyKeystring

A unique key which the server can use to recognize and reject subsequent retries of the same request.

GLCodestring

An optional unique identification general ledger code.

TransactionTypeCodestring

CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).

TransactionLabelstring

Statement descriptor. Max 25 chars.

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

TransactionIDinteger required

The unique ID of the transaction that was just submitted.

Flaggedstring

Details on why the transaction was flagged, if applicable. Flagged transactions will need to be confirmed by using the /account/transaction/confirm endpoint.

Example response

{
  "Success": true,
  "Flagged": "The transaction has been flagged as a potential duplicate."
}

Changes

No recorded changes to this operation across all 1 revision of this API.