Version - 2.4

{
  "eventType":"PAYMENT.STATUS",
  "date":"2021-02-21T15:36:16.367687",
  "notificationConfig":{
    "id":"cc51f9f0-7e1c-492b-9d37-f83a818f6070",
    "description":"Payment webhook"
  },
  "version":"2.4",
  "signedAt": "1689221338",
  "payment":{
    "id":"DdRZ6YY0",
    "date":"2021-02-21T15:34:16.367687",
    "dateUpdated":"2021-02-21T15:35:16.133701",
    "amount":3000,
    "currencyCode":"GBP",
    "customerId":"cust-123",
    "orderId":"order-123",
    "status":"SETTLED",
    "cardTokenType":"CARD_PAN",
    "customer": {
      "emailAddress": "test@primer.io",
      "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"
        }
      },
      "authorizationType": "FINAL",
      "threeDSecureAuthentication":{
        "responseCode":"NOT_PERFORMED"
      }
    },
    "processor":{
      "name":"STRIPE",
      "processorMerchantId":"acct_1GORasdasqNWFwi8c",
      "amountCaptured":3000,
      "amountRefunded":0
    },
    "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",
        "cardTokenType":"CARD_PAN"
      }
    ],
    "riskData":{
      "fraudChecks":{
        "source":"riskified",
        "preAuthorizationResult":"THREE_DS_EXEMPTION",
        "preAuthorizationRecommendation":"TRANSACTION_RISK_ANALYSIS",
        "postAuthorizationResult":"ACCEPT"
      },
      "cvvCheck": {
        "source": "processor",
        "result": "MATCHED"
      },
      "avsCheck": {
        "source": "processor",
        "result": {
          "streetAddress": "NOT_MATCHED",
          "postalCode": "NOT_VERIFIED"
        }
      }
    }
  }
}

Payment Status Update

Primer notifies you with a PAYMENT.STATUS webhook when a payment’s status has been updated. This is especially useful for asyncronous processor Connections, which do not respond with an upfront authorization.

The webhook events will arrive in the order that the payment status changes, for example you should expect a status of PENDING, then AUTHORIZED, then SETTLED (depending on how your workflow is set up).

The webhook body contains the full payment object.

Version - 2.4

{
  "eventType":"PAYMENT.STATUS",
  "date":"2021-02-21T15:36:16.367687",
  "notificationConfig":{
    "id":"cc51f9f0-7e1c-492b-9d37-f83a818f6070",
    "description":"Payment webhook"
  },
  "version":"2.4",
  "signedAt": "1689221338",
  "payment":{
    "id":"DdRZ6YY0",
    "date":"2021-02-21T15:34:16.367687",
    "dateUpdated":"2021-02-21T15:35:16.133701",
    "amount":3000,
    "currencyCode":"GBP",
    "customerId":"cust-123",
    "orderId":"order-123",
    "status":"SETTLED",
    "cardTokenType":"CARD_PAN",
    "customer": {
      "emailAddress": "test@primer.io",
      "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"
        }
      },
      "authorizationType": "FINAL",
      "threeDSecureAuthentication":{
        "responseCode":"NOT_PERFORMED"
      }
    },
    "processor":{
      "name":"STRIPE",
      "processorMerchantId":"acct_1GORasdasqNWFwi8c",
      "amountCaptured":3000,
      "amountRefunded":0
    },
    "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",
        "cardTokenType":"CARD_PAN"
      }
    ],
    "riskData":{
      "fraudChecks":{
        "source":"riskified",
        "preAuthorizationResult":"THREE_DS_EXEMPTION",
        "preAuthorizationRecommendation":"TRANSACTION_RISK_ANALYSIS",
        "postAuthorizationResult":"ACCEPT"
      },
      "cvvCheck": {
        "source": "processor",
        "result": "MATCHED"
      },
      "avsCheck": {
        "source": "processor",
        "result": {
          "streetAddress": "NOT_MATCHED",
          "postalCode": "NOT_VERIFIED"
        }
      }
    }
  }
}

Version - 2.4

{
  "eventType":"PAYMENT.STATUS",
  "date":"2021-02-21T15:36:16.367687",
  "notificationConfig":{
    "id":"cc51f9f0-7e1c-492b-9d37-f83a818f6070",
    "description":"Payment webhook"
  },
  "version":"2.4",
  "signedAt": "1689221338",
  "payment":{
    "id":"DdRZ6YY0",
    "date":"2021-02-21T15:34:16.367687",
    "dateUpdated":"2021-02-21T15:35:16.133701",
    "amount":3000,
    "currencyCode":"GBP",
    "customerId":"cust-123",
    "orderId":"order-123",
    "status":"SETTLED",
    "cardTokenType":"CARD_PAN",
    "customer": {
      "emailAddress": "test@primer.io",
      "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"
        }
      },
      "authorizationType": "FINAL",
      "threeDSecureAuthentication":{
        "responseCode":"NOT_PERFORMED"
      }
    },
    "processor":{
      "name":"STRIPE",
      "processorMerchantId":"acct_1GORasdasqNWFwi8c",
      "amountCaptured":3000,
      "amountRefunded":0
    },
    "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",
        "cardTokenType":"CARD_PAN"
      }
    ],
    "riskData":{
      "fraudChecks":{
        "source":"riskified",
        "preAuthorizationResult":"THREE_DS_EXEMPTION",
        "preAuthorizationRecommendation":"TRANSACTION_RISK_ANALYSIS",
        "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

required

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

date

string<date-time>

required

The date-time that the webhook was sent.

signedAt

string

required

The Unix timestamp at which the webhook payload was signed.

Example:

"1689221338"

notificationConfig

Notification Config · object

required

The notification configuration details.

Show child attributes

payment

Payment Details · object

required

Show child attributes

version

string

The payload version

Example:

"2.4"

Response

200

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

Payment Refund

⌘I

Documentation Index

Headers

Body

Response