Batch Refund Payments

PUT

https://api-sandbox.coinflow.cash/api/merchant/payments/refunds/batch

Partial amounts are not supported here, and payments needing a destination wallet are skipped with skipped: true on their result. Refund those payments individually with PUT /merchant/payments/{paymentId}/refund.

Queues a full refund for each of the given payments. Every payment is refunded independently - one refund job per payment, identical to refunding them one at a time - so a payment that cannot be refunded is reported in `results` while the rest still proceed. Partial amounts are not supported here, and payments needing a destination wallet are skipped with `skipped: true` on their result. Refund those payments individually with `PUT /merchant/payments/{paymentId}/refund`.

Authentication

Authorizationstring

The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Request

This endpoint expects an object.

paymentIdslist of stringsRequired

Ids of the payments to refund in full. Maximum of 100 per request.

refundReasonenumRequired

Response

queueddouble

Number of refunds successfully queued.

faileddouble

Number of payments that failed to queue and may be worth retrying.

skippeddouble

Number of payments skipped because batch refunds cannot process them.

resultslist of objects

$	curl -X PUT https://api-sandbox.coinflow.cash/api/merchant/payments/refunds/batch \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"paymentIds": [
>	"string"
>	],
>	"refundReason": "userCancellation"
>	}'

1	{
2	"queued": 1.1,
3	"failed": 1.1,
4	"skipped": 1.1,
5	"results": [
6	{
7	"paymentId": "string",
8	"success": true,
9	"jobId": "string",
10	"error": "string",
11	"skipped": true
12	}
13	]
14	}