How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Primer Payment Webhooks API

The Payment Webhooks API from Primer — 2 operation(s) for payment webhooks.

Primer Payment Webhooks API is one of 5 APIs that Primer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payment Webhooks. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 51 schemas. It is described by OpenAPI 3.2.0, at version 2.4.

Requests are made against 2 base URLs: https://api.sandbox.primer.io, https://api.primer.io.

2 operations 2 paths 51 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.4
Base URL
https://api.primer.io
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Primer Payment Webhooks API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Payment Webhooks 2
POST
/payment-status
Payment Status Update
payment_status_webhook_event 2 params body → 200
POST
/payment-refund
Payment Refund
payment_refund_webhook_event 2 params body → 200

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are KlarnaAddressAPISchema (12 properties), TransactionOverviewAPISchema (11 properties), BinDataAPISchema (11 properties), StatusReasonAPISchema (9 properties). Each schema is shown below with its type and property counts.

KlarnaTokenDetails
object
4 properties 1 required
PaymentResponsePaymentMethodOptionsAPISchema
object
8 properties
ThreeDSecureAuthenticationAPISchema
object
5 properties 1 required
CVVCheckAPISchema
object
Results of any external CVV check performed on this payment.
2 properties
RecurringTransactionTypeEnum
string
An enumeration.
AdvisedActionEnum
string
The Primer-recommended action to take based on the underlying decline reason and advice code. This advised action is unified across all supported processors an…
BinDataAPISchema
object
11 properties 8 required
PaymentStatusWebhookPayload
object
5 properties
PrepaidReloadableEnum
string
An enumeration.
ThreeDSecureSkippedReasonCodeEnum
string
An enumeration.
PayPalBillingAgreementAPISchema
object
4 properties 1 required
ApayaCustomerTokenAPISchema
object
3 properties 1 required
KlarnaAddressAPISchema
object
12 properties
RiskDataAPISchema
object
Risk data associated with this payment.
3 properties
PreAuthorizationRecommendationEnum
string
Pre-authorization recommendation indicating the SCA exemption or risk assessment path taken. Only present when preAuthorizationResult is THREEDSEXEMPTION. Valu…
TransactionTypeEnum
string
An enumeration.
FraudCheckAPISchema
object
Results of the pre-authorization and post-authorization fraud checks.
4 properties
AVSRiskAssessmentValues
object
2 properties
ThreeDSecureFailedReasonCodeEnum
string
This enum is derived from the transStatusReason on page 218 of the [EMV Co 3DS protocol specification](https://www.emvco.com/terms-of-use/?u=/wp-content/upload…
CardAccountNumberTypeEnum
string
An enumeration.
PostAuthFraudDecisionTypeEnum
string
Possible post-authorization fraud check outcomes.
PaymentStatus
string
An enumeration.
PaymentRefundWebhookPayload
object
5 properties
CardProductTypeEnum
string
An enumeration.
PaymentStatusTypeEnum
string
An enumeration.
PaymentResponseProcessorAPISchema
object
4 properties
AccountFundingTypeEnum
string
An enumeration.
ThreeDSecureAuthResponseCodeEnum
string
An enumeration.
PayPalOrderTokenAPISchema
object
3 properties 1 required
RiskAssessmentStatusEnum
string
Possible risk assessment values for CVV and AVS checks.
TransactionDeclineReasonV2Enum
string
An enumeration.
PaymentMethodTypeEnum
string
[The list of available payment methods and their PAYMENTMETHODTYPE can be found here.](https://primer.io/docs/connections/payment-methods/available-payment-met…
OptionalAddressAPISchema
object
8 properties
GoCardlessMandateAPISchema
object
1 property 1 required
PayPalExternalPayerInfoAPISchema
object
4 properties
CardRegionRestrictionEnum
string
An enumeration.
StatusReasonAPISchema
object
9 properties 1 required
KlarnaSessionDetailsAPISchema
object
8 properties 5 required
CardNetworkEnum
string
The list of available card networks.
DeclineTypeEnum
string
An enumeration.
KlarnaPaymentSessionAPISchema
object
2 properties 2 required
PaymentCardTokenAPISchema
object
8 properties 3 required
AddressAPISchema
object
8 properties 3 required
AVSCheckAPISchema
object
Results of any external AVS check performed on this payment.
2 properties
PreAuthFraudDecisionTypeEnum
string
Possible pre-authorization fraud check outcomes.
CountryCodeEnum
An enumeration.
TransactionOverviewAPISchema
object
11 properties 8 required
KlarnaCustomerTokenAPISchema
object
2 properties 2 required
RecurringPaymentTypeSchema
Payment types, primarily to be used for recurring payments. See the table below for all possible values. Note: if no field is set, we will return a blank value…
Currency
Enumerates all supported currencies
IdealPayNLTokenAPISchema
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

primer-payment-webhooks-api-openapi.yml Raw ↑

Other APIs Primer publishes across the network.

Primer Client Session API API
Primer Dispute & Chargebacks Webhooks API
Primer Payment Methods API API
Primer Payments API API
Where this information came from

This is an independent, third-party profile of Primer Payment Webhooks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.