\FiatTransfersAPI

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

Method	HTTP request	Description
CreateFiatAccount	Post /transfer/fiat-accounts	Create Fiat Account
CreateFiatDepositInstructions	Post /transfer/fiat-deposit-instructions	Create Fiat Deposit Instructions
CreateFiatWithdrawal	Post /transfer/fiat-withdrawals	Create Fiat Withdrawal
DeleteFiatAccount	Delete /transfer/fiat-accounts/{id}	Delete Fiat Account
GetFiatAccount	Get /transfer/fiat-accounts/{id}	Get Fiat Account
GetFiatDepositInstructions	Get /transfer/fiat-deposit-instructions/{id}	Get Fiat Deposit Instructions
ListFiatAccounts	Get /transfer/fiat-accounts	List Fiat Accounts
ListFiatDepositInstructions	Get /transfer/fiat-deposit-instructions	List Fiat Deposit Instructions
UpdateFiatAccount	Put /transfer/fiat-accounts/{id}	Update Fiat Account

CreateFiatAccount

FiatAccount CreateFiatAccount(ctx).CreateFiatAccountRequest(createFiatAccountRequest).Execute()

Create Fiat Account

Example

package main

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

func main() {
	createFiatAccountRequest := *openapiclient.NewCreateFiatAccountRequest("IdentityId_example", *openapiclient.NewFiatAccountOwner(), *openapiclient.NewFiatNetworkInstructions()) // CreateFiatAccountRequest | 

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
createFiatAccountRequest	CreateFiatAccountRequest

Return type

FiatAccount

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

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

CreateFiatDepositInstructions

FiatDepositInstructions CreateFiatDepositInstructions(ctx).CreateFiatDepositInstructionsRequest(createFiatDepositInstructionsRequest).Execute()

Create Fiat Deposit Instructions

Example

package main

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

func main() {
	createFiatDepositInstructionsRequest := *openapiclient.NewCreateFiatDepositInstructionsRequest("ProfileId_example", "IdentityId_example", openapiclient.FiatNetwork("WIRE")) // CreateFiatDepositInstructionsRequest | 

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
createFiatDepositInstructionsRequest	CreateFiatDepositInstructionsRequest

Return type

FiatDepositInstructions

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

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

CreateFiatWithdrawal

Transfer CreateFiatWithdrawal(ctx).CreateFiatWithdrawalRequest(createFiatWithdrawalRequest).Execute()

Create Fiat Withdrawal

Example

package main

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

func main() {
	createFiatWithdrawalRequest := *openapiclient.NewCreateFiatWithdrawalRequest("Amount_example", "Asset_example", "FiatAccountId_example", "ProfileId_example", "IdentityId_example") // CreateFiatWithdrawalRequest | 

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
createFiatWithdrawalRequest	CreateFiatWithdrawalRequest

Return type

Transfer

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json, application/problem+json

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

DeleteFiatAccount

interface{} DeleteFiatAccount(ctx, id).Execute()

Delete Fiat Account

Example

package main

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

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

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	The Paxos fiat account ID (UUID).

Other Parameters

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

Name	Type	Description	Notes

Return type

interface{}

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]

GetFiatAccount

FiatAccount GetFiatAccount(ctx, id).Execute()

Get Fiat Account

Example

package main

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

func main() {
	id := "id_example" // string | The Paxos fiat account ID (UUID). The Fiat Account ID (`id`) is provided in the response of the [Create Fiat Account](#operation/CreateFiatAccount). Use this ID to retrieve the instructions using [Get Fiat Account](#operation/GetFiatAccount) & [List Fiat Accounts](#operation/ListFiatAccounts).

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	The Paxos fiat account ID (UUID). The Fiat Account ID (`id`) is provided in the response of the Create Fiat Account. Use this ID to retrieve the instructions using Get Fiat Account & List Fiat Accounts.

Other Parameters

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

Name	Type	Description	Notes

Return type

FiatAccount

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]

GetFiatDepositInstructions

FiatDepositInstructions GetFiatDepositInstructions(ctx, id).Execute()

Get Fiat Deposit Instructions

Example

package main

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

func main() {
	id := "id_example" // string | Retrieve the Paxos Fiat Deposit Instructions for the given `id`.

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	Retrieve the Paxos Fiat Deposit Instructions for the given `id`.

Other Parameters

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

Name	Type	Description	Notes

Return type

FiatDepositInstructions

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]

ListFiatAccounts

ListFiatAccountsResponse ListFiatAccounts(ctx).Ids(ids).RefIds(refIds).CreatedAtLt(createdAtLt).CreatedAtLte(createdAtLte).CreatedAtEq(createdAtEq).CreatedAtGte(createdAtGte).CreatedAtGt(createdAtGt).Limit(limit).Order(order).OrderBy(orderBy).PageCursor(pageCursor).Execute()

List Fiat Accounts

Example

package main

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

func main() {
	ids := []string{"Inner_example"} // []string | Optionally filter by the UUIDs of the accounts. Limit 100. (optional)
	refIds := []string{"Inner_example"} // []string | Optionally filter by the client-specified IDs provided during account creation. Limit 100. (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)
	limit := int32(56) // int32 | Number of results to return. Defaults to 100 if no limit is provided. Maximum 1000. (optional)
	order := "order_example" // string | Return items in ascending (ASC) or descending (DESC) order. Defaults to DESC. (optional)
	orderBy := "orderBy_example" // string | The specific method by which the returned results will be ordered. Defaults to CREATED_AT. (optional)
	pageCursor := "pageCursor_example" // string | Optional: Cursor for getting the next page of results. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.FiatTransfersAPI.ListFiatAccounts(context.Background()).Ids(ids).RefIds(refIds).CreatedAtLt(createdAtLt).CreatedAtLte(createdAtLte).CreatedAtEq(createdAtEq).CreatedAtGte(createdAtGte).CreatedAtGt(createdAtGt).Limit(limit).Order(order).OrderBy(orderBy).PageCursor(pageCursor).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `FiatTransfersAPI.ListFiatAccounts``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListFiatAccounts`: ListFiatAccountsResponse
	fmt.Fprintf(os.Stdout, "Response from `FiatTransfersAPI.ListFiatAccounts`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description
ids	[]string	Optionally filter by the UUIDs of the accounts. Limit 100.
refIds	[]string	Optionally filter by the client-specified IDs provided during account creation. Limit 100.
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`.
limit	int32	Number of results to return. Defaults to 100 if no limit is provided. Maximum 1000.
order	string	Return items in ascending (ASC) or descending (DESC) order. Defaults to DESC.
orderBy	string	The specific method by which the returned results will be ordered. Defaults to CREATED_AT.
pageCursor	string	Optional: Cursor for getting the next page of results.

Return type

ListFiatAccountsResponse

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]

ListFiatDepositInstructions

ListFiatDepositInstructionsResponse ListFiatDepositInstructions(ctx).Ids(ids).RefIds(refIds).CreatedAtLt(createdAtLt).CreatedAtLte(createdAtLte).CreatedAtEq(createdAtEq).CreatedAtGte(createdAtGte).CreatedAtGt(createdAtGt).Limit(limit).Order(order).PageCursor(pageCursor).Execute()

List Fiat Deposit Instructions

Example

package main

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

func main() {
	ids := []string{"Inner_example"} // []string | Optionally filter by the UUIDs of the instructions. Limit 100. (optional)
	refIds := []string{"Inner_example"} // []string | Optionally filter by the client-specified IDs provided during instructions creation. Limit 100. (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)
	limit := int32(56) // int32 | Number of results to return. Defaults to 100 if no limit is provided. Maximum 1000. (optional)
	order := "order_example" // string | Return items in ascending (ASC) or descending (DESC) order. Defaults to DESC. (optional)
	pageCursor := "pageCursor_example" // string | Optional: Cursor for getting the next page of results. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.FiatTransfersAPI.ListFiatDepositInstructions(context.Background()).Ids(ids).RefIds(refIds).CreatedAtLt(createdAtLt).CreatedAtLte(createdAtLte).CreatedAtEq(createdAtEq).CreatedAtGte(createdAtGte).CreatedAtGt(createdAtGt).Limit(limit).Order(order).PageCursor(pageCursor).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `FiatTransfersAPI.ListFiatDepositInstructions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListFiatDepositInstructions`: ListFiatDepositInstructionsResponse
	fmt.Fprintf(os.Stdout, "Response from `FiatTransfersAPI.ListFiatDepositInstructions`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description
ids	[]string	Optionally filter by the UUIDs of the instructions. Limit 100.
refIds	[]string	Optionally filter by the client-specified IDs provided during instructions creation. Limit 100.
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`.
limit	int32	Number of results to return. Defaults to 100 if no limit is provided. Maximum 1000.
order	string	Return items in ascending (ASC) or descending (DESC) order. Defaults to DESC.
pageCursor	string	Optional: Cursor for getting the next page of results.

Return type

ListFiatDepositInstructionsResponse

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]

UpdateFiatAccount

FiatAccount UpdateFiatAccount(ctx, id).UpdateFiatAccountRequest(updateFiatAccountRequest).Execute()

Update Fiat Account

Example

package main

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

func main() {
	id := "id_example" // string | The Paxos fiat account ID (UUID). The Fiat Account ID (`id`) is provided in the response of the [Create Fiat Account](#operation/CreateFiatAccount). Use this ID to retrieve the instructions using [Get Fiat Account](#operation/GetFiatAccount) & [List Fiat Accounts](#operation/ListFiatAccounts).
	updateFiatAccountRequest := *openapiclient.NewUpdateFiatAccountRequest() // UpdateFiatAccountRequest | 

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	The Paxos fiat account ID (UUID). The Fiat Account ID (`id`) is provided in the response of the Create Fiat Account. Use this ID to retrieve the instructions using Get Fiat Account & List Fiat Accounts.

Other Parameters

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

Name	Type	Description	Notes

updateFiatAccountRequest | UpdateFiatAccountRequest | |

Return type

FiatAccount

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

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

Files

FiatTransfersAPI.md

Latest commit

History

FiatTransfersAPI.md

File metadata and controls

\FiatTransfersAPI

CreateFiatAccount

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateFiatDepositInstructions

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateFiatWithdrawal

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteFiatAccount

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetFiatAccount

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetFiatDepositInstructions

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListFiatAccounts

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListFiatDepositInstructions

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateFiatAccount

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers