Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Preferred: path to the JSON file downloaded from the CDP Portal.
CDP_API_KEY_FILE=/absolute/path/to/cdp_api_key.json

# Alternative to CDP_API_KEY_FILE.
# CDP_KEY_ID=organizations/.../apiKeys/...
# CDP_KEY_SECRET=base64-ed25519-secret-or-ecdsa-pem

# Defaults to sandbox. Supported values: sandbox, production.
CDP_ENVIRONMENT=sandbox

# Optional custom endpoint, primarily for local testing.
# CDP_API_BASE_URL=https://sandbox.cdp.coinbase.com/platform
23 changes: 23 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: CI

on:
pull_request:
push:
branches: [main]

permissions:
contents: read

jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-java@v4
with:
distribution: temurin
java-version: "17"
cache: maven
- run: make lint
- run: make test
- run: make build
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
target/
.idea/
.vscode/
*.iml
.DS_Store
.env
cdp_api_key.json
*.pem
184 changes: 184 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship made available under
the License, as indicated by a copyright notice that is included in
or attached to the work (an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean, as submitted to the Licensor for inclusion
in the Work by the copyright owner or by an individual or Legal Entity
authorized to submit on behalf of the copyright owner. For the purposes
of this definition, "submitted" means any form of electronic, verbal,
or written communication sent to the Licensor or its representatives,
including but not limited to communication on electronic mailing lists,
source code control systems, and issue tracking systems that are managed
by, or on behalf of, the Licensor for the purpose of discussing and
improving the Work, but excluding communication that is conspicuously
marked or designated in writing by the copyright owner as "Not a
Contribution."

"Contributor" shall mean Licensor and any Legal Entity on behalf of
whom a Contribution has been received by the Licensor and included
within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by the combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a cross-claim
or counterclaim in a lawsuit) alleging that the Work or any
Contribution embodied within the Work constitutes direct or
contributory patent infringement, then any patent licenses granted
to You under this License for that Work shall terminate as of the
date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or Derivative
Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, You must include a readable copy of the
attribution notices contained within such NOTICE file, in
at least one of the following places: within a NOTICE text
file distributed as part of the Derivative Works; within
the Source form or documentation, if provided along with the
Derivative Works; or, within a display generated by the
Derivative Works, if and wherever such third-party notices
normally appear. The contents of the NOTICE file are for
informational purposes only and do not modify the License.
You may add Your own attribution notices within Derivative
Works that You distribute, alongside or as an addendum to
the NOTICE text from the Work, provided that such additional
attribution notices cannot be construed as modifying the License.

You may add Your own license statement for Your modifications and
may provide additional grant of rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the
Contribution, either as-is or with modifications, whether in Source
or Object form.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or reproducing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or exemplary damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or all other
commercial damages or losses), even if such Contributor has been
advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

Copyright 2026-present Coinbase Global, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
22 changes: 22 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
.PHONY: build test lint format clean run

build:
mvn -q -DskipTests package

test:
mvn -q test

lint:
mvn -q spotless:check

format:
mvn -q spotless:apply

clean:
mvn -q clean

run:
@test -n "$(SCRIPT)" || (echo "Usage: make run SCRIPT=accounts.ListAccounts ARGS='...'" >&2; exit 2)
mvn -q compile exec:java \
-Dexec.mainClass=com.coinbase.cdp.scripts.$(SCRIPT) \
-Dexec.args="$(ARGS)"
112 changes: 111 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,111 @@
# CDP Payments Java Scripts
# CDP Payments Java scripts

