For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GuidesAPI Reference
GuidesAPI Reference
  • Network API
  • Customer Request API
      • Action
      • Request
      • Link Account Action
      • One Time Payment Action
      • On File Payment Action
      • On File Payout Action
      • Channel
      • Customer Metadata
      • ErrorResponse
  • Management API
LogoLogo
Customer Request APISchemas

Request

Example
1{
2  "id": "GRR_1hrxhz136krcq6ezdte2ha5q",
3  "status": "PENDING",
4  "actions": [
5    {
6      "amount": 2500,
7      "currency": "USD",
8      "scope_id": "MMI_4vxs5egfk7hmta3qx2h6rp91x",
9      "type": "ONE_TIME_PAYMENT"
10    }
11  ],
12  "auth_flow_triggers": {
13    "qr_code_image_url": "https://api.cash.app/qr/f/GRANTLY_MANAGED_GRANT%3Frequest_id=GRR_1hrxhz136krcq6ezdte2ha5q-k21srg&method=qr?rounded=0&format=png",
14    "qr_code_svg_url": "https://api.cash.app/qr/f/GRANTLY_MANAGED_GRANT%3Frequest_id=GRR_1hrxhz136krcq6ezdte2ha5q-k21srg&method=qr?rounded=0&format=svg",
15    "mobile_url": "https://cash.app/f/GRANTLY_MANAGED_GRANT%3Frequest_id=GRR_1hrxhz136krcq6ezdte2ha5q-k21srg&method=mobile_url",
16    "refreshes_at": "2019-08-24T14:15:22Z",
17    "desktop_url": "https://pay.cash.app?customerRequestId={request_id}"
18  },
19  "redirect_url": "https://example.com",
20  "created_at": "2022-01-01T12:09:00Z",
21  "updated_at": "2022-01-01T12:10:00Z",
22  "expires_at": "2033-01-01T12:20:00Z",
23  "origin": {
24    "type": "DIRECT",
25    "id": "string"
26  },
27  "channel": "ONLINE",
28  "grants": [
29    {
30      "id": "GRG_221243dc6985a6819ff6950c1a21332f7bc4a46ebd49b5a7002908ab768e8e5ff7831e084d0d2c9d8d939793b55eff50",
31      "customer_id": "CST_AQmxh4y_QGoNNIG5NUw0jttqyYedL1LklACQdyJ3H-Vs6WmLtP6A_C7XjQNohvY",
32      "action": {
33        "amount": 2500,
34        "currency": "USD",
35        "scope_id": "MMI_4vxs5egfk7hmta3qx2h6rp91x",
36        "type": "ONE_TIME_PAYMENT"
37      },
38      "status": "ACTIVE",
39      "type": "ONE_TIME",
40      "channel": "ONLINE",
41      "created_at": "2019-08-24T14:15:22Z",
42      "updated_at": "2019-08-24T14:15:22Z",
43      "expires_at": "2022-04-01T12:00:00Z"
44    }
45  ],
46  "reference_id": "external-id",
47  "requester_profile": {
48    "name": "A Brand",
49    "logo_url": "https://picsum.photos/200"
50  },
51  "customer_profile": {
52    "id": "CST_AQmxh4y_QGoNNIG5NUw0jttqyYedL1LklACQdyJ3H-Vs6WmLtP6A_C7XjQNohvY",
53    "cashtag": "$CashTag"
54  },
55  "metadata": {},
56  "customer_metadata": {
57    "reference_id": "string"
58  }
59}
Was this page helpful?
Previous

Link Account Action

Next
Built with

Response

requestobjectRequired
Describes a request from a client to perform a given action on a customer's account.