# Cash App

> Manage Cash App Pay brands, merchants, customer grants, payments, refunds and disputes.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/cash-app

## Actions

### Capture payment

Set the final amount of an authorized payment and complete it, so it is paid out in the next nightly settlement.

**Inputs**

- Payment id (`payment_id`, text, required): Payment id.
- Idempotency key (`idempotency_key`, text, required): A unique identifier which can be used by Cash App to de-duplicate retries of this request, making it idempotent. For more information, see Idempotency.
- Amount (`amount`, number, required): The amount of money to collect from the customer, in the lowest denomination of currency for the payment. To over-capture or under-capture the payment, set this field to a different value from the current payment amount. Min value: 1. At least 1.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "payment": {
      "amount": 1,
      "authorization_updates": [],
      "capture_before": "example",
      "captured_amount": 1,
      "created_at": "example",
      "currency": "USD",
      "customer_id": "example",
      "decline_errors": [],
      "enrichments": {
        "initiation": {
          "actor": "CUSTOMER"
        },
        "recurring_series_id": "example",
        "restricted_categories": [],
        "statement_descriptor": "example"
      },
      "fee_amount": 1.0,
      "fee_rate": {
        "basis_points": 1,
        "fixed_amount": 1
      },
      "grant_id": "example",
      "id": "example",
      "merchant_id": "example",
      "metadata": {},
      "net_amount": 1,
      "reference_id": "example",
      "refund_ids": [],
      "refunded_amount": 1,
      "status": "AUTHORIZED",
      "updated_at": "example",
      "voided_amount": 1
    }
  }
}
```

### Capture refund

Complete a refund, so it is paid out in the next nightly settlement.

**Inputs**

- Refund id (`refund_id`, text, required): Refund id.
- Idempotency key (`idempotency_key`, text, required): A unique identifier which can be used by Cash App to de-duplicate retries of this request, making it idempotent. For more information, see Idempotency.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "refund": {
      "amount": 1,
      "created_at": "example",
      "currency": "USD",
      "customer_id": "example",
      "decline_errors": [],
      "grant_id": "example",
      "id": "example",
      "merchant_id": "example",
      "metadata": {},
      "payment_id": "example",
      "reference_id": "example",
      "status": "AUTHORIZED",
      "updated_at": "example"
    }
  }
}
```

### Create brand

Create a brand.

**Inputs**

- Idempotency key (`idempotency_key`, text, required): A unique identifier which can be used by Cash App to de-duplicate retries of this request, making it idempotent. For more information, see Idempotency.
- Brand (`brand`, object, required): Details about the brand to create.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "brand": {
      "color": "example",
      "created_at": "example",
      "id": "example",
      "metadata": {},
      "name": "example",
      "profile_image_url": "example",
      "reference_id": "example",
      "updated_at": "example"
    }
  }
}
```

### Create merchant

Create a merchant. A merchant needs an address or a website URL.

**Inputs**

- Idempotency key (`idempotency_key`, text, required): A unique identifier which can be used by Cash App to de-duplicate retries of this request, making it idempotent. For more information, see Idempotency.
- Merchant (`merchant`, object, required): Details about the merchant to create.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "merchant": {
      "address": {
        "address_line_1": "example",
        "address_line_2": "example",
        "administrative_district_level_1": "example",
        "country": "US",
        "locality": "example",
        "postal_code": "example"
      },
      "brand_id": "example",
      "category": "example",
      "country": "US",
      "created_at": "example",
      "currency": "USD",
      "default_fee_plans": {
        "in_app_fee_plan_id": "example",
        "in_person_fee_plan_id": "example",
        "online_fee_plan_id": "example"
      },
      "id": "example",
      "metadata": {},
      "name": "example",
      "reference_id": "example",
      "site_url": "example",
      "status": "ACTIVE",
      "updated_at": "example"
    }
  }
}
```

### Create payment

Create a payment from a customer to a merchant.

**Inputs**

- Idempotency key (`idempotency_key`, text, required): A unique identifier which can be used by Cash App to de-duplicate retries of this request, making it idempotent. For more information, see Idempotency.
- Payment (`payment`, object, required): Data about the payment to create.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "payment": {
      "amount": 1,
      "authorization_updates": [],
      "capture_before": "example",
      "captured_amount": 1,
      "created_at": "example",
      "currency": "USD",
      "customer_id": "example",
      "decline_errors": [],
      "enrichments": {
        "initiation": {
          "actor": "CUSTOMER"
        },
        "recurring_series_id": "example",
        "restricted_categories": [],
        "statement_descriptor": "example"
      },
      "fee_amount": 1.0,
      "fee_rate": {
        "basis_points": 1,
        "fixed_amount": 1
      },
      "grant_id": "example",
      "id": "example",
      "merchant_id": "example",
      "metadata": {},
      "net_amount": 1,
      "reference_id": "example",
      "refund_ids": [],
      "refunded_amount": 1,
      "status": "AUTHORIZED",
      "updated_at": "example",
      "voided_amount": 1
    }
  }
}
```

### Create refund

Create a refund from a merchant to a customer.

**Inputs**

- Idempotency key (`idempotency_key`, text, required): A unique identifier which can be used by Cash App to de-duplicate retries of this request, making it idempotent. For more information, see Idempotency.
- Refund (`refund`, object, required): Details about the refund to create.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "refund": {
      "amount": 1,
      "created_at": "example",
      "currency": "USD",
      "customer_id": "example",
      "decline_errors": [],
      "grant_id": "example",
      "id": "example",
      "merchant_id": "example",
      "metadata": {},
      "payment_id": "example",
      "reference_id": "example",
      "status": "AUTHORIZED",
      "updated_at": "example"
    }
  }
}
```

