Sign in
merchant

Batch Refund Payments

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.

put/merchant/payments/refunds/batch

Headers

Authorizationstring required

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

Request body

paymentIdsstring[] required

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

refundReason'userCancellation' | 'failedFulfillment' | 'buyerFraud' | 'other' required

Response

Ok

queuednumber double required

Number of refunds successfully queued.

failednumber double required

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

skippednumber double required

Number of payments skipped because batch refunds cannot process them.

Changes