Get Transaction

Request

Retrieves a single transaction activity by ID. A transaction activity represents a single side (debit/credit) of a transaction.

Security

HTTPBearer

Path

transaction_activity_idstring, (uuid)(Transaction Activity Id)required

x-jiko-idempotencystring, (uuid)(X-Jiko-Idempotency)required

A UUID you generate to identify this request. Reusing a value that was already sent is rejected as a duplicate request.

x-jiko-signaturestring(X-Jiko-Signature)required

Base64-encoded HMAC-SHA256 hash of x-jiko-idempotency + request pathname + body, keyed with your shared secret. See Authentication for the full algorithm and a code sample.

curl -i -X GET \
  'https://your-partner-name.sandbox-api.jikoservices.com/api/v2/transactions/{transaction_activity_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-jiko-idempotency: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-jiko-signature: string'

Responses

Successful Response

Bodyapplication/json

idstring, (uuid)(Id)required

The ID of the transaction from the perspective of the respective pocket

transaction_idstring, (uuid)(Transaction Id)required

The ID of the transaction this activity is representing

descriptionstring(Description)required

A description of the transaction type, e.g. "ACH Electronic Debit".

amountobject(Amount)required

time_bookedstring, (date-time)(Time Booked)required

The time at which the transaction was originally booked into the ledger.

time_settledstring or null(Time Settled)required

Any of:

The time at which transaction was settled.

string (date-time)

statusstring(Status)required

Status of the transactions. Has the transactions been settled

Enum:"BOOKED""SETTLED"

titlestring(Title)required

directionstring(Direction)required

Enum:"DEBIT""CREDIT"

pocket_idstring, (uuid)(Pocket Id)required

The pocket associated with the transaction

customer_idstring, (uuid)(Customer Id)required

The customer associated with the transaction

remittance_informationRemittanceInformation (object) or null

Any of:

typestring(Type)required

Enum:"ACH""WIRE""CARD""ON_US""FEE""CREDIT""GENERIC""ON_CHAIN"

Discriminator

Value:"ACH"

company_namestring(Company Name)required

company_entry_descriptionstring or null(Company Entry Description)

Any of:

string

individual_identification_numberstring or null(Individual Identification Number)

Any of:

string

trace_numberstring or null(Trace Number)

Any of:

string

ach_idstring or null(Ach Id)

Any of:

string (uuid)

ach_directionstring(ACHDirection)required

Enum:"RECEIVING""ORIGINATION"

portal_idstring or null(Portal Id)

Any of:

string (uuid)

Response

{
  "id": "05964326-49b7-4e74-9783-81137ee3cf3b",
  "transaction_id": "4b955c69-dd95-4f6a-a0ff-325ee029f240",
  "description": "Wire Transfer In",
  "amount": {
    "value": 100000,
    "currency": "USD",
    "formatted": "$1,000.00"
  },
  "time_booked": "2023-01-01T12:00:00Z",
  "time_settled": "2023-01-02T12:00:00Z",
  "status": "SETTLED",
  "title": "From External Account",
  "direction": "DEBIT",
  "pocket_id": "8a7ec6c0-2701-40a1-8954-68870964b50d",
  "customer_id": "66f6e46c-f6a1-4af8-a1bd-49666bc01301",
  "type": "WIRE",
  "reference_number": "9999XXXX",
  "counterparty_name": "John Smith",
  "wire_id": "4854014d-5540-4f0c-9efe-a0137f01e1da",
  "portal_id": "cc093946-a894-415e-bb69-eff95f5ece78",
  "wire_type": "PAYMENT"
}

Get Transaction

Request

Path

Headers

Responses

Was this helpful?