Rehive logo
Powered by Redocly

transaction-collections

List transaction collections

SecurityapiAuth
Request
query Parameters
created
string <date-time>
created__gt
string <date-time>
created__gte
string <date-time>
created__lt
string <date-time>
created__lte
string <date-time>
id
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

transactions__account
string
transactions__amount
string
transactions__amount__abs
string
transactions__amount__abs__gt
string
transactions__amount__abs__gte
string
transactions__amount__abs__lt
string
transactions__amount__abs__lte
string
transactions__amount__gt
string
transactions__amount__gte
string
transactions__amount__lt
string
transactions__amount__lte
string
transactions__currency
string
transactions__status
string
transactions__subtype
string
transactions__tx_type
string
updated
string <date-time>
updated__gt
string <date-time>
updated__gte
string <date-time>
updated__lt
string <date-time>
updated__lte
string <date-time>
Responses
200
get/3/transaction-collections/
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create transaction collection

SecurityapiAuth
Request
Request Body schema:
required
id
string <= 64 characters
required
Array of objects (CreateTransactionCollectionTransaction)
status
string
  • Initiating - Initiating
  • Quoted - Quoted
  • Pending - Pending
Enum: "Initiating" "Quoted" "Pending"
Responses
201
post/3/transaction-collections/
Request samples
{
  • "id": "string",
  • "transactions": [
    ],
  • "status": "Initiating"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve transaction collection

SecurityapiAuth
Request
path Parameters
identifier
required
string^[a-zA-Z0-9\_\-]+$
Responses
200
get/3/transaction-collections/{identifier}/
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}
➔ Next to transactions