GET
/
v1
/
businesses
/
{businessId}
/
invoices
/
refunds
/
payments
List refund payments
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/invoices/refunds/payments \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "31415926535",
    "refunded_amount": 123,
    "fee": 123,
    "completed_at": "2023-11-07T05:31:56Z",
    "method": "CREDIT_CARD",
    "processor": "STRIPE",
    "payment_clearing_account": {
      "id": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "name": "Current Assets",
      "stable_name": {
        "type": "StableName",
        "stable_name": "CURRENT_ASSETS"
      },
      "normality": "CREDIT",
      "account_type": {
        "value": "ASSET",
        "display_name": "Asset"
      },
      "account_subtype": {
        "value": "BANK_ACCOUNTS",
        "display_name": "Current Assets"
      }
    },
    "refunded_payment_fees": [
      {
        "account": {
          "type": "AccountId",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "description": "<string>",
        "fee_amount": 123
      }
    ],
    "transaction_tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "ExampleTagKey",
        "value": "ExampleTagValue",
        "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      }
    ],
    "memo": "<string>",
    "metadata": {
      "custom_field": "value",
      "any valid json": "below 10kb",
      "nested": {
        "meaning of life": 42,
        "array": []
      }
    },
    "reference_number": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Content-Type
string

Content-Type must be set to application/json

Path Parameters

​
businessId
string
required

The UUID of the business to fetch refund payments for.

Query Parameters

​
external_id
string

Filter customer refund payments by external ID (unique idempotency key). This will always yield zero or one result.

​
completed_at_start
string<date-time>

Filter customer refund payments by completion date. Payments completed on or after this date will be included. ISO 8601 date format.

​
completed_at_end
string<date-time>

Filter customer refund payments by completion date. Payments completed on or before this date will be included. ISO 8601 date format.

​
method
string

Filter customer refund payments by payment method. Supported values are CASH, CHECK, CREDIT_CARD, ACH, CREDIT_BALANCE, OTHER.

​
processor
string

Filter customer refund payments by payment processor (e.g. STRIPE, etc.).

​
min_amount
integer

Filter customer refund payments by minimum amount. Only payments with amounts greater than or equal to this value will be included. Must be a positive integer.

Required range: x >= 0
​
max_amount
integer

Filter customer refund payments by maximum amount. Only payments with amounts less than or equal to this value will be included. Must be a positive integer.

Required range: x >= 0
​
memo_contains
string

Filter customer refund payments by memo content. Returns payments where the memo contains this string (case-sensitive).

​
memo
string

Filter customer refund payments by exact memo match. Returns payments where the memo exactly matches this string.

​
reference_numbers
string

Comma-separated list of reference numbers to filter customer refund payments by. Only customer refund payments with reference numbers matching any value in this list will be returned.

​
included_in_payout
boolean

Filter customer refund payments by whether they are included in a payout. Set to true to show only payments that are part of a payout, false to show only payments not in any payout.

​
is_matched
boolean

Filter customer refund payments by match status. If true, only matched payments will be returned. If false, only unmatched payments will be returned. Customer refund payments are considered matched if they are matched directly, or if they are included in a payout that is matched.

Response

200 - application/json

List of refund payments

​
id
string<uuid>

Unique identifier for the payment.

​
external_id
string

Unique ID of the payment in your system for linking purposes. Idempotency key.

Example:

"31415926535"

​
refunded_amount
integer

Amount refunded to the customer in cents.

​
fee
integer | null

Fee charged for the refund in cents.

​
completed_at
string<date-time>

Time when the payment was completed.

​
method
string

Method of the payment.

Example:

"CREDIT_CARD"

​
processor
string | null

Processor used for the payment.

Example:

"STRIPE"

​
payment_clearing_account
object

The the ledger account to use for the payment (overrides the default determined by the payment method), if specified.

​
refunded_payment_fees
object[]

Refunded payment fees associated with the refund payment

​
transaction_tags
object[]
​
memo
string | null

Memo for any text you would like to associate with the refund payment (for example, to display to end users).

​
metadata
object

Arbitrary custom metadata in JSON format with a size limit of 10KB

Example:
{
  "custom_field": "value",
  "any valid json": "below 10kb",
  "nested": { "meaning of life": 42, "array": [] }
}
​
reference_number
string | null

Any (typically user-visible) identifier you would like to associate with the refund payment. Can be used to filter when listing refund payments.