Runnable Java examples for the [CDP Payments and Custodial Accounts APIs](https://docs.cdp.coinbase.com/api-reference/v2/introduction). Each API operation has one `main` class. Scripts call the REST API directly, print formatted responses, and default to CDP Sandbox.

## Requirements

- JDK 17 or newer
- Maven 3.9 or newer
- A Sandbox API key with the permissions required by the endpoint

Create and fund a simulated account using the [Custodial Wallets quickstart](https://docs.cdp.coinbase.com/wallets/custodial-wallets/quickstart). Sandbox never moves real funds.

## Configure credentials

Keep credentials outside this repository. Point to the JSON file downloaded from the CDP Portal:

```bash
export CDP_API_KEY_FILE="$HOME/Downloads/cdp_api_key.json"
```

You can instead export its values directly:

```bash
export CDP_KEY_ID='organizations/.../apiKeys/...'
export CDP_KEY_SECRET='base64 Ed25519 secret or ECDSA PEM'
```

`CDP_API_KEY_FILE` takes precedence. Both recommended Ed25519 keys and legacy ECDSA keys are supported.

Scripts use `https://sandbox.cdp.coinbase.com/platform` unless configured otherwise:

```bash
export CDP_ENVIRONMENT=production
# Or, for a custom server:
export CDP_API_BASE_URL=https://example.test/platform
```

## Run scripts

Build and see a script's options:

```bash
make build
make run SCRIPT=accounts.ListAccounts ARGS='--help'
```

List accounts and balances:

```bash
make run SCRIPT=accounts.ListAccounts
make run SCRIPT=accounts.ListBalances ARGS='--account-id account_123'
```

Create an account from a sample request:

```bash
make run SCRIPT=accounts.CreateAccount \
ARGS='--body-file examples/requests/create-account.json'
```

Create a Sandbox transfer after replacing `account_REPLACE_ME` in the sample:

```bash
make run SCRIPT=transfers.CreateTransfer \
ARGS='--body-file examples/requests/create-transfer.json'
```

Mutating scripts accept `--body '{...}'` or `--body-file path`, never both. Eligible operations also accept `--idempotency-key UUID`. When omitted, the script generates a UUID v4 and prints it to stderr so the request can be retried safely.

Every non-2xx response returns a nonzero exit code. JSON responses are formatted on stdout. Diagnostics and generated idempotency keys go to stderr.

For a runnable Sandbox command for every account, deposit-destination, transfer, and payment-method endpoint, see [`examples/README.md`](examples/README.md).

## Endpoint scripts

| API | Script | Method and path |
| --- | --- | --- |
| Accounts | `accounts.ListAccounts` | `GET /v2/accounts` |
| Accounts | `accounts.CreateAccount` | `POST /v2/accounts` |
| Accounts | `accounts.GetAccount` | `GET /v2/accounts/{accountId}` |
| Accounts | `accounts.ListBalances` | `GET /v2/accounts/{accountId}/balances` |
| Accounts | `accounts.GetBalance` | `GET /v2/accounts/{accountId}/balances/{asset}` |
| Deposit Destinations | `depositdestinations.ListDepositDestinations` | `GET /v2/deposit-destinations` |
| Deposit Destinations | `depositdestinations.CreateDepositDestination` | `POST /v2/deposit-destinations` |
| Deposit Destinations | `depositdestinations.GetDepositDestination` | `GET /v2/deposit-destinations/{depositDestinationId}` |
| Transfers | `transfers.CreateTransfer` | `POST /v2/transfers` |
| Transfers | `transfers.ListTransfers` | `GET /v2/transfers` |
| Transfers | `transfers.GetTransfer` | `GET /v2/transfers/{transferId}` |
| Transfers | `transfers.ExecuteTransfer` | `POST /v2/transfers/{transferId}/execute` |
| Transfers | `transfers.SubmitTravelRule` | `POST /v2/transfers/{transferId}/travel-rule` |
| Payment Methods | `paymentmethods.ListPaymentMethods` | `GET /v2/payment-methods` |
| Payment Methods | `paymentmethods.GetPaymentMethod` | `GET /v2/payment-methods/{paymentMethodId}` |

Run any script with `--help` for its path and query options. List operations expose every filter and pagination field in the [v2 OpenAPI specification](https://docs.cdp.coinbase.com/api-reference/v2/cdp-api-v2.yaml).

## Development

Use Make targets rather than invoking their underlying tools:

```bash
make format
make lint
make test
make build
```

Automated tests use a local HTTP server and do not contact CDP.

## License

Apache License 2.0. See [LICENSE](LICENSE).
5 changes: 5 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Security

Never commit CDP API keys, private keys, production identifiers, or customer data. Use environment variables or an external key file.

Report suspected vulnerabilities through Coinbase's [HackerOne program](https://hackerone.com/coinbase). Do not disclose vulnerabilities in a public issue.
7 changes: 7 additions & 0 deletions THIRD-PARTY-NOTICES
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
This project uses open source libraries distributed under their respective licenses.

- Jackson, Apache License 2.0
- Nimbus JOSE + JWT, Apache License 2.0
- Bouncy Castle, MIT License
- Picocli, Apache License 2.0
- JUnit, Eclipse Public License 2.0
Loading
Loading