credit-card/charge

post

https://earthnode-dev.vopay.com/api/v2/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

AccountID

string

required

Your account ID

Key

string

required

API key for the account

Signature

string

required

Hashed signature for the request

ClientAccountID

string

Client Account ID

ContactID

string

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

CreditCardToken

string

required

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

Amount

number

required

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

Currency

string

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).

Country

string

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).

ClientReferenceNumber

string

Optional reference number for the transaction.

IdempotencyKey

string

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

GLCode

string

An optional unique identification general ledger code.

TransactionTypeCode

string

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).

TransactionLabel

string

Statement descriptor. Max 25 chars.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200