Enrollment Payment Composition

integrationType

enum<string>

required

Integration type used to execute the enrollment.

Available options:

api

paymentMethodCode

enum<string>

required

Code of the payment method used to execute the enrollment in the provider.

Available options:

card

success

boolean

required

Operation outcome. If true, then the enrollment was finished successfully, and false otherwise.

paymentInstrumentId

string<uuid>

Unique identifier of the Payment Instrument that the customer selected for the Payment.

storeInstrument

boolean

Holder intention to store the payment instrument on authorize.

operationResult

enum<string>

Result of the Operation according to Payrails mapping from the provider response.

Available options:

Success,

Accepted,

Pending,

HTTPRedirectRequired,

FormRedirectRequired,

Unknown,

UnexpectedProviderResponse,

ProviderUnknownError,

ProviderConnectionError,

Timeout,

ProviderTimeout,

GenericRejection,

FraudRisk,

DuplicateOperation,

OperationNotAllowed,

InstrumentNotAllowed,

InvalidInstrument,

InsufficientBalance,

BlockedInstrument,

ExpiredInstrument,

ValidationError,

ParamsError,

ProviderConfigError,

InvalidSignature,

InternalServerError,

PayerCanceled,

AuthenticationError,

AuthenticationRequired,

LimitExceeded,

PaymentMethodNotSupported,

AuthorizationRevoked

providerId

string<uuid>

Unique identifier of the provider used to execute the enrollment.

providerConfigId

string<uuid>

Unique identifier of the provider configuration used to execute the enrollment.

operationProviderReference

string

Reference of the operation in the provider's system.

errors

object[]

The reason why the operation was not successful, set if success = false.

Hide child attributes

errors.id

string<uuid>

required

Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.

errors.code

string

required

Machine-friendly error code assigned to the error. Check the full list of possible values here.

errors.detail

string

required

Human-readable description about the error, its cause, and resolution.

errors.docUrl

string

Link to the specific documentation about this particular code.

errors.reason

object

Metadata providing more details about the reason of the error. The structure of this object varies according to the code.

paymentInstrument

object

Payment Instrument and tokens what was enrolled to network offers.

Hide child attributes

paymentInstrument.id

string<uuid>

required

Id of the instrument.

paymentInstrument.createdAt

string<date-time>

required

Date and time when the Instrument was created in Payrails.

paymentInstrument.updatedAt

string<date-time>

required

When the Instrument was last updated.

paymentInstrument.holderId

string<uuid>

required

Unique identifier of the Holder in Payrails.

paymentInstrument.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,

upiDirect,

cashFreeWallet,

paytmWallet,

phonePe,

iDeal,

iDealDirect,

bancontact,

mbWay,

mbWayDirect,

sepaDirectDebit,

sepaDirectDebitDirect,

klarnaPayLater,

klarnaPayNow,

klarnaPayOverTime,

scalapay,

payNow,

atome,

fpx,

swish

paymentInstrument.status

enum<string>

required

Status of the instrument.

Available options:

created,

deleted,

enabled,

disabled,

transient

paymentInstrument.displayName

string

Instrument name suitable for display.

paymentInstrument.description

string

Description of the instrument.

paymentInstrument.default

boolean | null

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

paymentInstrument.merchantReference

string

Merchant-provided reference for the instrument.

paymentInstrument.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.

paymentInstrument.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

paymentInstrument.networkTransactionReference

string

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

paymentInstrument.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.

paymentInstrument.data

Card · object

Type-specific information about the instrument.

Hide child attributes

paymentInstrument.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

paymentInstrument.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"

paymentInstrument.data.suffix

string

required

Last digits of the Card number.

Required string length: 4

paymentInstrument.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

paymentInstrument.data.binLookup

object

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

Hide child attributes

paymentInstrument.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"

paymentInstrument.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

paymentInstrument.data.binLookup.localNetwork

enum<string>

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

Available options:

bancontact,

cartesbancaires,

dankort,

mada

paymentInstrument.data.binLookup.issuer

string

Name of the bank or institution that issued the card.

paymentInstrument.data.binLookup.issuerCountry

object

Country of the bank or institution that issued the card.

Hide child attributes

paymentInstrument.data.binLookup.issuerCountry.code

string

required

ISO 3166-1 alpha-2 country code.

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

paymentInstrument.data.binLookup.issuerCountry.iso3

string

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

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

paymentInstrument.data.binLookup.issuerCountry.name

string

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

paymentInstrument.data.binLookup.segment

string

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

paymentInstrument.data.binLookup.type

string

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

paymentInstrument.data.binLookup.typeDetails

string

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

paymentInstrument.data.binLookup.isNetworkToken

boolean

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

paymentInstrument.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.

paymentInstrument.data.billingAddress

object

Billing Address of the instrument.

Hide child attributes

paymentInstrument.data.billingAddress.street

string

The name of the street of a postal address.

paymentInstrument.data.billingAddress.doorNumber

string

The number on the door, building, or room.

paymentInstrument.data.billingAddress.complement

string

Additional addressing information, 2nd line of postal address.

paymentInstrument.data.billingAddress.area

string

The name of the suburb or area within a city.

paymentInstrument.data.billingAddress.city

string

The name of the city of a postal address.

paymentInstrument.data.billingAddress.postalCode

string

The postal code.

paymentInstrument.data.billingAddress.state

string

The name of the state a postal address is in.

paymentInstrument.data.billingAddress.country

object

The country where the address is in.

Hide child attributes

paymentInstrument.data.billingAddress.country.code

string

required

ISO 3166-1 alpha-2 country code.

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

paymentInstrument.data.billingAddress.country.iso3

string

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

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

paymentInstrument.data.billingAddress.country.name

string

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

paymentInstrument.data.billingAddress.latitude

number<float>

Latitude of the address in the GPS coordinate system.

paymentInstrument.data.billingAddress.longitude

number<float>

Longitude of the address in the GPS coordinate system.

paymentInstrument.data.billingAddress.phone

object

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

Hide child attributes

paymentInstrument.data.billingAddress.phone.number

string

required

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

Pattern: ^[0-9]+$

paymentInstrument.data.billingAddress.phone.countryCode

string

International prefix of the phone, if known separately.

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

paymentInstrument.data.billingAddress.alias

string

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

paymentInstrument.data.billingAddress.name

string

Name of the person to whom the address belongs to.

paymentInstrument.data.billingAddress.lastName

string

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

paymentInstrument.data.billingAddress.email

string

Email of the person to whom the address belongs to.

paymentInstrument.data.expiryMonth

string

Expiry month of the Card.

Required string length: 2

paymentInstrument.data.expiryYear

string

Expiry year of the Card.

Required string length: 4

paymentInstrument.data.holderName

string

Name of the owner of the Card.

paymentInstrument.data.taxId

string

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

paymentInstrument.tokens

object[]

Payment Instrument tokens created as a result of the enrollment.

Hide child attributes

paymentInstrument.tokens.reference

string

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

paymentInstrument.tokens.type

enum<string>

Type of the token.

Available options:

network,

vault,

psp,

networkOffers,

networkGateway

paymentInstrument.tokens.meta

object

Any provider-specific data that was stored for context in the token.

Payrails API Reference

Get started

Workflow

Payment

Provider

Merchant

Vault

Analytics

Reporting

Reconciliation

Dispute

Enrollment Payment Composition