All URIs are relative to https://api-sandbox.circle.com
| Method | HTTP request | Description |
|---|---|---|
| create_business_deposit_address | POST /v1/businessAccount/wallets/addresses/deposit | Create a deposit address |
| create_business_recipient_address | POST /v1/businessAccount/wallets/addresses/recipient | Create a recipient address |
| delete_business_recipient_address | DELETE /v1/businessAccount/wallets/addresses/recipient/{id} | Delete a recipient address |
| get_business_deposit_address | GET /v1/businessAccount/wallets/addresses/deposit | List all deposit addresses |
| list_business_recipient_addresses | GET /v1/businessAccount/wallets/addresses/recipient | List all recipient addresses |
models::CreateBusinessDepositAddressResponse create_business_deposit_address(business_generate_address_request) Create a deposit address
Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you're requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in pending status.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| business_generate_address_request | Option<BusinessGenerateAddressRequest> |
models::CreateBusinessDepositAddressResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::CreateBusinessRecipientAddressResponse create_business_recipient_address(business_recipient_address_creation_request) Create a recipient address
Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in pending status.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| business_recipient_address_creation_request | Option<BusinessRecipientAddressCreationRequest> |
models::CreateBusinessRecipientAddressResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_business_recipient_address(id) Delete a recipient address
Deletes an external blockchain address. The recipient address must be in an 'active' or 'pending' state in order to be deleted successfully.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | uuid::Uuid | Universally unique identifier (UUID v4) of a resource. | [required] |
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::GetBusinessDepositAddressResponse get_business_deposit_address() List all deposit addresses
This endpoint does not need any parameter.
models::GetBusinessDepositAddressResponse
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::ListBusinessRecipientAddressesResponse list_business_recipient_addresses(from, to, page_before, page_after, page_size) List all recipient addresses
Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending administrator verification are not included in the response.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| from | Option<String> | Queries items created since the specified date-time (inclusive). | ||
| to | Option<String> | Queries items created before the specified date-time (inclusive). | ||
| page_before | Option<String> | A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjuction with pageAfter. |
||
| page_after | Option<String> | A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjuction with pageBefore. |
||
| page_size | Option<i32> | Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself. |
models::ListBusinessRecipientAddressesResponse
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]