Update refund

curl --request PUT \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/invoices/refunds/{refundId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "refunded_amount": 123,
  "completed_at": "2023-11-07T05:31:56Z",
  "allocations": [
    {
      "total_amount": 123,
      "line_items": [
        {
          "amount": 123,
          "external_id": "<string>",
          "account_identifier": {
            "type": "AccountId",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "prepayment_account_identifier": {
            "type": "AccountId",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "tags": [
            {
              "key": "department",
              "value": "sales",
              "dimension_display_name": "Department",
              "value_display_name": "Sales Department"
            }
          ],
          "memo": "<string>",
          "metadata": {
            "custom_field": "value",
            "any valid json": "below 1kb",
            "nested": {
              "meaning of life": 42,
              "array": []
            }
          },
          "reference_number": "<string>"
        }
      ],
      "external_id": "<string>",
      "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_external_id": "<string>",
      "invoice_line_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_line_item_external_id": "<string>",
      "invoice_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_payment_external_id": "<string>",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_external_id": "<string>",
      "tags": [
        {
          "key": "department",
          "value": "sales",
          "dimension_display_name": "Department",
          "value_display_name": "Sales Department"
        }
      ],
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>"
    }
  ],
  "payments": [
    {
      "refunded_amount": 123,
      "completed_at": "2023-11-07T05:31:56Z",
      "method": "CASH",
      "external_id": "31415926535",
      "refund_processing_fee": 123,
      "processor": "STRIPE",
      "payment_clearing_account_identifier": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "refunded_payment_fees": [
        {
          "account": {
            "type": "AccountId",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "fee_amount": 123,
          "description": "<string>"
        }
      ],
      "tags": [
        {
          "key": "department",
          "value": "sales",
          "dimension_display_name": "Department",
          "value_display_name": "Sales Department"
        }
      ],
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>"
    }
  ],
  "external_id": "<string>",
  "tags": [
    {
      "key": "department",
      "value": "sales",
      "dimension_display_name": "Department",
      "value_display_name": "Sales Department"
    }
  ],
  "memo": "<string>",
  "metadata": {
    "custom_field": "value",
    "any valid json": "below 1kb",
    "nested": {
      "meaning of life": 42,
      "array": []
    }
  },
  "reference_number": "<string>"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "31415926535",
  "refunded_amount": 123,
  "status": "PAID",
  "completed_at": "2023-11-07T05:31:56Z",
  "is_dedicated": true,
  "allocations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "account_identifier": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "invoice_external_id": "<string>",
      "invoice_line_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_line_item_external_id": "<string>",
      "invoice_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_payment_external_id": "<string>",
      "customer": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "31415926535",
        "individual_name": "<string>",
        "company_name": "<string>",
        "email": "<string>",
        "mobile_phone": "<string>",
        "office_phone": "<string>",
        "address_string": "<string>",
        "memo": "<string>",
        "status": "ACTIVE",
        "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",
            "dimension_display_name": "<string>",
            "value_display_name": "<string>",
            "archived_at": "2023-11-07T05:31:56Z"
          }
        ]
      },
      "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",
          "dimension_display_name": "<string>",
          "value_display_name": "<string>",
          "archived_at": "2023-11-07T05:31:56Z"
        }
      ],
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>"
    }
  ],
  "payments": [
    {
      "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",
        "account_number": "4000",
        "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",
          "dimension_display_name": "<string>",
          "value_display_name": "<string>",
          "archived_at": "2023-11-07T05:31:56Z"
        }
      ],
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>"
    }
  ],
  "payouts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "payout-1234",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "paid_out_amount": 123,
      "fee": 123,
      "processor": "STRIPE",
      "imported_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "match": {
        "id": "6b0a3734-f4ef-4fb0-9fc1-3f59b0c1cf99",
        "match_type": "PAYOUT",
        "bank_transaction": {
          "type": "Bank_Transaction_Data",
          "id": "a703c8d6-cfe8-453d-a275-b92eacc6fc6e",
          "business_id": "738ec216-e8e5-48f2-b7f2-cdc89c96b3d4",
          "source": "STRIPE",
          "source_transaction_id": "trxn_1sdOeLQiFAKE2LQBkcvrJw95f",
          "source_account_id": "738ec216-e154-48f2-1111-cdc89c96b3d4",
          "imported_at": "2024-03-19T22:09:53.290591Z",
          "date": "2024-03-06T06:06:40Z",
          "direction": "CREDIT",
          "amount": 87459,
          "counterparty_name": null,
          "description": "Payout (po_1OqnTHISISFAKEiTVBkCiyAERwm)",
          "account_name": "Layer Banking",
          "categorization_status": "MATCHED"
        },
        "details": {
          "type": "Payout_Match",
          "id": "d224508b-b05e-41da-89de-0fbd8a573507",
          "amount": 87459,
          "date": "2024-03-06T00:00:00Z",
          "description": "Payout from STRIPE",
          "adjustment": null
        }
      },
      "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",
          "dimension_display_name": "<string>",
          "value_display_name": "<string>",
          "archived_at": "2023-11-07T05:31:56Z"
        }
      ],
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>"
    }
  ],
  "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",
      "dimension_display_name": "<string>",
      "value_display_name": "<string>",
      "archived_at": "2023-11-07T05:31:56Z"
    }
  ],
  "memo": "<string>",
  "metadata": {
    "custom_field": "value",
    "any valid json": "below 1kb",
    "nested": {
      "meaning of life": 42,
      "array": []
    }
  },
  "reference_number": "<string>"
}

