Create a Payment Method

Tokenization is the process of breaking a stream of text/numbers up into words, phrases, symbols, or other meaningful elements called tokens. This token can then be used in place of a card number or account and routing numbers when processing a transaction. This is useful when a developer does not want to take responsibility for the security requirements of storing payment method data.

This command validates the payment method data and then returns a payment method reference token. The payment method reference token can be used in the card number field or account and routing number fields in most scenarios. Tokens for cards only store the card number and the expiration date. Tokens for checks only store the account and routing numbers. Tokens are not related to a specific merchant and can be used across multiple merchants. Credit card numbers, check account numbers, and check routing numbers will not be retrievable after initial tokenization.

Note: If it is desired to use an External ID with the Payment Method, it must be associated to the Payment Method when the Payment Method is created.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

A non-tokenized credit card or check. The 'number' and 'exp' fields are required to tokenize a card. The 'account' and 'routing' fields are required to tokenize a check. Any of the other credit card or check fields can be supplied, but they are not necessary.

In order to tokenize a card, the card number and expiration date are required. Any remaining credit card fields are optional.

string
required

required when creating a new card.

string
required

Date in the format 'MM/YY'.

string | null
^[a-zA-Z0-9]*$

Unique identifier used to look up customer. This is not generated by PaidYET.

string

Visa, MasterCard, etc.

string | null

Name on the card.

string | null

Email address associated with the card.

string | null

A description about the card.

billing_address
object

An Address represents a billing address that can be associated to a Card, Customer, or Transaction.

integer

CVV (not saved, not returned)

string | null
enum

credit, debit, prepaid, charge, deferred debit

Allowed:
string | null
enum

consumer, business, commercial, government, all, other

Allowed:
string | null

Type of card.

string | null

Country code of account.

string | null

Name of the issuer.

custom_fields
array of objects

Any custom fields associated with the card.

custom_fields
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json