Skip to main content
POST
Apply Transaction to a Refund

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

The id of the business

Example:

"biz_GA6EG2qFxA97NZHtxeLPUy"

Body

application/json
refund_id
string<rfu_string>
required

The ID of the refund to apply payment to

Example:

"rfu_Lq5AyApd4pdL1VvakpY5aJ"

transaction_id
string<txn_string>
required

The ID of the transaction to apply as payment

Example:

"txn_oiL7THC5RDi2PVUbVyyoJ"

payment_amount

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

Required range: x >= 0

Response

Successful Response

data
RefundPublic · object
required