merchant

Batch Refund Payments

Changed on

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

Request

  • Base URL
    https://api-sandbox.coinflow.cash/api
  • URL
    https://api-sandbox.coinflow.cash/api/merchant/payments/refunds/batch
  • Auth
    API key in header Authorization

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

  • 81b590227b14Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security merchant was added to the API

  • 66b771d6d31fRevision changes
    • info

      api operation id batch-refund-payments removed and replaced with merchant_BatchRefundPayments