Sign in

v1

latestOpenAPI 3.0.02026-07-1498163181.9 KB
Payment Intents

Mark payment as refunded

Mark payment as refunded

post/api/v1/payment-intents/{paymentIntentId}/mark-as-refund

Path parameters

paymentIntentIdstring required

Request body

markRefundedCommentstring

Response

idstring required
createdAtstring date-time
updatedAtstring date-time
organizationIdstring uuid required
amountinteger
amountReceivedinteger
currency'usdc' | 'usdt' | 'pyusd' | 'eurc' | 'brett' | 'dai' | 'btc' | 'eth' | 'matic' | 'bnb' | 'sol' | 'busd' | 'trx' | 'food' | 'bonk' | 'wif' | 'goat' | 'spx' | 'truf' | 'pengu' | 'usd' | 'inr'
status'requires_payment_method' | 'requires_confirmation' | 'requires_action' | 'processing' | 'requires_capture' | 'canceled' | 'succeeded' required
paymentMethodIdstring uuid required
descriptionstring
paymentMethodTypesPaymentMethodType[]
transferAccountAddressstring
canceledAtstring date-time
cancellationReasonstring
isMarkRefundedboolean nullable
markRefundedAtstring date-time nullable
markRefundedCommentstring nullable

Example response

{
  "organizationId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
  "paymentMethodId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
  "paymentMethod": {
    "assetId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
    "asset": {
      "chainId": 1,
      "decimals": 1,
      "superToken": {
        "decimals": 1
      }
    },
    "customerId": "c3611c05-df51-4b47-b601-f2eac02f4ef0"
  },
  "transactions": [
    {
      "nonce": 1,
      "gasLimit": 1,
      "asset": {
        "chainId": 1,
        "decimals": 1,
        "superToken": {
          "decimals": 1
        },
        "chain": {
          "id": 1
        }
      }
    }
  ],
  "paymentReceipt": {
    "organizationId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
    "paymentIntentId": "c3611c05-df51-4b47-b601-f2eac02f4ef0"
  }
}