Payment Refund

Primer notifies you with a PAYMENT.REFUND Webhook when a refund request has been fully processed by a payment processor and the refund has reached a final state.

Check the transaction with the most recent transactionType: "REFUND" in the transactions array:

• if processorStatus is SETTLED, the refund was successful and the funds have been returned to the customer
• if processorStatus is FAILED, the refund was unsuccessful

Learn more about how Primer handles webhooks.

Payload

{
  "version": "2.2"
}

Example payment refund notification

{
  "eventType":"PAYMENT.REFUND",
  "date":"2021-02-21T15:37:16.367687",
  "notificationConfig":{
    "id":"cc51f9f0-7e1c-492b-9d37-f83a818f6070",
    "description":"Refund webhook"
  },
  "version":"2.2",
  "signedAt": "1689221398",
  "payment":{
    "id":"DdRZ6YY0",
    "date":"2021-02-21T15:34:16.367687",
    "amount":3000,
    "currencyCode":"GBP",
    "customerId":"cust-123",
    "orderId":"order-123",
    "status":"SETTLED",
    "customer": {
      "emailAddress": "[e-mail]",
      "mobileNumber": "0123456789",
      "billingAddress": {
        "firstName": "John",
        "postalCode": "CB94BQ",
        "addressLine1": "10001 Alpha St",
        "countryCode": "GB",
        "city": "Cambridge",
        "state": "Cambridgeshire"
      }
    },
    "paymentMethod":{
      "paymentType":"FIRST_PAYMENT",
      "paymentMethodToken":"-lcWjvBAAs2DnIRXwxNjUzNTYzNjIy",
      "isVaulted": "false",
      "analyticsId":"LUi5pETUaVsdSEamK25L",
      "paymentMethodType":"PAYMENT_CARD",
      "paymentMethodData":{
        "last4Digits":"1111",
        "first6Digits": "411111",
        "expirationMonth":"03",
        "expirationYear":"2030",
        "cardholderName":"ADYEN",
        "network":"Visa",
        "isNetworkTokenized":false,
        "binData":{
          "network":"VISA",
          "issuerCountryCode":"US",
          "issuerName":"JPMORGAN CHASE BANK, N.A.",
          "regionalRestriction":"UNKNOWN",
          "accountNumberType":"UNKNOWN",
          "accountFundingType":"UNKNOWN",
          "prepaidReloadableIndicator":"NOT_APPLICABLE",
          "productUsageType":"UNKNOWN",
          "productCode":"UNKNOWN",
          "productName":"UNKNOWN"
        }
      },
      "threeDSecureAuthentication":{
        "responseCode":"NOT_PERFORMED"
      }
    },
    "processor":{
      "name":"STRIPE",
      "processorMerchantId":"acct_1GORasdasqNWFwi8c",
      "amountCaptured":3000,
      "amountRefunded":3000
    },
    "transactions":[
      {
        "date":"2021-02-21T15:34:16.367687",
        "amount":3000,
        "currencyCode":"GBP",
        "transactionType":"SALE",
        "orderId":"order-123",
        "processorTransactionId":"pi_3L3edsGZasdasdc1iget38p",
        "processorName":"STRIPE",
        "processorMerchantId":"acct_1GORasvasdNWFwi8c",
        "processorStatus":"SETTLED"
      },
      {
        "date":"2021-02-21T15:37:16.267687",
        "amount":3000,
        "currencyCode":"GBP",
        "transactionType":"REFUND",
        "orderId":"order-123",
        "processorTransactionId":"re_3L3edsGZasdasdc1iget38p",
        "processorName":"STRIPE",
        "processorMerchantId":"acct_1GORasvasdNWFwi8c",
        "processorStatus":"SETTLED"
      }
    ],
    "riskData":{
      "fraudChecks":{
        "source":"riskified",
        "preAuthorizationResult":"THREE_DS",
        "postAuthorizationResult":"ACCEPT"
      },
      "cvvCheck": {
        "source": "processor",
        "result": "MATCHED"
      },
      "avsCheck": {
        "source": "processor",
        "result": {
          "streetAddress": "NOT_MATCHED",
          "postalCode": "NOT_VERIFIED"
        }
      }
    }
  }
}

Payload

{
  "version": "2.2"
}

Example payment refund notification

