Rehive logo
Powered by Redocly

transactions

List transactions

SecurityapiAuth
Request
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>
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
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>
Responses
200
get/3/transactions/
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create transaction

SecurityapiAuth
Request
Request Body schema:
required
required
Array of objects (ExplicitCreateTransaction)
Responses
201
post/3/transactions/
Request samples
{
  • "transactions": [
    ]
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve transaction

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

Update transaction

SecurityapiAuth
Request
path Parameters
tx_code
required
string^[a-zA-Z0-9\_\-]+$
Request Body schema:
status
string
Default: "Pending"
  • Pending - Pending
Value: "Pending"
Responses
200
put/3/transactions/{tx_code}/
Request samples
{
  • "status": "Pending"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update transaction

SecurityapiAuth
Request
path Parameters
tx_code
required
string^[a-zA-Z0-9\_\-]+$
Request Body schema:
status
string
Default: "Pending"
  • Pending - Pending
Value: "Pending"
Responses
200
patch/3/transactions/{tx_code}/
Request samples
{
  • "status": "Pending"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

List transaction messages

SecurityapiAuth
Request
path Parameters
tx_code
required
string^[a-zA-Z0-9\_\-]+$
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/3/transactions/{tx_code}/messages/
Response samples
application/json
{}

Retrieve transaction message

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
tx_code
required
string^[a-zA-Z0-9\_\-]+$
Responses
200
get/3/transactions/{tx_code}/messages/{id}/
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create credit transaction

SecurityapiAuth
Request
Request Body schema:
required
id
string <= 64 characters
amount
required
integer
currency
required
string
account
string or null
subtype
string or null
reference
string or null <= 100 characters
note
string <= 100 characters
Default: ""
object or null
inclusive
boolean
Default: false
status
string
Default: "Pending"
  • Initiating - Initiating
  • Pending - Pending
  • Complete - Complete
  • Failed - Failed
Enum: "Initiating" "Pending" "Complete" "Failed"
Responses
201
post/3/transactions/credit/
Request samples
{
  • "id": "string",
  • "amount": 0,
  • "currency": "string",
  • "account": "string",
  • "subtype": "string",
  • "reference": "string",
  • "note": "",
  • "metadata": {
    },
  • "inclusive": false,
  • "status": "Initiating"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create debit transaction

SecurityapiAuth
Request
Request Body schema:
required
id
string <= 64 characters
amount
required
integer
currency
required
string
account
string or null
subtype
string or null
reference
string or null <= 100 characters
note
string <= 100 characters
Default: ""
object or null
inclusive
boolean
Default: false
status
string
Default: "Pending"
  • Initiating - Initiating
  • Pending - Pending
  • Complete - Complete
  • Failed - Failed
Enum: "Initiating" "Pending" "Complete" "Failed"
Responses
201
post/3/transactions/debit/
Request samples
{
  • "id": "string",
  • "amount": 0,
  • "currency": "string",
  • "account": "string",
  • "subtype": "string",
  • "reference": "string",
  • "note": "",
  • "metadata": {
    },
  • "inclusive": false,
  • "status": "Initiating"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve transaction totals

SecurityapiAuth
Responses
200
get/3/transactions/totals/
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create transfer

SecurityapiAuth
Request
Request Body schema:
required
debit_account
string or null
debit_subtype
string or null
object or null
debit_note
string <= 100 characters
Default: ""
debit_reference
string or null <= 100 characters
credit_account
string or null
credit_subtype
string or null
object or null
credit_note
string <= 100 characters
Default: ""
credit_reference
string or null <= 100 characters
recipient
string or null <= 100 characters
amount
required
integer
currency
required
string
inclusive
boolean
Default: false
Responses
201
post/3/transactions/transfer/
Request samples
{
  • "debit_account": "string",
  • "debit_subtype": "string",
  • "debit_metadata": {
    },
  • "debit_note": "",
  • "debit_reference": "string",
  • "credit_account": "string",
  • "credit_subtype": "string",
  • "credit_metadata": {
    },
  • "credit_note": "",
  • "credit_reference": "string",
  • "recipient": "string",
  • "amount": 0,
  • "currency": "string",
  • "inclusive": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}
➔ Next to user