## Get a charge by id.

`client.charges.unmask(stringid, ChargeUnmaskParamsparams?, RequestOptionsoptions?): ChargeUnmaskResponse`

**get** `/v1/charges/{id}/unmask`

Get a charge by id.

### Parameters

- `id: string`

- `params: ChargeUnmaskParams`

  - `correlationID?: string`

    Optional client generated identifier to trace and debug a series of requests.

  - `requestID?: string`

    Optional client generated identifier to trace and debug a request.

  - `straddleAccountID?: string`

    For use by platforms to specify an account id and set scope of a request.

### Returns

- `ChargeUnmaskResponse`

  - `data: Data`

    - `id: string`

      Id.

    - `amount: number`

      Amount.

    - `config: Config`

      - `balance_check: "required" | "enabled" | "disabled"`

        Defines whether to check the customer's balance before processing the charge.

        - `"required"`

        - `"enabled"`

        - `"disabled"`

      - `auto_hold?: boolean | null`

        Defines whether to automatically place this charge on hold after being created.

      - `auto_hold_message?: string | null`

        The reason the charge is being automatically held on creation.

      - `sandbox_outcome?: "standard" | "paid" | "on_hold_daily_limit" | 8 more`

        Payment will simulate processing if not Standard.

        - `"standard"`

        - `"paid"`

        - `"on_hold_daily_limit"`

        - `"cancelled_for_fraud_risk"`

        - `"cancelled_for_balance_check"`

        - `"failed_insufficient_funds"`

        - `"reversed_insufficient_funds"`

        - `"failed_customer_dispute"`

        - `"reversed_customer_dispute"`

        - `"failed_closed_bank_account"`

        - `"reversed_closed_bank_account"`

    - `consent_type: "internet" | "signed"`

      The channel or mechanism through which the payment was authorized. Use `internet` for payments made online or through a mobile app and `signed` for signed agreements where there is a consent form or contract. Use `signed` for PDF signatures.

      - `"internet"`

      - `"signed"`

    - `created_at: string`

      Created at.

    - `currency: string`

      Currency.

    - `description: string | null`

      Description.

    - `device: Device`

      - `ip_address: string`

        Ip address.

    - `external_id: string`

      External id.

    - `funding_ids: Array<string>`

      Funding Ids

    - `paykey: string`

      Paykey.

    - `payment_date: string`

      Payment date.

    - `status: "created" | "scheduled" | "failed" | 6 more`

      The current status of the `charge` or `payout`.

      - `"created"`

      - `"scheduled"`

      - `"failed"`

      - `"cancelled"`

      - `"on_hold"`

      - `"pending"`

      - `"paid"`

      - `"reversed"`

      - `"validating"`

    - `status_details: StatusDetailsV1`

      - `changed_at: string`

        The time the status change occurred.

      - `message: string`

        A human-readable description of the current status.

      - `reason: "insufficient_funds" | "closed_bank_account" | "invalid_bank_account" | 24 more`

        A machine-readable identifier for the specific status, useful for programmatic handling.

        - `"insufficient_funds"`

        - `"closed_bank_account"`

        - `"invalid_bank_account"`

        - `"invalid_routing"`

        - `"disputed"`

        - `"payment_stopped"`

        - `"owner_deceased"`

        - `"frozen_bank_account"`

        - `"risk_review"`

        - `"fraudulent"`

        - `"duplicate_entry"`

        - `"invalid_paykey"`

        - `"payment_blocked"`

        - `"amount_too_large"`

        - `"too_many_attempts"`

        - `"internal_system_error"`

        - `"user_request"`

        - `"ok"`

        - `"other_network_return"`

        - `"payout_refused"`

        - `"cancel_request"`

        - `"failed_verification"`

        - `"require_review"`

        - `"blocked_by_system"`

        - `"watchtower_review"`

        - `"validating"`

        - `"auto_hold"`

      - `source: "watchtower" | "bank_decline" | "customer_dispute" | 2 more`

        Identifies the origin of the status change (e.g., `bank_decline`, `watchtower`). This helps in tracking the cause of status updates.

        - `"watchtower"`

        - `"bank_decline"`

        - `"customer_dispute"`

        - `"user_action"`

        - `"system"`

      - `code?: string | null`

        The status code if applicable.

    - `status_history: Array<StatusHistory>`

      Status history.

      - `changed_at: string`

        The time the status change occurred.

      - `message: string`

        A human-readable description of the status.

      - `reason: "insufficient_funds" | "closed_bank_account" | "invalid_bank_account" | 24 more`

        A machine-readable identifier for the specific status, useful for programmatic handling.

        - `"insufficient_funds"`

        - `"closed_bank_account"`

        - `"invalid_bank_account"`

        - `"invalid_routing"`

        - `"disputed"`

        - `"payment_stopped"`

        - `"owner_deceased"`

        - `"frozen_bank_account"`

        - `"risk_review"`

        - `"fraudulent"`

        - `"duplicate_entry"`

        - `"invalid_paykey"`

        - `"payment_blocked"`

        - `"amount_too_large"`

        - `"too_many_attempts"`

        - `"internal_system_error"`

        - `"user_request"`

        - `"ok"`

        - `"other_network_return"`

        - `"payout_refused"`

        - `"cancel_request"`

        - `"failed_verification"`

        - `"require_review"`

        - `"blocked_by_system"`

        - `"watchtower_review"`

        - `"validating"`

        - `"auto_hold"`

      - `source: "watchtower" | "bank_decline" | "customer_dispute" | 2 more`

        Identifies the origin of the status change (e.g., `bank_decline`, `watchtower`). This helps in tracking the cause of status updates.

        - `"watchtower"`

        - `"bank_decline"`

        - `"customer_dispute"`

        - `"user_action"`

        - `"system"`

      - `status: "created" | "scheduled" | "failed" | 6 more`

        The current status of the `charge` or `payout`.

        - `"created"`

        - `"scheduled"`

        - `"failed"`

        - `"cancelled"`

        - `"on_hold"`

        - `"pending"`

        - `"paid"`

        - `"reversed"`

        - `"validating"`

      - `code?: string | null`

        The status code if applicable.

    - `trace_ids: Record<string, string>`

      Trace Ids.

    - `updated_at: string`

      Updated at.

    - `customer_details?: CustomerDetailsV1`

      Information about the customer associated with the charge or payout.

      - `id: string`

        Unique identifier for the customer

      - `customer_type: "individual" | "business"`

        The type of customer

        - `"individual"`

        - `"business"`

      - `email: string`

        The customer's email address

      - `name: string`

        The name of the customer

      - `phone: string`

        The customer's phone number in E.164 format

    - `effective_at?: string | null`

      Effective at.

    - `metadata?: Record<string, string> | null`

      Metadata.

    - `paykey_details?: PaykeyDetailsV1`

      - `id: string`

        Unique identifier for the paykey.

      - `customer_id: string`

        Unique identifier for the customer associated with the paykey.

      - `label: string`

        Human-readable label that combines the bank name and masked account number to help easility represent this paykey in a UI

      - `balance?: number | null`

        The most recent balance of the bank account associated with the paykey in dollars.

    - `payment_rail?: "ach"`

      The payment rail used for the charge or payout.

      - `"ach"`

    - `processed_at?: string | null`

      Processed at.

    - `related_payments?: Record<string, "original" | "resubmit" | "refund"> | null`

      Related payments.

      - `"original"`

      - `"resubmit"`

      - `"refund"`

  - `meta: ResponseMetadata`

    Metadata about the API request, including an identifier and timestamp.

    - `api_request_id: string`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: string`

      Timestamp for this API request, useful for troubleshooting.

  - `response_type: "object" | "array" | "error" | "none"`

    Indicates the structure of the returned content.

    - "object" means the `data` field contains a single JSON object.
    - "array" means the `data` field contains an array of objects.
    - "error" means the `data` field contains an error object with details of the issue.
    - "none" means no data is returned.

    - `"object"`

    - `"array"`

    - `"error"`

    - `"none"`

### Example

```typescript
import Straddle from '@straddlecom/straddle';

