Transactions History

The transactions history resource returns a collection of transactions that have been processed along with their current status and other relevant information. Transactions that are currently scheduled but have not yet been processed can be found in the https://gotobilling.atlassian.net/wiki/spaces/DOC/pages/2648440846 resource.

End-point

Method

Description

End-point

Method

Description

/api/transactions-history

GET

Returns a collection of transactions that have been processed

/api/transactions-history/{id}

GET

Return a specific transaction based on the transaction ID

All API endpoints require an authentication header to be included with the request.  See API Authentication

Filters

Parameter

Type

Description

 

Parameter

Type

Description

 

id

int or Array Filter

OmniFund assigned Transaction ID

1 2 3 4 5 # filter based on a single id GET /api/transactions-history?id=231432546 # filter based on multiple ids GET /api/transactions-history?id[]=231432546&id[]=231432546

customer

int or Array Filter

OmniFund assigned Customer ID

1 2 3 4 5 # filter based on a single customer GET /api/transactions-history?customer=231432546 # filter based on multiple customers GET /api/transactions-history?customer[]=3245345&customer[]=21176543

amount

float or Array Filter

Amount of the transaction

1 2 3 4 5 # filter based on a single amount GET /api/transactions-history?amount=1.25 # filter based on multiple amounts GET /api/transactions-history?amount[]=1.25&amount[]=25.33

referenceId

string or Array Filter

Merchant provided transaction reference ID

1 2 3 4 5 # filter based on a single referenceId GET /api/transactions-history?amount=1.25 # filter based on multiple referenceIds GET /api/transactions-history?referenceId[]=A1234&referenceId[]=B2345

 

tranDate

Range Filter

Effective date the transaction is schedule to be processed on. Dates are displayed in and accept Unix format.

1 2 3 4 5 6 7 8 # filter based on a single timestamp GET /api/transactions-history?tranDate=1553538663 # filter events between two timestamps GET /api/transactions-history?tranDate[between]=1553538663..1553638663 # filter events greater than or equal to a timestamp GET /api/transactions-history?tranDate[gte]=1553538663

Response

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 { "@context": "/api/contexts/transactions-history", "@id": "/api/transactions-history", "@type": "hydra:Collection", "hydra:member": [ { "@id": "/api/transactions-history/29678731", "@type": "transactions-history", "amount": "1.25", "customer": { "@type": "Customer", "@id": "_:13734", "id": 2970560, "customerRef": "1999", "company": "", "firstName": "Test", "lastName": "Customer", "email": "" }, "id": 29678731, "lockStatus": 0, "loginId": "100100", "memo": "", "notes": "", "occurrence": "monthly", "occurrence_remaining": "4", "poNumber": "", "recordType": "debit", "referenceId": "A1234", "surcharge": "0.00", "tranDate": "1619197200", "tranStatus": "settled" "tranType": "ach" } ], "hydra:totalItems": 1 }

Pagination

Transaction History collection items also support pagination. For more information on pagination see Paginating Collection Results.

Response Fields

Field

Description

Field

Description

amount

Total mount of the transaction

customer

Customer data object

id

OmniFund assigned transaction ID

loginID

ID of the user that created the transaction

memo

Memo attached to the transaction. This value is included on the customer facing emails and receipts

notes

Internal notes attached to the transaction. This value is only visible to the merchant

occurrence

  • single

  • weekly

  • bi-weekly

  • monthly

  • quarterly

  • annually

occurrence_remaining

Number of occurrences remaining. Only applicable for recurring transactions

poNumber

PO Number assigned to the transaction by the merchant

recordType

For card transactions

  • sale

  • auth

  • force

  • void

  • refund

  • avsonly

  • prior auth capture

For ach transactions

  • debit

  • credit

For POS transactions

  • cash

referenceId

Merchant assigned reference ID

surcharge

Surcharge amount that was included in the total amount

tranDate

Unix timestamp effective date of the transaction

tranStatus

  • Y - Card approval

  • N - Card decline

  • Processing - ACH processing

  • Settled - ACH settled

  • Returned - ACH returned

tranType

  • card

  • ach

  • pos