View Transaction

GET /transactions/{id}
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/transactions/{id}

Retrieves the details of a Transaction that has previously been created if a valid identifier was provided

path Parameters
Arrow
Name
Description
idstring (uuid)required
A unique identifier generated by the Ocamba platform.


Example: c7db9321-dc48-43f1-b32d-a45a4991879a
query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ transaction ]
An array of all created items.
Transaction
Name
Description
amountnumber
Transaction price.


Example: 10.99
company_idstring
A unique company identifier generated by the Ocamba platform.


Example: 1234567
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
currency_codestring
Three-letter, uppercase currency code.


Example: USD
idstring (uuid)
A unique identifier generated by the Ocamba platform.


Example: 37ca408f-59d8-4910-bcb0-54dad2641c61
invoice_numbers[ string ]
Array of the invoice numbers.
payment_providerstring
Name of the payment provider.


Example: paypal
update_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
totalinteger
A total number of items.


Example: 1
tip
1 If you don't know the transaction id, list the transactions to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
    "total": 1,
    "items": [
        {
            "id": "37ca408f-59d8-4910-bcb0-54dad2641c61",
            "company_id": "1234567",
            "invoice_numbers": [
                "OCM-213376"
            ],
            "payment_provider": "paypal",
            "amount": 11.99,
            "currency_code": "USD",
            "create_time": "2021-11-24 10:23:55",
            "update_time": "2021-11-24 10:24:02"
        }
    ]
}

{
  "total": 1,
  "items": [
    {
      "id": "37ca408f-59d8-4910-bcb0-54dad2641c61",
      "company_id": "1234567",
      "invoice_numbers": [
        "OCM-213376"
      ],
      "payment_provider": "paypal",
      "amount": 10.99,
      "currency_code": "USD",
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}