Skip to main content
POST
Create vendor refund payment

Rate Limiting

This endpoint has a custom rate limit policy. Rate Limit Details: Response Headers: All responses include the following rate limit headers:
  • X-RateLimit-Limit: The rate limit bucket capacity
  • X-RateLimit-Remaining: The number of tokens remaining in the bucket
  • X-RateLimit-Reset: UTC timestamp (in seconds) when the bucket will be refilled
For more details on rate limiting, see Rate Limiting.

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<int64>

Amount refunded to the business in cents.

refund_processing_fee
integer<int64> | 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
Account ID · object

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

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 | null

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

Example:
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.

data
object
required

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.