Create an instrument - Payrails Docs

Authorizations

Authorization

string

header

required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Headers

x-idempotency-key

string<uuid>

required

Idempotency key to be used. Sending again the same key would return the same result without re-executing the update.

Body

application/json

paymentMethod

enum<string>

required

Represents the payment method type.

Available options:

googlePay,

applePay,

card,

payPal,

bankAccount,

iDeal,

bancontact,

mbWay,

klarnaPayLater,

klarnaPayNow,

klarnaPayOverTime

holderId

string<uuid>

Unique identifier of the Holder in Payrails. At least one of holderId or holderReference values have to be provided in the request.

holderReference

string

Merchant-provided reference for the transaction counterparty, i.e. the paying consumer. At least one of holderReference or holderId values have to be provided in the request.

futureUsage

enum<string>

Represents the future usage to define the payment flows that the stored instrument will be used for.

Available options:

Subscription,

CardOnFile,

UnscheduledCardOnFile

description

string

Human-friendly description of the Instrument.

Example:

"Main card, mom's card, company card"

merchantReference

string

Merchant-provided reference for the instrument.

networkTransactionReference

string

Identifier of the initial payment made with this instrument on the Networks, e.g. Mastercard Trace ID or Visa Transaction ID.

transactionLinkId

string

Mastercard Transaction Link Identifier (TLID) of the transaction series this instrument belongs to. Returned by the card network on the initial cardholder-initiated transaction and required on economically related merchant-initiated transactions, such as recurring payments and installments, when the series spans payment providers.

storeInstrument

boolean

True if the holder wants to store the instrument for future use when payment is completed.

default

boolean | null

True if the holder wants to make this instrument as default.

workspaceId

string<uuid>

Workspace identifier. When a merchant has multiple network token provider configs, this determines which workspace-scoped config is used for network token provisioning.

provisionNetworkToken

boolean

True if the merchant wants to provision a network token for this instrument.

data

Card · object

Type-specific information about the instrument.

Hide child attributes

data.network

enum<string>

required

Network of the instrument.

Available options:

unspecified,

visa,

visadankort,

mastercard,

amex,

diners,

discover,

unionpay,

unionpayuzcard,

maestro,

maestrobancontact,

hipercard,

jcb,

jcblankapay,

argencard,

aura,

belkart,

bpfuelcard,

cabal,

carnet,

cirrus,

chjonesfuelcard,

uzcard,

codensa,

dankort,

dinacard,

duet,

ebt,

eftpos,

elo,

euroshellfuelcard,

gecapital,

bc,

hrgstore,

humo,

lankapay,

lukoilfuelcard,

bancontact,

meeza,

newday,

mir,

ourocard,

pagobancomat,

paypak,

paypal,

phhfuelcard,

prostir,

rupay,

sbercard,

sodexo,

starrewards,

cencosud,

naranja,

troy,

uatp,

ukfuelcard,

verve,

voyager,

vpay,

wex,

cmi,

atm,

bankcard,

localbrand,

loyalty,

privatelabel,

fuelcard,

redfuelcard,

redliquidfuelcard

data.bin

string

required

First 6-8 digits of the Card number. Also known as IIN (Issuer Identification Number).

Required string length: 6 - 8

Example:

"416598"

data.suffix

string

required

Last digits of the Card number.

Required string length: 4

data.preferredScheme

enum<string>

Network of the instrument.

Available options:

unspecified,

visa,

visadankort,

mastercard,

amex,

diners,

discover,

unionpay,

unionpayuzcard,

maestro,

maestrobancontact,

hipercard,

jcb,

jcblankapay,

argencard,

aura,

belkart,

bpfuelcard,

cabal,

carnet,

cirrus,

chjonesfuelcard,

uzcard,

codensa,

dankort,

dinacard,

duet,

ebt,

eftpos,

elo,

euroshellfuelcard,

gecapital,

bc,

hrgstore,

humo,

lankapay,

lukoilfuelcard,

bancontact,

meeza,

newday,

mir,

ourocard,

pagobancomat,

paypak,

paypal,

phhfuelcard,

prostir,

rupay,