{
  "eventType":"PAYMENT.REFUND",
  "date":"2021-02-21T15:37:16.367687",
  "notificationConfig":{
    "id":"cc51f9f0-7e1c-492b-9d37-f83a818f6070",
    "description":"Refund webhook"
  },
  "version":"2.2",
  "signedAt": "1689221398",
  "payment":{
    "id":"DdRZ6YY0",
    "date":"2021-02-21T15:34:16.367687",
    "amount":3000,
    "currencyCode":"GBP",
    "customerId":"cust-123",
    "orderId":"order-123",
    "status":"SETTLED",
    "customer": {
      "emailAddress": "[e-mail]",
      "mobileNumber": "0123456789",
      "billingAddress": {
        "firstName": "John",
        "postalCode": "CB94BQ",
        "addressLine1": "10001 Alpha St",
        "countryCode": "GB",
        "city": "Cambridge",
        "state": "Cambridgeshire"
      }
    },
    "paymentMethod":{
      "paymentType":"FIRST_PAYMENT",
      "paymentMethodToken":"-lcWjvBAAs2DnIRXwxNjUzNTYzNjIy",
      "isVaulted": "false",
      "analyticsId":"LUi5pETUaVsdSEamK25L",
      "paymentMethodType":"PAYMENT_CARD",
      "paymentMethodData":{
        "last4Digits":"1111",
        "first6Digits": "411111",
        "expirationMonth":"03",
        "expirationYear":"2030",
        "cardholderName":"ADYEN",
        "network":"Visa",
        "isNetworkTokenized":false,
        "binData":{
          "network":"VISA",
          "issuerCountryCode":"US",
          "issuerName":"JPMORGAN CHASE BANK, N.A.",
          "regionalRestriction":"UNKNOWN",
          "accountNumberType":"UNKNOWN",
          "accountFundingType":"UNKNOWN",
          "prepaidReloadableIndicator":"NOT_APPLICABLE",
          "productUsageType":"UNKNOWN",
          "productCode":"UNKNOWN",
          "productName":"UNKNOWN"
        }
      },
      "threeDSecureAuthentication":{
        "responseCode":"NOT_PERFORMED"
      }
    },
    "processor":{
      "name":"STRIPE",
      "processorMerchantId":"acct_1GORasdasqNWFwi8c",
      "amountCaptured":3000,
      "amountRefunded":3000
    },
    "transactions":[
      {
        "date":"2021-02-21T15:34:16.367687",
        "amount":3000,
        "currencyCode":"GBP",
        "transactionType":"SALE",
        "orderId":"order-123",
        "processorTransactionId":"pi_3L3edsGZasdasdc1iget38p",
        "processorName":"STRIPE",
        "processorMerchantId":"acct_1GORasvasdNWFwi8c",
        "processorStatus":"SETTLED"
      },
      {
        "date":"2021-02-21T15:37:16.267687",
        "amount":3000,
        "currencyCode":"GBP",
        "transactionType":"REFUND",
        "orderId":"order-123",
        "processorTransactionId":"re_3L3edsGZasdasdc1iget38p",
        "processorName":"STRIPE",
        "processorMerchantId":"acct_1GORasvasdNWFwi8c",
        "processorStatus":"SETTLED"
      }
    ],
    "riskData":{
      "fraudChecks":{
        "source":"riskified",
        "preAuthorizationResult":"THREE_DS",
        "postAuthorizationResult":"ACCEPT"
      },
      "cvvCheck": {
        "source": "processor",
        "result": "MATCHED"
      },
      "avsCheck": {
        "source": "processor",
        "result": {
          "streetAddress": "NOT_MATCHED",
          "postalCode": "NOT_VERIFIED"
        }
      }
    }
  }
}

Learn more about how Primer handles webhooks.

Headers

X-Signature-Primary · string · required

An HMAC signature generated using the webhook payload and a shared signing secret. This is then converted to a base64 encoded string.

X-Signature-Secondary · string · required

A secondary signature that is added when you have rotated your secret within the past 24 hours.

Body

application/json

eventType · string

The type of the webhook raised. PAYMENT.REFUND in this case.

date · string<date-time>

The date-time that the webhook was sent.

notificationConfig · Notification Config · object

The notification configuration details.

Show child attributes

version · string

The payload version

Example:

"2.2"

payment · Payment Details · object

Show child attributes

Response

200

Return a 200 status to indicate that the data was received successfully