INTRODUCTION

RECIPIENT USE CASES

FINANCIAL ACCOUNT USE CASES

PAYMENT REASON USE CASES

TRANSACTION USE CASES

NOTE USE CASES

Design  /  Transaction Use Cases  /  Retrieve a Transaction’s Status History

Retrieve a Transaction’s Status History

Overview

In this use case, we’ll walk through retrieving the status history for a transaction. A transaction’s status changes depending on where it is in the transaction processing flow.

This method returns the transaction’s current status as well as all of the statuses that have been historically assigned to the transaction.

API Operation

Steps

Send a request to the following endpoint:

GET /api/external/v1/transactions/{transactionId}/status

  • Use the {transactionId} path parameter to specify the transaction ID. The status history of this transaction will be retrieved.
  • Use the page and size query parameters to limit the number of results returned.
  • Request body is not required.
  • Include a Basic Auth Authorization header where the username is your API key ID and the password is your API key secret.

Sample Response

Returns a paginated response with an array of transaction status objects. Details are returned for each status.

				
					{
  "totalElements": 1,
  "totalPages": 1,
  "number": 1,
  "numberOfElements": 1,
  "hasNext": false,
  "content": [
    {
      "id": "9qw98h31-3978-2498-g2ko-8w965t32kwe6",
      "createdAt": "2021-07-01T17:40:22.601Z",
      "transactionId": "8hb21a87-3985-9217-a6zq-5y643x47hsa7",
      "status": "NEW",
      "message": "Transaction creation successful"
    }
  ]
}
				
			
ON THIS PAGE