sbercard,

sodexo,

starrewards,

cencosud,

naranja,

troy,

uatp,

ukfuelcard,

verve,

voyager,

vpay,

wex,

cmi,

atm,

bankcard,

localbrand,

loyalty,

privatelabel,

fuelcard,

redfuelcard,

redliquidfuelcard

data.binLookup

object

Information about an issuer by the given BIN (or IIN).

Hide child attributes

data.binLookup.bin

string

required

First 6-8 digits of the Card number. Also known as IIN (Issuer Identification Number).

Required string length: 6 - 8

Example:

"416598"

data.binLookup.network

enum<string>

Network of the instrument.

Available options:

unspecified,

visa,

visadankort,

mastercard,

amex,

diners,

discover,

unionpay,

unionpayuzcard,

maestro,

maestrobancontact,

hipercard,

jcb,

jcblankapay,

argencard,

aura,

belkart,

bpfuelcard,

cabal,

carnet,

cirrus,

chjonesfuelcard,

uzcard,

codensa,

dankort,

dinacard,

duet,

ebt,

eftpos,

elo,

euroshellfuelcard,

gecapital,

bc,

hrgstore,

humo,

lankapay,

lukoilfuelcard,

bancontact,

meeza,

newday,

mir,

ourocard,

pagobancomat,

paypak,

paypal,

phhfuelcard,

prostir,

rupay,

sbercard,

sodexo,

starrewards,

cencosud,

naranja,

troy,

uatp,

ukfuelcard,

verve,

voyager,

vpay,

wex,

cmi,

atm,

bankcard,

localbrand,

loyalty,

privatelabel,

fuelcard,

redfuelcard,

redliquidfuelcard

data.binLookup.localNetwork

enum<string>

Card local network that supports the card, e.g. CartesBancaires, Dankort, Mada, Bancontact.

Available options:

bancontact,

cartesbancaires,

dankort,

mada

data.binLookup.issuer

string

Name of the bank or institution that issued the card.

data.binLookup.issuerCountry

object

Country of the bank or institution that issued the card.

Hide child attributes

data.binLookup.issuerCountry.code

string

required

ISO 3166-1 alpha-2 country code.

Pattern: ^[A-Z]{2}$

data.binLookup.issuerCountry.iso3

string

ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.

Pattern: ^[A-Z]{3}$

data.binLookup.issuerCountry.name

string

The English name of the country. Returned by Payrails, but not interpreted in requests.

data.binLookup.segment

string

Segment of the card, e.g. gold, black, business.

data.binLookup.type

string

Type of the card, e.g. credit, debit, prepaid, gift.

data.binLookup.typeDetails

string

More information about the card type, e.g. personal, commercial.

data.binLookup.isNetworkToken

boolean

Indicates whether the card credential represents a network token rather than a primary account number (PAN).

data.binLookup.isFlexCard

boolean

Indicates whether the card is enrolled in a Flexible Credential or Flex Card program supported by the network - e.g. Visa Flexible Credential, Mastercard FlexCard.

data.billingAddress

object

Billing Address of the instrument.

Hide child attributes

data.billingAddress.street

string

The name of the street of a postal address.

data.billingAddress.doorNumber

string

The number on the door, building, or room.

data.billingAddress.complement

string

Additional addressing information, 2nd line of postal address.

data.billingAddress.area

string

The name of the suburb or area within a city.

data.billingAddress.city

string

The name of the city of a postal address.

data.billingAddress.postalCode

string

The postal code.

data.billingAddress.state

string

The name of the state a postal address is in.

data.billingAddress.country

object

The country where the address is in.

Hide child attributes

data.billingAddress.country.code

string

required

ISO 3166-1 alpha-2 country code.

Pattern: ^[A-Z]{2}$

data.billingAddress.country.iso3

string

ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.

Pattern: ^[A-Z]{3}$

data.billingAddress.country.name

string

The English name of the country. Returned by Payrails, but not interpreted in requests.

data.billingAddress.latitude

number<float>

Latitude of the address in the GPS coordinate system.

data.billingAddress.longitude

number<float>

