Search

client.experimental.payments.search(?, ?): PaymentSearchResponse { data }

POST/payments/search

Searches payments.

ParametersExpand Collapse

body: PaymentSearchParams { page_info, payment_flow_id }

page_info?: PageInfo

Pagination parameters.

after?: string

Pagination cursor.

limit?: number

Maximum number of results.

payment_flow_id?: string

Filter by payment flow ID.

ReturnsExpand Collapse

PaymentSearchResponse { data }

List of payments.

data: Array<Payment { id, amount, created, 8 more } >

id: string

FRAGMENT generated unique ID.

amount: string

Amount in smallest currency unit.

created: string

Timestamp when the payment was created.

currency: string

Currency code.

direction: string

Direction of the payment.

modified: string

Timestamp when the payment was last modified.

payment_account_id: string

Payment account ID.

payment_flow_id: string

Payment flow ID.

status: string

Status of the payment.

transaction_ids: Array<string>

Associated transaction IDs.

external_id?: string

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

Search

import Fragment from '@fragment-dev/ts-node';

const client = new Fragment();

const response = await client.experimental.payments.search();

console.log(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"
    }
  ]
}