Skip to main content
POST
Pay out a customer credit memo by check

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

Idempotency-Key
string

Optional idempotency key (UUID). Re-POST with same key returns cached 200 without re-processing.

Path Parameters

id
string<uuid>
required

Body

application/json
amount
number

The amount to pay out. Omitted, the memo's whole remaining balance.

reason
string

Why the credit is paid out; recorded on the payout.

Maximum string length: 500
acknowledge_open_invoices
boolean

true pays out although the customer has open invoices; otherwise such a payout is refused with the invoices named.

Response

The credit memo was paid out by check.

success
enum<boolean>
Available options:
true
payout_id
string<uuid>
credit_memo_id
string<uuid>
credit_memo_number
string | null
account_id
string<uuid>
amount
number
balance_remaining
number

The memo's balance after the payout.

status
enum<string>
Available options:
partially_used,
fully_applied
bank_check_id
string<uuid>

The refund check; its number is read from the check, and it changes when the check is first printed.

check_number
string
journal_entry_id
string<uuid> | null
entry_number
string | null
source_payment_id
string<uuid> | null

The receipt the credit came from, for a credit made from unapplied cash or an overpayment.