This API call retrieves all the details associated with the client session corresponding to the client token that is provided in the request. The fields with empty values are excluded from the response.

Retrieve a client session

Client token corresponding to the client session to retrieve

Create a client session

Update client session

Client Session API

Search & list payments

Filter payments by their payment method type.

Filter payments by their payment processor.

Return only payments from this date (inclusive).

Return only payments up to this date (inclusive).

Return payments related to this order ID.

Return payments of this amount minimum (inclusive).

Return payments of this amount max (inclusive).

ID of the customer that has made the payment.

ID of the merchant involved in the payment.

Email of the customer that has made the payment.

Last 4 digits of the card used for the payment.

Paypal email address associated with the payment.

Klarna email address associated with the payment.

Maximum number of payments to return per page.

Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request.

Create a payment

Authorize a payment

Capture a payment

Cancel a payment

Refund a payment

Resume a payment

Adjust authorized amount

ID of payment for adjusting authorization.

Get a payment

Payments API

Save a payment method token

Retrieve a list of stored payment methods for a customer.

List saved payment methods

Return payment methods for this customer ID.

Delete a saved payment method

Update a saved payment method to be the default stored payment method for a customer.

Update the default saved payment method

Saved payment method token to set to default.

Payment Methods API

Get a loyalty customer's points balance

The unique identifier for the customer on the loyalty provider.

ID of the Primer connection configuration.

List the transactions for a customer

The number of items to skip before returning results

Create a loyalty transaction

Loyalty API

AccountFundingTypeEnum

AddressApiSchema

Name of the city, district, town or village

ApayaCustomerTokenApiSchema

AuthorizationTypeEnum

Results of any external AVS check performed on this payment.

AvsCheckApiSchema

AvsRiskAssessmentValues

BinDataApiSchema

BlockingPaymentActionTypeEnum

CardAccountNumberTypeEnum

CardNetworkEnum

CardProductTypeEnum

CardRegionRestrictionEnum

CardTokenTypeEnum

CheckoutCustomerDetailsApiSchema

The customer's tax id number for tax exemptions

The customer's national identification number

CheckoutPaymentMethodCardOptionApiSchema

Dictionary of available card networks as a key with value of Payment Method Card Network Option.

CheckoutPaymentMethodOptionApiSchema

For payments using the Klarna payment method, depending on the merchant segment and/or
the services available to consumers, Klarna may require additional information regarding
the customer, the merchant and/or the purchase. This information, referred to as extra merchant
data (EMD), consist of data that is typically not available at the checkout, but which enables
Klarna to complete an assertive risk assessment, enable new promotional products and improve
conversion rates for a boost in performance.

CheckoutPaymentMethodOptionCardNetworkApiSchema

CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema

CheckoutPaymentMethodOptionExtraMerchantDataApiSchema

CheckoutPaymentMethodOptionSurchargeApiSchema

The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.

CheckoutPaymentMethodOptionsApiSchema

Whether the payment method should be vaulted on a successful payment or not.

Whether the payment method should be vaulted after a successful 3DS authentication or not.

A description of the payment, as it would typically appear on a bank statement.

CheckoutPaymentMethodOptionsApiSchemaOptions

ClientSessionApiResponse

Additional data to be used throughout the payment lifecycle.

More information associated with the customer.

More information associated with the order.

Enable certain options associated with the payment methods.

ClientSessionWarningsApiResponse

A unique code describing the particular issue

More information as to the reason for the warning

ClientSessionWithTokenApiResponse

Client token used to initialize the SDK on all platforms.

Expiration date & time of the client token (UTC with no timezoneinfo).

Warning messages to indicate missing information that are required for payment methods, checkout modules and other features; or when third-party services are unavailable.

CountryCodeEnum

Currency

CustomerDetailsApiSchema

Results of any external CVV check performed on this payment.

CvvCheckApiSchema

DeclineTypeEnum

An object containing information about the error that occurred.

ErrorObject

A human readable description of the error

Returned in case of a badly formed request

Results of the pre-authorization and post-authorization fraud checks.

FraudCheckApiSchema

FraudDecisionTypeEnum

GoCardlessMandateApiSchema

Unique identifier of a GoCardless mandate agreement

IdealPayNlTokenApiSchema

KlarnaAddressApiSchema

KlarnaCustomerTokenApiSchema

KlarnaPaymentSessionApiSchema

KlarnaSessionDetailsApiSchema

KlarnaTokenDetails

LoyaltyApiBalanceResponse

LoyaltyApiTransactionResponse

Creation date & time of the transaction (UTC)

Unique Primer identifier for the loyalty transaction.

ID of the transaction on the loyalty provider's side.

