Transactions

List transactions

SecurityToken
Request
query Parameters
reference
string
reference__lt
string
reference__gt
string
reference__lte
string
reference__gte
string
executed
string
executed__lt
string
executed__gt
string
executed__lte
string
executed__gte
string
created
string
created__lt
string
created__gt
string
created__lte
string
created__gte
string
updated
string
updated__lt
string
updated__gt
string
updated__lte
string
updated__gte
string
id
string
id__in
string
collection
string
parent
string
subtype
string
subtype__in
string
subtype__exclude
string
partner
string
partner__isnull
string
amount
string
amount__lt
string
amount__gt
string
amount__lte
string
amount__gte
string
amount__abs
string
amount__abs__lt
string
amount__abs__gt
string
amount__abs__lte
string
amount__abs__gte
string
currency
string
status
string
status__in
string
tx_type
string
account
string
account__exclude
string
account__name
string
account__recon
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/transactions/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Create transaction

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

Create credit transaction

SecurityToken
Request
Request Body schema: application/json
id
string (Id) [ 1 .. 64 ] characters
amount
required
integer (Amount)
currency
required
string (Currency) non-empty
account
string or null (Account)
subtype
string or null (Subtype)
reference
string or null (Reference) <= 100 characters
note
string (Note) <= 100 characters
Default: ""
metadata
object or null (Metadata)
status
string (Status)
Enum: "Initiating" "Pending" "Complete" "Failed"
Responses
201
post/transactions/credit/
Request samples
application/json
{
  • "id": "string",
  • "amount": 0,
  • "currency": "string",
  • "account": "string",
  • "subtype": "string",
  • "reference": "string",
  • "note": "",
  • "metadata": { },
  • "status": "Initiating"
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Create debit transaction

SecurityToken
Request
Request Body schema: application/json
id
string (Id) [ 1 .. 64 ] characters
amount
required
integer (Amount)
currency
required
string (Currency) non-empty
account
string or null (Account)
subtype
string or null (Subtype)
reference
string or null (Reference) <= 100 characters
note
string (Note) <= 100 characters
Default: ""
metadata
object or null (Metadata)
status
string (Status)
Enum: "Initiating" "Pending" "Complete" "Failed"
Responses
201
post/transactions/debit/
Request samples
application/json
{
  • "id": "string",
  • "amount": 0,
  • "currency": "string",
  • "account": "string",
  • "subtype": "string",
  • "reference": "string",
  • "note": "",
  • "metadata": { },
  • "status": "Initiating"
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Retrieve transaction totals

SecurityToken
Responses
200
get/transactions/totals/
Response samples
application/json
{
  • "status": "string",
  • "data": [
    ]
}

Create transfer

SecurityToken
Request
Request Body schema: application/json
debit_account
string or null (Debit account)
debit_subtype
string or null (Debit subtype)
debit_metadata
object or null (Debit metadata)
debit_note
string (Debit note) <= 100 characters
Default: ""
debit_reference
string or null (Debit reference) <= 100 characters
credit_account
string or null (Credit account)
credit_subtype
string or null (Credit subtype)
credit_metadata
object or null (Credit metadata)
credit_note
string (Credit note) <= 100 characters
Default: ""
credit_reference
string or null (Credit reference) <= 100 characters
recipient
string (Recipient) [ 1 .. 100 ] characters
amount
required
integer (Amount)
currency
required
string (Currency) non-empty
Responses
201
post/transactions/transfer/
Request samples
application/json
{
  • "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"
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Retrieve transaction

SecurityToken
Request
path Parameters
tx_code
required
string
Responses
200
get/transactions/{tx_code}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

List transaction messages

SecurityToken
Request
path Parameters
tx_code
required
string
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/transactions/{tx_code}/messages/
Response samples
application/json
{
  • "status": "string",
  • "data": {}
}

Retrieve transaction message

SecurityToken
Request
path Parameters
id
required
string
tx_code
required
string
Responses
200
get/transactions/{tx_code}/messages/{id}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}