Get details for a specific credit card deposit

Use this endpoint to retrieve the full details of a specific credit card deposit using its unique referenceDepositID. This call returns all metadata associated with the deposit, including the customer and account identifiers, deposit status, amount, timestamps, funding source details, and any related processing information. This endpoint is most commonly used to check the current status of a credit card deposit (e.g., pending, completed, failed), confirm the amount, funding source, and card token used for the deposit, reconcile deposits within your platform by matching your internal reference to Tango's deposit record, and support operational workflows such as troubleshooting failed deposits or validating completed ones.

Use case

Acme Health uses this endpoint to verify the status and financial details of each funding transaction after submitting a credit card deposit, enabling automated confirmation that incentive funds are available before distributing patient rewards. By relying on this data, Acme ensures precise financial reconciliation, identifies failed or pending deposits early, and maintains consistent, reliable delivery of wellness incentives to patients.

Endpoint

Use the following endpoint to find out the details of a specific credit card deposit on your platform:

Endpoint	Description
`GET {URI}/creditCardDeposits/{referenceDepositID}`	Get details for a specific credit card Deposit.

Parameters

The path parameter used in this endpoint represents the unique credit card deposit identifier that Tango returns when you initially create a deposit:

Path Params	Data type	Requirement	Description
`referenceDepositID`	string	required	Credit card deposit identifier returned in `POST {URI}/creditCardDeposits` response payload when you Fund an account.

Response body

The response includes all deposit‑level attributes returned by this endpoint, but does not return full credit card numbers, cardholder credentials, or other sensitive data. These fields give you the complete data associated with a specific credit card deposit, such as its status, amount, timestamps, and the customer or account it belongs to.

On a successful request (200 OK), the response body includes the following fields:

Object	Data type	Description
referenceDepositID	string	A unique identifier for the deposit. You use this value to look up the specific deposit record.
amount	number	The dollar amount of the credit card deposit.
amountCharged	number	The total dollar amount charged to the credit card for the deposit transaction. This represents the exact amount the cardholder was billed when the deposit was processed.
feePercent	number	The percentage fee applied to the credit card deposit, represented as a decimal or percentage. This value indicates how much of the deposit amount is charged as a processing or service fee. It’s typically used in combination with `amountCharge` or `feeAmount` to calculate the total cost of the transaction.
createdDate	date-time	The timestamp indicating when the deposit record was created in the system.
status	string	The current state of the deposit. Common values may include: Pending Completed Failed Canceled
externalRefID	string	An optional external reference identifier supplied by your system or another integrated platform.
accountNumber	string	The account number associated with this deposit. This is not a credit card number, but the number of the customer’s account within your platform or Tango’s system.

Examples

The following payload is an example for when you get details for a credit card:

{
  "referenceDepositID": "string",
  "amount": 0,
  "amountCharged": 0,
  "feePercent": 0,
  "createdDate": "2025-02-03T21:19:59.336Z",
  "status": "string",
  "accountNumber": "string"
}

Here's an example payload for when you receive an error:

{
  "timestamp": "2025-02-21T23:23:13.930Z",
  "requestId": "string",
  "path": "string",
  "httpCode": 0,
  "httpPhrase": "string",
  "i18nKey": "string",
  "message": "The error message will show here for error codes ",
  "errors": [
    {}
  ]
}

Response codes

The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:

Response code	Meaning
200	The request was successful.
400	The server could not understand the request due to invalid syntax.
401	Authentication is required and has either not been provided or failed.
403	The server understood the request but refuses to authorize it.
404	The server could not find the requested resource. In other words, the URL you’re trying to access doesn’t point to anything that exists on the server.
500	Something went wrong on the server, but the server cannot be more specific about what the exact problem is.
503	The server is currently unable to handle the request due to temporary overload or maintenance.