PUT

businesses

{businessId}

invoices

refunds

{refundId}

Update refund

curl --request PUT \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/invoices/refunds/{refundId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "refunded_amount": 123,
  "completed_at": "2023-11-07T05:31:56Z",
  "allocations": [
    {
      "total_amount": 123,
      "line_items": [
        {
          "amount": 123,
          "external_id": "<string>",
          "account_identifier": {
            "type": "AccountId",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "prepayment_account_identifier": {
            "type": "AccountId",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "tags": [
            {
              "key": "department",
              "value": "sales",
              "dimension_display_name": "Department",
              "value_display_name": "Sales Department"
            }
          ],
          "memo": "<string>",
          "metadata": {
            "custom_field": "value",
            "any valid json": "below 1kb",
            "nested": {
              "meaning of life": 42,
              "array": []
            }
          },
          "reference_number": "<string>"
        }
      ],
      "external_id": "<string>",
      "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_external_id": "<string>",
      "invoice_line_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_line_item_external_id": "<string>",
      "invoice_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_payment_external_id": "<string>",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_external_id": "<string>",
      "tags": [
        {
          "key": "department",
          "value": "sales",
          "dimension_display_name": "Department",
          "value_display_name": "Sales Department"
        }
      ],
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>"
    }
  ],
  "payments": [
    {
      "refunded_amount": 123,
      "completed_at": "2023-11-07T05:31:56Z",
      "method": "CASH",
      "external_id": "31415926535",
      "refund_processing_fee": 123,
      "processor": "STRIPE",
      "payment_clearing_account_identifier": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "refunded_payment_fees": [
        {
          "account": {
            "type": "AccountId",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "fee_amount": 123,
          "description": "<string>"
        }
      ],
      "tags": [
        {
          "key": "department",
          "value": "sales",
          "dimension_display_name": "Department",
          "value_display_name": "Sales Department"
        }
      ],
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>"
    }
  ],
  "external_id": "<string>",
  "tags": [
    {
      "key": "department",
      "value": "sales",
      "dimension_display_name": "Department",
      "value_display_name": "Sales Department"
    }
  ],
  "memo": "<string>",
  "metadata": {
    "custom_field": "value",
    "any valid json": "below 1kb",
    "nested": {
      "meaning of life": 42,
      "array": []
    }
  },
  "reference_number": "<string>"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "31415926535",
  "refunded_amount": 123,
  "status": "PAID",
  "completed_at": "2023-11-07T05:31:56Z",
  "is_dedicated": true,
  "allocations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "account_identifier": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "invoice_external_id": "<string>",
      "invoice_line_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_line_item_external_id": "<string>",
      "invoice_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_payment_external_id": "<string>",
      "customer": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "31415926535",
        "individual_name": "<string>",
        "company_name": "<string>",
        "email": "<string>",
        "mobile_phone": "<string>",
        "office_phone": "<string>",
        "address_string": "<string>",
        "memo": "<string>",
        "status": "ACTIVE",
        "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",
            "dimension_display_name": "<string>",
            "value_display_name": "<string>",
            "archived_at": "2023-11-07T05:31:56Z"
          }
        ]
      },
      "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",
          "dimension_display_name": "<string>",
          "value_display_name": "<string>",
          "archived_at": "2023-11-07T05:31:56Z"
        }
      ],
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>"
    }
  ],
  "payments": [
    {
      "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",
        "account_number": "4000",
        "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",
          "dimension_display_name": "<string>",
          "value_display_name": "<string>",
          "archived_at": "2023-11-07T05:31:56Z"
        }
      ],
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>"
    }
  ],
  "payouts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "payout-1234",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "paid_out_amount": 123,
      "fee": 123,
      "processor": "STRIPE",
      "imported_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "match": {
        "id": "6b0a3734-f4ef-4fb0-9fc1-3f59b0c1cf99",
        "match_type": "PAYOUT",
        "bank_transaction": {
          "type": "Bank_Transaction_Data",
          "id": "a703c8d6-cfe8-453d-a275-b92eacc6fc6e",
          "business_id": "738ec216-e8e5-48f2-b7f2-cdc89c96b3d4",
          "source": "STRIPE",
          "source_transaction_id": "trxn_1sdOeLQiFAKE2LQBkcvrJw95f",
          "source_account_id": "738ec216-e154-48f2-1111-cdc89c96b3d4",
          "imported_at": "2024-03-19T22:09:53.290591Z",
          "date": "2024-03-06T06:06:40Z",
          "direction": "CREDIT",
          "amount": 87459,
          "counterparty_name": null,
          "description": "Payout (po_1OqnTHISISFAKEiTVBkCiyAERwm)",
          "account_name": "Layer Banking",
          "categorization_status": "MATCHED"
        },
        "details": {
          "type": "Payout_Match",
          "id": "d224508b-b05e-41da-89de-0fbd8a573507",
          "amount": 87459,
          "date": "2024-03-06T00:00:00Z",
          "description": "Payout from STRIPE",
          "adjustment": null
        }
      },
      "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",
          "dimension_display_name": "<string>",
          "value_display_name": "<string>",
          "archived_at": "2023-11-07T05:31:56Z"
        }
      ],
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>"
    }
  ],
  "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",
      "dimension_display_name": "<string>",
      "value_display_name": "<string>",
      "archived_at": "2023-11-07T05:31:56Z"
    }
  ],
  "memo": "<string>",
  "metadata": {
    "custom_field": "value",
    "any valid json": "below 1kb",
    "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 update the refund for.

refundId

string

required

The UUID of the refund to update.

Body

application/json

Itemized refund creation parameters. Provides full control over refund allocations and payments. The sum of allocation amounts must equal the refunded_amount.

refunded_amount

integer<int64>

required

The total amount of the refund in cents. This value must be positive and equal to the sum of all allocation amounts.

completed_at

string<date-time>

required

The time the refund was completed.

allocations

object[]

required

The targets of the refund. Each allocation specifies how much of the refund should be applied to a specific invoice, line item, payment, or customer.

Show child attributes

allocations.total_amount

integer<int64>

required

The total amount of this allocation in cents. Must equal the sum of all line item amounts.

allocations.line_items

object[]

required

The line items that make up this allocation.

Show child attributes

allocations.line_items.amount

integer<int64>

required

The amount of this line item in cents.

allocations.line_items.external_id

string | null

An external identifier for the line item.

allocations.line_items.account_identifier

Account ID · object

Identifier of the ledger account for this line item.

Account ID
Account Stable Name

Show child attributes

allocations.line_items.account_identifier.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

allocations.line_items.account_identifier.id

string<uuid>

ID of the account

allocations.line_items.prepayment_account_identifier

Account ID · object

Identifier of the prepayment ledger account for this line item.

Account ID
Account Stable Name

Show child attributes

allocations.line_items.prepayment_account_identifier.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

allocations.line_items.prepayment_account_identifier.id

string<uuid>

ID of the account

allocations.line_items.tags

object[]

Tags to associate with the line item.

Show child attributes

allocations.line_items.tags.key

string

required

The tag dimension key (e.g., "department", "project", "location")

Example:

"department"

allocations.line_items.tags.value

string

required

The tag value (e.g., "sales", "marketing", "engineering")

Example:

"sales"

allocations.line_items.tags.dimension_display_name

string | null

If the TagDimension doesn't exist, providing this value specifies the display name upon database insertion. Otherwise, it is left as null on the TagDimension.

Example:

"Department"

allocations.line_items.tags.value_display_name

string | null

If the TagValueDefinition doesn't exist, providing this value specifies the display name upon database insertion. Otherwise, it is left as null on the TagValueDefinition.

Example:

"Sales Department"

allocations.line_items.memo

string | null

Memo for any text you would like to associate with the line item.

allocations.line_items.metadata

object

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

Example:

{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}

allocations.line_items.reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the refund allocation line item.

allocations.external_id

string | null

An external identifier for the refund allocation.

allocations.invoice_id

string<uuid> | null

The ID of the invoice to refund.

allocations.invoice_external_id

string | null

The external ID of the invoice to refund.

allocations.invoice_line_item_id

string<uuid> | null

The ID of the invoice line item to refund.

allocations.invoice_line_item_external_id

string | null

The external ID of the invoice line item to refund.

allocations.invoice_payment_id

string<uuid> | null

The ID of the invoice payment to refund.

allocations.invoice_payment_external_id

string | null

The external ID of the invoice payment to refund.

allocations.customer_id

string<uuid> | null

The ID of the customer to refund.

allocations.customer_external_id

string | null

The external ID of the customer to refund.

allocations.tags

object[]

Tags to associate with the allocation.

Show child attributes

allocations.tags.key

string

required

The tag dimension key (e.g., "department", "project", "location")

Example:

"department"

allocations.tags.value

string

required

The tag value (e.g., "sales", "marketing", "engineering")

Example:

"sales"

allocations.tags.dimension_display_name

string | null

If the TagDimension doesn't exist, providing this value specifies the display name upon database insertion. Otherwise, it is left as null on the TagDimension.

Example:

"Department"

allocations.tags.value_display_name

string | null

If the TagValueDefinition doesn't exist, providing this value specifies the display name upon database insertion. Otherwise, it is left as null on the TagValueDefinition.

Example:

"Sales Department"

allocations.memo

string | null

Memo for any text you would like to associate with the refund allocation.

allocations.metadata

object

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

Example:

{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}

allocations.reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the refund allocation.

payments

object[]

required

The payment methods and amounts used to process the refund.

Show child attributes

payments.refunded_amount

integer<int64>

required

Amount refunded to the customer in cents.

payments.completed_at

string<date-time>

required

Time when the payment was completed.

payments.method

enum<string>

required

Payment method used for the refund.

Available options:

CASH,

CHECK,

CREDIT_CARD,

ACH,

CREDIT_BALANCE,

OTHER

payments.external_id

string | null

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

Example:

"31415926535"

payments.refund_processing_fee

integer<int64> | null

Fee charged to the business for processing the refund in cents.

payments.processor

string | null

Processor used to make the payment, if any. Any processor name can be provided and will be tracked. Supported processors (e.g. STRIPE) will have additional asset balance tracking.

Example:

"STRIPE"

payments.payment_clearing_account_identifier

Account ID · object

The the ledger account to use for the payment (overrides the default determined by the payment method)

Account ID
Account Stable Name

Show child attributes

payments.payment_clearing_account_identifier.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

payments.payment_clearing_account_identifier.id

string<uuid>

ID of the account

payments.refunded_payment_fees

object[]

List of fees associated with this payment. These are refunded from the payment processor rather than the business.

Show child attributes

payments.refunded_payment_fees.account

Account ID · object

required

Account to which the fee should be allocated.

Account ID
Account Stable Name

Show child attributes

payments.refunded_payment_fees.account.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

payments.refunded_payment_fees.account.id

string<uuid>

ID of the account

payments.refunded_payment_fees.fee_amount

integer<int64>

required

Amount of the fee in cents.

payments.refunded_payment_fees.description

string | null

Description of the fee.

payments.tags

object[]

Tags to associate with the payment.

Show child attributes

payments.tags.key

string

required

The tag dimension key (e.g., "department", "project", "location")

Example:

"department"

payments.tags.value

string

required

The tag value (e.g., "sales", "marketing", "engineering")

Example:

"sales"

payments.tags.dimension_display_name

string | null

If the TagDimension doesn't exist, providing this value specifies the display name upon database insertion. Otherwise, it is left as null on the TagDimension.

Example:

"Department"

payments.tags.value_display_name

string | null

If the TagValueDefinition doesn't exist, providing this value specifies the display name upon database insertion. Otherwise, it is left as null on the TagValueDefinition.

Example:

"Sales Department"

payments.memo

string | null

Memo for any text you would like to associate with the refund payment.

payments.metadata

object

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

Example:

{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}

payments.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.

external_id

string | null

An external identifier for the refund transaction.

Response

Refund updated successfully.

A refund represents a transaction that returns value to from a business to a customer. A specific payment can be refunded or a general refund can be applied to an invoice.

string<uuid>

Unique identifier for the refund.

external_id

string

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

Example:

"31415926535"

refunded_amount

integer<int64>

Amount refunded to the customer in cents.

status

string

Status of the refund.

Example:

"PAID"

completed_at

string<date-time>

Time when the refund was completed.

is_dedicated

boolean

Whether this refund is dedicated or not. Dedicated refunds can only have one allocation and one payment.

Example:

true

allocations

object[]

Allocations associated with this refund.

Show child attributes

allocations.id

string<uuid>

Unique identifier for the refund allocation.

allocations.invoice_id

string<uuid> | null

ID of the invoice this allocation is associated with.

allocations.amount

integer<int64>

Amount of the allocation in cents.

allocations.account_identifier

Account ID · object

Identifier of the ledger account for the refund allocation to apply to

Account ID
Account Stable Name

Show child attributes

allocations.account_identifier.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

allocations.account_identifier.id

string<uuid>

ID of the account

allocations.invoice_external_id

string | null

External ID of the invoice this allocation is associated with.

allocations.invoice_line_item_id

string<uuid> | null

ID of the invoice line item this allocation is associated with. If specified, must not refer to a different invoice invoice_external or invoice_id.

allocations.invoice_line_item_external_id

string | null

The external ID of the invoice line item to refund. If specified alongside invoice_line_item_id, they must refer to the same invoice line item.

allocations.invoice_payment_id

string<uuid> | null

ID of the invoice payment this allocation is associated with.

allocations.invoice_payment_external_id

string | null

External ID of the invoice payment this allocation is associated with.

allocations.customer

object

Show child attributes

allocations.customer.id

string<uuid>

Unique identifier for the customer.

allocations.customer.external_id

string

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

Example:

"31415926535"

allocations.customer.individual_name

string | null

Full name of the individual customer or contact at a corporate customer.

allocations.customer.company_name

string | null

Name of the company customer.

allocations.customer.email

string | null

Email address of the customer.

allocations.customer.mobile_phone

string | null

Mobile phone number of the customer.

allocations.customer.office_phone

string | null

Office phone number of the customer.

allocations.customer.address_string

string | null

Address of the customer.

allocations.customer.memo

string | null

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

allocations.customer.status

string

Status of the customer. Possible values: ACTIVE, ARCHIVED.

Example:

"ACTIVE"

allocations.customer.transaction_tags

object[]

Show child attributes

allocations.customer.transaction_tags.id

string<uuid>

required

ID for the tag

allocations.customer.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

allocations.customer.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

allocations.customer.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

allocations.customer.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

allocations.customer.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

allocations.customer.transaction_tags.value_display_name

string | null

Display name for the tag value definition

allocations.customer.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

allocations.transaction_tags

object[]

Show child attributes

allocations.transaction_tags.id

string<uuid>

required

ID for the tag

allocations.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

allocations.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

allocations.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

allocations.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

allocations.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

allocations.transaction_tags.value_display_name

string | null

Display name for the tag value definition

allocations.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

allocations.memo

string | null

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

allocations.metadata

object

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

Example:

{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}

allocations.reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the refund allocation.

payments

object[]

Payments associated with this refund.

Show child attributes

payments.id

string<uuid>

Unique identifier for the payment.

payments.external_id

string

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

Example:

"31415926535"

payments.refunded_amount

integer<int64>

Amount refunded to the customer in cents.

payments.fee

integer<int64> | null

Fee charged for the refund in cents.

payments.completed_at

string<date-time>

Time when the payment was completed.

payments.method

string

Method of the payment.

Example:

"CREDIT_CARD"

payments.processor

string | null

Processor used for the payment.

Example:

"STRIPE"

payments.payment_clearing_account

object

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

Show child attributes

payments.payment_clearing_account.id

Account ID · object

ID of the account

Account ID
Account Stable Name

Show child attributes

payments.payment_clearing_account.id.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

payments.payment_clearing_account.id.id

string<uuid>

ID of the account

payments.payment_clearing_account.name

string

Name of the account

Example:

"Current Assets"

payments.payment_clearing_account.account_number

string | null

Account number if configured

Example:

"4000"

payments.payment_clearing_account.stable_name

object

Show child attributes

payments.payment_clearing_account.stable_name.type

string

Resource type. Value will be StableName.

Example:

"StableName"

payments.payment_clearing_account.stable_name.stable_name

string

Stable name of the account

Example:

"CURRENT_ASSETS"

payments.payment_clearing_account.normality

enum<string>

Available options:

CREDIT,

DEBIT

payments.payment_clearing_account.account_type

object

Show child attributes

payments.payment_clearing_account.account_type.value

enum<string>

Type of the account

Available options:

ASSET,

LIABILITY,

EQUITY,

REVENUE,

COGS,

EXPENSE

payments.payment_clearing_account.account_type.display_name

string

Display name of the account type

Example:

"Asset"

payments.payment_clearing_account.account_subtype

object

Show child attributes

payments.payment_clearing_account.account_subtype.value

enum<string>

Available options:

BANK_ACCOUNTS,

ACCOUNTS_RECEIVABLE,

INVENTORY,

PAYMENT_PROCESSOR_CLEARING_ACCOUNT,

FIXED_ASSET,

ACCUMULATED_DEPRECIATION,

CASH,

UNDEPOSITED_FUNDS,

CURRENT_ASSET,

NON_CURRENT_ASSET,

PREPAID_EXPENSES,

DEVELOPMENT_COSTS,

LOANS_RECEIVABLE,

INTANGIBLE_ASSET,

ACCOUNTS_PAYABLE,

CREDIT_CARD,

TAXES_PAYABLE,

INCOME_TAXES_PAYABLE,

SALES_TAXES_PAYABLE,

OTHER_TAXES_PAYABLE,

PAYROLL_TAXES_PAYABLE,

UNEARNED_REVENUE,

PAYROLL_LIABILITY,

PAYROLL_CLEARING,

LINE_OF_CREDIT,

TIPS,

REFUND_LIABILITIES,

UNDEPOSITED_OUTFLOWS,

OUTGOING_PAYMENT_CLEARING_ACCOUNT,

OTHER_CURRENT_LIABILITY,

LOANS_PAYABLE,

NOTES_PAYABLE,

SHAREHOLDER_LOAN,

NON_CURRENT_LIABILITY,

CONTRIBUTIONS,

DISTRIBUTIONS,

COMMON_STOCK,

PREFERRED_STOCK,

ADDITIONAL_PAID_IN_CAPITAL,

RETAINED_EARNINGS,

ACCUMULATED_ADJUSTMENTS,

OPENING_BALANCE_EQUITY,

OTHER_EQUITY,

SALES,

UNCATEGORIZED_REVENUE,

RETURNS_ALLOWANCES,

DIVIDEND_INCOME,

INTEREST_INCOME,

OTHER_INCOME,

COGS,

OPERATING_EXPENSES,

PAYROLL,

TAXES_LICENSES,

UNCATEGORIZED_EXPENSE,

CHARITABLE_CONTRIBUTIONS,

LOAN_EXPENSES,

FINANCE_COSTS,

INTEREST_EXPENSES,

DEPRECIATION,

AMORTIZATION,

BAD_DEBT,

OTHER_EXPENSES

payments.payment_clearing_account.account_subtype.display_name

string

Display name of the account subtype

Example:

"Current Assets"

payments.refunded_payment_fees

object[]

Refunded payment fees associated with the refund payment

Show child attributes

payments.refunded_payment_fees.account

Account ID · object

Identifier of the ledger account for the refunded payment fee

Account ID
Account Stable Name

Show child attributes

payments.refunded_payment_fees.account.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

payments.refunded_payment_fees.account.id

string<uuid>

ID of the account

payments.refunded_payment_fees.description

string | null

Description of the fee that the refunded payment fee refunds

payments.refunded_payment_fees.fee_amount

integer<int64>

Amount of the fee refund in cents

payments.transaction_tags

object[]

Show child attributes

payments.transaction_tags.id

string<uuid>

required

ID for the tag

payments.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

payments.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

payments.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

payments.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

payments.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

payments.transaction_tags.value_display_name

string | null

Display name for the tag value definition

payments.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

payments.memo

string | null

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

payments.metadata

object

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

Example:

{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}

payments.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.

payouts

object[]

Payouts associated with this refund.

Show child attributes

payouts.id

string<uuid>

Unique ID for the Payout. Idempotency key.

payouts.external_id

string | null

Unique ID of the payout in your system for linking purposes.

Example:

"payout-1234"

payouts.business_id

string<uuid>

ID of the Business that generated the payout.

payouts.paid_out_amount

integer<int64>

The amount of the payout, in cents

payouts.fee

integer<int64>

The platform fee associated with the payout

payouts.processor

enum<string>

Processor used to make the payment, if any. Any processor name can be provided and will be tracked.

Available options:

STRIPE,

PAYPAL,

SHOPIFY,

ADYEN,

RAINFOREST

Example:

"STRIPE"

payouts.imported_at

string<date-time>

Timestamp of when the payout was imported

payouts.completed_at

string<date-time>

Timestamp of when the payout was completed

payouts.match

object

The transaction match associated with the payout

Show child attributes

payouts.match.id

string<uuid>

Layer's UUID for the match

payouts.match.match_type

enum<string>

Type of the object to match

Available options:

TRANSFER,

INVOICE_PAYMENT,

PAYOUT

payouts.match.bank_transaction

object

Show child attributes

payouts.match.bank_transaction.id

string<uuid>

required

Layer's UUID for the bank transaction

payouts.match.bank_transaction.date

string<date-time>

required

Timestamp when the transaction was created.

payouts.match.bank_transaction.amount

integer<int64>

required

Amount of the transaction, in cents.

payouts.match.bank_transaction.business_id

string<uuid>

UUID of the business the transaction is for

payouts.match.bank_transaction.source

enum<string>

Source of the bank transaction.

Available options:

UNIT,

PLAID,

API,

STRIPE,

CUSTOM

payouts.match.bank_transaction.source_transaction_id

string

External transaction ID from the source platform (e.g, Plaid transaction ID)

Example:

"g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko"

payouts.match.bank_transaction.source_account_id

string

External account ID from the source platform (e.g, Plaid account ID)

Example:

"Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG"

payouts.match.bank_transaction.imported_at

string<date-time>

Timestamp when the transaction was imported.

payouts.match.bank_transaction.direction

enum<string>

Direction of the transaction.

Available options:

CREDIT,

DEBIT

payouts.match.bank_transaction.counterparty_name

string | null

Name of the transaction counterparty

Example:

"WeWork"

payouts.match.bank_transaction.description

string | null

Description of the transaction.

Example:

"WeWork monthly rent payment"

payouts.match.bank_transaction.account_name

string | null

Name of the bank account

Example:

"Plaid Checking"

payouts.match.bank_transaction.categorizationStatus

enum<string>

The status of the transaction’s categorization in Layer’s systems.

Available options:

PENDING,

READY_FOR_INPUT,

CATEGORIZED,

SPLIT,

LAYER_REVIEW,

JOURNALING,

MATCHED

payouts.match.bank_transaction.memo

string | null

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

payouts.match.bank_transaction.metadata

object

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

Example:

{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}

payouts.match.bank_transaction.reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the bank transaction. Can be used to filter when listing bank transactions.

payouts.match.details

object

Show child attributes

payouts.match.details.id

string<uuid>

required

Layer's ID for the match

payouts.match.details.amount

integer<int64>

required

Monetary amount of the matched transaction, in cents

payouts.match.details.date

string<date-time>

required

Date that the matched transaction occurred

payouts.match.details.description

string | null

Description of the match

Example:

"Transfer from SavingsAccount to CheckingAccount"

Example:

{
  "id": "6b0a3734-f4ef-4fb0-9fc1-3f59b0c1cf99",
  "match_type": "PAYOUT",
  "bank_transaction": {
    "type": "Bank_Transaction_Data",
    "id": "a703c8d6-cfe8-453d-a275-b92eacc6fc6e",
    "business_id": "738ec216-e8e5-48f2-b7f2-cdc89c96b3d4",
    "source": "STRIPE",
    "source_transaction_id": "trxn_1sdOeLQiFAKE2LQBkcvrJw95f",
    "source_account_id": "738ec216-e154-48f2-1111-cdc89c96b3d4",
    "imported_at": "2024-03-19T22:09:53.290591Z",
    "date": "2024-03-06T06:06:40Z",
    "direction": "CREDIT",
    "amount": 87459,
    "counterparty_name": null,
    "description": "Payout (po_1OqnTHISISFAKEiTVBkCiyAERwm)",
    "account_name": "Layer Banking",
    "categorization_status": "MATCHED"
  },
  "details": {
    "type": "Payout_Match",
    "id": "d224508b-b05e-41da-89de-0fbd8a573507",
    "amount": 87459,
    "date": "2024-03-06T00:00:00Z",
    "description": "Payout from STRIPE",
    "adjustment": null
  }
}

payouts.transaction_tags

object[]

A list of tags associated with the payout

Show child attributes

payouts.transaction_tags.id

string<uuid>

required

ID for the tag

payouts.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

payouts.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

payouts.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

payouts.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

payouts.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

payouts.transaction_tags.value_display_name

string | null

Display name for the tag value definition

payouts.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

payouts.memo

string | null

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

payouts.metadata

object

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

Example:

{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}

payouts.reference_number

string | null

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

transaction_tags

object[]

Show child attributes

transaction_tags.id

string<uuid>

required

ID for the tag

transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

transaction_tags.value_display_name

string | null

Display name for the tag value definition

transaction_tags.archived_at

string<date-time> | null

When the tag was archived

memo

string | null

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

metadata

object

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

Example:

{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}

reference_number

string | null

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

Delete refund Patch refund

⌘I

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Quickbooks

Update refund

Authorizations

Headers

Path Parameters

Body

Response