### Get balance

Get one balance by its ID.

**Inputs**

- Balance id (`balance_id`, text, required): Balance id.
- Grant id (`grant_id`, text): Grant id.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "balance": {
      "amount": 1,
      "created_at": "example",
      "currency": "USD",
      "customer_id": "example",
      "id": "example",
      "type": "CHECKING",
      "updated_at": "example"
    }
  }
}
```

### Get brand

Get one brand by its ID.

**Inputs**

- Brand id (`brand_id`, text, required): Brand id.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "brand": {
      "color": "example",
      "created_at": "example",
      "id": "example",
      "metadata": {},
      "name": "example",
      "profile_image_url": "example",
      "reference_id": "example",
      "updated_at": "example"
    }
  }
}
```

### Get customer

Get one customer by their ID.

**Inputs**

- Customer id (`customer_id`, text, required): Customer id.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "customer": {
      "cashtag": "example",
      "id": "example",
      "reference_id": "example"
    }
  }
}
```

### Get customer grant

Get one customer grant, by the ID of the customer who approved it and the grant's own ID.

**Inputs**

- Customer id (`customer_id`, text, required): Customer id.
- Grant id (`grant_id`, text, required): Grant id.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "grant": {
      "action": {},
      "channel": "IN_PERSON",
      "created_at": "example",
      "customer_id": "example",
      "expires_at": "example",
      "id": "example",
      "request_id": "example",
      "status": "ACTIVE",
      "type": "ONE_TIME",
      "updated_at": "example"
    }
  }
}
```

### Get merchant

Get one merchant by its ID.

**Inputs**

- Merchant id (`merchant_id`, text, required): Merchant id.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "merchant": {
      "address": {
        "address_line_1": "example",
        "address_line_2": "example",
        "administrative_district_level_1": "example",
        "country": "US",
        "locality": "example",
        "postal_code": "example"
      },
      "brand_id": "example",
      "category": "example",
      "country": "US",
      "created_at": "example",
      "currency": "USD",
      "default_fee_plans": {
        "in_app_fee_plan_id": "example",
        "in_person_fee_plan_id": "example",
        "online_fee_plan_id": "example"
      },
      "id": "example",
      "metadata": {},
      "name": "example",
      "reference_id": "example",
      "site_url": "example",
      "status": "ACTIVE",
      "updated_at": "example"
    }
  }
}
```

### Get payment

Get one payment by its ID.

**Inputs**

- Payment id (`payment_id`, text, required): Payment id.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "payment": {
      "amount": 1,
      "authorization_updates": [],
      "capture_before": "example",
      "captured_amount": 1,
      "created_at": "example",
      "currency": "USD",
      "customer_id": "example",
      "decline_errors": [],
      "enrichments": {
        "initiation": {
          "actor": "CUSTOMER"
        },
        "recurring_series_id": "example",
        "restricted_categories": [],
        "statement_descriptor": "example"
      },
      "fee_amount": 1.0,
      "fee_rate": {
        "basis_points": 1,
        "fixed_amount": 1
      },
      "grant_id": "example",
      "id": "example",
      "merchant_id": "example",
      "metadata": {},
      "net_amount": 1,
      "reference_id": "example",
      "refund_ids": [],
      "refunded_amount": 1,
      "status": "AUTHORIZED",
      "updated_at": "example",
      "voided_amount": 1
    }
  }
}
```

### Get refund

Get one refund by its ID.

**Inputs**

- Refund id (`refund_id`, text, required): Refund id.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "refund": {
      "amount": 1,
      "created_at": "example",
      "currency": "USD",
      "customer_id": "example",
      "decline_errors": [],
      "grant_id": "example",
      "id": "example",
      "merchant_id": "example",
      "metadata": {},
      "payment_id": "example",
      "reference_id": "example",
      "status": "AUTHORIZED",
      "updated_at": "example"
    }
  }
}
```

### List balances

List balances, optionally filtered by customer, grant or type.

**Inputs**

- Customer id (`customer_id`, text, required): Customer id.
- Type (`type`, text, required): Type. One of: `CHECKING`.
- Grant id (`grant_id`, text): Grant id.
- Cursor (`cursor`, text): Cursor.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `50`.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "balances": [],
    "cursor": "example"
  }
}
```

### List brands

List brands, optionally filtered by reference ID.

