List all transactions - WooshPay OpenAPI

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Query Params

card

string

optional

Only return transactions that belong to the given card.

cardholder

string

optional

Only return transactions that belong to the given cardholder.

limit

integer

optional

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created [gt]

integer

optional

Return results where the created field is greater than this value.

created [gte]

integer

optional

Return results where the created field is greater than or equal to this value.

created [lt]

integer

optional

Return results where the created field is less than this value.

created [lte]

integer

optional

Return results where the created field is less than or equal to this value.

ending_before

string

optional

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

starting_after

string

optional

Header Params

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

object

string

optional

Default:

"list"

url

string

optional

has_more

boolean

optional

data

array [object {16}]

optional

string

optional

Unique identifier for the object.

object

string

optional

String representing the object’s type. Objects of the same type share the same value.

amount

integer

optional

The transaction amount

authorization

string

optional

The Authorization object that led to this transaction.

card

string

optional

The card used to make this transaction.

cardholder

string

optional

The cardholder to whom this transaction belongs.

currency

string

optional

Three-letter ISO currency code, in lowercase. Must be a supported currency.

metadata

object

optional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

type

enum<string>

optional

The nature of the transaction.

Allowed values:

capturerefund

created

string

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

dispute

string

optional

If you’ve disputed the transaction, the ID of the dispute.

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

merchant_amount

integer

optional

The amount that the merchant will receive, denominated in merchant_currency and in the smallest currency unit. It will be different from amount if the merchant is taking payment in a different currency.

merchant_currency

string

optional

The currency with which the merchant is taking payment.

merchant_data

object

optional

Details about the seller (grocery store, e-commerce website, etc.) involved in this transaction.

network_data

object

optional

Details about the transaction, such as processing dates, set by the card network.

Example

{
    "object": "\"list\"",
    "url": "string",
    "has_more": true,
    "data": [
        {
            "id": "string",
            "object": "string",
            "amount": 0,
            "authorization": "string",
            "card": "string",
            "cardholder": "string",
            "currency": "string",
            "metadata": {},
            "type": "capture",
            "created": "string",
            "dispute": "string",
            "livemode": true,
            "merchant_amount": 0,
            "merchant_currency": "string",
            "merchant_data": {
                "category": "string",
                "category_code": "string",
                "city": "string",
                "country": "string",
                "name": "string",
                "network_id": "string",
                "postal_code": "string",
                "state": "string",
                "terminal_id": "string",
                "url": "string"
            },
            "network_data": {
                "authorization_code": "string",
                "transaction_id": "string"
            }
        }
    ]
}