applePaySessions1

attachments2

bank1

Cards4

closedLoopReads1

Contacts3

Devices1

eventSubscriptions6

fundingAccounts4

fundingActivity2

fundingInstructions5

fundingRecipients9

hostedFields1

merchantPlatforms5

Owners3

paymentInstructions3

paymentIntents1

paymentLinks5

paymentPlans5

payments5

Payments5

pricingIntents6

processingAccounts9

processingTerminals4

refundInstructions3

refunds13

secureTokens6

Settlement11

sharingEvents2

signatureInstructions3

Signatures1

singleUseTokens1

Subscriptions7

terminalOrders1

pricingIntents

Create pricing intent

Use this method to create a pricing intent that you can assign to a processing account.

In the request, you must provide the following:

Processing fees, including the pricing program and the fee to process each transaction.
Gateway fees, including the fee for each transaction handled by our gateway.
Base fees, including maintenance and PCI fees.

In the response, our gateway returns information about the pricing intent and the pricingIntentId, which you need for the following methods:

Create Merchant Platform - Assign the pricing intent to a processing account, when you create the merchant platform and its processing accounts.
Create Processing Account - Assign the pricing intent to a processing account.
Retrieve Pricing Intent - Retrieve information about a pricing intent.
Update Pricing Intent - Update the details of a pricing intent.
Delete Pricing Intent - Delete a pricing intent.
Partially Update Pricing Intent - Partially update the details of a pricing intent.

post/pricing-intents

Headers

Authorizationstring required

Bearer authentication

Idempotency-Keystring uuid required

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request body

idstring

Unique identifier of the pricing intent.

createdDatestring date-time

Date and time that we received your request to create the pricing intent. We return this value in the ISO-8601 format.

lastUpdatedDatestring date-time

Date and time that the pricing intent was last modified. We return this value in the ISO-8601 format.

status'active' | 'pendingReview' | 'rejected'

Status of the pricing intent. The value can be one of the following:

active - We have approved the pricing intent.
pendingReview - We have not yet reviewed the pricing intent.
rejected - We have rejected the pricing intent.

keystring required

Unique identifier that you can assign to the pricing intent for your own records.

metadataobject

Metadata object that contains your custom data.

country'US' required

Two-digit code for the country that the pricing intent applies to. The format follows the ISO-3166-1 standard.

version'5.2' required

Version of the MPA.

Response

Successful response. We created the pricing intent and it is waiting for approval.