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/admin/transaction-collections/
Request samples 
rehive.admin.transaction_collections.get()
.then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create transaction-collections

SecurityapiAuth
Request
Request Body schema:
required
id
string <= 64 characters
required
Array of objects (AdminCreateTransactionCollectionTransaction)
status
string
  • Initiating - Initiating
  • Quoted - Quoted
  • Pending - Pending
  • Complete - Complete
  • Failed - Failed
Enum: "Initiating" "Quoted" "Pending" "Complete" "Failed"
checks
Array of strings or null
Enum: "type" "verification" "limits" "balance"
expires
integer or null >= 0
Responses
201
post/3/admin/transaction-collections/
Request samples
{
  • "id": "string",
  • "transactions": [
    ],
  • "status": "Initiating",
  • "checks": [
    ],
  • "expires": 0
}
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/admin/transaction-collections/{identifier}/
Request samples 
rehive.admin.transaction_collections.get(
  {"id":transactionCollectionsIdentifier}
).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update transaction-collection

SecurityapiAuth
Request
path Parameters
identifier
required
string^[a-zA-Z0-9\_\-]+$
Request Body schema:
status
string
  • Quoted - Quoted
  • Pending - Pending
  • Complete - Complete
  • Failed - Failed
Enum: "Quoted" "Pending" "Complete" "Failed"
checks
Array of strings or null
Enum: "type" "verification" "limits" "balance"
archived
boolean
Default: false
Responses
200
put/3/admin/transaction-collections/{identifier}/
Request samples
{
  • "status": "Quoted",
  • "checks": [
    ],
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update transaction-collection

SecurityapiAuth
Request
path Parameters
identifier
required
string^[a-zA-Z0-9\_\-]+$
Request Body schema:
status
string
  • Quoted - Quoted
  • Pending - Pending
  • Complete - Complete
  • Failed - Failed
Enum: "Quoted" "Pending" "Complete" "Failed"
checks
Array of strings or null
Enum: "type" "verification" "limits" "balance"
archived
boolean
Default: false
Responses
200
patch/3/admin/transaction-collections/{identifier}/
Request samples
{
  • "status": "Quoted",
  • "checks": [
    ],
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

List transaction-collection transactions

SecurityapiAuth
Request
path Parameters
identifier
required
string^[a-zA-Z0-9\_\-]+$
query Parameters
account
string
account__definition
string
account__exclude
string
account__name
string
account__recon
boolean
amount
string
amount__abs
string
amount__abs__gt
string
amount__abs__gte
string
amount__abs__lt
string
amount__abs__lte
string
amount__gt
string
amount__gte
string
amount__lt
string
amount__lte
string
collection
string
created
string <date-time>
created__gt
string <date-time>
created__gte
string <date-time>
created__lt
string <date-time>
created__lte
string <date-time>
currency
string
executed
string or null <date-time>
executed__gt
string or null <date-time>
executed__gte
string or null <date-time>
executed__lt
string or null <date-time>
executed__lte
string or null <date-time>
group
string
group__isnull
boolean
id
string
id__in
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

parent
string
partner
string
partner__isnull
boolean
reference
string
reference__gt
string
reference__gte
string
reference__lt
string
reference__lte
string
search
string
status
string
status__in
Array of strings

Multiple values may be separated by commas.

subtype
string
subtype__exclude
string
subtype__in
string
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>
user
string
user__exclude
string
user__isnull
boolean
user__temporary
boolean
Responses
200
get/3/admin/transaction-collections/{identifier}/transactions/
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create transaction-collection transaction

SecurityapiAuth
Request
path Parameters
identifier
required
string^[a-zA-Z0-9\_\-]+$
Request Body schema:
required
required
Array of objects (AdminAppendTransactionCollectionTransaction)
Responses
201
post/3/admin/transaction-collections/{identifier}/transactions/
Request samples
{
  • "transactions": [
    ]
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}
➔ Next to transaction-transitions