Skip to content

Latest commit

 

History

History
187 lines (132 loc) · 11.5 KB

TransfersAPI.md

File metadata and controls

187 lines (132 loc) · 11.5 KB
Raw

\TransfersAPI

All URIs are relative to https://api.paxos.com/v2

Method HTTP request Description
GetTransfer Get /transfer/transfers/{id} Get Transfer
ListTransfers Get /transfer/transfers List Transfers

GetTransfer

Transfer GetTransfer(ctx, id).Execute()

Get Transfer

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/avianlabs/paxos-go"
)

func main() {
	id := "id_example" // string | The Paxos transfer UUID.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TransfersAPI.GetTransfer(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TransfersAPI.GetTransfer``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetTransfer`: Transfer
	fmt.Fprintf(os.Stdout, "Response from `TransfersAPI.GetTransfer`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string The Paxos transfer UUID.

Other Parameters

Other parameters are passed through a pointer to a apiGetTransferRequest struct via the builder pattern

Name Type Description Notes

Return type

Transfer

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListTransfers

ListTransfersResponse ListTransfers(ctx).ProfileIds(profileIds).IdentityIds(identityIds).RefIds(refIds).CreatedAtLt(createdAtLt).CreatedAtLte(createdAtLte).CreatedAtEq(createdAtEq).CreatedAtGte(createdAtGte).CreatedAtGt(createdAtGt).UpdatedAtLt(updatedAtLt).UpdatedAtLte(updatedAtLte).UpdatedAtEq(updatedAtEq).UpdatedAtGte(updatedAtGte).UpdatedAtGt(updatedAtGt).Limit(limit).Order(order).OrderBy(orderBy).PageCursor(pageCursor).AccountIds(accountIds).Ids(ids).Type_(type_).GroupIds(groupIds).Execute()

List Transfers

Example

package main

import (
	"context"
	"fmt"
	"os"
    "time"
	openapiclient "github.com/avianlabs/paxos-go"
)

func main() {
	profileIds := []string{"Inner_example"} // []string | Optionally filter by the target profiles of the transfers. Limit 100. Can be combined with created_at.* or updated_at.* filtering options only. (optional)
	identityIds := []string{"Inner_example"} // []string | Optionally filter by the Identities associated with the transfers. Limit 100. Can be combined with created_at.* or updated_at.* filtering options only. (optional)
	refIds := []string{"Inner_example"} // []string | The client-specified IDs provided during transfer creation. Limit 100. Can be combined with created_at.* or updated_at.* filtering options only. (optional)
	createdAtLt := time.Now() // time.Time | Include timestamps strictly less than lt. RFC3339 format, like `2006-01-02T15:04:05Z`. (optional)
	createdAtLte := time.Now() // time.Time | Include timestamps less than or equal to lte. RFC3339 format, like `2006-01-02T15:04:05Z`. (optional)
	createdAtEq := time.Now() // time.Time | Include timestamps exactly equal to eq. RFC3339 format, like `2006-01-02T15:04:05Z`. (optional)
	createdAtGte := time.Now() // time.Time | Include timestamps greater than or equal to lte. RFC3339 format, like `2006-01-02T15:04:05Z`. (optional)
	createdAtGt := time.Now() // time.Time | Include timestamps strictly greater than gt. RFC3339 format, like `2006-01-02T15:04:05Z`. (optional)
	updatedAtLt := time.Now() // time.Time | Include timestamps strictly less than lt. RFC3339 format, like `2006-01-02T15:04:05Z`. (optional)
	updatedAtLte := time.Now() // time.Time | Include timestamps less than or equal to lte. RFC3339 format, like `2006-01-02T15:04:05Z`. (optional)
	updatedAtEq := time.Now() // time.Time | Include timestamps exactly equal to eq. RFC3339 format, like `2006-01-02T15:04:05Z`. (optional)
	updatedAtGte := time.Now() // time.Time | Include timestamps greater than or equal to lte. RFC3339 format, like `2006-01-02T15:04:05Z`. (optional)
	updatedAtGt := time.Now() // time.Time | Include timestamps strictly greater than gt. RFC3339 format, like `2006-01-02T15:04:05Z`. (optional)
	limit := int32(56) // int32 | Number of results to return. Defaults to 100 if no limit is provided. Maximum 1000. (optional)
	order := "order_example" // string | Determines whether the items are returned in ascending (ASC), or descending (DESC) order. Defaults to ASC if `order_by` is UPDATED_AT. Otherwise defaults to DESC. (optional)
	orderBy := "orderBy_example" // string | The specific method by which the returned results will be ordered. When specifying both `order_by` and a timestamp filter, `order_by` must equal the timestamp filter type. For example:  `updated_at.gte = 2022-07-01T03:02:01Z`, `order_by = UPDATED_AT`  Using `updated_at.gte = 2022-07-01T03:02:01Z`, `order_by = CREATED_AT` is an invalid pairing. (optional)
	pageCursor := "pageCursor_example" // string | Optional: Cursor for getting the next page of results. When the number of items returned is fewer than the limit, there is currently no next page. (optional)
	accountIds := []string{"Inner_example"} // []string | Optionally filter by the Accounts associated with the transfers. Limit 100. Can be combined with created_at.* or updated_at.* filtering options only. (optional)
	ids := []string{"Inner_example"} // []string | Optionally filter by the transfer ids. Limit 100. Can be combined with created_at.* or updated_at.* filtering options only. (optional)
	type_ := []string{"Type_example"} // []string | Retrieve all (default) or the specified transfers. Optionally filter by transfer `type`. To retrieve multiple transfer types, use query parameters: e.g., `type=CRYPTO_DEPOSIT&type=CRYPTO_WITHDRAWAL`. Can be combined with `created_at.*` or `updated_at.*` filtering options only. (optional)
	groupIds := []string{"Inner_example"} // []string | Optionally filter by transfer `group_ids`. Limit 100. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TransfersAPI.ListTransfers(context.Background()).ProfileIds(profileIds).IdentityIds(identityIds).RefIds(refIds).CreatedAtLt(createdAtLt).CreatedAtLte(createdAtLte).CreatedAtEq(createdAtEq).CreatedAtGte(createdAtGte).CreatedAtGt(createdAtGt).UpdatedAtLt(updatedAtLt).UpdatedAtLte(updatedAtLte).UpdatedAtEq(updatedAtEq).UpdatedAtGte(updatedAtGte).UpdatedAtGt(updatedAtGt).Limit(limit).Order(order).OrderBy(orderBy).PageCursor(pageCursor).AccountIds(accountIds).Ids(ids).Type_(type_).GroupIds(groupIds).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TransfersAPI.ListTransfers``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListTransfers`: ListTransfersResponse
	fmt.Fprintf(os.Stdout, "Response from `TransfersAPI.ListTransfers`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListTransfersRequest struct via the builder pattern

Name Type Description Notes
profileIds []string Optionally filter by the target profiles of the transfers. Limit 100. Can be combined with created_at.* or updated_at.* filtering options only.
identityIds []string Optionally filter by the Identities associated with the transfers. Limit 100. Can be combined with created_at.* or updated_at.* filtering options only.
refIds []string The client-specified IDs provided during transfer creation. Limit 100. Can be combined with created_at.* or updated_at.* filtering options only.
createdAtLt time.Time Include timestamps strictly less than lt. RFC3339 format, like `2006-01-02T15:04:05Z`.
createdAtLte time.Time Include timestamps less than or equal to lte. RFC3339 format, like `2006-01-02T15:04:05Z`.
createdAtEq time.Time Include timestamps exactly equal to eq. RFC3339 format, like `2006-01-02T15:04:05Z`.
createdAtGte time.Time Include timestamps greater than or equal to lte. RFC3339 format, like `2006-01-02T15:04:05Z`.
createdAtGt time.Time Include timestamps strictly greater than gt. RFC3339 format, like `2006-01-02T15:04:05Z`.
updatedAtLt time.Time Include timestamps strictly less than lt. RFC3339 format, like `2006-01-02T15:04:05Z`.
updatedAtLte time.Time Include timestamps less than or equal to lte. RFC3339 format, like `2006-01-02T15:04:05Z`.
updatedAtEq time.Time Include timestamps exactly equal to eq. RFC3339 format, like `2006-01-02T15:04:05Z`.
updatedAtGte time.Time Include timestamps greater than or equal to lte. RFC3339 format, like `2006-01-02T15:04:05Z`.
updatedAtGt time.Time Include timestamps strictly greater than gt. RFC3339 format, like `2006-01-02T15:04:05Z`.
limit int32 Number of results to return. Defaults to 100 if no limit is provided. Maximum 1000.
order string Determines whether the items are returned in ascending (ASC), or descending (DESC) order. Defaults to ASC if `order_by` is UPDATED_AT. Otherwise defaults to DESC.
orderBy string The specific method by which the returned results will be ordered. When specifying both `order_by` and a timestamp filter, `order_by` must equal the timestamp filter type. For example: `updated_at.gte = 2022-07-01T03:02:01Z`, `order_by = UPDATED_AT` Using `updated_at.gte = 2022-07-01T03:02:01Z`, `order_by = CREATED_AT` is an invalid pairing.
pageCursor string Optional: Cursor for getting the next page of results. When the number of items returned is fewer than the limit, there is currently no next page.
accountIds []string Optionally filter by the Accounts associated with the transfers. Limit 100. Can be combined with created_at.* or updated_at.* filtering options only.
ids []string Optionally filter by the transfer ids. Limit 100. Can be combined with created_at.* or updated_at.* filtering options only.
type_ []string Retrieve all (default) or the specified transfers. Optionally filter by transfer `type`. To retrieve multiple transfer types, use query parameters: e.g., `type=CRYPTO_DEPOSIT&type=CRYPTO_WITHDRAWAL`. Can be combined with `created_at.` or `updated_at.` filtering options only.
groupIds []string Optionally filter by transfer `group_ids`. Limit 100.

Return type

ListTransfersResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]