1b61c9b309
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
12 lines
1.4 KiB
Plaintext
12 lines
1.4 KiB
Plaintext
---
|
|
displayed_sidebar: paymentReference
|
|
---
|
|
|
|
import { TypeList } from "docs-ui"
|
|
|
|
# CreateRefundDTO
|
|
|
|
The refund to be created.
|
|
|
|
<TypeList types={[{"name":"payment_id","type":"`string`","description":"The associated payment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../types/payment.BigNumberInput/page.mdx)","description":"The amount of the refund.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_by","type":"`string`","description":"Who refunded the payment. For example,\na user's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CreateRefundDTO"/>
|