const client = new Straddle({
  apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted
});

const response = await client.charges.unmask('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(response.data);
```

#### Response

```json
{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "amount": 0,
    "config": {
      "balance_check": "required",
      "auto_hold": true,
      "auto_hold_message": "auto_hold_message",
      "sandbox_outcome": "standard"
    },
    "consent_type": "internet",
    "created_at": "2019-12-27T18:11:19.117Z",
    "currency": "currency",
    "description": "description",
    "device": {
      "ip_address": "ip_address"
    },
    "external_id": "external_id",
    "funding_ids": [
      "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    ],
    "paykey": "paykey",
    "payment_date": "2019-12-27",
    "status": "created",
    "status_details": {
      "changed_at": "2019-12-27T18:11:19.117Z",
      "message": "Payment successfully created and awaiting validation.",
      "reason": "insufficient_funds",
      "source": "system",
      "code": null
    },
    "status_history": [
      {
        "changed_at": "2019-12-27T18:11:19.117Z",
        "message": "Payment successfully created and awaiting validation.",
        "reason": "insufficient_funds",
        "source": "watchtower",
        "status": "created",
        "code": null
      }
    ],
    "trace_ids": {
      "foo": "string"
    },
    "updated_at": "2019-12-27T18:11:19.117Z",
    "customer_details": {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "customer_type": "individual",
      "email": "ron@swanson.com",
      "name": "Ron Swanson",
      "phone": "+1234567890"
    },
    "effective_at": "2019-12-27T18:11:19.117Z",
    "metadata": {
      "foo": "string"
    },
    "paykey_details": {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "label": "Bank of America ****1234",
      "balance": 0
    },
    "payment_rail": "ach",
    "processed_at": "2019-12-27T18:11:19.117Z",
    "related_payments": {
      "foo": "original"
    }
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}
```