BYbyaccrue
ExternalTransactions

List External Transactions

get/api/v1/external-transactions

Request

Query parameters

filter[phoneNumber]string

Filter the list of objects by the value of the phoneNumber field.

filter[userId]string

Filter the list of objects by the value of the userId field.

filter[sourceId]string

Filter the list of objects by the value of the sourceId field.

page[limit]number

Maximum number of objects that will be returned. Can not be greater than 50.

page[offset]number

Offset from the beginning of the list of objects. Can not be negative.

Headers

Client-IDstring uuid required

The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.

Example:123e4567-e89b-12d3-a456-426614174000
Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "linkedExternalTransactionId": "9f755746-13cb-4d0b-81f2-3b4f1b44f6d8",
        "source": {
          "id": "9f755746-13cb-4d0b-81f2-3b4f1b44f6d8",
          "customerId": "607329"
        },
        "channel": "nyc-store-1",
        "payments": [
          {
            "method": "Cash",
            "amount": 10000
          },
          {
            "method": "DebitCard",
            "amount": 5000
          }
        ]
      },
      "relationships": {
        "linkedExternalTransaction": {
          "data": [
            {
              "id": "9f755746-13cb-4d0b-81f2-3b4f1b44f6d8"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "total": 1,
    "limit": 10
  }
}

Changes

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