View Refund Information for Payment

GET

https://api-sandbox.coinflow.cash/api/refunds/payment/:paymentId

GET

/api/refunds/payment/:paymentId

curl https://api-sandbox.coinflow.cash/api/refunds/payment/paymentId \
     -H "Authorization: <apiKey>"

200Retrieved

{
  "refundedBy": {
    "editor": "string",
    "editorType": "Coinflow",
    "ipAddress": "string"
  },
  "reason": "userCancellation",
  "updatedAt": "2024-01-15T09:30:00Z",
  "createdAt": "2024-01-15T09:30:00Z",
  "invoiceId": "string",
  "provider": "string",
  "method": "Card",
  "source": "Credits",
  "outstanding": {
    "cents": 1,
    "currency": "USD"
  },
  "reimbursementStatus": "Pending",
  "status": "Pending",
  "payment": "string",
  "merchant": "string",
  "customer": "string",
  "totals": {
    "subtotal": {
      "cents": 1,
      "currency": "USD"
    },
    "processorFees": {
      "cents": 1,
      "currency": "USD"
    },
    "total": {
      "cents": 1,
      "currency": "USD"
    },
    "rate": 1.1,
    "resolution": {
      "cents": 1,
      "currency": "USD"
    },
    "adjustment": {
      "cents": 1,
      "currency": "USD"
    }
  },
  "_id": "string",
  "returnSignature": "string",
  "walletDebitTxHash": "string",
  "walletDebitStatus": "pending",
  "cryptoRefundInfo": {
    "refundAddress": "string",
    "denominationType": "usd",
    "refundTransactionHash": "string",
    "refundTransactionUrl": "string",
    "amountUSD": "string",
    "tokenAmount": "string",
    "paymentCurrency": "string"
  },
  "failureReason": "string",
  "invoicedAt": "2024-01-15T09:30:00Z",
  "reimbursementId": "string",
  "signature": "string"
}

Authentication

Authorizationstring

API Key authentication via header

Authorizationstring

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

Path parameters

paymentIdstringRequired

Response

refundedByobject

reasonenum

Allowed values:

updatedAtdatetime

createdAtdatetime

invoiceIdstring

providerstring

methodenum

sourceenum

Allowed values:

outstandingobject

reimbursementStatusenum

Allowed values:

statusenum

Allowed values:

paymentstring or object

merchantstring or object

customerstring or object

totalsobject

_idstring

returnSignaturestringOptional

walletDebitTxHashstringOptional

walletDebitStatusenumOptional

Allowed values:

cryptoRefundInfoobjectOptional

failureReasonstringOptional

invoicedAtdatetimeOptional

reimbursementIdstringOptional

signaturestringOptional