Transactions
Attribute | Type | Description |
id | uuid | The unique identifier for the moment. |
out_user_id | uuid | The unique identifier for the user who made the transaction. |
in_user_id | uuid | The unique identifier for the user who received the transaction. |
out_funding_source_id | uuid | The unique identifier for the source funding source. |
in_funding_source_id | uuid | The unique identifier for the destination funding source. |
rule_id | uuid | The unique identifier for the internal rule used when this transaction was created, if set. |
payment_id | uuid | The unique identifier for the payment object associated transaction, if set. |
payment_request_id | uuid | The unique identifier for the payment request object associated with this transaction, if set. |
pool_id | uuid | The unique identifier for the money pool object associated with this transaction, if set. |
payment_recipient_id | uuid | The unique identifier for the payment participant object associated with this transaction, if set. |
status | string | The transactions status.
active
cancelledcreatedfailedprocessing |
amount | float | The transaction amount. |
out_fee | float | The fee amount applied to the payer, if any. |
in_fee | float | The fee amount applied to the payee, if any. |
currency | string | Three-letter ISO-4217 code. |
tracking_code | string | An optional tracking code which can be used for reference. |
tracking_number | string | An optional tracking number which can be used for reference. |
error | boolean | Whether the transaction resulted in an error. |
error_message | string | An error message in case of an error. |
meta | string | A JSON object which can store meta data used by the client. |
expires_at | time | The time when the transaction expires, if set. |
created_at | time | The time when the transaction was created. |
updated_at | time | The time when the transaction was updated. |
{
"id": "add5c52a-0c57-4d5c-7525-db14566f2f1a",
"out_funding_source_id": "45df677b-a602-48ac-bfbb-b563914621bf",
"in_funding_source_id": "5d2c6ab5-392f-4495-8ce5-5d38eeb99220",
"out_user_id": "dd72ebb8-db1f-4442-b203-095ac9ded974",
"in_user_id": "1c478b12-288a-4ea0-831d-1e36639300da",
"payment_id": "745ad357-c7dc-478d-a46b-a97ebd9de4c7",
"status": "active",
"amount": 50.0,
"currency": "EUR",
"tracking_code": "DEF456",
"error": false,
"expires_at": "2017-10-04T12:25:48.827724Z",
"created_at": "2017-09-04T12:25:48.827724Z",
"updated_at": "2017-09-04T12:25:48.827724Z"
}
Get a list of all transactions, in and out, for all of the funding sources belonging to the user. A transaction has a GatewayResponse object if the transaction was processed by a gateway.
Request
Response
GET /v1/transactions
Name | Type | Description |
page | int | Item pagination. |
limit | int | Number of items to return per page. |
sort | string | Sort the results by created_at, updated_at. |
filter | string | Filter the results. |
Attribute | Type | Operators | Values |
funding_source_id | uuid | eq, in | Funding source ID(s). |
status | string | eq | Status code. |
200 OK
Returns a list of transaction objects.
Get a single transaction by ID.
Request
Response
GET /v1/transactions/{id}
200 OK
Returns a transaction object.
Last modified 1yr ago