LoyaltyApiTransactionsListResponse

LoyaltyTransactionTypeEnum

MerchantPaymentMethodTokenApiResponse

Date & time when this object was revoked. (UTC)

Whether or not this object has been revoked.

Unique analytics identifier corresponding to a payment method

Payment method type associated with a token.

Whether or not this payment method is the default

MerchantPaymentMethodTokenApiResponsePaymentMethodData

OptionalAddressApiSchema

OrderDetailsApiSchema

The details of the line items of the order.

The country in which the order is created

OrderFeesApiSchema

A description of the fee, e.g. "Currency Conversion Fee".

OrderLineItemsApiSchema

The amount charged to the customer, in minor units. The minimum amount is 0.

The number of the particular line item that is being ordered.

The tax code associated with this item, in minor units. This is required for Primer-initiated tax calculations.

OrderLineItemsProductDataApiSchema

The product Global Trade Item Number (e.g. ISBN)

OrderShippingApiSchema

PayPalBillingAgreementApiSchema

PayPalExternalPayerInfoApiSchema

PayPalOrderTokenApiSchema

PaymentApiResponse

The date and time at which the payment was created in UTC format.

The date and time of the last payment update in UTC format.

The amount you charged the customer, in minor units.

The payment method options provided in the request, as well as the token used to process the payment.

More information associated with the payment processor, including the processor name.

Required action to perform in order to resume the payment workflow. This can be requiring a 3DS check from the customer for instance.

PaymentAuthorizationRequestProcessorApiSchema

The processor's merchant ID used to authorize the payment.

The processor name should be provided if the processorMerchantId is not unique across all of your integrations.

PaymentCardTokenApiSchema

PaymentListApiResponse

PaymentMethodTypeEnum

PaymentRequestPaymentMethodOptionsApiSchema

PaymentRequiredActionApiSchema

Human description of the required action to perform.

The client token to be returned to the SDK if a required action is returned.

PaymentResponsePaymentMethodOptionsApiSchema

The description of the payment, as it would typically appear
on a bank statement.

The payment method token used to authorize the transaction.

Whether the payment method token represents a vaulted payment method and can be used for future payments.

Payment method type used for payment authorization.

PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData

PaymentResponseProcessorApiSchema

The payment processor used for this payment.

The merchant ID registered at the payment processor used for this payment.

PaymentStatus

PaymentStatusTypeEnum

PaymentSummaryApiSchema

PaymentSummaryProcessorApiSchema

PaymentsInsightsBinData

The usage type of the payment card e.g. commercial, consumer.

The funding type of the payment card e.g. credit, debit, prepaid.

PaymentsInsightsBinDataIssuerCountryCode

PaymentsInsightsOrder

PaymentsInsightsOrderCountryCode

PaymentsInsightsPatchedPayment

A description of the payment,
as it would typically appear on a bank statement.

PaymentsInsightsPatchedPaymentCurrencyCode

PaymentsInsightsPatchedPaymentPaymentType

PaymentsInsightsPatchedPaymentStatus

PaymentsInsightsPayment

PaymentsInsightsPaymentCurrencyCode

PaymentsInsightsPaymentMethod

PaymentsInsightsPaymentMethodData

The first six digits of the card used for payment,
also known as the Bank Identification Number (BIN).

PaymentsInsightsPaymentPaymentType

PaymentsInsightsPaymentStatus

PaymentsInsightsProcessor

The payment processor used for this payment.
Primer supports the above processors through the Payments API,
however any value can be passed here.

PaymentsInsightsProcessorName

PaymentsInsightsStatusReason

Payment status code with the error code when
the issuer declined the payment.

Message detail returned by the processor when
the error on appeared on their part.

$	curl -X POST https://api.sandbox.primer.io/payment-instruments/string/vault \
>	-H "X-API-KEY: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"customerId": "string"
>	}'

1	{
2	"paymentMethodData": {
3	"last4Digits": "string",
4	"expirationMonth": "string",
5	"expirationYear": "string",
6	"binData": {
7	"network": "AMEX",
8	"issuerCountryCode": "AW",
9	"issuerCurrencyCode": "AED",
10	"regionalRestriction": "DOMESTIC_USE_ONLY",
11	"accountNumberType": "PRIMARY_ACCOUNT_NUMBER",
12	"accountFundingType": "CREDIT",
13	"prepaidReloadableIndicator": "RELOADABLE",
14	"productUsageType": "CONSUMER",
15	"productCode": "string",
16	"productName": "string"
17	}
18	},
19	"paymentMethodType": "PAYMENT_CARD"
20	}

Introduction

API Reference

Webhooks

Save a payment method token

Path parameters

Request

Response

Errors