customer/v1/token/fund
[POST] customer/v1/token/fund
Fund account via tokenized debit card
The tokenized fund endpoint allows customers to fund their account balance via transaction from an external debit card account. The card details are tokenized first, before being passed in the POST call as "paymentToken". The "cardType" for this transaction must be "TOKEN". 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/token/fund
{
"amount" : "",
"currency" : "",
"memo" : "",
"cardType" : "",
"paymentToken" : "",
"cardholderFirstname" : "",
"cardholderLastname" : "",
"cardholderCompany" : "",
"cardholderAddress1" : "",
"cardholderAddress2" : "",
"cardholderCity" : "",
"cardholderState" : "",
"cardholderZip" : "",
"cardholderCountry" : "",
"cardholderPhone" : "",
"cardholderEmail" : "",
}
Input Parameters
Parameter | Size/Absolute Value Restrictions | Format Restrictions | Required | Type |
---|---|---|---|---|
amount | >=100 and <= 100000 | Funding amount in the lowest currency (cents) | Y | Numeric |
currency | 3 | ISO 4217 | Y | String |
memo | 200 | None | N | Alphanumeric |
cardType | 50 | Should accept "TOKEN" only | Y | Alpha |
cardholderFirstName | 50 | No special characters (" !"#$%'*+.:;<=>?@[]^_`{|}~") | Y | Alpha |
cardholderLastName | 50 | No special characters (" !"#$%'*+.:;<=>?@[]^_`{|}~") | Y | Alpha |
cardholderCompany | 100 | No special characters " !"#$%'*+.:;<=>?@[]^_`{|}~" Except: ()'-&,/ | N | Alphanumeric |
cardholderAddress1 | 128 | None | Y | Alphanumeric |
cardholderAddress2 | 128 | None | N | Alphanumeric |
cardholderCity | 100 | No special characters (" !"#$%'*+.:;<=>?@[]^_`{|}~") | Y | Alpha |
cardholderState | 2 | ISO 3166-2:US | Y | Alpha |
cardholderZip | 9 | No dashes Has to be minimum of 5 digits or 9 digits if more than 5. | Y | Numeric |
cardholderCountry | 2 | ISO 3166 - alpha 2 | N | Alpha |
cardholderPhone | 10 | No special characters (" !"#$%'*+:;<=>?[]^_`{|}~") No dashes or hyphens | N | Numeric |
cardholderEmail | 320 | No special characters (" !"#$%'*+:;<=>?[]^_`{|}~") Exception: “At” sign - “@” allowed directly preceding the domain name. Alphanumeric prefix with the @ symbol followed by most common Top Level Domains (TLDs) .com/.co/.net/.org/.edu/.gov/.us | N | Alphanumeric |
Card Types
Code | description | Notes |
---|---|---|
TOKEN | Tokenized debit card information | Requires paymentToken |
Example Response
{
"fund" : {
"amount" : "",
"currency" : "",
"memo" : "",
"cardType" : "",
"paymentToken" : "",
"cardholderFirstname" : "",
"cardholderLastname" : "",
"cardholderCompany" : "",
"cardholderAddress1" : "",
"cardholderAddress2" : "",
"cardholderCity" : "",
"cardholderState" : "",
"cardholderZip" : "",
"cardholderCountry" : "",
"cardholderPhone" : "",
"cardholderEmail" : "",
},
"transactionId" : "",
"cardToken" : "",
"status": "",
"dateCreated": "",
"dateUpdated": "",
}
Response Elements
(In addition to elements found in the input parameters)
Element | Details |
---|---|
transactionId | UUID payment identifier |
cardToken | Tokenized debit card information |
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
Category | Response Code | Response Error Message |
---|---|---|
Format | AB3006 | : Invalid Format |
Size (S) | AB3010 | : Invalid Length |
Required (R) | AB3013 | : Missing Required Field |
Updated 4 months ago