Search

experimental.payments.search() -> PaymentSearchResponse

POST/payments/search

Searches payments.

ParametersExpand Collapse

page_info: Optional[PageInfo]

Pagination parameters.

after: Optional[str]

Pagination cursor.

limit: Optional[float]

Maximum number of results.

payment_flow_id: Optional[str]

Filter by payment flow ID.

ReturnsExpand Collapse

class PaymentSearchResponse: …

List of payments.

data: List[Payment]

id: str

FRAGMENT generated unique ID.

amount: str

Amount in smallest currency unit.

created: str

Timestamp when the payment was created.

currency: str

Currency code.

direction: str

Direction of the payment.

modified: str

Timestamp when the payment was last modified.

payment_account_id: str

Payment account ID.

payment_flow_id: str

Payment flow ID.

status: str

Status of the payment.

transaction_ids: List[str]

Associated transaction IDs.

external_id: Optional[str]

User-provided unique ID when the payment was created with one.

Search

from fragment import Fragment

client = Fragment()
response = client.experimental.payments.search()
print(response.data)

{
  "data": [
    {
      "id": "pmt_abc123",
      "amount": "10000",
      "created": "2024-01-01T00:00:00.000Z",
      "currency": "USD",
      "direction": "payin",
      "modified": "2024-01-01T00:00:00.000Z",
      "payment_account_id": "pmt_account_abc123",
      "payment_flow_id": "pf_xyz789",
      "status": "settled",
      "transaction_ids": [
        "txn_abc123"
      ],
      "external_id": "pmt_ext_123"
    }
  ]
}

Returns Examples

{
  "data": [
    {
      "id": "pmt_abc123",
      "amount": "10000",
      "created": "2024-01-01T00:00:00.000Z",
      "currency": "USD",
      "direction": "payin",
      "modified": "2024-01-01T00:00:00.000Z",
      "payment_account_id": "pmt_account_abc123",
      "payment_flow_id": "pf_xyz789",
      "status": "settled",
      "transaction_ids": [
        "txn_abc123"
      ],
      "external_id": "pmt_ext_123"
    }
  ]
}