Refund Settled Transaction with Split Instructions
Refunds a settled transaction with split instructions.
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Headers
A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.
"6B29FC40-CA47-1067-B31D-00DD010662DA"
Path Parameters
ReferenceId for the transaction (PaymentId).
"45-as456777hhhhhhhhhh77777777-324"
Body
Custom identifier to indicate the transaction or request source.
100
"api"
Custom identifier for the transaction.
250
"O-5140"
Recommended. The customer's IP address. This field is used to help prevent fraudulent transactions, and Payabli strongly recommends including this data.
"255.255.255.255"
Text description of the transaction.
250
"Depost for materials for 123 Walnut St"
Amount to refund from original transaction, minus any service fees charged on the original transaction.
The amount provided cannot be greater than the original total amount of the transaction, minus service fees. For example, if a transaction was $90 plus a $10 service fee, you can refund up to $90.
An amount equal to zero will refund the total amount authorized minus any service fee.
72.53
Object containing details about the refund, including line items and optional split instructions.
Response
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.
true
Response text for operation: 'Success' or 'Declined'.
"Success"
Code for the response. Learn more in API Response Codes.
1
Auxiliary validation used internally by payment pages and components.
null
Was this page helpful?