POST
/
v1
/
businesses
/
{businessId}
/
bills
/
refunds
/
{refundId}
/
payments
Create vendor refund payment
curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/bills/refunds/{refundId}/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "external_id": "payment-456",
  "refunded_amount": 123,
  "refund_processing_fee": 123,
  "completed_at": "2023-11-07T05:31:56Z",
  "method": "CASH",
  "processor": "STRIPE",
  "payment_clearing_account_identifier": {
    "type": "AccountId",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "tags": [
    {
      "key": "Location",
      "value": "MainStreet"
    }
  ],
  "memo": "<string>",
  "metadata": {
    "custom_field": "value",
    "any valid json": "below 10kb",
    "nested": {
      "meaning of life": 42,
      "array": []
    }
  },
  "reference_number": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "payment-456",
  "refunded_amount": 123,
  "refund_processing_fee": 123,
  "completed_at": "2023-11-07T05:31:56Z",
  "method": "ACH",
  "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"
    }
  },
  "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<uuid>
required

The UUID of the business to create a vendor refund payment for.

​
refundId
string<uuid>
required

The UUID of the vendor refund to create a payment for.

Body

application/json

Parameters for creating a vendor refund payment.

​
external_id
string | null

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

Example:

"payment-456"

​
refunded_amount
integer

Amount refunded to the business in cents.

​
refund_processing_fee
integer | null

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

​
completed_at
string<date-time>

Time when the payment was completed.

​
method
enum<string>

Payment method used for the refund.

Available options:
CASH,
CHECK,
CREDIT_CARD,
ACH,
CREDIT_BALANCE,
OTHER
​
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"

​
payment_clearing_account_identifier
object

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

​
tags
object[]

Tags to associate with the payment.

​
memo
string | null

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

​
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 vendor refund payment. Can be used to filter when listing vendor refund payments.

Response

Vendor refund payment has been successfully updated or unchanged.

A payment represents a transaction that moves value from a vendor to a business. A specific bill can be refunded or a general refund can be applied to a vendor.

​
id
string<uuid>

Unique identifier for the payment.

​
external_id
string | null

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

Example:

"payment-456"

​
refunded_amount
integer

Amount refunded to the business in cents.

​
refund_processing_fee
integer | null

Fee charged for the refund processing in cents.

​
completed_at
string<date-time>

Time when the payment was completed.

​
method
string

Method of the payment.

Example:

"ACH"

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

​
transaction_tags
object[]
​
memo
string | null

Memo for any text you would like to associate with the vendor 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 vendor refund payment. Can be used to filter when listing vendor refund payments.