SPspinwheel
Transactions

Look Up Transactions by Creation Window

This API will allow you to get the current status of all transactions created after a timestamp, optionally filtered by status. Results are returned in pages of 100. Pass the nextCursor from a response as cursor to get the next page.

get/v1/payments/transactions/lookup

Request

  • Base URL
    https://sandbox-api.spinwheel.io
  • URL
    https://sandbox-api.spinwheel.io/v1/payments/transactions/lookup
  • Auth
    API key in header Authorization

Query parameters

createdAfternumber

Lower bound on transaction creation time, epoch milliseconds, within the last 31 days. Required unless cursor is supplied.

statusesstring[]

Comma-separated statuses to include. Omit for all statuses.

cursorstring

nextCursor from a previous response. When present, the other parameters are ignored.

Response

Successful response

nextCursorstring nullable required

Pass as cursor to get the next page. null on the last page.

Example response

{
  "nextCursor": "eyJ3aW5kb3ciOnsiZnJvbSI6MTc4NzA3ODQwMDAwMCwidG8iOjE3ODgyOTIyMzg2ODN9LCJzdGF0dXNlcyI6WyJSRVRVUk5FRCJdLCJhZnRlciI6eyJjcmVhdGVkT24iOjE3ODc5OTk5OTk5OTksIl9pZCI6IjFlYmMxOTc0LWNlYTMtNGNhYi1iOTQ4LThiN2UxN2U3ZWFlOCJ9fQ",
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": [
    {
      "userId": "75d84539-78e7-492d-9394-8aa63beb7146",
      "payerId": "33ab228a-5afc-4993-b976-de8f522062c0",
      "requestId": "d35b822d-8bde-4d21-bbbe-d8f9c4f5b656",
      "extRequestId": "800830ab-950a-4fbd-a8f1-2936680ed69b",
      "statusComment": "Txn request successfully created",
      "paymentStatusCode": "200",
      "transactionId": "392683d5-108d-4610-94cf-88bbb46990c9",
      "settlementAccountId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "useOfFunds": {
        "homeLoanId": "435ed671-2800-4a7f-8e72-21aa7e65faf1",
        "percentage": 50,
        "liabilityType": "HOME_LOAN"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.