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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Primer

Primer Payments API API

The Payments API API from Primer — 8 operation(s) for payments api.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 9 operations across 8 paths, and defines 82 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.

9 operations 8 paths 82 schemas 2 GET7 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 Payments API 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 9

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

Payments API 9
GET
/payments
Search & list payments
list_payments_payments_get 18 params → 200422
POST
/payments
Create a payment
create_payment_payments_post 2 params body → 200400422
POST
/payments/{id}/authorize
Authorize a payment
authorize_payment_payments__id__authorize_post 3 params body → 200400404409422
POST
/payments/{id}/capture
Capture a payment
capture_payment_payments__id__capture_post 3 params body → 200400409422
POST
/payments/{id}/cancel
Cancel a payment
cancel_payment_payments__id__cancel_post 3 params body → 200400409
POST
/payments/{id}/refund
Refund a payment
refund_payment_payments__id__refund_post 3 params body → 200400409422
POST
/payments/{id}/resume
Resume a payment
resume_payment_payments__id__resume_post 2 params body → 200202400
POST
/payments/{id}/adjust-authorization
Adjust authorized amount
adjust_authorization_payments__id__adjust_authorization_post 3 params body → 200400404409422
GET
/payments/{id}
Get a payment
get_payment_by_id_payments__id__get 3 params → 200400

Schemas 82

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

ProductTypeEnum
string
An enumeration
PrepaidReloadableEnum
string
An enumeration.
PaymentSummaryAPISchema
object
9 properties 7 required
KlarnaAddressAPISchema
object
12 properties
RiskDataAPISchema
object
Risk data associated with this payment.
3 properties
CardAccountNumberTypeEnum
string
An enumeration.
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…
PostAuthFraudDecisionTypeEnum
string
Possible post-authorization fraud check outcomes.
PaymentStatus
string
An enumeration.
CardProductTypeEnum
string
An enumeration.
PaymentStatusTypeEnum
string
The status reason type for the payment, providing more information on the error. APPLICATIONERROR indicates something went wrong internally within primer's sys…
PaymentRequiredActionAPISchema
object
3 properties 2 required
PaymentResumeAPIRequest
object
1 property 1 required
OptionalAddressAPISchema
object
8 properties
PaymentCancelAPIRequest
object
2 properties
CardRegionRestrictionEnum
string
An enumeration.
StatusReasonAPISchema
object
9 properties 1 required
DeclineTypeEnum
string
An enumeration.
TransactionEventApiResponse
object
6 properties 3 required
PaymentCardTokenAPISchema
object
8 properties 3 required
TransactionOverviewAPISchema
object
13 properties 8 required
KlarnaCustomerTokenAPISchema
object
2 properties 2 required
PaymentSummaryProcessorAPISchema
object
2 properties 1 required
Currency
3-letter currency code in ISO 4217 format, e.g. USD for US dollars.
ThreeDSecureSkippedReasonCodeEnum
string
An enumeration.
AuthorizationTypeEnum
string
Type of authorization for the payment.
CustomerDetailsAPISchema
object
8 properties
400ErrorResponse
object
1 property 1 required
FraudCheckAPISchema
object
Results of the pre-authorization and post-authorization fraud checks.
4 properties
422ErrorResponse
object
1 property 1 required
409ErrorResponse
object
1 property 1 required
PayPalOrderTokenAPISchema
object
3 properties 1 required
PaymentListAPIResponse
object
3 properties
TransactionDeclineReasonV2Enum
string
An enumeration.
OrderDetailsAPISchema
object
5 properties
PaymentCreationAPIRequest
object
10 properties 1 required
OrderFeesAPISchema
object
3 properties 1 required
PaymentRequestPaymentMethodOptionsAPISchema
object
7 properties
KlarnaTokenDetails
object
4 properties 1 required
OrderLineItemsAPISchema
object
The details of the line items of the order. The total amount of a line item is calculated like so: totalAmount = (amount quantity) - discountAmount + taxAmount
10 properties 1 required
OrderLineItemsProductDataAPISchema
object
Details related to the product
8 properties
ThreeDSecureAuthenticationAPISchema
object
5 properties 1 required
BinDataAPISchema
object
11 properties 8 required
PaymentAuthorizationAPIRequest
object
2 properties 1 required
Expand
arraynull
A list of fields to expand, such as transactions.events.
PayPalBillingAgreementAPISchema
object
4 properties 1 required
404ErrorResponse
object
1 property 1 required
TransactionTypeEnum
string
An enumeration.
AVSRiskAssessmentValues
object
2 properties
ErrorObject
object
An object containing information about the error that occurred.
5 properties 2 required
AccountFundingTypeEnum
string
An enumeration.
ThreeDSecureAuthResponseCodeEnum
string
An enumeration.
RiskAssessmentStatusEnum
string
Possible risk assessment values for CVV and AVS checks.
GoCardlessMandateAPISchema
object
1 property 1 required
PayPalExternalPayerInfoAPISchema
object
4 properties
KlarnaSessionDetailsAPISchema
object
8 properties 5 required
CardNetworkEnum
string
The list of available card networks.
KlarnaPaymentSessionAPISchema
object
2 properties 2 required
OrderShippingAPISchema
object
4 properties
PreAuthFraudDecisionTypeEnum
string
Possible pre-authorization fraud check outcomes.
PaymentResponsePaymentMethodOptionsAPISchema
object
9 properties
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…
PaymentAPIResponse
object
18 properties
ApayaCustomerTokenAPISchema
object
3 properties 1 required
PreAuthorizationRecommendationEnum
string
Pre-authorization recommendation indicating the SCA exemption or risk assessment path taken. Only present when preAuthorizationResult is THREEDSEXEMPTION. Valu…
FirstPaymentReasonEnum
string
The reason for the first payment. This is used for informing payment processors about the specific reason a payment method is being stored. Defaults to None if…
202AcceptedResponse
object
1 property
PaymentResponseProcessorAPISchema
object
4 properties
BlockingPaymentActionTypeEnum
string
An enumeration.
CardTokenTypeEnum
string
An enumeration.
PaymentMethodTypeEnum
string
Payment method type, where OFFSESSIONPAYMENT is used for APM (Alternative Payment Method) payments and PAYMENTCARD for traditional debit or credit cards. Pleas…
AddressAPISchema
object
8 properties 3 required
AVSCheckAPISchema
object
Results of any external AVS check performed on this payment.
2 properties
PaymentAdjustAuthorizationAPIRequest
object
2 properties 1 required
PaymentCaptureAPIRequest
object
5 properties
CountryCodeEnum
2-letter country code in ISO 3166-1 alpha format, e.g. FR for France and GB for the United Kingdom.
PaymentAuthorizationRequestProcessorAPISchema
object
2 properties 1 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…
PaymentRefundAPIRequest
object
5 properties
IdealPayNLTokenAPISchema
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

primer-payments-api-api-openapi.yml Raw ↑

Other APIs Primer publishes across the network.

Primer Client Session API API
AE Profile APIs.io
Primer Dispute & Chargebacks Webhooks API
AE Profile APIs.io
Primer Payment Methods API API
AE Profile APIs.io
Primer Payment Webhooks API
AE Profile APIs.io
#Payments API
← Back to P APIs
API Details
ID
primer:primer-payments-api-api
Base URL
https://api.primer.io
Docs
https://primer.io/docs/api-reference/get-started/overview
Provider
Primer
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=primer-payments-api-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/primer-payments-api-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Primer Payments API 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.