Apply Transaction to a Refund

curl --request POST \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/refund-payment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "refund_id": "<string>",
  "transaction_id": "<string>",
  "payment_amount": 1
}
'

{
  "data": {
    "business_id": "<string>",
    "external_id": "<string>",
    "amount": 123,
    "method": "cash",
    "refunded_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "amount_paid": 0,
    "memo": "<string>",
    "processor": "<string>",
    "is_return": false,
    "refund_credit": false,
    "status": "pending",
    "payments": [
      {
        "amount": 123,
        "id": "<string>",
        "transaction_id": "<string>"
      }
    ],
    "refund_invoices": [
      {
        "amount": 123,
        "id": "<string>",
        "invoice_id": "<string>",
        "invoice_line_id": "inl_WQMDNUHpBThYSNh4AprDBo",
        "external_id": "<string>",
        "memo": "<string>"
      }
    ]
  }
}

POST

business

{business_id}

refund-payment

Apply Transaction to a Refund

curl --request POST \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/refund-payment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "refund_id": "<string>",
  "transaction_id": "<string>",
  "payment_amount": 1
}
'

{
  "data": {
    "business_id": "<string>",
    "external_id": "<string>",
    "amount": 123,
    "method": "cash",
    "refunded_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "amount_paid": 0,
    "memo": "<string>",
    "processor": "<string>",
    "is_return": false,
    "refund_credit": false,
    "status": "pending",
    "payments": [
      {
        "amount": 123,
        "id": "<string>",
        "transaction_id": "<string>"
      }
    ],
    "refund_invoices": [
      {
        "amount": 123,
        "id": "<string>",
        "invoice_id": "<string>",
        "invoice_line_id": "inl_WQMDNUHpBThYSNh4AprDBo",
        "external_id": "<string>",
        "memo": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-user-id

string | null

Optional external entity identifier that performed the action

Path Parameters

business_id

string<biz_string>

required

Body

application/json

refund_id

string<rfu_string>

required

The ID of the refund to apply payment to

transaction_id

string<txn_string>

required

The ID of the transaction to apply as payment

payment_amount

The amount to apply as payment. Defaults to the transaction amount.

Required range: x >= 0

Response

Successful Response

data

RefundPublic · object

required

Show child attributes

data.business_id

string<biz_string>

required

The ID of the Business that the refund is associated with

data.external_id

string

required

The external ID of the refund

Maximum string length: 255

data.amount

number

required

The amount of the refund

data.method

enum<string>

required

Method of refund

Available options:

cash,

check,

credit_card,

ach,

credit_balance,

other

data.refunded_at

string<date-time>

required

The date and time the refund was created

data.id

string<rfu_string>

required

The ID of the refund

data.amount_paid

number

default:0

The amount of the refund that has been paid

data.memo

string | null

Description of the refund

Maximum string length: 255

data.processor

string | null

The entity that processed the refund

Maximum string length: 255

data.is_return

boolean

default:false

Whether the refund is a return

data.refund_credit

boolean

default:false

Whether the refund is a credit (not a cash refund)

data.status

enum<string>

default:pending

The status of the refund

Available options:

pending,

completed,

voided

data.payments

RefundPaymentPublic · object[] | null

The payments for this refund

Show child attributes

data.payments.amount

number

required

The amount of the refund that has been paid

data.payments.id

string<rfp_string>

required

The ID of the payment

data.payments.transaction_id

string<txn_string>

required

The ID of the transaction that the refund payment is associated with

data.refund_invoices

RefundInvoicePublic · object[] | null

The invoices refunded

Show child attributes

data.refund_invoices.amount

number

required

The amount of the refund

data.refund_invoices.id

string<rfi_string>

required

The ID of the invoice

data.refund_invoices.invoice_id

string<inv_string>

required

The ID of the invoice that the refund invoice is associated with

data.refund_invoices.invoice_line_id

string<inl_string> | null

required

The ID of the invoice line that the refund invoice is associated with

Example:

"inl_WQMDNUHpBThYSNh4AprDBo"

data.refund_invoices.external_id

string | null

The external ID of the refund

Maximum string length: 255

data.refund_invoices.memo

string | null

Description of the refund

Maximum string length: 255

List all Invoice Refunds for a Business Remove Refund Payment

⌘I

API Overview

Authentication

Business

Journal Entry

Ledger

Reports

Transaction

Invoice

Bill

Request

Document

Webhooks

Apply Transaction to a Refund

Authorizations

Headers

Path Parameters

Body

Response