PRprimer
Payment Webhooks

Payment Refund

Changed on

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.

post/payment-refund

Request

  • Base URL
    https://api.sandbox.primer.io
  • URL
    https://api.sandbox.primer.io/payment-refund
  • Auth
    none declared. Required headers: X-Signature-Primary, X-Signature-Secondary

Headers

X-Signature-Primarystring 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-Secondarystring required

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

Request body

eventTypestring required

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

datestring date-time required

The date-time that the webhook was sent.

signedAtstring required

The Unix timestamp at which the webhook payload was signed.

versionstring

The payload version

Example request

{
  "signedAt": "1689221338",
  "version": "2.4",
  "payment": {
    "transactions": [
      {
        "reason": "Item returned."
      }
    ],
    "riskData": {
      "fraudChecks": {
        "source": "FRAUD_PROVIDER"
      },
      "cvvCheck": {
        "source": "PROCESSOR"
      },
      "avsCheck": {
        "source": "PROCESSOR"
      }
    }
  }
}

Response

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

Changes

  • 759dd96284bdRevision changes
    • info

      added the new XCG enum value to the request property ///////

    • info

      added the new XCG enum value to the request property ////

    • info

      added the new ZWG enum value to the request property ///////

    • info

      added the new ZWG enum value to the request property ////

  • 1435b9ef9e82Revision changes
    • info

      added the new optional request property //////