createPaymentToken

Circle Mint

Core Functionality

Balances

Payouts

Wires

CBIT

PIX

Transfers

Addresses

Deposits

Accounts API

Wallets

Transfers

API Overview

Health

Management

Encryption

Subscriptions

Stablecoins

Channels

Payments API

Payments

Pull Crypto Payments

Crypto Payment Intents

Cards

Payment Tokens

Settlements

Chargebacks

Balances

Checkout Sessions

Payouts API

Payouts

Crypto Address Book

Crypto Exchange Rates

Create a payment token

POSThttps://api.circle.com/v1/paymentTokens

Convert a digital wallet (Apple Pay, Google Pay) token to a single-use payment token.

Body parameters

tokenData

object

Required

The token data

type

string

Required

Type of the digital wallet token.

idempotencyKey

uuid

Required

Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

Response

201CreatePaymentTokenResponse

Response Body

object

data

object

Show 6 properties

string

Required

Unique system generated identifier for the digital wallet token.

type

string

Required

Type of the digital wallet token.

expiresOn

string

Required

Datetime when the digital token expires. ISO-8601.

cardDetails

object

Required

Show 7 properties

expMonth

integer

Required

The card's expiration month.

expYear

integer

Required

Four digit number representing the card's expiration year.

network

string

The network of the card.

last4

string

Required

The last 4 digits of the card.

bin

string

Required

The bank identification number (BIN), the first 6 digits of the card.

fundingType

string

The funding type of the card.

issuerCountry

string

The country code of the issuer bank. Follows the ISO 3166-1 alpha-2 standard.

createDate

string

Required

ISO-8601 UTC date/time format.

updateDate

string

Required

ISO-8601 UTC date/time format.

400BadRequest

401NotAuthorized

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "id": "gc988ed5-c189-4f70-a074-e5beb7eb8e32",
4    "type": "applepay",
5    "expiresOn": "2022-01-18T19:20:00Z",
6    "cardDetails": {
7      "expMonth": 1,
8      "expYear": 2020,
9      "network": "VISA",
10      "last4": "0123",
11      "bin": "401230",
12      "fundingType": "credit",
13      "issuerCountry": "US"
14    },
15    "createDate": "2020-04-10T02:13:30.000Z",
16    "updateDate": "2020-04-10T02:13:30.000Z"
17  }
18}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy