List transactions
Request Body
application/jsonOptionalsearchstringtypestring"all" | "deposit" | "buy" | "sell" | "withdraw"limitnumberrecipient_idstringResponse Body
Successful response
TypeScript Definitions
Use the response body type in TypeScript.
dataRequiredobjectError response
TypeScript Definitions
Use the response body type in TypeScript.
errorRequiredobjectcurl -X POST "/v1/transaction.getMany" \
-H "Content-Type: application/json" \
-d '{
"search": "string",
"type": "all",
"limit": 0,
"recipient_id": "string"
}'const body = JSON.stringify({
"search": "string",
"type": "all",
"limit": 0,
"recipient_id": "string"
})
fetch("/v1/transaction.getMany", {
body
})package main
import (
"fmt"
"net/http"
"io/ioutil"
"strings"
)
func main() {
url := "/v1/transaction.getMany"
body := strings.NewReader(`{
"search": "string",
"type": "all",
"limit": 0,
"recipient_id": "string"
}`)
req, _ := http.NewRequest("POST", url, body)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}import requests
url = "/v1/transaction.getMany"
body = {
"search": "string",
"type": "all",
"limit": 0,
"recipient_id": "string"
}
response = requests.request("POST", url, json = body, headers = {
"Content-Type": "application/json"
})
print(response.text){
"data": {
"transactions": [
{
"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "PENDING",
"currency_in": {
"value": "string",
"code": "AUD",
"decimals": 0,
"chain": "arbitrum",
"metadata": "string"
},
"currency_out": {
"value": "string",
"code": "AUD",
"decimals": 0,
"chain": "arbitrum",
"metadata": "string"
},
"external_reference": "string",
"fees": [
{
"type": "direct",
"value": {
"value": "string",
"code": "AUD",
"decimals": 0,
"chain": "arbitrum",
"metadata": "string"
},
"label": "string",
"rate": 0
}
],
"metadata": {
"description": "string",
"payout_reference": "string",
"price_pair": {
"marketRate": 0,
"direction": "bid",
"tickSize": 0
},
"rail": "balance",
"proof_of_purpose": {
"url": "string",
"name": "string"
},
"required_fields": {
"property1": {
"value": "string",
"label": "string"
},
"property2": {
"value": "string",
"label": "string"
}
}
},
"external_reference_type": "CRYPTO_ETHEREUM"
}
],
"totals": {
"transfers": 0,
"fiatAmount": 0
}
}
}{
"error": {
"code": "PARSE_ERROR",
"message": "string"
}
}Get transaction
Previous Page
Get transfer requirements
Lists the payout fields the destination requires before it will accept a transfer, each with the option set the caller must choose from. `fields` is null when the destination requires nothing. Two calls: read the requirements here, then submit one chosen option per field as `metadata.required_fields` on `transaction.transfer`, keyed by the field's `key` and carrying that option's `value` and `label`. Option ids are issued per destination and can change, so read them per transfer rather than caching them. A mutation despite reading like a lookup: rails serve their catalogues scoped to the beneficiary and the paying sub-account, so resolving them registers both upstream when they do not exist yet. Call it once per route on submit intent, never as a cached or retried read. `currency_out`/`currency_in` are the same pair the transfer will carry, chain included: the paying sub-account is matched on it.