Skip to main content
GET
/
transaction
Get transactions
curl --request GET \
  --url http://api.obsidiam.com/transaction
{
  "id": "<string>",
  "status": "AWAITING_PAYMENT",
  "settlement": "D0",
  "quantity": 123,
  "rate": 123,
  "total": 123,
  "beneficiaryId": "<string>"
}

Query Parameters

​
from
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
to
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
page
number
default:1
​
settlement
enum<string>
default:all
Available options:
D0,
D1,
D2,
all
​
status
enum<string>
default:all
Available options:
AWAITING_PAYMENT,
PAID_AWAITING_FULFILLMENT,
FULFILLED,
CANCELLED,
all

Response

default - application/json
​
id
string
required
​
status
enum<string>
required
Available options:
AWAITING_PAYMENT,
PAID_AWAITING_FULFILLMENT,
FULFILLED,
CANCELLED
​
settlement
enum<string>
required
Available options:
D0,
D1,
D2
​
quantity
number
required
​
rate
number
required
​
total
number
required
​
beneficiaryId
string | null
required