Refund split transaction

Refunds a settled transaction with split instructions.

Authentication

requestTokenstring

API Key authentication via header

Path parameters

transIdstringRequired

ReferenceId for the transaction (PaymentId).

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 can’t 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.

Amount to refund from original transaction, minus any service fees charged on the original transaction. The amount provided can't 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.

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

responseTextstring

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

isSuccessboolean

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

responseDataobject

pageidentifierstring or null

Auxiliary validation used internally by payment pages and components.

1	curl -X POST https://api-sandbox.payabli.com/api/MoneyIn/refund/10-3ffa27df-b171-44e0-b251-e95fbfc7a723 \
2	-H "idempotencyKey: 8A29FC40-CA47-1067-B31D-00DD010662DB" \
3	-H "requestToken: <apiKey>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"amount": 100,
7	"orderDescription": "Materials deposit",
8	"refundDetails": {
9	"splitRefunding": [
10	{
11	"accountId": "187-342",
12	"amount": 60,
13	"description": "Refunding undelivered materials",
14	"originationEntryPoint": "7f1a381696"
15	},
16	{
17	"accountId": "187-343",
18	"amount": 40,
19	"description": "Refunding deposit for undelivered materials",
20	"originationEntryPoint": "7f1a381696"
21	}
22	]
23	},
24	"source": "api"
25	}'

1	{
2	"responseText": "Success",
3	"isSuccess": true,
4	"responseData": {
5	"authCode": "",
6	"customerId": null,
7	"cvvResponseText": null,
8	"methodReferenceId": null,
9	"referenceId": "288-a1192b75-99e9-4d43-8af1-7ae9ab7da4f4",
10	"resultCode": 1,
11	"resultText": "CAPTURED",
12	"avsResponseText": null
13	},
14	"pageidentifier": null
15	}

Refund split transaction

Authentication

Path parameters

Headers

Request

Response

Errors