Try it

Create a payment token

FramePay is the recommended way to create a payment token because it minimizes PCI DSS compliance. Once a payment token is created, it can only be used once.

A payment token expires upon first use or within 30 minutes of the token creation (whichever comes first).

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used)

Request Body schema: application/json

PaymentToken resource

One of
method
required
string
Value: "payment-card"

The token payment method

required
object

The payment card instrument details.

object

The billing address object

object (Browser data)

Browser data used for 3DS and risk scoring.

object

Responses

Request samples

Content type
application/json
Example
{
  • "method": "payment-card",
  • "paymentInstrument":
    {
    },
  • "billingAddress":
    {
    },
  • "browserData":
    {
    },
  • "leadSource":
    {
    }
}

Response samples

Content type
application/json
Example
{
  • "method": "payment-card",
  • "paymentInstrument":
    {
    },
  • "billingAddress":
    {
    },
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "isUsed": false,
  • "browserData":
    {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "usageTime": "2019-08-24T14:15:22Z",
  • "expirationTime": "2019-08-24T14:15:22Z",
  • "_links":
    [
    ]
}