Longitude of the address in the GPS coordinate system.

data.billingAddress.phone

object

The phone to contact in the address (can be different that the customer's).

Hide child attributes

data.billingAddress.phone.number

string

required

The local number of the phone, such that countryCode + number can be dialed.

Pattern: ^[0-9]+$

data.billingAddress.phone.countryCode

string

International prefix of the phone, if known separately.

Pattern: ^\+?[0-9]+$

data.billingAddress.alias

string

Name of the address, e.g. home, work.

data.billingAddress.name

string

Name of the person to whom the address belongs to.

data.billingAddress.lastName

string

Last name of the person to whom the address belongs to.

data.billingAddress.email

string

Email of the person to whom the address belongs to.

data.expiryMonth

string

Expiry month of the Card.

Required string length: 2

data.expiryYear

string

Expiry year of the Card.

Required string length: 4

data.holderName

string

Name of the owner of the Card.

data.taxId

string

Payer-provided tax identification number (e.g. CPF in Brazil) collected on the instrument.

token

object | null

Token-specific information about the instrument. Required when creating an instrument from a tokenization tool like the Payrails SDK.

Hide child attributes

token.providerId

string<uuid>

required

Provider of the instrument token.

token.providerConfigId

string<uuid>

required

Provider config of the instrument token.

token.reference

string

required

Id of the instrument token on the provider.

token.type

enum<string>

Type of the token.

Available options:

network,

vault,

psp,

networkOffers,

networkGateway

token.requestNetworkToken

boolean

Flag indicating if the network token should be requested in the provider.

token.meta

object

Any merchant or provider-specific data that should be stored for context in the token.

encryptedDataAttributes

object

Additional attributes for the instrument tokenization.

Hide child attributes

encryptedDataAttributes.tokenMigrationId

string

Token migration ID for the instrument tokenization in case the instrument is tokenized as part of a token migration.

encryptedDataAttributes.tokenMigrationRunId

string<uuid>

Token migration run ID for the instrument tokenization in case the instrument is tokenized as part of a token migration.

encryptedDataAttributes.tokenMigrationReference

string

Token migration reference for the instrument tokenization in case the instrument is tokenized as part of a token migration.

Response

Created.

string<uuid>

required

Id of the instrument.

createdAt

string<date-time>

required

Date and time when the Instrument was created in Payrails.

updatedAt

string<date-time>

required

When the Instrument was last updated.

holderId

string<uuid>

required

Unique identifier of the Holder in Payrails.

paymentMethod

enum<string>

required

Represents the payment method type.

Available options:

alexBankMa7fazty,

applePay,

audi2pay,

bankAccount,

card,

2c2p,

vietQR,

cibSmartWallet,

easypaisa,

etisalatCash,

fawryMobileWallet,

fawryPay,

googlePay,

jazzCash,

nbePhoneCash,

orangeCash,

payPal,

qnbEWallet,

weCash,

genericRedirect,

alfa,

konnect,

eftPro,

netBanking,

upi,

cashFreeWallet,

paytmWallet,

phonePe,

iDeal,

bancontact,

klarnaPayLater,

klarnaPayNow,

klarnaPayOverTime,

scalapay

status

enum<string>

required

Status of the instrument.

Available options:

created,

deleted,

enabled,

disabled,

transient

displayName

string

Instrument name suitable for display.

description

string

Description of the instrument.

default

boolean | null

True if this instrument is set as default for the holder.

merchantReference

string

Merchant-provided reference for the instrument.

fingerprint

string

System-wide unique identifier of the Instrument. If two Holders have the same instrument stored, this value will be the same for both, but the instrument and token IDs will be different. Cannot be used for payments, should only be used for analytics and fraud prevention.

futureUsage

enum<string>

Represents the future usage to define the payment flows that the stored instrument will be used for.

Available options:

Subscription,

CardOnFile,

UnscheduledCardOnFile

networkTransactionReference

string

Identifier of the initial payment made with this instrument on the Networks, e.g. Mastercard Trace ID or Visa Transaction ID.

transactionLinkId

string

data

Card · object

Type-specific information about the instrument.

Hide child attributes

data.network

enum<string>

required

Network of the instrument.

Available options:

unspecified,

visa,

visadankort,

mastercard,

amex,

diners,

discover,

unionpay,

unionpayuzcard,

maestro,

maestrobancontact,

hipercard,

jcb,

jcblankapay,

argencard,

aura,

belkart,

bpfuelcard,

cabal,

carnet,

cirrus,

chjonesfuelcard,

uzcard,

codensa,

dankort,

dinacard,

duet,

ebt,

eftpos,

elo,

euroshellfuelcard,

gecapital,

bc,

hrgstore,

humo,

lankapay,

lukoilfuelcard,

bancontact,

meeza,

newday,

mir,

ourocard,

pagobancomat,

paypak,

paypal,

phhfuelcard,

prostir,

rupay,

sbercard,

sodexo,

starrewards,

cencosud,

naranja,

troy,

uatp,

ukfuelcard,

verve,

voyager,

vpay,

wex,

cmi,

atm,

bankcard,

localbrand,

loyalty,

privatelabel,

fuelcard,

redfuelcard,

redliquidfuelcard

data.bin

string

required

First 6-8 digits of the Card number. Also known as IIN (Issuer Identification Number).

Required string length: 6 - 8

Example:

"416598"

data.suffix

string

required

Last digits of the Card number.

Required string length: 4

data.preferredScheme

enum<string>

Network of the instrument.

Available options:

unspecified,

visa,

visadankort,

mastercard,

amex,

diners,

discover,

unionpay,

unionpayuzcard,

maestro,

maestrobancontact,

hipercard,

jcb,

jcblankapay,

argencard,

aura,

belkart,

bpfuelcard,

cabal,

carnet,

cirrus,

chjonesfuelcard,

uzcard,

codensa,

dankort,

dinacard,

duet,

ebt,

eftpos,

elo,

euroshellfuelcard,

gecapital,

bc,

hrgstore,

humo,

lankapay,

lukoilfuelcard,

bancontact,

meeza,

newday,

mir,

ourocard,

pagobancomat,

paypak,

paypal,

phhfuelcard,

prostir,

rupay,

sbercard,

sodexo,

starrewards,

cencosud,

naranja,

troy,

uatp,

ukfuelcard,

verve,

voyager,

vpay,

wex,

cmi,

atm,

bankcard,

localbrand,

loyalty,

privatelabel,

fuelcard,

redfuelcard,

redliquidfuelcard

data.binLookup

object

Information about an issuer by the given BIN (or IIN).

Hide child attributes

data.binLookup.bin

string

required

First 6-8 digits of the Card number. Also known as IIN (Issuer Identification Number).

Required string length: 6 - 8

Example:

"416598"

data.binLookup.network

enum<string>

Network of the instrument.

Available options:

unspecified,

visa,

visadankort,

mastercard,

amex,

diners,

discover,

unionpay,

unionpayuzcard,

maestro,

maestrobancontact,

hipercard,

jcb,

jcblankapay,

argencard,

aura,

belkart,

bpfuelcard,

cabal,

carnet,

cirrus,

chjonesfuelcard,

uzcard,

codensa,

dankort,

dinacard,

duet,

ebt,

eftpos,

elo,

euroshellfuelcard,

gecapital,

bc,

hrgstore,

humo,

lankapay,

lukoilfuelcard,

bancontact,

meeza,

newday,

mir,

ourocard,

pagobancomat,

paypak,

paypal,

phhfuelcard,

prostir,

rupay,

sbercard,

sodexo,

starrewards,

cencosud,

naranja,

troy,

uatp,

ukfuelcard,

verve,

voyager,

vpay,

wex,

cmi,

atm,

bankcard,

localbrand,

loyalty,

privatelabel,

fuelcard,

redfuelcard,

redliquidfuelcard

data.binLookup.localNetwork

enum<string>

Card local network that supports the card, e.g. CartesBancaires, Dankort, Mada, Bancontact.

Available options:

bancontact,

cartesbancaires,

dankort,

mada

data.binLookup.issuer

string

Name of the bank or institution that issued the card.

data.binLookup.issuerCountry

object

Country of the bank or institution that issued the card.

Hide child attributes

data.binLookup.issuerCountry.code

string

required

ISO 3166-1 alpha-2 country code.

Pattern: ^[A-Z]{2}$

data.binLookup.issuerCountry.iso3

string

ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.

Pattern: ^[A-Z]{3}$

data.binLookup.issuerCountry.name

string

The English name of the country. Returned by Payrails, but not interpreted in requests.

data.binLookup.segment

string

Segment of the card, e.g. gold, black, business.

data.binLookup.type

string

Type of the card, e.g. credit, debit, prepaid, gift.

data.binLookup.typeDetails

string

More information about the card type, e.g. personal, commercial.

data.binLookup.isNetworkToken

boolean

Indicates whether the card credential represents a network token rather than a primary account number (PAN).

data.binLookup.isFlexCard

boolean

Indicates whether the card is enrolled in a Flexible Credential or Flex Card program supported by the network - e.g. Visa Flexible Credential, Mastercard FlexCard.

data.billingAddress

object

Billing Address of the instrument.

Hide child attributes

data.billingAddress.street

string

The name of the street of a postal address.

data.billingAddress.doorNumber

string

The number on the door, building, or room.

data.billingAddress.complement

string

Additional addressing information, 2nd line of postal address.

data.billingAddress.area

string

The name of the suburb or area within a city.

data.billingAddress.city

string

The name of the city of a postal address.

data.billingAddress.postalCode

string

The postal code.

data.billingAddress.state

string

The name of the state a postal address is in.

data.billingAddress.country

object

The country where the address is in.

Hide child attributes

data.billingAddress.country.code

string

required

ISO 3166-1 alpha-2 country code.

Pattern: ^[A-Z]{2}$

data.billingAddress.country.iso3

string

ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.

Pattern: ^[A-Z]{3}$

data.billingAddress.country.name

string

The English name of the country. Returned by Payrails, but not interpreted in requests.

data.billingAddress.latitude

number<float>

Latitude of the address in the GPS coordinate system.

data.billingAddress.longitude

number<float>

Longitude of the address in the GPS coordinate system.

data.billingAddress.phone

object

The phone to contact in the address (can be different that the customer's).

Hide child attributes

data.billingAddress.phone.number

string

required

The local number of the phone, such that countryCode + number can be dialed.

Pattern: ^[0-9]+$

data.billingAddress.phone.countryCode

string

International prefix of the phone, if known separately.

Pattern: ^\+?[0-9]+$

data.billingAddress.alias

string

Name of the address, e.g. home, work.

data.billingAddress.name

string

Name of the person to whom the address belongs to.

data.billingAddress.lastName

string

Last name of the person to whom the address belongs to.

data.billingAddress.email

string

Email of the person to whom the address belongs to.

data.expiryMonth

string

Expiry month of the Card.

Required string length: 2

data.expiryYear

string

Expiry year of the Card.

Required string length: 4

data.holderName

string

Name of the owner of the Card.

data.taxId

string

Payer-provided tax identification number (e.g. CPF in Brazil) collected on the instrument.

tokens

object[]

List of tokens inside the instrument. Not included by default, includeTokens query parameter must be used.

Hide child attributes

tokens.id

string<uuid>

required

Id of the token in Payrails.

tokens.createdAt

string<date-time>

required

Date and time when the Token was created in Payrails.

tokens.updatedAt

string<date-time>

required

When the Token was last updated.

tokens.instrumentId

string<uuid>

required

Id of the payment instrument the token belongs to.

tokens.status

enum<string>

required

Status of the token.

Available options:

created,

enabled,

disabled,

deleted

tokens.type

enum<string>

required

Type of the token.

Available options:

network,

vault,

psp,

networkOffers,

networkGateway

tokens.providerId

string<uuid>

required

Id of the provider the token belongs to.

tokens.reference

string

required

Unique identifier of the token in the provider's system.

tokens.providerConfigId

string<uuid>

Id of the configuration in the provider the token belongs to.

tokens.meta

object

Any merchant or provider-specific data that should be stored for context in the token.