customer/v1/fund

[POST] customer/v1/fund

Fund account via debit card

The fund endpoint allows customers to fund their account balance via transaction from an external debit card account. Funds are not available immediately, they will display in the customer's current balance, but they require settlement before they display in the customer's available balance. All funding requests are made in the lowest possible denomination of a currency; eg a funding request for $1.00 USD will be sent as 100.

Example [POST] Request

{{card_base_url}}/customer/v1/fund

{
        "amount" : "",
        "currency" : "",
        "memo" : "",
        "cardType" : "",
        "cardNumber" : "",
        "cardExp" : "",
        "cardCvv" : "",
        "cardholderFirstname" : "",
        "cardholderLastname" : "",
        "cardholderCompany" : "",
        "cardholderAddress1" : "", 
        "cardholderAddress2" : "",
        "cardholderCity" : "",
        "cardholderState" : "",
        "cardholderZip" : "",
        "cardholderCountry" : "",
        "cardholderPhone" : "",
        "cardholderEmail" : "",
        "saveCard" : "",
}

Input Parameters

Parameter	Format	Required	Details
"amount"	Integer	Y	Funding amount in lowest currency e.g. cents
"currency"	String; Three-letter ISO currency code	Y	The transaction currency
"memo"	String	N	The transaction memo
"cardType"	enum	Y	Card type. See below
"cardNumber"	String	Y	Credit card number
"cardExp"	String	C; required for cardType of "DEBIT"	Card expiration date
"cardCvv"	String	N	Card security code (CVV / CVC)
"cardholderFirstname"	String	Y	Cardholder first name
"cardholderLastname"	String	Y	Cardholder last name
"cardholderCompany"	String	N	Cardholder's company
"cardholderAddress1"	String	Y	Cardholder's billing address
"cardholderAddress2"	String	N	Cardholder's billing address, line 2
"cardholderCity"	String	Y	Cardholder's billing city
"cardholderState"	String; Format: CC	Y	Cardholder's billing state
"cardholderZip"	String	Y	Cardholder's billing zip code
"cardholderCountry"	String; Two-letter ISO 3166. Format: CC	N	Cardholder's billing country
"cardholderPhone"	String	N	Cardholder's billing phone number
"cardholderEmail"	String	N	Cardholder's billing email
"saveCard"	Boolean	Y	Customer authorization to save card details

Card Types

Code	description	Notes
`DEBIT`	Debit card	Requires cardExp

Example Response

{
    "fund" : {
        "amount" : "",
        "currency" : "",
        "memo" : "",
        "cardType" : "",
        "cardNumber" : "",
        "cardExp" : "",
        "cvv" : "",
        "cardholderFirstname" : "",
        "cardholderLastname" : "",
        "cardholderCompany" : "",
        "cardholderAddress1" : "",
        "cardholderAddress2" : "",
        "cardholderCity" : "",
        "cardholderState" : "",
        "cardholderZip" : "",
        "cardholderCountry" : "",
        "cardholderPhone" : "",
        "cardholderEmail" : "",
        "saveCard" : "",
    },
    "transactionId" : "",
    "cardToken" : "",
    "status": "",
    "dateCreated": "",
    "dateUpdated": "",
}

Response Elements

(In addition to elements found in the input parameters)

Element	Details
transactionId	UUID payment identifier
cardToken	Avenu issued card token; set to blank currently
status	Status of payment at end of transaction. See Payments Overview.
dateCreated	Transaction processed date in format ISO 8601 YYYY-MM-DD.
dateUpdated	Date of last status update in format ISO 8601 YYYY-MM-DD

Error Codes

code	Message
1001	"Missing required field"
1002	"Invalid data structure"
1003	"Invalid data"