API referencePay In endpointsCancel transactions

Refund split transaction

Refunds a settled transaction with split instructions.

Path parameters

transIdstringRequired

ReferenceId for the transaction (PaymentId).

Headers

requestTokenstringRequired
idempotencyKeystringOptional

Optional but recommended A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.

Request

This endpoint expects an object.
amountdoubleOptional

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 90plusa90 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.

ipaddressstringOptional

Recommended. The customer’s IP address. This field is used to help prevent fraudulent transactions, and Payabli strongly recommends including this data.

orderDescriptionstringOptional<=250 characters
Text description of the transaction.
orderIdstringOptional<=250 characters
Custom identifier for the transaction.
refundDetailsobjectOptional
Object containing details about the refund, including line items and optional split instructions.
sourcestringOptional<=100 characters
Custom identifier to indicate the transaction or request source.

Response

Success
isSuccessboolean or null

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

pageIdentifierstring or null
Auxiliary validation used internally by payment pages and components.
responseCodeinteger or null

Code for the response. Learn more in API Response Codes.

responseDataobject or null
responseTextstring or null

Response text for operation: ‘Success’ or ‘Declined’.

Errors