**Inputs**

- Cursor (`cursor`, text): Cursor.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `50`.
- Reference id (`reference_id`, text): Reference id.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "brands": [],
    "cursor": "example"
  }
}
```

### List customer grants

List a customer's grants.

**Inputs**

- Customer id (`customer_id`, text, required): Customer id.
- Cursor (`cursor`, text): Cursor.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `50`.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "cursor": "example",
    "grants": []
  }
}
```

### List customers

List the customers who have ever allowed you to take actions on their Cash App account, optionally filtered by cashtag.

**Inputs**

- Cursor (`cursor`, text): Cursor.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `50`.
- Cashtag (`cashtag`, text): Cashtag.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "cursor": "example",
    "customers": []
  }
}
```

### List disputes

List the disputes on your payments, optionally for one merchant.

**Inputs**

- Cursor (`cursor`, text): Cursor.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `50`.
- Merchant id (`merchant_id`, text): Merchant id.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "cursor": "example",
    "disputes": []
  }
}
```

### List merchants

List merchants, optionally filtered by reference ID.

**Inputs**

- Reference id (`reference_id`, text): Reference id.
- Cursor (`cursor`, text): Cursor.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `50`.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "cursor": "example",
    "merchants": []
  }
}
```

### List payments

List payments, optionally filtered by customer, merchant or reference ID.

**Inputs**

- Cursor (`cursor`, text): Cursor.
- Reference id (`reference_id`, text): Reference id.
- Customer id (`customer_id`, text): Customer id.
- Merchant id (`merchant_id`, text): Merchant id.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `50`.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "cursor": "example",
    "payments": []
  }
}
```

### List refunds

List refunds, optionally filtered by customer, merchant or reference ID.

**Inputs**

- Cursor (`cursor`, text): Cursor.
- Reference id (`reference_id`, text): Reference id.
- Customer id (`customer_id`, text): Customer id.
- Merchant id (`merchant_id`, text): Merchant id.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `50`.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "cursor": "example",
    "refunds": []
  }
}
```

### Update brand

Update a brand.

**Inputs**

- Brand id (`brand_id`, text, required): Brand id.
- Brand (`brand`, object, required): Details about the brand to update

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "brand": {
      "color": "example",
      "created_at": "example",
      "id": "example",
      "metadata": {},
      "name": "example",
      "profile_image_url": "example",
      "reference_id": "example",
      "updated_at": "example"
    }
  }
}
```

### Update merchant

Update a merchant.

**Inputs**

- Merchant id (`merchant_id`, text, required): Merchant id.
- Merchant (`merchant`, object, required): Details about the merchant to update.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "merchant": {
      "address": {
        "address_line_1": "example",
        "address_line_2": "example",
        "administrative_district_level_1": "example",
        "country": "US",
        "locality": "example",
        "postal_code": "example"
      },
      "brand_id": "example",
      "category": "example",
      "country": "US",
      "created_at": "example",
      "currency": "USD",
      "default_fee_plans": {
        "in_app_fee_plan_id": "example",
        "in_person_fee_plan_id": "example",
        "online_fee_plan_id": "example"
      },
      "id": "example",
      "metadata": {},
      "name": "example",
      "reference_id": "example",
      "site_url": "example",
      "status": "ACTIVE",
      "updated_at": "example"
    }
  }
}
```

### Void payment

Void an authorized payment, releasing the hold on the customer's Cash App account.

**Inputs**

- Payment id (`payment_id`, text, required): Payment id.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "payment": {
      "amount": 1,
      "authorization_updates": [],
      "capture_before": "example",
      "captured_amount": 1,
      "created_at": "example",
      "currency": "USD",
      "customer_id": "example",
      "decline_errors": [],
      "enrichments": {
        "initiation": {
          "actor": "CUSTOMER"
        },
        "recurring_series_id": "example",
        "restricted_categories": [],
        "statement_descriptor": "example"
      },
      "fee_amount": 1.0,
      "fee_rate": {
        "basis_points": 1,
        "fixed_amount": 1
      },
      "grant_id": "example",
      "id": "example",
      "merchant_id": "example",
      "metadata": {},
      "net_amount": 1,
      "reference_id": "example",
      "refund_ids": [],
      "refunded_amount": 1,
      "status": "AUTHORIZED",
      "updated_at": "example",
      "voided_amount": 1
    }
  }
}
```

### Void refund

Void an authorized refund, removing the pending refund from the customer's Cash App account.

**Inputs**

- Refund id (`refund_id`, text, required): Refund id.

**Outputs**

- `data` (object): Cash App response data.

**Example output**

```json
{
  "data": {
    "refund": {
      "amount": 1,
      "created_at": "example",
      "currency": "USD",
      "customer_id": "example",
      "decline_errors": [],
      "grant_id": "example",
      "id": "example",
      "merchant_id": "example",
      "metadata": {},
      "payment_id": "example",
      "reference_id": "example",
      "status": "AUTHORIZED",
      "updated_at": "example"
    }
  }
}
```
