Fund your account
Before submitting your first order, you need to fund your account. In Tango, you can fund for free via Automated Clearing House (ACH), wire transfer, or check. You may also use Credit Cards to fund your account, but there is a 3.5% associated fee with Credit Cards. Currently, only Credit Card funding is accessible using the API. Your Tango Customer Success manager will provide instructions for using these funding methods.
Fund an account
Use the following endpoints to fund an account.
Endpoint | Description |
---|---|
POST {URI}/creditCardDeposits | Fund an Account. |
Here are a list of parameters for when you use POST {URI}/creditCardDeposits
to fund an account.
Parameter | Data Type | Description |
---|---|---|
customerIdentifier | string | Specify the customer associated with the Credit Card. It must be the customer the accountIdentifier is associated with. The string must have 5-100 characters. |
accountIdentifier | string | Specify the account this Credit Card is associated with. The string must have 5-100 characters. |
creditCardToken | string | Specify the Credit Card token to fund with. The string must have 40 characters. |
amount | string | Specify the amount to fund in USD. |
The response message for this endpoint is:
- 200 OK
- 400 Bad request
- 401 Unauthorized
- 403 Forbidden
When you perform a funding call, one of these statuses are returned:
Status | Description | Authorization | Account balance update | Charged |
---|---|---|---|---|
Success | The funding transaction has successfully completed and funds have been applied to the specified account. | Yes | Yes | Yes |
Pending | The deposit has been received but the processing is not completed yet. It may be subject to review by Tango. While an authorization has been requested from the issuing bank, a capture/settlement has not yet occurred, and therefore the Credit Card has not yet been charged, as indicated by amountCharged in the response. It may take up to the end of the following business day for pending deposits to complete processing and transition status. | Yes | No | No |
Declined | The funding transaction did not complete successfully and funds were not applied to the account. The Credit Card was not charged. If you need assistance, please contact [email protected]. | Yes* | No | No |
The following example shows the response using POST {URI}/creditCardDeposits\
to fund your account:
{
"accountIdentifier": "string", (5-100 chars)
"amount": 1000,
"creditCardToken": "string", (40 chars)
"customerIdentifier": "string", (5-100 chars)
}
Note:
Authorizations may take several business days to expire.
Get details for a specific credit card deposit
Use the GET {URI}/creditCardDeposits/{DepositID}
endpoint to get the details of a specific card.
Endpoint | Description |
---|---|
GET {URI}/creditCardDeposits/{DepositID} | Get details for a specific Credit Card Deposit. |
Here is the path parameter for GET {URI}/creditCardDeposits/{DepositID}
endpoint.
Path Parameter | Data Type | Description |
---|---|---|
referenceDepositID | string | Credit card deposit identifier returned in Fund an Account (POST /creditCardDeposits) response payload. |
The response message for this endpoint is:
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
Unregister a credit card
You may remove a stored Credit Card from your account by unregistering it. Once a Credit Card is unregistered it can no longer be used to fund an Account until it is registered again.
In some rare instances, Tango may choose to unregister Credit Cards at its own discretion. If this occurs Tango will make a best effort to notify the business contact on the account.
Endpoint | Description |
---|---|
POST {URI}/creditCardUnregisters | unregister a Credit Card. |
The following parameters are used for POST {URI}/creditCardUnregisters
endpoint to unregister a Credit Card. The Credit Card token provided in the call is specially useful when you intend to apply access restrictions.
Body Parameter | Data Type | Description |
---|---|---|
customerIdentifier | string | Specify the customer associated with the Credit Card. It must be the customer the accountIdentifier is associated with. The string must have 5-100 characters. |
accountIdentifier | string | Specify the Account this Credit Card is associated with. |
creditCardToken | string | Specify the Credit Card token to unregister. The string must have 40 characters. |
The response message this query is:
- 200 OK
- 400 Bad request
- 401 Unauthorized
- 403 Forbidden
List all credit cards registered on this platform
Use the GET {URI}/creditCards
endpoint to list all Credit Cards registered on this platform.
Endpoint | Description |
---|---|
GET {URI}/creditCards | List all Credit Cards registered on this Platform. |
The following parameter is used for GET {URI}/creditCards
endpoint.
Query Parameter | Data Type | Description |
---|---|---|
showInactive | string | Show inactive cards (true or false). |
The response message for this query is:
- 200 OK
- 400 Bad request
- 401 Unauthorized
- 403 Forbidden
Register a new credit card
Currently, only Credit Card funding is accessible using the API. Credit cards that are successfully registered provide an activation date in the registration response. Registered Credit Cards are available to fund your account immediately. The first funding after registration must occur after the activation date is returned in the registration response. Any funding attempt prior to the activation date will return an error. All funding calls require the origin token returned at the time of registration.
Notes:
- Up to ten Credit Cards can be registered for an account.
- There is a 3.5% fee associated with Credit Card funding transactions.
Use the following endpoint to register a new Credit Card on this platform:
Endpoint | Description |
---|---|
POST {URI}/creditCards | Register a new Credit Card. |
Here is the list of parameters for when you use POST {URI}/creditCards
to register a new Credit Card.
Body Parameter | Data Type | Description |
---|---|---|
customerIdentifier | string | Specify the customer associated with the Credit Card. It must be the customer the accountIdentifier is associated with. The string must have 5-100 characters. |
accountIdentifier | string | Specify the account this Credit Card is associated with The string must have 5-100 characters. |
ipAdress | string | Specify the The IP address of the person adding the Credit Card |
label | string | Specify a label for the Credit Card |
creditCard | object | Required Enter the Credit Card details that is being registered |
-number | string | Specify the account this order will be deducted from |
-expiration | string | Specify the card expiration date in YYYY-MM format |
-verificationNumber | string | Specify the 3 or 4-digit card security code on back of card (CVV2, CVC2, or CID) |
billingAddress | object | (Required) Enter the billing address information for the Credit Card that is being registered |
-firstName | string | Specify the billing address first name |
-lastName | string | Specify the billing address last name |
-adressLine1 | string | Specify the billing address line 1 |
-addressLine2 | string | (Optional) Specify the billing address line 2 |
-city | string | Specify the billing address city |
-state | string | Specify the billing address state |
-postalCode | string | Specify the billing address postal code |
-country | string | Specify the billing address 2-letter country code |
-emailAddress | string | Specify the billing address email |
contactInformation | array of objects | (Optional) Enter the contact information of the any person(s) who will be notified if there are issues. |
-fullName | string | (Optional) Used for email receipts. Specify the contact full name. |
-emailAddress | string | (Optional) Used for email receipts. Specify the contact email address. |
The response message for this endpoint is:
- 201 Created
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
How to register a new credit card for sandbox
When registering a Credit Card for your Sandbox, you must use the correct card number for the type of card you are testing. Other numbers are not supported in the Sandbox environment:
Card Brand | Credit Card Number | Security Code |
---|---|---|
Visa | 4111111111111111 | requires 3-digit security code. |
MasterCard | 5555555555554444 | requires 3-digit security code. |
Discover | 6011111111111117 | requires 3-digit security code. |
American Express | 378282246310005 | requires 4-digit security code. |
Test Credit Card Registered with Sandbox
You can test a pending Credit Card deposit status and simulated transitions in our sandbox environment with expected updates within one hour:
- $5.55 - Initial response status of PENDING and resolves to SUCCESS
- $6.55 - Initial response of PENDING and resolves to DECLINED
- $7.55 - Initial and final response of DECLINED
The following example shows the response using POST {URI}/creditCards
to register a fake sandbox Credit Card for your account:
{
"accountIdentifier": "string", (5-100 chars)
"billingAddress": {
"addressLine1": "123 Street",
"addressLine2": "Suite 456",
"city": "Seattle",
"country": "US",
"emailAddress": "[email protected]",
"firstName": "First",
"lastName": "Last",
"postalCode": "12345",
"state": "WA"
},
"creditCard": {
"expiration": "2025-12",
"number": "4111111111111111",
"verificationNumber": "123"
},
"customerIdentifier": "string", (5-100 chars)
"ipAddress": "100.10.SAMPLE.10",
"label": "Test Card"
}
How to get an email receipt when registering a credit card
For the Credit Cards that are successfully registered after March 22, 2018, Tango sends Credit Card funding receipts to the primary email address included in the registration call as well as up to five additional specified contacts. A contact is defined by an emailAddress and fullName.
Contacts included with a successful registration call are reflected in the response. Contacts can also be retrieved at any time using GET creditCards.
Receipts are only sent after a successful funding attempt has completed processing, the Credit Card has been charged, and the associated account balance is updated.
Note:
For security reasons, the primary email address provided during Credit Card registration cannot be modified. To change the contacts where receipts are sent, the Credit Card must be deleted and re-registered with a new contact.
Get details for a specific credit card deposit
To view the details of a specific Credit Card, use the Credit Card token provided in the call. This is specially useful when you intend to apply access restrictions.
Endpoint | Description |
---|---|
GET {URI}/creditCards/{token} | Get details for a specific Credit Card. |
Here is the path parameter for when you use GET {URI}/creditCards/{token}
to get details for a specific Credit Card.
Path Parameter | Data Type | Description |
---|---|---|
token | string | Credit Card token |
The response message for this endpoint is:
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
Also visit our cross-site scripting (XXS) and Malicious Behavior.
Updated 4 days ago